Paylocity JDBC Driver を使用した OBIEE でのレポート作成

Jerod Johnson
Senior Technology Evangelist

Paylocity JDBC Driver を OBIEE にデプロイして、エンタープライズ全体でリアルタイムレポートを実現します。

CData JDBC Driver for Paylocity は、標準的なデータベースドライバーとして、Java ベースのレポーティングサーバーにPaylocity のデータへのリアルタイムアクセスを統合できます。この記事では、Oracle Business Intelligence Enterprise Edition（OBIEE）にドライバーをデプロイし、変更がリアルタイムに反映されるPaylocity のデータのレポートを作成する方法を説明します。

JDBC Driver のデプロイ

以下の手順で、JDBC Driver を WebLogic のクラスパスに追加します。

WebLogic 12.2.1 の場合、ドライバーの JAR ファイルと .lic ファイルを DOMAIN_HOME\lib に配置するだけで完了です（例：ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib）。これらのファイルは起動時にサーバーのクラスパスに追加されます。

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

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.paylocity.jar;%PRE_CLASSPATH%

すべてのサーバーを再起動します（例：DOMAIN_HOME\bitools\bin の stop コマンドと start コマンドを実行）。

Paylocity 用 JDBC データソースの作成

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

BI Publisher にログインします（URL は例えば http://localhost:9502/analytics）。Administration -> Manage BI Publisher をクリックします。
JDBC Connection -> Add Data Source をクリックします。
以下の情報を入力します：
- Data Source Name：ユーザーがレポートで接続を作成する際に使用する名前を入力します。
- Driver Type：Other を選択します。
- 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;
```
- Username：ユーザー名を入力します。
- Password：パスワードを入力します。
Security セクションで、許可するユーザーロールを選択します。

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

これで、リアルタイムPaylocity のデータに基づいたレポートや分析を作成できます。以下の手順で、標準のレポートウィザードを使用して、Paylocity のデータの変更がリアルタイムに反映されるインタラクティブなレポートを作成します。

グローバルヘッダーで、New -> Data Model をクリックします。
Diagram タブで、メニューから SQL query を選択します。
クエリの名前を入力し、Data Source メニューで作成した Paylocity JDBC データソースを選択します。
standard SQL を選択し、以下のようなクエリを入力します：
```
SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
```
View Data をクリックして、レポート作成に使用するサンプルデータを生成します。
サンプルデータに含める行数を選択し、View をクリックしてから、Save As Sample Data をクリックします。
Create Report -> Use Data Model をクリックします。
Guide Me を選択し、Select Layout ページで含めるレポートオブジェクトを選択します。この例では Chart と Table を選択します。
LastName のような数値カラムを Y 軸の Drop Value Here ボックスにドロップします。FirstName のようなディメンションカラムを X 軸の Drop Label Here ボックスにドロップします。
Refresh をクリックすると、Paylocity のデータの変更が反映されます。