JDBI からUKG Pro HCM データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムUKG Pro HCM のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、UKG Pro HCM のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するUKG Pro HCM のデータ の読み書きのためのコードの作成について説明します。
UKG Pro HCM UserDetails Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyUserDetailsDAO {
//request specific data from UKG Pro HCM (String type is used for simplicity)
@SqlQuery("SELECT UserName FROM UserDetails WHERE UserStatus = :userStatus")
String findUserNameByUserStatus(@Bind("userStatus") String userStatus);
/*
* close with no args is used to close the connection
*/
void close();
}
UKG Pro HCM への接続を開く
必要な接続プロパティを収集し、UKG Pro HCM に接続するための適切なJDBC 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
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
UKG Pro HCM の接続文字列は、通常次のようになります。
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';
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("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';");
MyUserDetailsDAO dao = dbi.open(MyUserDetailsDAO.class);
//do stuff with the DAO
dao.close();
UKG Pro HCM データについて
UKG Pro HCM への接続を開いた状態で以前定義したメソッドを呼び出すだけで、UKG Pro HCM のUserDetails エンティティからデータを取得できます。
//disply the result of our 'find' method
String userName = dao.findUserNameByUserStatus("A");
System.out.println(userName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムUKG Pro HCM を操作しましょう。