Paylocity JDBC ドライバーを使用したOBIEE でのPaylocity レポート

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

CData JDBC Driver for Paylocity は、Paylocity へのリアルタイムアクセスをJava ベースのレポートサーバーに統合できる標準のデータベースドライバーです。この記事では、ドライバーをOracle Business Intelligence Enterprise Edition (OBIEE) にデプロイし、変更を反映するPaylocity に関する方法を示します。

JDBC ドライバーをデプロイ

以下のステップに従って、WebLogic のクラスパスにJDBC ドライバーを追加します。

WebLogic 12.2.1 の場合、ドライバーJAR と.lic ファイルをORACLE_HOME\user_projects\domains\MY_DOMAIN\lib のようにDOMAIN_HOME\lib に配置します。これらのファイルは、起動時にサーバーのクラスパスに追加されます。

ドライバーをクラスパスに手動で追加することもできます。これは、以前のバージョンで必要です。setDomainEnv.cmd (Windows) または setDomainEnv.sh (Unix) のPRE_CLASSPATH の前に以下を追加します。このスクリプトは、そのドメインのフォルダーのbin サブフォルダーにあります。例：ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

DOMAIN_HOME\bitools\bin でstop コマンドとstart コマンドを実行するなど、すべてのサーバーを再起動します。

JDBC Data Source for Paylocity の作成

JDBC ドライバーをデプロイした後、BI Publisher からJDBC データソースを作成できます。

1. BI Publisher にURL http://localhost:9502/analytics でログインし、［Administration］->［Manage BI Publisher］とクリックします。
2. ［JDBC Connection］->［Add Data Source］と進みます。
3. 以下の情報を入力します。
   • Data Source Name:ユーザーが接続を作成する名前をレポートに入力します。
   • Driver Type:SELECTOther.
   • Database DriverClass:ドライバークラスに cdata.jdbc.paylocity.PaylocityDriver を入力します。
   • Connection String: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 を設定することを意味します。

     ビルトイン接続文字列デザイナ

     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;InitiateOAuth=GETANDREFRESH
   • Username:ユーザー名。
   • Password:パスワード。
4. ［Security］セクションで、許可されているユーザーロールを選択します。

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

リアルタイムのPaylocity に基づいてレポートと分析を作成できるようになります。以下のステップに従って、標準のレポートウィザードを使用してPaylocity への変更を反映するインタラクティブなレポートを作成します。

1. グローバルヘッダーで、［New］->［Data Model］をクリックします。
2. Diagram タブでメニューからSQL クエリを選択します。
3. クエリの名前を入力し、［Data Source］メニューで、作成したPaylocity JDBC データを選択します。
4. 標準のSQL を選択し、以下のようなクエリを入力します。 SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
5. ［View Data］をクリックし、レポートの作成に使用するサンプルデータを生成します。
6. サンプルデータに含める行数を選択し、［View］をクリックして［Save As Sample Data］をクリックします。
7. ［Create Report］->［Use Data Model］とクリックします。
8. ［Guide Me］を選択し、［Select Layout］ページで含めるレポートオブジェクトを選択します。この例では、［Chart］と［Table］を選択します。
9. LastName のような数値列をy 軸の［Drop Value Here］ボックスにドロップします。FirstName のようなディメンション列をx 軸の［Drop Label Here］ボックスにドロップします。
10. ［Refresh］をクリックしてPaylocity への変更を取得します。