APOS Live Data Gateway でPaylocity のデータのセマンティックレイヤービューを構築

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

APOS Live Data Gateway（LDG）は、SAP Analytics Cloud をはじめとするSAP ソリューションのリアルタイムデータ接続やデータソースオプションの拡張を実現する、データ連携およびデータ変換ソリューションです。CData コネクタと組み合わせると、ユーザーはリアルタイムPaylocity のデータのセマンティックレイヤービューを構築し、リレーショナルデータベースを扱うのと同じようにPaylocity のリアルタイム分析を行うことができます。

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

コネクタファイルのダウンロードおよびインストール

APOS Live Data Gateway を経由してPaylocity のデータにアクセスするには、APOS からコネクタファイルをダウンロードしてLive Data Gateway をホストするマシンにインストールする必要があります。APOS の担当者から必要なファイルが届きます。

• CData DLL ファイル（System.Data.CData.Paylocity.dll）をAPOS Live Data Gateway のインストールディレクトリ（デフォルトではC:\Program Files\Live Data Gateway\Admin\）にインストールします。
• CData JAR ファイル（cdata.jdbc.paylocity.jar）をインストールディレクトリ（デフォルトではC:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\）のConnectionTest_lib フォルダにインストールします。
• CData JAR ファイル（cdata.jdbc.paylocity.jar）をWeb UI インストールディレクトリ（例：C:\LDG_WebUI\lib\）のlib フォルダにインストールします。

Paylocity 接続文字列の設定

APOS Live Data Gateway からPaylocity への接続を確立する前に、Paylocity のJDBC 接続文字列を構築する必要があります。

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

JDBC 接続文字列作成の補助として、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインから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 を設定することを意味します。

接続文字列は以下のようになります。

Paylocity への接続とセマンティックレイヤービューの作成

コネクタファイルのインストールと接続文字列の設定が完了したら、Live Data Gateway Admin ツールでPaylocity に接続し、Live Data Gateway Web UI でセマンティックレイヤービューを構築していきましょう。

Paylocity への接続を構成

1. APOS Live Data Gateway Manager にログインします。
2. まだAPOS LDG のライセンスファイルを更新していない場合は、更新してください。
   1. 「File」->「Configurations」をクリックします。
   2. License の「...」メニューをクリックします。
   3. APOS チームで CData Connector ライセンスを含むライセンスファイルを選択します。
3. APOS Live Data Gateway Manager で、「Add」をクリックします。
4. APOS Live Data Gateway のConnection タブで、接続を設定します。
   • Data Source を「Database」に設定します。
   • Database を「CData Drivers」に設定します。
   • Database CData Drivers を「Paylocity」に設定します。
   • Connection String を、以下の例のような先に構築した接続文字列に設定します。 jdbc:Paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
   • Driver Class を「cdata.jdbc.paylocity.PaylocityDriver」（デフォルト設定）に設定します。
5. 「Test Connection」をクリックします。
6. 「Save」をクリックします。
7. 接続に固有の接頭辞を付けます（例："paylocity"）。
8. 新しく作成した接続をハイライトし、「File」->「Approve Users For Web UI」をクリックします。
9. ビューを作成する適切なDB ユーザーを承認し、「Save」をクリックします。

これで、Live Data Gateway Web UI でセマンティックレイヤービューを構築する準備が整いました。

セマンティックレイヤービューを作成

1. ブラウザで、APOS Live Data Gateway Portal に移動します。
2. Connection（例："paylocity"）を選択します。
3. Paylocity は認証にUser やPassword を必要としないため、User Name とPassword には任意の値を使用できます。
4. 「Login」をクリックします。
5. 接続後、「Semantic Layer」をクリックし、新しいセマンティックレイヤービューを作成します。
6. 「New Semantic Layer View」をクリックします。
7. Semantic Layer View Prefix およびSemantic Layer View Name を設定します。
8. 「Step 2」をクリックします。
9. ビューに追加したいテーブルとカラムを選択します。
10. 「Step 3」をクリックします。
11. 利用可能なテーブルのカラムでMeasure を選択します。
12. 「Step 5」をクリックします（「Extra Dimensions」ステップはスキップします）。
13. 任意のVariable Prompt を追加します。
14. 「Step 6」をクリックします。
15. 任意のTable Join を定義します。
16. 「Review」をクリックします。
17. セマンティックレイヤービューを確認し、「Save」をクリックします。

セマンティックレイヤービューを作成できたので、APOS Live Data Gateway を経由してPaylocity のデータにアクセスする準備が整い、SAP Analytics Cloud や他のSAP ソリューションからPaylocity のデータへのリアルタイムデータ接続が可能になりました。

詳細と無料トライアル

APOS Live Data Gateway でリアルタイムPaylocity のデータを扱うための詳細は、APOS Systems - APOS Solutions - Request Evaluation Software で評価用ソフトウェアをリクエストするか、[email protected] にメールでお問い合わせください。