LINQ を使ってUKG Pro HCM のデータに連携する方法

この記事では、CData ADO.NET Data Provider for API 経由でLINQ を使ってUKG Pro HCM テーブルにアクセスする方法を説明します。これを行うには、Entity Framework にLINQ を使います。これにより接続を作成し、あらゆる CData ADO.NET Data Providers からLINQ を使ってデータにアクセスできるようになります。

1. Visual Studio の新規プロジェクトで、プロジェクトを右クリックし［新しい項目の追加］を選択します。［ADO.NET Entity Data Model］を追加します。
2. ［データベースから生成］を選択し、［次へ］をクリックします。
3. ［接続の追加］をクリックし、データソースタイプを "CData UKG Pro HCM Data Source" に変更します。

4. データソースの接続情報を入力します。一般的な接続プロパティは以下のとおりです：

   まず、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）をご参照ください。

   Below is a typical connection string:

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


5. エンティティ接続をApp.Config に保存する場合は、エンティティ名を設定します。この例では、APIEntities をエンティティ接続としてApp.Config に設定しています。
6. モデル名を入力し、モデルに含めたいテーブルまたはビューを選択します。

作成したエンティティを使って、選択、更新、削除、および挿入コマンドが実行できます。例：

APIEntities context = new APIEntities();
var userdetailsQuery = from userdetails in context.UserDetails  select userdetails;
foreach (var result in userdetailsQuery) {
	Console.WriteLine("{0} {1} ", result.Id, result.UserId);
}
	

サポートされたLINQ のクエリ例は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。