MySQL Workbench で Paylocity のデータをクエリする方法

Paylocity 用のODBC Driver のSQL Gateway を使用すると、MySQL インターフェースを通じて Paylocity のデータ にクエリできます。以下の手順に従って、SQL Gateway のMySQL リモーティングサービスを起動し、MySQL Workbench でリアルタイムの Paylocity のデータ を操作してみましょう。

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

SQL Gateway の設定

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

MySQL Workbench から Paylocity をクエリ

以下の手順では、SQL Gateway で作成した仮想 Paylocity データベースにMySQL Workbench から接続し、基本的なクエリを発行してリアルタイムの Paylocity のデータ を操作する方法を説明します。

SQL Gateway 経由で Paylocity に接続

1. MySQL Workbench で、新しいMySQL 接続を追加するためにクリックします。
2. 接続に名前を付けます（CData SQL Gateway for Paylocity）。
3. SQL Gateway に接続するためのHostname、Port、Username パラメータを設定します。
4. Store in Vault をクリックしてパスワードを設定・保存します。
5. Test Connection をクリックして接続が正しく設定されていることを確認し、OK をクリックします。

NOTE: Username および Password は、SQL Gateway 用に作成したユーザーの資格情報を指します。

Paylocity のデータをクエリ

1. 作成した接続（CData SQL Gateway for Paylocity）を開きます。
2. File -> New Query Tab をクリックします。
3. SELECT * FROM `CData Paylocity Sys`.Employee; のようなSQL クエリを記述して Paylocity のデータ を取得します。

MySQL Workbench からリアルタイムの Paylocity のデータ にアクセスできるようになりました。MySQL データベースと同じ感覚で Paylocity を簡単に操作できます。CData ODBC Driver for Paylocity とCData SQL Gateway の30日間の無償トライアルをぜひお試しください。