Aqua Data Studio で UKG Pro HCM のデータ に接続

CData JDBC Driver for UKG Pro HCM は、Aqua Data Studio などの IDE のウィザードや分析機能と UKG Pro HCM のデータ を連携できます。本記事では、接続マネージャーを使って UKG Pro HCM のデータ に接続し、クエリを実行する方法を説明します。

JDBC データソースの作成

接続マネージャーを使用して接続プロパティを定義し、新しい JDBC データソースとして保存できます。作成した UKG Pro HCM データソースは、Aqua Data Studio の各ツールからアクセスできるようになります。

1. Aqua Data Studio で、Servers メニューから Register Server を選択します。
2. Register Server フォームで、「Generic - JDBC」接続を選択します。
3. 以下の JDBC 接続プロパティを入力します：
   • Name: データソースの名前を入力します（例：UKG Pro HCM）。
   • Driver Location: Browse ボタンをクリックし、インストールディレクトリの lib サブフォルダにある cdata.jdbc.api.jar ファイルを選択します。
   • Driver: ドライバーのクラス名 cdata.jdbc.api.APIDriver を入力します。

   • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後にセミコロン区切りで接続プロパティを指定します。

     まず、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 URL の作成には、UKG Pro HCM JDBC Driver に組み込まれている接続文字列デザイナーをご利用いただけます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

     
     java -jar cdata.jdbc.api.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     一般的な JDBC URL は以下のとおりです：

     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';

   

UKG Pro HCM のデータ へのクエリ

これで、公開されているテーブルにクエリを実行できます。