C++Builder でUKG Pro HCM のデータにデータバインドするコントロールを作成

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
C++Builder で標準コンポーネントとコントロールを使ってUKG Pro HCM のデータ にデータバインド。



CData ODBC ドライバー for UKG Pro HCM を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのUKG Pro HCM のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL（Visual Component Library）アプリケーションを作成し、UKG Pro HCM のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。

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 接続を作成します。

  1. 新しい VCL Forms アプリケーションで、Data Explorer の FireDAC ノードを展開します。
  2. Data Explorer の ODBC Data Source ノードを右クリックします。
  3. Add New Connection をクリックします。
  4. 接続の名前を入力します。
  5. 表示される FireDAC Connection Editor で、DataSource プロパティをUKG Pro HCM の ODBC DSN の名前に設定します。
ODBC データソースへの FireDAC 接続（Salesforce の例）

UKG Pro HCM のデータに接続する VCL アプリケーションを作成

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

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

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

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

    • Connection：TFDConnection コンポーネントに設定します（まだ指定されていない場合）。

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

      
SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'
    • Active：このプロパティを true に設定します。

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

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

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

    • DataSource：TDataSource の名前を選択します。
  5. TFDGUIxWaitCursor をフォームにドロップします — これは実行時エラーを回避するために必要です。
編集可能なグリッドをデータソースにデータバインドするための FireDAC コンポーネント（Salesforce の例）

FireDAC コンポーネントを使ってUKG Pro HCM にコマンドを実行

TFDConnection および TFQuery コンポーネントを使用して、UKG Pro HCM のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のUKG Pro HCM 固有の例を紹介します。

UKG Pro HCM のデータに接続

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


FDConnection1->ConnectionDefName = "CData UKG Pro HCM ODBC Source";
FDConnection1->Connected = true;

TFDQuery コンポーネントをUKG Pro HCM のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。

パラメータ化クエリの作成

パラメータ化クエリを作成するには、以下の構文を使用します： 


FDQuery1->SQL->Text = "select * from UserDetails where userstatus = :UserStatus";
FDQuery1->ParamByName("userstatus")->AsString = "A";
FDQuery1->Open();

上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。

ステートメントの準備

ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。

クエリの実行

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


FDQuery1->SQL->Text = "select * from UserDetails where userstatus = :UserStatus";
FDQuery1->ParamByName("userstatus")->AsString = "A";
FDQuery1->Open();

関連記事

以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。

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

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

UKG Pro HCM に接続

この記事の内容

関連記事