Squirrel SQL Client からPaylocity データに連携

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for Paylocity を使用して、Squirrel SQL Client などのツールでPaylocity へのクエリを実行できます。この記事では、JDBC data source for Paylocity を作成し、クエリを実行します。

JDBC Driver for Paylocity を追加する

以下のステップに従ってドライバーJAR を追加します。

1. Squirrel SQL で［Windows］->［View Drivers］と進みます。
2. プラスアイコンをクリックし、［Add Driver］ウィザードを開きます。
3. ［Name］ボックスで、CData JDBC Driver for Paylocity のようなドライバーのわかりやすい名前を入力します。
4. ［Example URL］ボックスで、jdbc:paylocity: と入力します。
5. ［Extra Class Path］タブで［Add］をクリックします。
6. 表示される［file explorer］ダイアログで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルを選択します。
7. ［List Drivers］をクリックして［Class Name］メニューにドライバーのクラス名(cdata.jdbc.paylocity.PaylocityDriver) を入力します。

接続プロパティを定義する

以下のステップに従って、接続プロパティをドライバーエイリアスに保存します。

1. ［Windows］->［View Aliases］と進みます。
2. エイリアスが一覧表示されているペインで、プラスアイコンをクリックします。

3. 表示される［Add Alias］ウィザードで、JDBC ドライバーには以下のフィールドが要求されます。

   • Name:CData Paylocity Source のようなエイリアスの名前を入力します。
   • Driver:CData JDBC Driver for Paylocity を選択します。
   • URL:jdbc:paylocity: と入力します。
4. 追加のプロパティを定義する場合は、［Properties］をクリックします。
5. 表示されるダイアログの［Driver properties］タブで、［Use driver properties］のチェックボックスを選択します。
6. ［Specify］カラムで必要な接続プロパティのチェックボックスを選択します。

   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:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
7. ［OK］をクリックし、表示されるダイアログで［connect］をクリックして接続を確認します。

スキーマを検出しPaylocity データをクエリする

メタデータが読み込まれると、Paylocity データソースの新しいタブが表示されます。［Objects］サブタブでは、使用可能なテーブルやビューなどのスキーマ情報を見つけることができます。

テーブルデータを表示するには［Objects］タブでテーブルを選択します。その後、テーブルデータが［Content］タブのグリッドに読み込まれます。

SQL クエリを実行するには、［SQL］タブにクエリを入力し、［Run SQL］(ランナーアイコン)をクリックします。例：