JReport Designer でPaylocity データを連携

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

CData JDBC Driver for Paylocity を使用すると、Paylocity がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してPaylocity] をクエリできます。ここでは、JDBC データソースとしてPaylocity に連携し、JReport Designer でPaylocity のレポートを作成する方法を説明します。

Paylocity データに接続

1. C:\JReport\Designer\bin\setenv.bat を編集し、JAR ファイルの場所をADDCLASSPATH 変数に追加します。

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Paylocity 2016\lib\cdata.jdbc.paylocity.jar;
   ...
   

2. ［File］［New］［Data Source］と進み、新しいデータソースを作成します。
3. 表示されるダイアログで、データソースの名前(CData JDBC Driver for Paylocity) を作成し、JDBC を選択して［OK］をクリックします。
4. ［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
   • Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.paylocity.PaylocityDriver
   • URL:jdbc:paylocity: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。

     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;InitiateOAuth=GETANDREFRESH
   • User:認証に使用するユーザー名は、通常空白のままにします。
   • Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。

5. ［Add Table］ダイアログで、レポート（またはこのデータソースを使用する予定のレポート）に含めるテーブルを選択し、［Add］をクリックします。

   ダイアログがテーブルのロードを完了したら、［Done］をクリックします。

6. ［Catalog Browser］では、レポートの作成に使用するクエリを作成できます。今すぐ、またはレポートの作成後に作成できますが、どちらにしても、 データソース(CData JDBC Driver for Paylocity) を展開()し、［Queries］を右クリックして［Add Query］を選択します。
7. ［Add Table/View/Query］ダイアログで、JDBC URL とTables を展開() し、クエリで使用するテーブルを選択して［OK］をクリックします。
8. ［Query Editor］ダイアログで、含めるカラムを選択するか、［SQL］ボタンをクリックして以下のようにカスタムクエリを手動で入力できます。

   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
   

   クエリが作成されたら、［OK］をクリックして［Query Editor］ダイアログを閉じます。この時点で、Paylocity を新規または既存のレポートに追加する準備が整いました。

   NOTE: クエリが作成されると、クエリに基づいて［Business View］を作成できます。［Business View］を使用すると、クエリに基づいてWeb レポートまたはライブラリコンポーネントを作成できます。これについてのより詳しい情報は、JReport のチュートリアルを参照してください。

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

Paylocity を使用してレポートを作成することができるようになりました。

1. 新しいレポートを作成(［File］［New］［Page Report］) するか、既存のレポートの［Chart Wizard］を開きます。
2. クエリを選択(または上記を参照して新しいクエリを作成) します。
3. クエリのカラムからグラフの［Category］と［Value］を割り当て、［Finish］をクリックします。
4. レポートの［View］タブをクリックし、チャートを表示します。