Denodo Platform で Paylocity のデータに接続

Jerod Johnson
Senior Technology Evangelist

CData ドライバーを使用して、Denodo Virtual DataPort Administrator で Paylocity のデータ用の仮想データソースを作成する方法を説明します。

Denodo Platform は、エンタープライズデータベースのデータを統合的に扱うことができるデータ仮想化製品です。CData JDBC Driver for Paylocity と組み合わせることで、Denodo ユーザーは他のエンタープライズデータソースと並んでライブ Paylocity のデータを扱うことができます。本記事では、Denodo Virtual DataPort Administrator で Paylocity 用の仮想データソースを作成する方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、ライブ Paylocity のデータとのやり取りにおいて比類のないパフォーマンスを提供します。Paylocity に対して複雑な SQL クエリを発行すると、ドライバーはフィルターや集計などのサポートされている SQL 操作を直接 Paylocity にプッシュし、内蔵の SQL エンジンを使用してサポートされていない操作（主に SQL 関数や JOIN 操作）をクライアントサイドで処理します。また、動的メタデータクエリ機能を内蔵しているため、ネイティブデータ型を使用して Paylocity のデータを操作・分析できます。

Paylocity 仮想ポートの作成

Denodo からライブ Paylocity のデータに接続するには、JDBC Driver の JAR ファイルを Denodo の外部ライブラリディレクトリにコピーし、Virtual DataPort Administrator ツールで新しい JDBC データソースを作成します。

CData JDBC Driver for Paylocity インストーラーをダウンロードし、パッケージを解凍して JAR ファイルを実行してドライバーをインストールします。
インストール先（通常は C:\Program Files\CData\CData JDBC Driver for Paylocity\lib\）から JAR ファイル（およびライセンスファイルが存在する場合はそれも）を Denodo 外部ライブラリディレクトリ（C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-paylocity-19）にコピーします。
Denodo Virtual DataPort Administrator ツールを開き、Server Explorer タブに移動します。
"admin" を右クリックし、New -> Data source -> JDBC を選択します。
JDBC 接続を設定します:
- 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;
  
  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 を設定することを意味します。
"Test connection" ボタンをクリックして設定を確認し、Save をクリックします。

VirtualPort Administrator ツールで Paylocity のデータを表示

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

新しく作成した VirtualPort (admin.Paylocity) で "Create base view" ボタンをクリックします。
オブジェクトツリーを展開し、インポートするオブジェクト（テーブル）を選択します。
"Create selected" ボタンをクリックして、Paylocity のデータのビューを作成します。
オプション: "Create associations from foreign keys" をクリックして、オブジェクト間のリレーションシップを定義できます。
ビューが作成されたら、Server Explorer で対象テーブル（cdata_paylocity_employee）に移動し、選択したテーブルをダブルクリックします。
新しいタブで "Execution panel" をクリックしてクエリパネルを開きます。
"Execute" タブでクエリをカスタマイズするか、デフォルトのクエリを使用します:
```
SELECT * FROM cdata_paylocity_employee CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
```
Execute をクリックしてデータを表示します。