SAP Lumira でPaylocity のOData Feeds を取り込み

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

CData Connect Cloud を使って、SAP Lumira でPaylocity に基づくビジュアライゼーションを作成できます。CData Connect Cloud により、リアルタイムデータへの接続が可能になります。ダッシュボードとレポートはオンデマンドで更新できます。この記事では、常に最新であるグラフを作成する方法を説明します。

CData Connect Cloud はPaylocity データへのクラウドベースのOData インターフェースを提供し、SAP Lumira からPaylocity データへのリアルタイム連携を実現します。

Connect Cloud を構成

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

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

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

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

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

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

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

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「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. 「Add Paylocity Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. Paylocity 接続（例：Paylocity1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

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

SAP Lumira からPaylocity への接続

以下のステップに従って、Paylocity をSAP Lumira に取得します。SQL クエリを実行するか、UI を使用できます。

1. SAP Lumira で［File］->［New］->［Query with SQL］とクリックします。Add New Dataset ダイアログが表示されます。
2. ［Generic］セクションを展開し、［Generic OData 2.0 Connector］オプションをクリックします。
3. ［Service Root URI］ボックスに、CData Connect Cloud のOData エンドポイントを入力します。URL は次の例のようになります。 https://your-server:8032/api.rsc
4. ［User Name］と［Password］のボックスにAPI ユーザーのユーザー名とパーソナルアクセストークンを入力します。これらの資格情報は、HTTP 基本認証で使用されます。

5. ツリーでエンティティを選択するか、SQL クエリを入力します。この記事では、Paylocity Employee エンティティをインポートします。

6. ［Connect］をクリックすると、SAP Lumira は対応するOData 要求を生成し、結果をメモリにロードします。その後、フィルタ、集計、要約関数など、SAP Lumira で使用可能な任意のデータ処理ツールを使用できます。

データのビジュアライゼーションを作成

データをインポートした後、［Visualize］ルームでデータのビジュアライゼーションを作成できます。以下のステップに従って、基本グラフを作成します。

1. ［Measures and Dimensions］ペインで、メジャーとディメンションを［Visualization Tools］ペインの［x-axis］フィールドと［y-axis］フィールドにドラッグします。SAP Lumira は、CData Connect Cloud のメタデータサービスからディメンションとメジャーを自動的に検出します。

   デフォルトでは、SUM 関数はすべてのメジャーに適用されます。メジャーの横にある歯車のアイコンをクリックしてデフォルトの要約を変更します。

2. ［Visualization Tools］ペインで、グラフの種類を選択します。
3. ［Chart Canvas］ペインで、フィルタを適用し、メジャーで並べ替え、ランキングを追加して現在のPaylocity でグラフを更新します。