Crystal Reports でPaylocity のデータに連携して帳票を作成

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

Crystal Reports には、JDBC 標準向けのサポートが組み込まれています。この記事では、Paylocity の機能を持つ帳票を作成するレポート作成ウィザードの使い方を説明します。

Paylocity JDBC Driver のインストール

CData JDBC Driver for Paylocity を、ドライバーのJAR をCrystal Reports のクラスパスに含めてインストール：DataDriverCommonElement の下のClassPath element のパスに、 .jar を含むファイルのフルパスを追加します。

CRConfig.xml は通常C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java に配置されます。— パスはインストールによって若干異なる場合があります。ドライバーのJAR はインストールディレクトリの［lib］サブフォルダ内にあります。

ClassPath にJAR を追加したら、Crystal Reports を再起動します。

Paylocity のデータに接続

下記の手順に従って、レポート作成ウィザードを使ってPaylocity 接続を作成します。

1. 新しい空の帳票で、［Create New Connection］>［JDBC (JNDI)］をクリックします。

2. ウィザードでJDBC 接続URL を選択します。

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

3. ドライバーのクラス名を設定：

   cdata.jdbc.paylocity.PaylocityDriver

   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 接続をPaylocity に追加したら、レポート作成ウィザードを使ってPaylocity を帳票に追加できます。

1. 帳票に必要なテーブルやフィールドを選択して、データソースを設定します。この例では、Employee テーブルのFirstName およびLastName カラムを使います。

2. チャートの種類を設定 ウィザードを完了すると、Crystal Reports はPaylocity のデータ に実行されるSQL クエリをビルドします。ドライバーは、ライブPaylocity のデータ に対してクエリを実行します。

3. 必要に応じて、ほかのフィルタや帳票テンプレートを設定します。

4. データのインポートが終わったら、データをサマライズもしくはソートするチャートやレポートオブジェクトを作成できます。［Insert］>［Chart］をクリックして、チャートエキスパートを開きます。Total LastName by FirstName を表すグラフを作成するには、FirstName を［On Change Of］メニューセレクションの下のボックスに追加してからLastName を［Show Values］の下のボックスに追加します。

完成した帳票をプレビューして、チャートにデータが入っていることを確認します。Null 値を取り除きたい場合は、SelectionFormula を使います。