WCF でUKG Pro HCM の OData サービスを公開する方法

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

OData サービスの作成

以下の手順で、OData 経由でUKG Pro HCM のデータへの接続を提供する 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 UKG Pro HCM Data Source を選択し、必要な認証情報を入力します。

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

   Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';

   まず、Profile 接続プロパティをディスク上の UKGProHCM プロファイルの場所に設定します（例：C:\profiles\UKGProHCM.apip）。次に、ProfileSettings 接続プロパティを UKGProHCM の接続文字列に設定します（以下を参照）。

   UKGProHCM API プロファイル設定

   UKG Pro HCM では、Basic 認証とカスタマー API キーを組み合わせて API へのアクセスを認可します。接続には、UKG Pro HCM の認証情報と、UKG が発行したカスタマー API キーが必要です。

   認証するには、以下の接続プロパティを設定します。

   • AuthScheme：Basic に設定します。
   • User：UKG Pro HCM のユーザー名に設定します。
   • Password：UKG Pro HCM のパスワードに設定します。
   • ProfileSettings：以下の項目をセミコロン区切りで指定します。
     • Host：UKG Pro HCM テナントのホスト名（例：yourcompany.ultipro.com）。
     • CustomerAPIKey：UKG のカスタマー API キー。各 API 呼び出しで US-CUSTOMER-API-KEY リクエストヘッダーとして渡されます。

   カスタマー API キーの入手方法については、UKG Pro HCM の管理者にお問い合わせいただくか、UKG Developer Portal（https://developer.ukg.com）をご参照ください。

   
9. OData クライアントからアクセスさせたい UKG Pro HCM のテーブルとビューを選択します。
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 にデータをインポートします。