チュートリアル: ビジネスデータを使用した SharePoint での外部リストの作成

[アーティクル]
06/19/2023

ビジネスデータ接続 (BDC) サービスを使用すると、SharePoint で、バックエンドサーバーアプリケーション、Web サービス、データベースのビジネスデータを表示できます。

このチュートリアルでは、サンプルデータベースに含まれる連絡先に関する情報を返すという、BDC サービスのモデルを作成する方法について説明します。次に、このモデルを使用して、SharePoint に外部リストを作成します。

このチュートリアルでは、次の作業について説明します。

プロジェクトの作成。
モデルへのエンティティの追加。
Finder メソッドの追加。
SpecificFinder メソッドの追加。
プロジェクトのテスト。

前提条件

このチュートリアルを実行するには、次のコンポーネントが必要です。

サポート対象エディションの Windows と SharePoint
AdventureWorks サンプルデータベースにアクセスします。 AdventureWorks データベースをインストールする方法の詳細については、SQL Server サンプルデータベースに関するページを参照してください。

BDC モデルを含むプロジェクトを作成する

Visual Studio のメニューバーで、[ファイル]>[新規作成]>[プロジェクト] の順に選択します。

[新しいプロジェクト] ダイアログボックスが表示されます。
[Visual C#] または [Visual Basic] のどちらかで、[SharePoint] ノードを展開し、[2010] 項目を選択します。
[テンプレート] ペインで、[SharePoint 2010 プロジェクト] を選択し、プロジェクトに AdventureWorksTest という名前を付けて、[OK] をクリックします。

SharePoint カスタマイズウィザードが表示されます。このウィザードでは、プロジェクトのデバッグ時に使用するサイトやソリューションの信頼レベルを設定できます。
[ファームソリューションとして配置する] オプションボタンをクリックして、信頼レベルを設定します。
[完了] をクリックして、既定のローカル SharePoint サイトを作成します。
ソリューションエクスプローラーで、[SharePoint] プロジェクトノードをクリックします。
メニューバーで [プロジェクト]>[新しい項目の追加] の順に選択します。

新しい項目の追加 ダイアログボックスが開きます。
[テンプレート] ペインで、[ビジネスデータ接続モデル (ファームソリューションのみ)] を選択し、プロジェクトに AdventureWorksContacts という名前を付けて、[追加] をクリックします。

プロジェクトにデータアクセスクラスを追加する

メニューバーで、[ツール]>[データベースへの接続] の順に選択します。

[接続の追加] ダイアログボックスが表示されます。
SQL Server AdventureWorks サンプルデータベースへの接続を追加します。

詳細については、「接続の追加/変更 (Microsoft SQL Server)」を参照してください。
ソリューションエクスプローラーで、プロジェクトノードを選択します。
メニューバーで [プロジェクト]>[新しい項目の追加] の順に選択します。
[インストールされたテンプレート] ペインで、[データ] ノードを選択します。
[テンプレート] ペインで、[LINQ to SQL クラス] を選択します。
[名前] ボックスで「AdventureWorks」と指定してから、[追加] を選択します。

.dbml ファイルがプロジェクトに追加され、オブジェクトリレーショナルデザイナー (O/R デザイナー) が開きます。
メニューバーで、[表示]>[サーバーエクスプローラー] を選択します。
サーバーエクスプローラーで、AdventureWorks サンプルデータベースを表すノードを展開し、[テーブル] ノードを展開します。
O/R デザイナーに [連絡担当者] テーブルを追加します。

エンティティクラスが作成され、デザインサーフェイスに表示されます。このエンティティクラスには、[連絡担当者] テーブルの列にマップされるプロパティが含まれています。

BDC モデルから既定のエンティティを削除する

ビジネスデータ接続モデル プロジェクトによって、Entity1 という名前の既定のエンティティがモデルに追加されます。このエンティティを削除します。後で、新しいエンティティを追加します。空のモデルから開始すると、このチュートリアルを行うために必要な手順の数が減ります。

ソリューションエクスプローラーで、[BdcModel1] ノードを展開し、BdcModel1.bdcm ファイルを開きます。
ビジネスデータ接続モデルファイルが BDC デザイナーで開きます。
デザイナーで、Entity1 のショートカットメニューを開き、[削除] を選択します。
ソリューションエクスプローラーで、Entity1.vb (Visual Basic の場合) または Entity1.cs (C# の場合) のショートカットメニューを開き、[削除] を選択します。
Entity1Service.vb (Visual Basic の場合) または Entity1Service.cs (C# の場合) のショートカットメニューを開き、[削除] を選択します。

モデルにエンティティを追加する

モデルにエンティティを追加します。エンティティは、Visual Studio のツールボックスから BDC デザイナーに追加できます。

メニューバーで [表示]、[ツールボックス] の順にクリックします。
ツールボックスの [BusinessDataConnectivity] タブで、BDC デザイナーにエンティティを追加します。

新しいエンティティがデザイナーに表示されます。 Visual Studio によって、EntityService.vb (Visual Basic の場合) または EntityService.cs (C# の場合) という名前のファイルがプロジェクトに追加されます。
メニューバーで [表示]>[プロパティ]>[ウィンドウ] の順に選択します。
[プロパティ] ウィンドウで、[名前] プロパティ値を「Contact」に設定します。
デザイナーで、エンティティのショートカットメニューを開き、[追加] を選択してから、[識別子] を選択します。

新しい識別子がエンティティに表示されます。
[プロパティ] ウィンドウで、識別子の名前を ContactID に変更します。
[型名] ボックスの一覧で、[System.Int32] を選択します。

SpecificFinder メソッドを追加する

BDC サービスで特定の連絡先を表示できるようにするには、SpecificFinder メソッドを追加する必要があります。ユーザーが一覧の項目を選択し、リボンの [項目の表示] をクリックすると、BDC サービスにより SpecificFinder メソッドが呼び出されます。

[BDC メソッドの詳細] ウィンドウを使用して、SpecificFinder メソッドを Contact エンティティに追加します。 SpecificFinder を返すには、コードをメソッドに追加します。

BDC デザイナーで、Contact エンティティを選択します。
メニューバーで、[表示]>[その他のウィンドウ]>[BDC メソッドの詳細] の順に選択します。

[BDC メソッドの詳細] ウィンドウが開きます。
[メソッドの追加] 一覧で、[Specific Finder メソッドの作成] を選択します。

Visual Studio により、次の要素がモデルに追加されます。これらの要素は、[BDC メソッドの詳細] ウィンドウに表示されます。
- ReadItem という名前のメソッド。
- メソッドの入力パラメーター。
- メソッドの戻り値パラメーター。
- 各パラメーターの型記述子。
- メソッドのメソッドインスタンス。
[BDC メソッドの詳細] ウィンドウで、Contact 型記述子に対して表示される一覧を開き、[編集] を選択します。

BDC エクスプローラーが開き、モデルの階層ビューが表示されます。
[プロパティ] ウィンドウで、TypeName プロパティの横にある一覧を開き、[現在のプロジェクト] タブを選択し、Contact プロパティを選択します。
BDC エクスプローラーで、Contact のショートカットメニューを開き、[型記述子の追加] をクリックします。

TypeDescriptor1 という名前の新しい型記述子が、BDC エクスプローラーに表示されます。
[プロパティ] ウィンドウで、[名前] プロパティの値を「ContactID」に設定します。
TypeName プロパティの横にある一覧を開き、[Int32] を選択します。
Identifier プロパティの横にある一覧を開き、[ContactID] を選択します。

手順 6 を繰り返して、次の各フィールドの型記述子を作成します。

名前	種類名
FirstName	System.String
LastName	System.String
電話	System.String
EmailAddress	System.String
EmailPromotion	System.Int32
NameStyle	System.Boolean
PasswordHash	System.String
PasswordSalt	System.String

BDC デザイナーの Contact エンティティで、ReadItem メソッドを開きます。

コードエディターで Contact サービスコードファイルが開きます。

ContactService クラスで、ReadItem メソッドを次のコードに置き換えます。このコードは、以下のタスクを実行します。

AdventureWorks データベースの Contact テーブルからレコードを取得します。
Contact エンティティが BDC サービスに返されます。

Note

ServerName フィールドの値をサーバーの名前に置き換えてください。

public static Contact ReadItem(int contactID)
{
    const string ServerName = "MySQLServerName";
    AdventureWorksDataContext dataContext = new AdventureWorksDataContext
          ("Data Source=" + ServerName + ";" +
           "Initial Catalog=AdventureWorks;Integrated Security=True");

    Contact Contact =
        (from contacts in dataContext.Contacts.AsEnumerable().Take(20)
         where contacts.ContactID == contactID
         select contacts).Single();
    return Contact;
}

Public Shared Function ReadItem(ByVal contactID As Integer) As Contact
    Const ServerName As String = "MySQLServerName"
    Dim dataContext As AdventureWorksDataContext = _
        New AdventureWorksDataContext("Data Source=" & ServerName & _
            ";Initial Catalog=AdventureWorks;Integrated Security=True")

    Dim Contact As Contact = _
        (From TempContacts In dataContext.Contacts.AsEnumerable().Take(20) _
        Where TempContacts.ContactID = contactID _
        Select TempContacts).[Single]()
    Return Contact
End Function

Finder メソッドを追加する

BDC サービスで一覧に連絡先を表示できるようにするには、Finder メソッドを追加する必要があります。 [BDC メソッドの詳細] ウィンドウを使用して、Finder メソッドを Contact エンティティに追加します。 BDC サービスにエンティティのコレクションを返すには、メソッドにコードを追加します。

BDC デザイナーで、Contact エンティティを選択します。
[BDC メソッドの詳細] ウィンドウで [ReadItem] ノードを折りたたみます。
ReadList メソッドの下にある [メソッドの追加] ボックスの一覧で、[Finder メソッドの作成] を選択します。

Visual Studio によって、メソッド、戻り値パラメーター、型記述子が追加されます。
BDC デザイナーの Contact エンティティで、ReadList メソッドを開きます。

連絡先サービスのコードファイルがコードエディターで開きます。

ContactService クラスで、ReadList メソッドを次のコードに置き換えます。このコードは、以下のタスクを実行します。

AdventureWorks データベースの Contacts テーブルからデータを取得します。

BDC サービスに Contact エンティティの一覧を返します。

Note

ServerName フィールドの値をサーバーの名前に置き換えてください。

public static IEnumerable<Contact> ReadList()
{
    const string ServerName = "MySQLServerName";
    AdventureWorksDataContext dataContext = new AdventureWorksDataContext
          ("Data Source=" + ServerName + ";" +
           "Initial Catalog=AdventureWorks;Integrated Security=True");

    IEnumerable<Contact> Contacts =
        from contacts in dataContext.Contacts.Take(20)
        select contacts;
    return Contacts;

}

Public Shared Function ReadList() As IEnumerable(Of Contact)
    Const ServerName As String = "MySQLServerName"
    Dim dataContext As AdventureWorksDataContext = _
        New AdventureWorksDataContext("Data Source=" & ServerName & _
            ";Initial Catalog=AdventureWorks;Integrated Security=True")

    Dim Contacts As IEnumerable(Of Contact) = _
        From TempContacts In dataContext.Contacts.Take(20) _
              Select TempContacts
    Return Contacts
End Function

プロジェクトをテストする

プロジェクトを実行すると、SharePoint サイトが開き、Visual Studio によってビジネスデータ接続サービスにモデルが追加されます。 Contact エンティティを参照する外部リストを SharePoint に作成します。 AdventureWorks データベースにおける連絡先のデータが一覧に表示されます。

Note

ソリューションをデバッグする前に、SharePoint のセキュリティ設定を変更することが必要になる場合があります。詳細については、「ビジネスデータ接続モデルを設計する」を参照してください。

F5 キーを押します。

SharePoint サイトが開きます。
[サイトの操作] メニューで [その他のオプション] コマンドをクリックします。
[作成] ページで、[外部リスト] テンプレートを選択し、[作成] をクリックします。
カスタムリストに Contacts という名前を付けます。
[外部コンテンツタイプ] フィールドの横にある参照ボタンをクリックします。
[外部コンテンツタイプの選択] ダイアログボックスで、[AdventureWorksContacts.BdcModel1.Contact] 項目を選択し、[作成] をクリックします。

SharePoint では、AdventureWorks サンプルデータベースの連絡先を含む外部リストが作成されます。
SpecificFinder メソッドをテストするには、一覧で連絡先を選択します。
リボンで [項目] タブを選択してから、[項目の表示] コマンドを選択します。

選択した連絡先の詳細がフォームに表示されます。

次の方法で共有

チュートリアル: ビジネスデータを使用した SharePoint での外部リストの作成

前提条件

BDC モデルを含むプロジェクトを作成する

プロジェクトにデータアクセスクラスを追加する

BDC モデルから既定のエンティティを削除する

モデルにエンティティを追加する

SpecificFinder メソッドを追加する

Finder メソッドを追加する

プロジェクトをテストする

フィードバック

その他のリソース

次の方法で共有

チュートリアル: ビジネス データを使用した SharePoint での外部リストの作成

前提条件

BDC モデルを含むプロジェクトを作成する

プロジェクトにデータ アクセス クラスを追加する

BDC モデルから既定のエンティティを削除する

モデルにエンティティを追加する

SpecificFinder メソッドを追加する

Finder メソッドを追加する

プロジェクトをテストする

関連するコンテンツ

フィードバック

その他のリソース

チュートリアル: ビジネスデータを使用した SharePoint での外部リストの作成

プロジェクトにデータアクセスクラスを追加する