デジタルワークプレイス Slingshot のダッシュボードでPaylocity のデータを可視化・分析

こんにちは！リードエンジニアの杉本です。

Slingshot はインフラジスティックス社が提供するオールインワンのデジタルワークプレイスサービスです。この記事では、CData Connect Cloud を経由して Slingshot からPaylocity に連携するダッシュボードを作成する方法を説明します。

CData Connect Cloud は、Paylocity のデータのクラウド to クラウドの仮想OData インターフェースを提供し、Slingshot からリアルタイムにPaylocity のデータへ連携することができます。

CData Connect Cloud の設定

Slingshot でPaylocity のデータをリアルタイムで操作するには、Connect Cloud からPaylocity に接続し、コネクションにユーザーアクセスを提供してPaylocity のデータのOData エンドポイントを作成する必要があります。

（オプション）新しいConnect Cloud ユーザーの追加

必要であれば、Connect Cloud 経由でPaylocity に接続するユーザーを作成します。

1. ユーザーページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
3. ユーザーページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
2. User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect Cloud からPaylocity に接続

CData Connect Cloud では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルから「Paylocity」を選択します。
3. 必要な認証プロパティを入力し、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 を設定することを意味します。

4. Create & Test をクリックします。
5. Edit Paylocity Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にPaylocity OData エンドポイントを追加する

Paylocity に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add to create new OData endpoints をクリックします。
2. Paylocity 接続（例：Paylocity1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、Confirm をクリックします。

コネクションとOData エンドポイントを設定したら、Slingshot からPaylocity のデータに接続できます。

Slingshot にデータソースを追加する

CData Connect Cloud の設定が完了したら、Slingshot 側に接続設定を追加しましょう。

1. Slingshot の対象のワークスペースに移動して「データソース」タブに移動し「＋データソース」をクリックします。
2. データソースの一覧から利用したいサービスを選択します。ここで先程CData Connect Cloud で設定したOData エンドポイントの接続を追加します。
3. 「URL」にOData エンドポイントのURL を指定し「先制認証を使用する」にチェックを入れます。その上で「資格情報」を追加しましょう。
4. 資格情報の種類は「汎用資格情報」になります。合わせてCData Connect Cloud へのログインユーザーIDをユーザー名に入力し、パスワードには先程生成したPAT を入力します。
5. あとは「データソースの追加」をクリックすれば、データソースの接続設定は完了になります。

ダッシュボードを作成する

すべての準備が整ったのでPaylocity のデータを活用してダッシュボードを作成していきましょう。

1. 「ダッシュボード」タブに移動して「＋ダッシュボード」をクリックします。
2. 先程追加したCData Connect Cloud へのOData フィードデータソースが表示されるので、これを選択します。
3. すると、事前にCData Connect Cloud 上で登録しておいたテーブルの一覧がエンティティのセットとして表示されるので、任意のエンティティを選択しましょう。
4. これでSlingshot 上に対象のデータがシームレスに読み込まれます。あとは可視化するためのラベルや値を選択することで、以下のように簡単にビジュアライズが実施できます。

このように、CData Connect Cloudを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたダッシュボードをSlingshot で開発できます。他にも多くのデータソースに対応するCData Connect Cloud の詳細をこちらからご覧ください。