DBxtra でPaylocity のデータを使ってダッシュボードを構築

CData のPaylocity 用 ODBC ドライバーは、ODBC 標準経由でPaylocity のリアルタイムデータにアクセスし、使い慣れた SQL クエリで各種 BI、レポート、ETL ツールからPaylocity のデータを利用可能にします。この記事では、汎用 ODBC データプロバイダーとしてPaylocity に接続し、DBxtra でPaylocity のデータを基にしたチャート、レポート、ダッシュボードを作成する方法を解説します。

Paylocity のデータへの接続設定

1. まだ設定していない場合は、データソース名（DSN）で必要な接続プロパティを指定します。DSN の設定は組み込みの Microsoft ODBC データソースアドミニストレーターを使用して行えます。これはドライバーインストールの最終ステップでもあります。Microsoft ODBC データソースアドミニストレーターを使用して DSN を作成・設定する方法については、ヘルプドキュメントの「はじめに」の章をご参照ください。
   
   

   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 を設定することを意味します。

   DSN を設定する際には、Max Rows 接続プロパティも設定することをお勧めします。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時にパフォーマンスを向上させるのに役立ちます。

2. DBxtra アプリケーションを開き、New メニューから Project をクリックしてプロジェクト名を入力します。
3. Data Connection Type として ODBC Connection を選択します。
4. Data Source の参照オプション（）をクリックします。
5. Data Link Properties ウィンドウの Provider タブで、Microsoft OLE DB Provider for ODBC Drivers を選択します。
6. Connection タブで、Data Source Name と使用する初期カタログ（CData）を選択します。
7. 接続名を入力し、適切なユーザーグループを選択します。
8. プロジェクト内で接続をダブルクリックしてデータに接続します。

Paylocity のデータでダッシュボードを作成

これでPaylocity のデータを使ってダッシュボードを作成する準備が整いました。

1. プロジェクト内の Report Objects を右クリックし、New Report Object を選択します。
2. 新しい Report Object で、リンクをクリックしてクエリを作成します。
3. Select Data Connection ウィンドウで、先ほど作成したデータ接続を選択します。
4. Query タブで、接続オブジェクトを展開し、ダッシュボードに含めたいテーブル、ビュー、特定のカラムを選択します。検索条件を指定したり、JOIN や集計を含む複雑なクエリを作成することもできます。
5. Dashboard タブで、ダッシュボードのビジュアライゼーションと機能を選択します。クエリからのデータ値をダッシュボード項目の適切なフィールド（Values、Series など）に割り当てます。

新しいダッシュボードが作成されたら、Paylocity のデータ分析を開始できます。Paylocity 用 ODBC ドライバーのおかげで、ダッシュボードを更新すればソースで行われた変更を即座に確認できます。同様に、常に最新のPaylocity データを反映したレポートを作成・表示できます。