JasperReports Server で Paylocity に連携する帳票を作成

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

CData JDBC Driver for Paylocity は企業全体のPaylocity へのデータ連携を可能にします。この記事では、JasperReports server にドライバーを配布してレポーティングドメイン、ビルディングブロックを作成し、ad hoc 帳票を作成する方法を説明します。

Paylocity ドライバーのJAR を配布

下記の手順に従って、ドライバーのJAR をJasperReports server に配置します。標準的なプロセスに従って、JNDI データソースをTomcat またはJBoss に配布できます。以下の説明にはPaylocity およびJasperReports Server にバンドルされたTomcat server の詳細が含まれます。

1. インストールディレクトリの［lib］サブフォルダ内のドライバーJAR およびlic ファイルを、apache-tomcat フォルダの［lib］サブフォルダにコピーします。
2. 以下のリソースエントリーをjasperserver-pro Web アプリケーションのcontext.xml に追加します。これはアプリケーションの［META-INF］サブフォルダに配置されています。必要な接続プロパティを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 を設定することを意味します。 <Resource name="jdbc/paylocity" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.paylocity.PaylocityDriver" url="jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSBasicDataSourceFactory"/>

3. jasperserver-pro Web アプリケーションのweb.xml に以下の参照を追加します。これはアプリケーションの［WEB-INF］サブフォルダに配置されています。 Paylocity データ JSP jdbc/paylocity javax.sql.DataSource Container
4. サーバーを再起動します。

Paylocity JDBC データソースの作成

ドライバーを配布したら、JNDI 接続を作成してバンドルされたあらゆるドライバーと同じように接続できます。

1. JasperReports Server にログインして［Create］>［Data Source］をクリックします。
2. ［Type］メニューで［JNDI Data Source］を選択します。
3. ［Service Name］ボックスにPaylocity に定義したJDNI ルックアップを入力します。例では、ルックアップは jdbc/paylocity です。

ドメイン の作成

データのドメインはJaspersoft のメタデータレイヤです。アドホックな分析および帳票で使うことができます。

1. ［Create］>［Domain］をクリックし、ドメインにID を入力します。
2. ［Data Source］セクションで［ブラウズ］をクリックし、作成したPaylocity のデータソースを選択します。
3. ［Domain Design］セクションで［Create with Database Designer］をクリックします。［Select Database Schema］ダイアログが表示されます。
4. Paylocity のデータソースを選択します。
5. ［Tables］タブの［Data Source］ペインでテーブルを選択し、矢印をクリックして［Selected Tables］に追加します。
6. ［Display］タブの［Resources］ペインでPaylocity エンティティを選択し、矢印をクリックしてリソースを［Sets and Items］ペインに追加します。

ドメインにView Based を作成

ドメインを使ってPaylocity のビジネスビューを作成したら、データに関連あるサブセットを表示するビューを作成します。下記の手順に従って、［Ad Hoc Editor］の［Ad Hoc view］にビューを作成します。

1. ［Create］>［Ad Hoc View］をクリックします。
2. ダイアログが表示されたら、作成したPaylocity ドメインを選択します。
3. ［Choose Data］ページで、ビューで使いたいカラムを選択します。［Select Fields］セクションでは、フィルターおよび入力用のプロンプトユーザーを作成できます。［Display］セクションでは、フィールドおよびフィールド名の並び順を変更できます。
4. ウィザードを完了したら、ビューの種類を選択しビューにカラムを追加できます。JasperSoft はドライバーのメタデータを使って、利用可能なdimensions およびmeasures をデータの種類に基づいて検出します。 ［Columns］ および［Rows］ボックスにdimensions およびmeasures をドラッグします。例えば、チャートを作成するには［Columns］ボックスに［excol#1］を、［Rows］ボックスに［excol#2］をドラッグします。
5. ビューを保存します。

帳票の作成

これでドメインから帳票を作成できます：