Delphi のUKG Pro WFM のデータへのデータバインドコントロール

古川えりか
古川えりか
コンテンツスペシャリスト
標準のデータアクセスコンポーネントとコントロールを備えたDelphi のUKG Pro WFM にデータバインドします。



CData ODBC Driver for API は、ODBC 標準をサポートし、リアルタイムUKG Pro WFM のデータとビジュアルフォームデザイナおよびDelphi の他のラピッド開発ツールとの統合を可能にします。ODBC ドライバーは、データベース開発用のシングルAPI を提供することにより、Delphi のような単一のコードベースを共有するアプリケーションのデータアクセス戦略を簡素化します。この記事では、UKG Pro WFM に接続してシンプルなVisual Component Library (VCL) アプリケーションおよびDelphi コードからデータをクエリする方法を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. UKG Pro WFM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにUKG Pro WFM のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてUKG Pro WFM の接続を設定、2.Delphi 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとUKG Pro WFM への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

未指定の場合は、初めにODBC DSN (data source name) で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および構成できます。

まず、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、クライアントシークレットを使って、直接アクセストークンを取得します。

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

  • 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 のパスワードに設定します。

アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

以下のステップに従ってData Explorer を使用し、UKG Pro WFM へのFireDAC 接続を作成できます。

  1. 新しいVCL Forms アプリケーションの［Data Explorer］で［FireDAC］ノードを展開します。
  2. ［Data Explorer］で［ODBC Data Source］ノードを右クリックします。
  3. ［Add New Connection］をクリックします。
  4. 接続の名前を入力します。
  5. 表示される［FireDAC Connection Editor］で、［DataSource］プロパティをODBC DSN for API の名前に設定します。
A FireDAC connection to the ODBC data source.(Salesforce is shown.)

UKG Pro WFM のデータに接続できるVCL アプリケーションの作成

以下のステップに従って、クエリの結果をグリッドに表示するシンプルなVCL アプリケーションからUKG Pro WFM のクエリの実行を開始します。

  1. TFDConnection コンポーネントフォームにドロップし、以下のプロパティを設定します。

    • ConnectionDefName：UKG Pro WFM へのFireDAC 接続を選択します。
    • Connected：メニューから［True］を選択し、表示されるダイアログで資格情報を入力します。

  2. TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します。

    • Connection：コンポーネントがまだ指定されていない場合は、このプロパティを［TFDConnection］コンポーネントに設定します。

    • SQL：［SQL］プロパティ内のボタンをクリックし、クエリを入力します。例：

      
SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'
    • Active：このプロパティをtrue に設定します。

  3. TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します。

    • DataSet：このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。

  4. TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します。

    • DataSource：TDataSource の名前を選択します。
  5. 実行時エラーを回避するために、TFDGUIxWaitCursor をフォームにドロップします。
Components in FireDAC used to databind an editable grid to the data source.(Salesforce is shown.)

FireDAC コンポーネントを使用してUKG Pro WFM へのコマンドを実行

TFDConnection およびTFQuery コンポーネントを使用してUKG Pro WFM へのクエリを実行できます。このセクションでは、TFQuery コンポーネントを使用してクエリを実行するUKG Pro WFM 固有の例を示します。

UKG Pro WFM のデータに接続

データソースに接続するには、TFDConnection コンポーネントの［Connected］プロパティをtrue に設定します。コードでも同じプロパティを設定できます。


FDConnection1.ConnectionDefName := 'myukgprowfm';
FDConnection1.Connected := true;

パラメータクエリの作成

パラメータ化されたリソースはパフォーマンスを向上させることができます。ステートメントの準備は、システムリソースと時間の面でコストがかかります。ステートメントの準備中、接続がアクティブで開いている必要があるためです。FireDACはデフォルトで、同じクエリが何度もリコンパイルされないようにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を［True］に設定します。クエリを一回だけ実行する必要がある場合などに設定します。

クエリの実行

select クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドは、クエリを実行して結果セットを返し、それを開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。


FDQuery1.Open('select * from Employees where PersonId = :PersonId',['12345']);

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

はじめる準備はできましたか？

API Driver で UKG Pro WFM のライブデータに接続

UKG Pro WFM に接続

この記事の内容

関連記事