Amazon QuickSight で MySQL 接続を使用して Paylocity のデータにアクセス

Jerod Johnson
Senior Technology Evangelist

Amazon QuickSight で MySQL 接続を使用して Paylocity に接続し、Paylocity のデータのビジュアライゼーションを構築する方法を紹介します。

Amazon QuickSight を使用すると、AWS データソース、アップロードしたファイル、クラウド上の他のデータベースからビジュアライゼーションの構築、分析の実行、インサイトの取得を素早く行うことができます。CData SQL Gateway と組み合わせることで、オンプレミスとクラウドの両方で 250種類以上のビッグデータ、NoSQL、SaaS ソースに対して同じ機能を利用できます。本記事では、SQL Gateway と CData ODBC Driver for Paylocity を使用して、Amazon QuickSight の MySQL 接続経由でPaylocity のデータにアクセスする方法を説明します。直接クエリを使用したリアルタイムアクセス、または SPICE へのデータインポートのどちらも可能です。

Paylocity のデータに接続

まだ行っていない場合は、データソース名（DSN）で必要な接続プロパティの値を指定してください。組み込みの Microsoft ODBC データソースアドミニストレーターを使用して DSN を設定できます。これはドライバーインストールの最後のステップでもあります。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 接続プロパティも設定することをお勧めします。これにより返される行数を制限でき、レポートやビジュアライゼーションを設計する際のパフォーマンス向上に特に効果的です。

SQL Gateway を設定

SQL Gateway 概要を参照して、Paylocity のデータを仮想 MySQL データベースとして接続を設定してください。クライアントからの MySQL リクエストをリッスンする MySQL リモーティングサービスを設定します。サービスは SQL Gateway UI で設定できます。

SQL Gateway で MySQL リモーティングサービスを作成（Salesforce の例）

QuickSight から SQL Gateway に接続するには、インターネット接続可能なマシンで SQL Gateway を実行する必要があります。SQL Gateway を設定した後、以下の情報をメモしておいてください。

SQL Gateway をホストしているマシンの IP アドレスまたはドメイン名
MySQL サービスのデータソース名（通常は CData Paylocity Sys）
MySQL サービスのポート番号
サービスへのアクセス権を持つ SQL Gateway ユーザーの資格情報

リモートアクセスの設定

ODBC Driver とリモーティングサービスがオンプレミスにインストールされている（Amazon QuickSight からアクセスできない）場合は、リバース SSH トンネリング機能を使用してリモートアクセスを有効にできます。詳細な手順については、Knowledge Base の記事「SQL Gateway SSH トンネリング機能」を参照してください。

QuickSight で Paylocity に接続

Paylocity ODBC Driver 用に MySQL サービスを設定したら、QuickSight でデータに接続する準備が整いました。QuickSight コンソールにログインし、「Manage Data」をクリックしてから「New Data Set」をクリックし、データソースとして MySQL を選択します。

SQL Gateway で設定した Paylocity 用の MySQL サービスの値を使用してデータセットを設定します（データベース名には DSN を使用してください）。接続を検証し、「Create Data Source」をクリックします。

QuickSight で Paylocity のデータを可視化

本記事では、データビジュアライゼーションにカスタム SQL クエリを使用します。「Edit/Preview Data」をクリックし、表示される Data Prep 画面で以下の手順に従います。

データセットに名前を付けます（例：Employee）。
データを QuickSight SPICE にインポートする場合は SPICE オプションをクリックします。そうでない場合は、QuickSight がデータを直接クエリします。
Tables メニューの下で「Switch to Custom SQL Tool」をクリックします。
- SQL クエリに名前を付けます。
- カスタム SQL クエリを入力します。例：
  SELECT FirstName, LastName FROM Employee
- 「Finish」をクリックします。
「Save & Visualize」をクリックします。

データセットを保存したら、ビジュアライゼーションを設定できます。可視化するカラムを選択し、ビジュアルタイプを選択します。ビジュアライゼーションは、名前からデータの集計方法までカスタマイズできます。

CData ODBC Driver for Paylocity と SQL Gateway を使用すると、Amazon QuickSight でPaylocity のデータのデータビジュアライゼーションの構築や分析を簡単に行うことができます。オンプレミスのデータに AWS QuickSight からアクセスする方法など、ご質問がありましたらサポートチームまでお問い合わせください。