Mule アプリケーションからPaylocity データにアクセス：CData JDBC Driver

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

CData JDBC Driver for Paylocity はPaylocity データをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、Paylocity データをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for Paylocity を使用して、Paylocity データのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でPaylocity データをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで250 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.paylocity.jar)。
   • Paylocity の接続文字列に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

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

   • Driver クラス名をcdata.jdbc.paylocity.PaylocityDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をPaylocity データをリクエストするためのSQL クエリに設定します。例えば、SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. Paylocity データを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、Paylocity データをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからPaylocity データを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for Paylocity の30日の無償評価版のダウンロードはこちらから。