JasperReports Server で Paylocity のレポートを作成

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
CData JDBC Driver をJasperReports Server にデプロイして、レポートや組み込み分析などから Paylocity データにリアルタイムでアクセスできます。

CData JDBC Driver for Paylocity を使用すると、企業全体で Paylocity のデータ へのアクセスを提供できます。この記事では、JasperReports Server にドライバーをデプロイし、Paylocity のデータ のビジネスビューであるレポートドメインに基づいたシンプルなレポートを作成する方法を説明します。

ドライバー JAR のデプロイ

以下の手順に従って、JasperReports Server にドライバー JAR をデプロイします。この手順は Paylocity と JasperReports Server にバンドルされている Tomcat サーバーに固有のものです。Tomcat ではなく JBoss AS 7 を使用している場合は、標準的なプロセスに従って JBoss への Paylocity JDBC Driver のデプロイを行ってください。

  1. インストールディレクトリの lib サブフォルダにあるドライバー JAR と .lic ファイルを、JasperReports Server インストールディレクトリ内の apache-tomcat フォルダの lib サブフォルダにコピーします。

  2. apache-tomcat -> webapps -> jasperserver-pro -> META-INF に移動し、以下のリソースエントリを context.xml ファイルに追加します。 

    
<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.JSCommonsBasicDataSourceFactory"/>

    JDBC URL（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 接続プロパティを設定することもできます。これにより返される行数が制限され、レポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。

  3. jasperserver-pro -> WEB-INF に移動し、以下の参照を web.xml ファイルに追加します。 
    
  Paylocity のデータ JSP
  jdbc/paylocity
  javax.sql.DataSource
  Container
  4. サーバーを再起動します。

Paylocity JDBC データソースの作成

以下の手順に従って、Paylocity JDBC Driver を JDBC データソースにマッピングします。

  1. JasperReports Server にログインし、Create -> Data Source をクリックします。
  2. Type メニューで、JNDI Data Source を選択します。
  3. Service Name ボックスに、web.xml ファイルのリソース定義で指定した JNDI ルックアップを入力します。この例では、ルックアップは「jdbc/paylocity」です。
  4. Save をクリックしてデータソースを作成します。

ドメインの作成

ドメインは、レポート作成者に関連するビジネスビューを提供するメタデータおよびアクセス制御レイヤーです。以下の手順に従って、Paylocity のカラムを選択し、フィルタを適用し、SQL を実行してドメインを作成します。

  1. Create -> Domain をクリックします。ドメインの ID を入力し、保存場所を選択します。
  2. Data Source セクションで Browse をクリックし、作成した Paylocity データソースを選択します。
  3. Domain Design セクションで、Create with Domain Designer をクリックします。
  4. テーブルが含まれるスキーマを選択します。
  5. Tables タブで、Data Source ペインからテーブルを選択し、矢印をクリックして Selected Tables ペインに追加します。
  6. Derived Tables タブでは、SQL クエリに基づいてドメインを定義できます。例えば、 
      SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
  7. Joins タブでは、結合条件を構築するカラムを選択し、結合タイプを選択することでテーブルを結合できます。
  8. Pre-Filters タブでは、カラムをドラッグ＆ドロップして、ドメインを通じて公開されるデータをフィルタする検索条件を定義します。
  9. Display タブで、ユーザーに提示されるデータセットに Paylocity データを選択します。
  10. OK をクリックして変更を確定し、Submit をクリックしてドメインを作成します。

リアルタイムでデータを探索

ドメインを作成したら、データに接続する準備が整います。以下の手順に従って、Ad Hoc Editor で Ad Hoc ビューを作成します。

  1. Create -> Ad Hoc View をクリックします。
  2. 表示されるダイアログで、作成した Paylocity ドメインを選択します。
  3. Choose Data ページで、ビューで使用するカラムを選択します。Pre-Filters セクションでは、選択したフィールドに基づいてフィルタを作成できます。Display セクションでは、ドメインで表示されるカラム情報を変更できます。
  4. ウィザードが完了したら、ビュータイプを選択し、ビューにカラムを追加します。JasperSoft はドライバーのメタデータを使用して、データ型に基づいて利用可能なディメンションとメジャーを検出します。ディメンションとメジャーを Columns ボックスと Rows ボックスにドラッグします。メジャーを右クリックして集計計算を変更できます。Filters セクションで Columns スライダーを目的のデータレベルにドラッグします。
  5. ビューの設計中にデータの更新にアクセスするには、設計モードのツールバーでメニュー選択を Sample Data から Full Data に変更します。変更を行うと、JasperSoft Server はドライバーに対して基になる SQL クエリを実行します。
  6. ビューを保存します。

リアルタイムレポートの作成

これで、JasperSoft Server でホストされるレポートを作成できます。Ad Hoc Editor から作成するには、Save Ad Hoc View をクリックし、Create Report をクリックします。

はじめる準備はできましたか？

Paylocity Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Paylocity Icon Paylocity JDBC Driver お問い合わせ

Paylocity のAccounts、Envelopes、Folders データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。

この記事の内容

関連記事