FineReport で Paylocity のデータを利用する

Jerod Johnson
Senior Technology Evangelist

FineReport で Paylocity のデータをJDBC データソースとして設定する方法。

CData JDBC Driver for Paylocity は、JDBC 標準を完全に実装しており、さまざまなBI、レポート、ETL ツール、カスタムアプリケーションに Paylocity のデータへの接続を提供します。この記事では、FineReport で Paylocity のデータをJDBC データソースとして設定し、レポートデザイナーで Paylocity のデータをテーブルとして表示する方法を説明します。

Paylocity のデータのJDBC データソースをセットアップする

以下の手順に従って、FineReport のデータベース接続として Paylocity のデータを設定します。

CData JDBC Driver for Paylocity のインストールディレクトリにあるlib フォルダから、cdata.jdbc.paylocity.jar ファイルをFineReport のインストールディレクトリにあるlib フォルダにコピーします。cdata.jdbc.paylocity.lic ファイルも同様にコピーしてください。
ServerタブからDefine Data Connectionを選択し、クリックして新しい接続を追加してJDBCをクリックします。

続いて、ウィンドウでデータ接続の定義を設定します。

Database: Others
JDBC Driver: cdata.jdbc.paylocity.PaylocityDriver
URL: セミコロン区切りの接続プロパティを使用した標準のJDBC 接続文字列を入力します。
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;
  
```