DBArtisan でJDBC 経由でPaylocity データ をデータ連携利用

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Paylocity は、データベースとしてPaylocity データ に連携できるようにすることで、Paylocity データ をDBArtisan などのデータベース管理ツールにシームレスに連携します。ここでは、DBArtisan でPaylocity のJDBC ソースを作成する方法を説明します。データを直観的に標準SQL で実行できます。

Paylocity データ をDBArtisan Projects に連携

以下のステップに従って、Paylocity をプロジェクトのデータベースインスタンスとして登録します。

1. DBArtisan で、［Data Source］->［Register Datasource］とクリックします。
2. ［Generic JDBC］を選択します。
3. ［Manage］をクリックします。
4. 表示されるダイアログで、［New］をクリックします。ドライバーの名前を入力し、［Add］をクリックします。次に、ドライバーJAR に移動します。ドライバーJAR は、インストールディレクトリのlib サブフォルダにあります。
5. Connection URL ボックスで、JDBC URLに資格情報とその他の必要な接続プロパティを入力します。

   Paylocity への接続を確立するには以下を設定します。

   • RSAPublicKey：Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。

     このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。

   • UseSandbox：サンドボックスアカウントを使用する場合はTrue に設定。
   • CustomFieldsCategory：Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
   • Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。これはコンテンツを暗号化するためのキーです。

     Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
     これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。

   • IV：コンテンツを暗号化するときに使用するAES IV（base 64 エンコード）。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。

   OAuth

   OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。

   Pay Entry API

   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

   接続プロパティを入力し、接続文字列をクリップボードにコピーします。

   下は一般的な接続文字列です。

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
6. ウィザードを終了して、Paylocity に接続します。Paylocity エンティティは、［Datasource Explorer］に表示されます。

ほかのデータベースを使うのと同じように、Paylocity を使うことができます。 Paylocity API にサポートされているクエリについてのより詳しい情報は、ドライバーのヘルプドキュメントを参照してください。