Grafana で Paylocity 連携ダッシュボードを作成
Grafana は、さまざまなデータソースからのテレメトリを分析、監視、可視化できるオープンソースプラットフォームです。CData Connect AI と組み合わせることで、ビジネスダッシュボードから Paylocity のデータ に即座にアクセスできます。この記事では、Connect AI を使用して Paylocity に接続し、Grafana 内で Paylocity のデータ から基本的なダッシュボードを作成する手順を解説します。
CData Connect AI は、Paylocity 用のピュア SQL Server のクラウド間インターフェースを提供します。これにより、ネイティブデータベースへのデータレプリケーションを行うことなく、Grafana 内でリアルタイムの Paylocity のデータ から直接ダッシュボードを作成できます。可視化を構築する際、Grafana はデータ取得のために SQL クエリを生成します。CData Connect AI は、最適化されたデータ処理機能を内蔵しており、フィルタや JOIN を含むサポートされている SQL オペレーションを Paylocity に直接送信します。これにより、サーバーサイド処理を活用して、リクエストされた Paylocity のデータ を迅速に配信します。
Paylocity 接続を Grafana 用に構成
Grafana から Paylocity への接続は、CData Connect AI を介して実現されます。Grafana から Paylocity のデータ を操作するには、まず Paylocity の接続を作成して構成します。
- Connect AI にログインし、Sources をクリックしてから、 Add Connection をクリックします
- Add Connection パネルから「Paylocity」を選択します
-
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 を設定することを意味します。
- RSAPublicKey:Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。
- Save & Test をクリックします
-
Add Paylocity Connection ページの Permissions タブに移動し、User-based permissions を更新します。
パーソナルアクセストークンの追加
REST API、OData API、または仮想 SQL Server を介して Connect AI に接続する場合、パーソナルアクセストークン(PAT)を使用して Connect AI への接続を認証します。アクセスの細かい制御を維持するため、各サービスごとに個別の PAT を作成することをお勧めします。
- Connect AI アプリの右上にある歯車アイコン()をクリックして、設定ページを開きます。
- 設定ページで Access Tokens セクションに移動し、 Create PAT をクリックします。
-
PAT に名前を付けて、Create をクリックします。
- パーソナルアクセストークンは作成時にのみ表示されるため、必ずコピーして安全な場所に保管しておいてください。
接続の構成と PAT の生成が完了したら、Grafana から Paylocity のデータ に接続する準備が整いました。
Grafana でリアルタイムの Paylocity のデータ を可視化
Grafana から CData Connect AI 仮想 SQL Server API への接続を確立するには、以下の手順に従います。
- まだインストールしていない場合は、Grafana のウェブサイトからお使いの OS 用の Grafana をダウンロードしてインストールします。インストール後、http://localhost:3000/ で Grafana にアクセスします。
- Grafana のユーザー名とパスワードでログインします。初回ログインの場合、ユーザー名は admin、パスワードは admin です。
-
ナビゲーションメニューで、Sources > Add new connection をクリックします。このページで Microsoft SQL Server を検索し、データソースとして選択します。
-
Microsoft SQL Server を選択し、Add new data source をクリックします。
-
新しいデータソースの名前を入力し、以下の接続設定を入力します:
- Host:tds.cdata.com:14333
- Database:接続したい CData Connect AI データソースの接続名を入力します(例:Paylocity1)。
- Username:CData Connect AI のユーザー名を入力します。これは CData Connect AI インターフェースの右上に表示されています。例:test@cdata.com
- Password:先ほど生成した PAT を入力します。
- Save & Test をクリックします。接続が正常に確立されると、Database Connect OK メッセージが表示されます。
ダッシュボードの作成
Paylocity 用のデータソースを作成したら、Paylocity のデータ でダッシュボードの構築を開始できます。ナビゲーションメニューで Dashboards をクリックして開始します。
- Dashboards ページで、+ Create dashboard をクリックし、次に + Add visualization をクリックします。
-
Select data source ウィンドウが開き、作成した接続を選択できます。
-
接続を選択したら、可視化用にクエリするテーブルとカラムを選択できます。Run Query を押して生成されたクエリを実行します。
-
クエリを実行すると、結果データがクエリエディターの上に表示されます。ここで、ダッシュボードパネルにデータを表示するための可視化タイプを選択できます。
- パネルの編集が完了したら、Save dashboard をクリックしてダッシュボードへの変更を保存できます。
300 以上の SaaS、ビッグデータ、NoSQL ソースへのリアルタイムデータアクセスをクラウドアプリケーションから直接取得するには、CData Connect AI をぜひお試しください!