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

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

はじめに

---

OData サービスの作成

以下の手順で、OData 経由でWorkday のデータへの接続を提供する 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.Workday" type="System.Data.CData.Workday.WorkdayProviderServices, System.Data.CData.Workday.Entities.EF6" />
        </providers>
      </entityFramework>
      </configuration>

   2. インストールディレクトリの lib/4.0 にある System.Data.CData.Workday.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 Workday Data Source を選択し、必要な認証情報を入力します。

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

   User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;

   Workday 接続プロパティの取得・設定方法

   ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

   接続の前提条件

   API / 前提条件 / 接続パラメータ
   WQL / WQL サービスを有効化（下記参照） / ConnectionType： WQL
   Reports as a Service / カタログレポートの設定（ヘルプドキュメントの「データアクセスのファインチューニング」参照） / ConnectionType： Reports
   REST / 自動で有効化 / ConnectionType： REST
   SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

   BaseURL およびTenant の取得

   BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

   REST API Endpoint のフォーマットは、 https://domain.com//mycompany です。ここで、
   

   • https://domain.com（URL のサブディレクトリと会社名の前の部分）はBaseURL です。
   • mycompany（URL の最後のスラッシュの後の部分）はTenant です。

   例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

   WQL サービスを有効化

   Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。
   1. Workday を開きます。
   2. 検索バーにView Domain と入力します。
   3. プロンプトにWorkday Query Language と入力します。
   4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

   Workday への認証

   Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。
   
9. OData クライアントからアクセスさせたい Workday のテーブルとビューを選択します。
10. Project -> Add New Item -> WCF Data Service をクリックします。

11. データソースクラスを指定し、新しい 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 WorkdayService{
      public class WorkdayDataService : DataService<WorkdayEntities> {
        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/WorkdayDataService.svc/）。
4. OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
5. ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
6. Close をクリックして、Power Pivot にデータをインポートします。