LINQPad でUKG Pro WFM のデータを操作する方法
CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってUKG Pro WFM の操作を実現します。この記事では、LINQPad から接続してLINQ クエリを実行する方法を説明します。
必要なもの
本記事の手順を実行してLINQPad からUKG Pro WFM に接続するには、以下の3つの製品が必要になります。
- UKG Pro WFM の環境
- LINQPad
- CData ADO.NET Provider for API。右側のサイドバーから30日間無償トライアルがダウンロードできます
データモデルの作成
CData ADO.NET Provider for API およびLINQPad をダウンロード・インストールしたら、Visual Studio で新しいクラスライブラリプロジェクトを作成します。
ADO.NET Provider の利用に必要となるEF 6を設定する方法については、ヘルプドキュメントを参照してください。
プロジェクトを右クリックし、［追加］→［新しい項目］→［ADO.NET Entity Data Model］をクリックします。ダイアログが表示されたら、データベースから［Code First］を選択します。 ［New Connection］をクリックして、表示されたウィザードで接続文字列オプションを指定します。
- AuthScheme：OAuthPassword に設定します。
- Host：UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します（例：yourcompany.mykronos.com）。プロトコル（https://）や末尾のスラッシュは含めないでください。
- OAuthClientId：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
- OAuthClientSecret：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
- User：UKG Pro Workforce Management のユーザー名に設定します。
- Password：UKG Pro Workforce Management のパスワードに設定します。
希望するテーブルおよびビューを選択して［Finish］をクリックし、データモデルを作成します。
- プロジェクトをビルドします。生成されたファイルを使ってLINQPad でUKG Pro WFM 接続を作成できます。
まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します（例：C:\profiles\UKGProWFM.apip）。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します（以下を参照）。
UKGProWFM API プロファイル設定
UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント（grant_type=password）を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。
認証するには、以下の接続プロパティを設定します。
アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。
一般的な接続文字列は次のとおりです。
Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;LINQPad でUKG Pro WFM のデータに接続
必要な接続プロパティを取得してデータモデルアセンブリを作成したら、以下の手順に従ってLINQPad でデータモデルを使いはじめましょう。
LINQPad を開き［接続の追加］をクリックします。
［Use a typed data context from your own assembly］オプションを選択します。
［Entity Framework DbContext］を選択します。
［Path to Custom Assembly］ボックスの横にある［参照］をクリックして、プロジェクトフォルダを参照します。bin フォルダの下の.dll または.exe を参照します。
- DbContext の名前を選択します。
- 接続文字列をApp.Config に保存した場合は、App.Config へのパスを指定します。
これでLINQPad 経由でUKG Pro WFM にクエリできます。サポートされたLINQ クエリの例は、ヘルプドキュメントの「LINQ およびEntity Framework」を参照してください。
