国産BI ツールのActionista! からPaylocity に直接連携してビジュアライズ

Actionista! からリアルタイムPaylocity のデータに直接連携して分析を実施。

桑島義行
テクニカルディレクター
最終更新日：2022-07-20

この記事で実現できるPaylocity 連携のシナリオ

CData

こんにちは！テクニカルディレクターの桑島です。

CData Driver for Paylocity を使って、国産BIツールのActionista!（https://www.justsystems.com/jp/products/actionista/）からPaylocity のデータをノーコードで連携して利用できます。この記事では、間にETL/EAI ツールをはさむ方法ではなく、CData JDBC Driver for Paylocity をActionista! 側に組み込むだけで連携を実現できます。

Actionista! からPaylocity のデータへの連携を設定

CData JDBC Driver for Paylocity をActionista! に配置

CData JDBC Driver for Paylocity をActionista! と同じマシンにインストールします。
次にインストールした.jar ファイルを以下のパスに格納します：
ドライバー.jar ファイルのディレクトリ C:\Program Files\CData\CData JDBC Driver for Paylocity 2019J\lib\cdata.jdbc.paylocity.jar
Actionista! 側のコピー先ディレクトリ C:\JUST\JustBI\jdbc
次に、C:\JUST\JustBI\conf にあるdatamanager.properties プロパティファイルに今回使用するPaylocity のドライバークラスなどを以下のように指定します：


# Paylocity
loader.jdbc.displayName.Paylocity = Paylocity
loader.jdbc.initJdbcUrl.Paylocity = jdbc:paylocity:
loader.jdbc.url.Paylocity = jdbc:paylocity:
loader.jdbc.driver.Paylocity = cdata.jdbc.paylocity.PaylocityDriver
loader.jdbc.dbmsInfo.Paylocity = cdata.jdbc.paylocity.PaylocityDriver

これでActionista! へのドライバーの配置が完了しました。

Paylocity のデータをActionista! のキューブに取り込み

Actionista! ではデータの保持をキューブという単位で保存します。また、クエリでデータソースからデータを取得するのではなく、キューブに対してクエリを行います。このステップでは、Paylocity のデータをキューブに取り込み、分析で使えるようにします。

Actionista! にログインします。
「DataManager」-> 「＋キューブの新規作成」をクリックします。
CData JDBC ドライバはRDB データソースとしてActionista! から利用できるので、「RDB」を選択します。
設定情報にPaylocity への接続に必要なプロパティを入れます：
- RDB の種類：には、上のステップでdisplayName で指定した名前をドロップダウンで選びます。
- 接続URL：Paylocity に接続するための認証情報をセミコロン区切りで入力します。
  
  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:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=REFRESH
- ユーザー名：接続するアカウントのユーザー名（URL に含めることも可）
- パスワード：接続するアカウントのパスワード（URL に含めることも可）