WCF アプリケーションで SharePoint のデータの OData サービスを公開

Jerod Johnson
Senior Technology Evangelist

この記事では、WCF サービスアプリケーションを開発してSharePoint のデータの OData フィードを生成する方法を解説します。

CData ADO.NET Provider for SharePoint を使用すると、Windows Communication Foundation（WCF）フレームワークを活用してサービス指向アプリケーションを素早く開発し、SharePoint のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。

SharePoint データ連携について

CData を使用すれば、SharePoint のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています：

Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以降、SharePoint Online を含む、幅広い SharePoint バージョンのデータにアクセスできます。
非表示カラムとルックアップカラムのサポートにより、SharePoint のすべてにアクセスできます。
フォルダを再帰的にスキャンして、すべての SharePoint データのリレーショナルモデルを作成できます。
SQL ストアドプロシージャを使用して、ドキュメントや添付ファイルをアップロード・ダウンロードできます。

多くのお客様は、SharePoint データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用していますが、Power BI、Tableau、Excel などのお気に入りのデータツールと SharePoint データを統合しているお客様もいます。

お客様が CData の SharePoint ソリューションで問題を解決している方法については、ブログをご覧ください：Drivers in Focus: Collaboration Tools

はじめに

OData サービスの作成

以下の手順で、OData 経由でSharePoint のデータへの接続を提供する WCF サービスアプリケーションを作成します。

Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
自動生成された IService.cs と Service1.svc を削除します。
Entity Framework 6 をインストールします：
Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。
```
Install-Package EntityFramework
```
Entity Framework プロバイダーを登録します：
1. App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。
```
<configuration>
...
<entityFramework>
  <providers>
    ...
    <provider invariantName="System.Data.CData.SharePoint" type="System.Data.CData.SharePoint.SharePointProviderServices, System.Data.CData.SharePoint.Entities.EF6" />
  </providers>
</entityFramework>
</configuration>
```
2. インストールディレクトリの lib/4.0 にある System.Data.CData.SharePoint.Entities.dll への参照を追加します。
3. プロジェクトをビルドして、EF6 のセットアップを完了します。
Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。
Connection properties ダイアログで、CData SharePoint Data Source を選択し、必要な認証情報を入力します。
一般的な接続文字列は以下のとおりです：
```
User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;
```
Microsoft SharePoint への接続

URL の設定：

Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。
```
https://teams.contoso.com
```
個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。
```
https://teams.contoso.com/TeamA
```
続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル（例：Microsoft Online Services アカウントのクレデンシャル）を設定します。

Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。
- Microsoft Entra ID（Azure AD）
- ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン（SSO）
- Azure MSI
- Azure パスワード
- OAuthJWT
- SharePointOAuth
Microsoft SharePoint オンプレミス

Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。
- Windows（NTLM）
- Kerberos
- ADFS
- 匿名アクセス
まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。

Windows（NTLM）認証

これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。
OData クライアントからアクセスさせたい SharePoint のテーブルとビューを選択します。
Project -> Add New Item -> WCF Data Service をクリックします。

データソースクラスを指定し、新しい WCF Data Service へのアクセスを構成します。以下の例では、エンティティの Access Rule が All に設定されています。これは、すべてのユーザーがデータの読み取りと変更を行えることを意味します。

  
using System;
using System.Collections.Generic;
using System.Data.Services;
using System.Data.Services.Common;
using System.Linq;
using System.ServiceModel.Web;
using System.Web;

namespace SharePointService{
  public class SharePointDataService : DataService<SharePointEntities> {
    public static void InitializeService(DataServiceConfiguration config) {
      config.SetEntitySetAccessRule("*", EntitySetRights.All);
      config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3;
    }
  }
}

プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます：

Power Pivot から OData サービスを利用する

これで、任意の OData クライアント（例：Excel Power Pivot）からサービスを利用できます。

Excel を開き、Power Pivot Window ボタンをクリックします。
新しいポップアップが表示されます。From Data Feeds オプションを選択します。
表示される Table Import Wizard で、OData URL を入力します（例：http://localhost:12449/SharePointDataService.svc/）。
OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
Close をクリックして、Power Pivot にデータをインポートします。