NetBeans IDE でPaylocity データに仮想RDB として連携

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

CData JDBC Driver for Paylocity は、JDBC をサポートするIDE にリアルタイムPaylocity データへの仮想DB 連携を実現します。JDBC 標準では、ビルトインのデータアクセスウィザードや、迅速な開発をサポートするその他のツールを使用できます。この記事では、NetBeans でPaylocity に接続する方法を説明します。接続を作成して［Table Editor］でPaylocity を編集および保存、 していきます。

NetBeans にPaylocity のJDBC データソースを作成

JDBC データソースを作成するには、［Service］ウィンドウの［Database］ノードを展開し、［Drivers］ノードを右クリックして［New Driver］を選択します。［New Driver］ウィザードが表示されたら、以下の情報を入力します：

• Driver File(s)：［Add］をクリックして、ファイルエクスプローラダイアログが表示されたらcdata.jdbc.paylocity.jar ファイルを選択。ドライバーのJAR はインストールディレクトリの［lib］サブフォルダ内にあります。
• Driver Class：［Find］をクリックしてJAR 内のドライバークラスを検索し、cdata.jdbc.paylocity.PaylocityDriver をメニューから選択。
• Name：ドライバーの名前を入力。

接続パラメータを定義

下記の手順に従って、必要な接続プロパティを定義します：

1. ［Service］ウィンドウで、［Database］ノードを右クリックし［New Connection］をクリックします。

2. ［New Connection］ウィザードで次の接続プロパティを入力します：

   • Driver Name：CData JDBC Driver for Paylocity を選択。
   • User Name：ユーザーネームを入力。JDBC URL でも定義できます。
   • Password：パスワードを入力。JDBC URL でも定義できます。

   • JDBC 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 です：
     jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

リアルタイムPaylocity データをクエリ

Paylocity に接続するには、［Database］ノードにある接続を右クリックし［Connect］をクリックします。接続が確立されたら、展開してスキーマ情報を見ることができます。

［Data Views］ウィンドウにテーブルをロードするには、テーブルを右クリックしてから［View Data］をクリックします。 ［Data Views］ウィンドウではレコードの挿入、更新、および削除もできます。