ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →Paylocity Driver の30日間無償トライアルをダウンロード
30日間の無償トライアルへ製品の詳細
Paylocity JDBC Driver
相談したい
Paylocity のAccounts、Envelopes、Folders データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。
CData
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Paylocity は、Java アプリケーションとリアルタイムPaylocity データ のデータ連携を実現します。これらの技術を組み合わせることによって、Paylocity データ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するPaylocity データ の読み書きのためのコードの作成について説明します。
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyEmployeeDAO {
//insert new data into Paylocity
@SqlUpdate("INSERT INTO Employee (EmployeeId, LastName) values (:employeeId, :lastName)")
void insert(@Bind("employeeId") String employeeId, @Bind("lastName") String lastName);
//request specific data from Paylocity (String type is used for simplicity)
@SqlQuery("SELECT LastName FROM Employee WHERE EmployeeId = :employeeId")
String findLastNameByEmployeeId(@Bind("employeeId") String employeeId);
/*
* close with no args is used to close the connection
*/
void close();
}
必要な接続プロパティを収集し、Paylocity に接続するための適切なJDBC URL を作成します。
Paylocity への接続を確立するには以下を設定します。
このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。
Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。
OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。
Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。
UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。
JDBC URL の構成については、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.paylocity.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Paylocity の接続文字列は、通常次のようになります。
jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH");
MyEmployeeDAO dao = dbi.open(MyEmployeeDAO.class);
//do stuff with the DAO
dao.close();
Paylocity への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Paylocity のEmployee エンティティからデータを取得できます。
//disply the result of our 'find' method
String lastName = dao.findLastNameByEmployeeId("1234");
System.out.println(lastName);
以前定義した方法を使用すれば、Paylocity にデータを書き込むことも簡単になります。
//add a new entry to the Employee entity
dao.insert(newEmployeeId, newLastName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Paylocity と統合することで、SQL Object API for Paylocity を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムPaylocity を操作しましょう。