各製品の資料を入手。
詳細はこちら →
製品をチェック
MySQL Workbench からPaylocity のデータをクエリする方法
MySQL Workbench からPaylocity のリアルタイムデータにクエリを実行します。
最終更新日：2022-06-10
この記事で実現できるPaylocity 連携のシナリオ
こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。
ODBC Driver for Paylocity とSQL Gateway を使用することで、MySQL インターフェースを使ってPaylocity にクエリを実行できます。この記事では、MySQL Workbench からPaylocity のデータにSQL クエリを投げてデータを取得する方法をご紹介します。
CData ODBC ドライバとは？
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Paylocity をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにPaylocity のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.MySQL Workbench 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとPaylocity への接続設定
まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
未指定の場合は、データソース名（DSN）で必要な接続プロパティの値を指定します。ドライバーのインストールの最後に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 を設定することを意味します。
SQL Gateway を構成する
Paylocity への接続を仮想MySQL データベースとして設定する方法については、SQL Gateway の解説記事 を参照してください。クライアントからのMySQL リクエストを受けるMySQL リモートサービスを構築します。このサービスは、SQL Gateway のUI で構成できます。
MySQL Workbench からPaylocity をクエリ
以下のステップでは、MySQL Workbench からSQL Gateway で作成された仮想Paylocity のデータベースに接続し、Paylocity のデータをリアルタイムで操作するための基本的なクエリを発行する方法を説明します。
SQL Gateway を介してPaylocity に接続
- MySQL Workbench で、［add a new MySQL connection］をクリックします。
- 接続（CData SQL Gateway for Paylocity）に名前を付けます。
- Hostname、Port、Username のパラメータを設定し、SQL Gateway に接続します。
- Store in Vault をクリックしてパスワードを設定し、保存します。
- Test Connection をクリックして接続が正しく構成されていることを確認し、OK をクリックします。
Paylocity のデータをクエリしてみる
- 作成した接続（CData SQL Gateway for Paylocity）を開きます。
- ［File］->［New Query Tab］と進みます。
- SELECT * FROM `CData Paylocity Sys`.Employee; のようなPaylocity のデータを取得するSQL を書いて、実行します。
- 無事、Paylocity のデータが取得できました。
おわりに
MySQL Workbench からリアルタイムPaylocity のデータにアクセスすることで、MySQL データベースと同じようにPaylocity をクエリおよび更新できます。CData ODBC Driver for Paylocity とCData SQL Gateway の30日の無償評価版はこちらです。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
