Birst でPaylocity データ のビジュアライゼーションを構築

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

Birst は、組織が複雑なプロセスを迅速に理解し、最適化することを支援するクラウドビジネスインテリジェンス（BI）ツールおよび分析プラットフォームです。CData JDBC Driver for Paylocity と組み合わせると、Birst Cloud Agent を経由してリアルタイムPaylocity データ に接続し、ビジュアライズを構築できます。ここでは、Cloud Agent を使用してPaylocity に連携し、Birst で動的レポートを作成する方法を段階的に説明します。

強力なデータ処理機能により、CData JDBC Driver はBirst のPaylocity データ 操作に高いパフォーマンスを提供します。Birst からPaylocity への複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Paylocity にプッシュし、組込みSQL エンジンを利用してクライアント側でサポートしない操作を処理します。組み込みの動的メタデータクエリにより、JDBC ドライバーはネイティブのBirst データ型を使用してPaylocity データ を視覚化および分析することを可能にします。

Birst でPaylocity データ へのJDBC 接続を設定

Birst プロジェクトを作成する前に、JDBC Driver を操作するためのBirst Cloud Agent をインストールする必要があります。また、JDBC ドライバーのJAR ファイル(および存在する場合はLIC ファイル)をCloud Agent のインストール場所の/drivers/ ディレクトリにコピーします。

ドライバーとCloud Agent のインストールが完了したら、開始できます。

1. Birst で新しいプロジェクトを作成します。
2. 接続に名前を付けます。(e.g. CDataPaylocity)
3. Live Access を選択します。
4. エージェントを選択します。
5. Database Type をOther に設定します。
6. SQL タイプをMSSQL に設定します。
7. 接続文字列を設定します。

   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 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

   以下はPaylocity の一般的なJDBC 接続文字列です。

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
8. Driver Name cdata.jdbc.paylocity.PaylocityDriver を設定し、［Save］をクリックします。

NOTE Paylocity への認証は接続文字列に管理されるため、［Security Credentials］は空白でも問題ありません。

Paylocity データ オブジェクトを設定

接続が構成されたら、データセットのスキーマを構成し、ビジュアライズするテーブル、ビュー、そしてカラムを選択することができるようになります。

1. スキーマを選択します。 (e.g. Paylocity)
2. ［Tables］や［Views］をクリックしてこれらのエンティティに接続し、［Apply］をクリックします。
3. アクセスする［Tables］と［Columns］を選択し、［Done］をクリックします。

オブジェクトが構成されたら、Pronto Prepare and Relate ツールを用いて、データ準備の実行やデータのリレーションを検出できるようになります。

ビジュアライゼーションを構築

データを準備し、接続されたオブジェクト間のリレーションを定義することで、ビジュアライゼーションを構築することができるようになります。

1. メニューから、Visualizer ツールを選択します。
2. オブジェクトからMeasures & Categories を選択します。
3. 選択したMeasure(s) に適切なビジュアライゼーションを選択し、構成します。

CData JDBC Driver for Paylocity をCloud Agent やBirst とともに用いることにより、Paylocity で簡単に堅牢なビジュアライゼーションとレポートを作成できます。30日の無償評価版をダウンロードし、Birst ビジュアライゼーションの構築を開始してください。