UKG Pro HCM のデータを帳票ツールbiz-Stream で連携利用する方法

宮本航太
宮本航太
プロダクトスペシャリスト
CData JDBC ドライバを使って、帳票ツールのbiz-Stream で UKG Pro HCM をノーコードで連携。



biz-Stream は、多様な表現が可能なWeb 帳票ソリューションです。

この記事では、biz-Stream からCData JDBC ドライバ経由でUKG Pro HCM のデータにリアルタイムで連携接続して帳票から利用する方法を紹介します。CData Drivers を使うことで、RDB のようにbiz-Stream 内でUKG Pro HCM のデータを扱うことができるようになります。

biz-Stream へのUKG Pro HCM JDBC ドライバーの配置

デフォルトの内容でインストールした場合、以下のパスに jar ファイルが配置されますので、その jar ファイルを biz-Stream の所定のパスにコピーします。

  • cdata.jdbc.api.jar
  • cdata.jdbc.api.lic （試用版では.lic ファイルは不要）
  • コピー元：C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib
  • コピー先：C:\Program Files (x86)\brainsellers\biz-Stream レイアウト・デザイナ\lib_jdbc

biz-Stream からUKG Pro HCM への接続設定

レイアウトデザイナを起動後、リソース定義にて UKG Pro HCM への接続設定を行います。ドライバー選択のプルダウンに CData API JDBC Driver が表示されますので選択します。

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

サーバURLは以下の形式で入力します。
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 のデータ リソースの作成

JDBC Driver の接続文字列デザイナーを使う

JDBC 接続文字列を作るには、UKG Pro HCM JDBC Driver のビルトイン接続文字列デザイナーを使う方法があります。ドライバーの.jar ファイルをダブルクリックするか、コマンドラインから.jar ファイルを実行します。

Windows:


java -jar 'C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar'

MacOS:


java -jar cdata.jdbc.api.jar

接続プロパティに値を入力して、生成される接続文字列をクリップボードにコピーします。

接続文字列デザイナーを使って、JDBC URL を生成する (Salesforce is shown.)

次にデータ取得条件を設定します。SQL 定義から定義名を設定し、編集ボタンをクリックします。

UKG Pro HCM のデータ リソースの編集

上のグレーエリアで右クリック → テーブルリストと選択しますと、UKG Pro HCM のオブジェクトがリストで表示されます。使用するテーブルを選択します。

UKG Pro HCM のデータ リソースの選択

ここでは取得対象の項目や条件などを設定することができます。対象項目や条件を指定できたらOKボタンをクリックし、戻った画面で追加ボタンをクリックします。

UKG Pro HCM のデータ のカラム選択と条件設定

最後にデータソース設定を行います。データソース定義名に先ほど設定したものを選択し、画面下部にある追加ボタンをクリックします。これでbiz-Stream でUKG Pro HCM のデータを利用する準備ができました。

データソース設定

UKG Pro HCM のデータをリアルタイムで参照するbiz-Stream 帳票のデザイン

用紙設定を行います。今回は A4 設定にしました。設定後は画面下部にある追加ボタンをクリックします。

ページ設定では新規ボタンをクリックします。

ここではレイアウトデザイナが帳票テンプレートを xml で保存しますので、ファイル名を設定します。

レイアウトにはさまざまなメニューがありますが、今回は表を使用します。表を設定後、UKG Pro HCM から取得したデータをセットするエリアを作成します。各セルにテキストボックスを挿入し、そのテキストボックス自体に UKG Pro HCM の項目を紐づけします。
※ヘッダーにもそれぞれテキストボックスを追加します。

表オブジェクトとしてUKG Pro HCM を使用

レイアウト作成画面を閉じた後、ページ設定の画面に戻りますので、画面下部にある追加ボタン（一度作成している場合は適用）をクリックし、レイアウトの作成が完了となります。

レイアウトデザイナーのトップ画面のヘッダーメニューからプレビューアイコンをクリックします。先ほど作成したレイアウトで UKG Pro HCM のデータを表示させることができます。

このようにCData JDBC ドライバをアップロードすることで、簡単にbiz-Stream でUKG Pro HCM のデータをリアルタイムに参照する帳票をノーコードで連携して作成することができます。

ぜひ、CData JDBC Driver for API 30日の無償評価版 をダウンロードして、お試しください。

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

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

UKG Pro HCM に接続

この記事の内容

関連記事