Denodo Platform でPaylocity データソースを作成

こんにちは！テクニカルディレクターの桑島です。

Denodo Platform は、エンタープライズデータベースのデータを一元管理するデータ仮想化製品です。CData JDBC Driver for Paylocity と組み合わせると、Denodo ユーザーはリアルタイムPaylocity データと他のエンタープライズデータソースを連携できるようになります。この記事では、Denodo Virtual DataPort Administrator でPaylocity の仮想データソースを作成する手順を紹介します。

最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムPaylocity データを扱う上で比類のないパフォーマンスを提供します。Paylocity にSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をPaylocity に直接渡し、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータ型を使ってPaylocity データを操作および分析できます。

Paylocity Virtual Port を作成

Denodo からリアルタイムPaylocity データに接続するには、JDBC Driver のJAR ファイルをDenodo の外部ライブラリディレクトリにコピーし、Virtual DataPort Administration Tool から新しいJDBC データソースを作成する必要があります。

1. CData JDBC Driver for Paylocity インストーラーをダウンロードしてパッケージを展開し、JAR ファイルを実行してドライバーをインストールします。
2. JAR ファイル（およびライセンスファイルがある場合はそれも）をインストール先（通常はC:\Program Files\CData\CData JDBC Driver for Paylocity\lib\）からDenodo 外部ライブラリディレクトリ（C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-paylocity-19）にコピーします。
3. Denodo Virtual DataPort Administration Tool を開き、Server Explorer タブに移動します。
4. 「admin」を右クリックし、「New」->「Data source」->「JDBC」を選択します。
5. JCBC Connection を設定します。
   • Name：任意の名前（例：paylocity）
   • Database adapter：Generic
   • Driver class path：C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-paylocity-19
   • Driver class：cdata.jdbc.paylocity.PaylocityDriver

   • Database URI：必要な接続プロパティを使用してJDBC のURL に設定。例えば次のようになります。

     jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

     Database URI の作成については以下を参照してください。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.paylocity.jar

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

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

6. 「接続テスト」をクリックして設定を確認し、「保存」をクリックします。

Virtual DataPort Administration Tool でPaylocity データを表示

データソースを作成したら、Denodo Platform で使用するPaylocity データの基本ビューを作成できます。

1. 新しく作成したVirtualPort（admin.Paylocity）で「Create base view」をクリックします。
2. オブジェクトツリーを展開し、インポートしたいオブジェクト（テーブル）を選択します。
3. 「Create selected」をクリックしてPaylocity データのビューを作成します。
   オプション：「Create associations from foreign keys」をクリックして、オブジェクト間の関係を定義します。
4. ビューを作成した状態で、Server Explorer のテーブル（cdata_paylocity_employee）に移動し、選択したテーブルをダブルクリックします。
5. 新しいタブで「Execution panel」をクリックしてクエリパネルを開きます。
6. 「Execute」タブでクエリをカスタマイズするか、デフォルトを使用します。

   SELECT * FROM cdata_paylocity_employee CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
   

7. 「Execute」をクリックすると、データが表示されます。

基本ビューを作成すると、Denodo Platform の他のデータソースと同様にリアルタイムPaylocity データを操作できるようになります。例えば、Denodo Data Catalog でPaylocity にクエリを実行できます。

CData JDBC Driver for Paylocity の30日の無償評価版をダウンロードして、Denodo Platform でリアルタイムPaylocity データの操作をはじめましょう！ご不明な点があれば、サポートチームにお問い合わせください。