Mule アプリケーションからUKG Pro HCM のデータにアクセス:CData JDBC Driver
CData JDBC Driver for API はUKG Pro HCM のデータをMule アプリケーションと連携することで、読みといった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、UKG Pro HCM のデータをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。
本記事では、Mule プロジェクト内でCData JDBC Driver for API を使用して、UKG Pro HCM のデータのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でUKG Pro HCM のデータをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで数百種類のデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。
- Anypoint Studio で新しいMule プロジェクトを作る。
- Message Flow にHTTP コネクタを追加する。
- HTTP コネクタのアドレスを設定する。

- HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
- データベースへの新しい接続を作成し(または既存の接続を編集し)、プロパティを設定する。
- 接続を「Generic Connection」に設定
- Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例:cdata.jdbc.api.jar)。
- UKG Pro HCM の接続文字列にURL を指定
まず、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接続プロパティを入力して、接続文字列をクリップボードにコピーします。
- Driver クラス名をcdata.jdbc.api.APIDriver に指定します。
- 「接続テスト」をクリックします。
- SQL Query Text をUKG Pro HCM のデータをリクエストするためのSQL クエリに設定します。例えば、
。SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'
- Transform Message コンポーネントをフローに追加します。
- Output スクリプトを次のように設定して、ペイロードをJSON に変換します。
%dw 2.0 output application/json --- payload
- UKG Pro HCM のデータを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します(デフォルトでは、localhost:8081):http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、UKG Pro HCM のデータをJSON として利用できます。
これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからUKG Pro HCM のデータを(JSON データとして)扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for API の30日の無償評価版のダウンロードはこちらから。