Paylocity データをDataSpider Servista の連携先として使う方法

こんにちは！リードエンジニアの杉本です。

DataSpider Servista は、異なるシステムのデータやアプリケーションをノンプログラミングで「つなぐ」データインテグレーションプラットフォームです。

CData JDBC ドライバはDataSpider Servista において、JDBC データソースとして利用することが可能です。通常のJDBC の検索・更新などのアイコンを使って、標準SQL でSaaS/Web DB のデータを扱うことを可能にします。 この記事では、DataSpider で CData JDBC Driverを利用してPaylocity データに外部データとしてSQL でアクセスする方法を紹介します。

CData JDBC Driver for Paylocity をDataSpider にコネクタとして登録

1. JDBC Driver をDataSpider と同じサーバーにインストール
2. DataSpider の外部JDBCドライバのパスにCData JDBC ドライバのcdata.jdbc.paylocity.jar とcdata.jdbc.paylocity.lic を配置
   DataSpider 側：DataSpiderServista\server\plugin\data_processing\modules\jdbc_adapter
   
3. グローバルリソースのプロパティで、ドライバクラス名およびURL を入力。
   
   • 接続名：任意
   • 種別：デフォルト
   • 接続タイプ：接続タイプ：JDBC（JDBC接続設定）
   • ドライバクラス名：cdata.jdbc.paylocity.PaylocityDriver
   • URL：jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

4. 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 を設定することを意味します。

DataSpider でPaylocity データを連携利用する

あとは通常のRDB コンポーネントのように、Paylocity データを扱うことが可能です。ツールパレットのJDBC からSQL 実行やストアドプロシージャ実行コンポーネントが使用できます。

例えばPaylocity データの取得であれば、検索系SQL実行処理を使って、SELECT 文でPaylocity データを抽出することができます。

このようにCData JDBC ドライバを使って、簡単にDataSpider でPaylocity データ データをノーコードで連携利用することができます。

CData JDBC Driver for Paylocity 30日の無償評価版 をダウンロードして、お試しください。