Exploratory でPaylocity データを連携する方法

こんにちは！テクニカルディレクターの桑島です。

CData ODBC Driver for Paylocity は、ODBC 経由でリアルタイムPaylocity データ に標準SQL での利用を可能にします。 ここでは、汎用ODBC データプロバイダーとしてPaylocity に接続し、データアナリティクスツールのExploratory (https://exploratory.io/) からPaylocity データを連携利用する手順を説明します。
Exploratory は、多くのRDB やRedshift、BigQuery などのクラウドデータストアに対応していますが、SaaS データを分析したい場合にはCData ODBC ドライバを使うことで、API コーディング不要でデータを活用できます。今回はPaylocity を例に説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Paylocity をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにPaylocity データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.Exploratory 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとPaylocity への接続設定

まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

次にマシンにPaylocity データ に接続するODBC DSN を設定します。Exploratory からはそのODBC DSN を参照する形になります。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 を設定することを意味します。

Exploratory 上でPaylocity のデータをセット

• Exploratory で［コネクション］をクリックして新しいコネクションを作成します。
• ［追加］→［ODBC］の順にクリック。
• コネクション追加画面で先ほど設定したPaylocity ODBC のDSN を設定します。
  名前：任意
  タイプ：ODBC
  DSN：上の設定したDSN 名（CData Paylocity Sys）
  
• コネクションテストを下の地、［追加］を押して接続を確定させます。

Exploratory でPaylocity データをクエリし、データフレームとして保存

さあ、Exploratory からPaylocity データを扱ってみましょう。

• Exploratory でプロジェクトを［新規作成］します。
• ［データフレーム］の［+］印をクリックし、［データベースデータ］を選択します。
• データベースは［ODBC］をクリック。
• ［コネクション］で先ほど設定したPaylocity のコネクションを選択します。
• RDB ソースの感覚でSELECT クエリでPaylocity データをクエリします。標準SQL でフィルタリング、ソート、JOIN も可能です。
• データセットをデータフレームとして保存します。

Exploratory でのPaylocity データの分析

データフレームになったデータは通常のRDB データソースと同じようにExploratory で利用可能です。

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。