Pentaho Report Designer にPaylocity データに連携して分析

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Paylocity はダッシュボードや帳票ツールからリアルタイムPaylocity データへの連携を可能にします。この記事では、Paylocity をJDBC データソースとして接続する方法と、Pentaho でPaylocity を元に帳票を作成する方法を説明します。

接続と帳票の作成

1. インストールディレクトリの［lib］サブフォルダ内のJAR ファイルをコピーし、Pentaho のディレクトリ内の\Report-Designer\lib\jdbc\ フォルダに配置します。
2. \Report-Designer\ フォルダのreport-designer.bat ファイルを起動し、Report-Designer UI を開きます。

3. 以下の手順でドライバーを新しいデータソースに設定します。［Data］>［Add Data Source］>［Advanced］>［JDBC (Custom)］とクリックし、新しいPaylocity 接続を作成します。ダイアログが表示されたら、次のように接続プロパティを設定します。

   • Custom Connection URL property：JDBC URL を入力。初めに以下を入力し jdbc:paylocity: 次にセミコロン区切りで接続プロパティを入力します。

     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 です：

     jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
   • Custom Driver Class Name：cdata.jdbc.paylocity.PaylocityDriver と入力。
   • User Name：認証するユーザーネーム。
   • Password：認証するパスワード。

レポートに Paylocity データを追加

これで、Paylocity の帳票を作成する準備が整いました。

1. 帳票にPaylocity データソースを追加します：［Data］>［Add Data Source］>［JDBC］をクリックし、データソースを選択します。

2. クエリを設定します。この記事では次を使います：

   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
3. 帳票にチャートをドラッグし、ダブルクリックしてチャートを編集します。帳票を実行して、チャートを表示します。このクエリ結果を使って、Employee テーブルのシンプルなチャートを作成することができます。
4. 帳票を実行して、チャートを見てみましょう。