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

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

OData サービスの作成

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

1. Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
2. 自動生成された IService.cs と Service1.svc を削除します。
3. Entity Framework 6 をインストールします：

   Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。

   Install-Package EntityFramework

4. Entity Framework プロバイダーを登録します：
   1. App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。

      <configuration>
      ...
      <entityFramework>
        <providers>
          ...
          <provider invariantName="System.Data.CData.API" type="System.Data.CData.API.APIProviderServices, System.Data.CData.API.Entities.EF6" />
        </providers>
      </entityFramework>
      </configuration>

   2. インストールディレクトリの lib/4.0 にある System.Data.CData.API.Entities.dll への参照を追加します。
   3. プロジェクトをビルドして、EF6 のセットアップを完了します。
5. Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
6. 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
7. Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。

8. Connection properties ダイアログで、CData ServiceDesk Plus Data Source を選択し、必要な認証情報を入力します。

   一般的な接続文字列は以下のとおりです：

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

   OAuth 認証の設定

   ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

   1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
   2. アプリケーション構成に合わせてリダイレクト URI を設定します
   3. アプリケーション設定から Client ID と Client Secret を控えておきます

   以下の接続プロパティを設定して接続を確立してください：

   • AuthScheme：OAuth に設定します。
   • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
   • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
   • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
   • Domain：ServiceDeskPlus のドメインに設定します。
   • Portal：ServiceDeskPlus のポータルに設定します。

   接続文字列の例

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

   
9. OData クライアントからアクセスさせたい ServiceDesk Plus のテーブルとビューを選択します。
10. Project -> Add New Item -> WCF Data Service をクリックします。

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

    able to read and modify data.

      
    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 APIService{
      public class APIDataService : DataService<APIEntities> {
        public static void InitializeService(DataServiceConfiguration config) {
          config.SetEntitySetAccessRule("*", EntitySetRights.All);
          config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3;
        }
      }
    }
    	

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

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

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

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