JDBI からUKG Pro WFM データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムUKG Pro WFM のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、UKG Pro WFM のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するUKG Pro WFM のデータ の読み書きのためのコードの作成について説明します。
UKG Pro WFM Employees Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyEmployeesDAO {
//request specific data from UKG Pro WFM (String type is used for simplicity)
@SqlQuery("SELECT UserName FROM Employees WHERE PersonId = :personId")
String findUserNameByPersonId(@Bind("personId") String personId);
/*
* close with no args is used to close the connection
*/
void close();
}
UKG Pro WFM への接続を開く
必要な接続プロパティを収集し、UKG Pro WFM に接続するための適切なJDBC URL を作成します。
まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します(例:C:\profiles\UKGProWFM.apip)。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します(以下を参照)。
UKGProWFM API プロファイル設定
UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント(grant_type=password)を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。
認証するには、以下の接続プロパティを設定します。
- AuthScheme:OAuthPassword に設定します。
- Host:UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します(例:yourcompany.mykronos.com)。プロトコル(https://)や末尾のスラッシュは含めないでください。
- OAuthClientId:UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
- OAuthClientSecret:UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
- User:UKG Pro Workforce Management のユーザー名に設定します。
- Password:UKG Pro Workforce Management のパスワードに設定します。
アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、UKG Pro WFM JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
UKG Pro WFM の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;");
MyEmployeesDAO dao = dbi.open(MyEmployeesDAO.class);
//do stuff with the DAO
dao.close();
UKG Pro WFM データについて
UKG Pro WFM への接続を開いた状態で以前定義したメソッドを呼び出すだけで、UKG Pro WFM のEmployees エンティティからデータを取得できます。
//disply the result of our 'find' method
String userName = dao.findUserNameByPersonId("12345");
System.out.println(userName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムUKG Pro WFM を操作しましょう。