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

Jerod Johnson
Senior Technology Evangelist

JReport Designer で Paylocity のデータをもとにチャートとレポートを作成。

CData JDBC Driver for Paylocity のデータを使えば、ダッシュボードやレポートから Paylocity をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Paylocity のデータのライブデータにアクセスできます。この記事では、JReport Designer で Paylocity のデータに JDBC データソースとして接続し、Paylocity のデータのデータをもとにレポートを作成する方法を説明します。

Paylocity ののデータに接続

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;
...

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Paylocity）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.paylocity.PaylocityDriver
```
- URL: JDBC URL を入力します。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;
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

テーブルの読み込みが完了したら Done をクリックします。
Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Paylocity）を展開（）し、Queries を右クリックして Add Query を選択します。
Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
```
SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
```
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Paylocity のデータを新規または既存のレポートに追加する準備が整いました。

NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。