UKG Pro HCM のデータ 用のシンプルな VCL アプリケーションを構築
Embarcadero RAD Studio は、Delphi および C++Builder アプリケーション用の開発環境を提供します。CData ODBC Driver for UKG Pro HCM を使用すると、RAD Studio 内からリアルタイムUKG Pro HCM のデータにアクセスでき、データをテーブル、ビュー、ストアドプロシージャとして抽象化してUKG Pro HCM のデータの取得が可能です。この記事では、UKG Pro HCM に接続し、フォームデザイナを使用してシンプルな VCL アプリケーションを作成する方法を説明します。
UKG Pro HCM のデータ への接続を作成
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最後のステップです。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成・設定できます。
まず、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)をご参照ください。
次に、以下の手順で Data Explorer を使用してUKG Pro HCM のデータへの FireDAC 接続を作成します。
- 新しい VCL フォームアプリケーションで、Data Explorer の FireDAC ノードを展開します。
- Data Explorer で ODBC Data Source ノードを右クリックします。
- [新しい接続の追加] をクリックします。
- 接続の名前を入力します。
- 表示される FireDAC Connection Editor で、DataSource プロパティに UKG Pro HCM 用 ODBC DSN の名前を設定します。
UKG Pro HCM のデータ に接続する VCL アプリケーションを作成
以下の手順に従って、クエリ結果をグリッドに表示するシンプルな VCL アプリケーションからUKG Pro HCM のデータへのクエリ実行を開始します。
-
TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- ConnectionDefName:UKG Pro HCM のデータへの FireDAC 接続を選択します。
- Connected: メニューから True を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- Connection: まだ指定されていない場合は、このプロパティを TFDConnection コンポーネントに設定します。
SQL: SQL プロパティのボタンをクリックしてクエリを入力します。例:
SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'- Active: このプロパティを true に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- DataSet: このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します。
- DataSource: TDataSource の名前を選択します。
- TFDGUIxWaitCursor をフォームにドロップします。これはランタイムエラーを回避するために必要です。
これで、TFDQuery オブジェクトに設定された SQL クエリの結果を表示する実行可能なアプリケーションが完成しました。
関連記事
RAD Studio、Delphi、C++ Builder で CData ODBC ドライバを使用するその他の記事は以下をご覧ください。