Pentaho Report Designer でPaylocity のデータを連携利用

CData JDBC Driver for 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 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 の構成については、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

     java -jar cdata.jdbc.paylocity.jar
     

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

     

     JDBC URL を設定する際、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限されます。特にレポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。

     一般的な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. 最後に、レポートを実行してチャートを確認します。