Squirrel SQL Client からUKG Pro HCM のデータに連携

CData JDBC Driver for API を使用して、Squirrel SQL Client などのツールでUKG Pro HCM へのクエリを実行できます。この記事では、JDBC data source for API を作成し、クエリを実行します。

JDBC Driver for API を追加する

以下のステップに従ってドライバーJAR を追加します。

1. Squirrel SQL で［Windows］->［View Drivers］と進みます。
2. プラスアイコンをクリックし、［Add Driver］ウィザードを開きます。
3. ［Name］ボックスで、CData JDBC Driver for API のようなドライバーのわかりやすい名前を入力します。
4. ［Example URL］ボックスで、jdbc:api: と入力します。
5. ［Extra Class Path］タブで［Add］をクリックします。
6. 表示される［file explorer］ダイアログで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルを選択します。
7. ［List Drivers］をクリックして［Class Name］メニューにドライバーのクラス名(cdata.jdbc.api.APIDriver) を入力します。

接続プロパティを定義する

以下のステップに従って、接続プロパティをドライバーエイリアスに保存します。

1. ［Windows］->［View Aliases］と進みます。
2. エイリアスが一覧表示されているペインで、プラスアイコンをクリックします。

3. 表示される［Add Alias］ウィザードで、JDBC ドライバーには以下のフィールドが要求されます。

   • Name:CData UKG Pro HCM Source のようなエイリアスの名前を入力します。
   • Driver:CData JDBC Driver for API を選択します。
   • URL:jdbc:api: と入力します。
   • User Name:ユーザー名を入力すると、JDBC URL に追加されます。
   • Password:パスワードを入力すると、JDBC URL に追加されます。
   
4. 追加のプロパティを定義する場合は、［Properties］をクリックします。
5. 表示されるダイアログの［Driver properties］タブで、［Use driver properties］のチェックボックスを選択します。
6. ［Specify］カラムで必要な接続プロパティのチェックボックスを選択します。

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

   以下は一般的な接続文字列です。

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

   
7. ［OK］をクリックし、表示されるダイアログで［connect］をクリックして接続を確認します。

スキーマを検出しUKG Pro HCM のデータをクエリする

メタデータが読み込まれると、UKG Pro HCM のデータソースの新しいタブが表示されます。［Objects］サブタブでは、使用可能なテーブルやビューなどのスキーマ情報を見つけることができます。

テーブルデータを表示するには［Objects］タブでテーブルを選択します。その後、テーブルデータが［Content］タブのグリッドに読み込まれます。

SQL クエリを実行するには、［SQL］タブにクエリを入力し、［Run SQL］(ランナーアイコン)をクリックします。例：

SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'