Paylocity のデータ のPostgreSQL インターフェースを作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

Paylocity にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for Paylocity とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからPaylocity にクエリを実行します。

JDBC データソースとしてPaylocity のデータに接続する

JDBC データソースとしてPaylocity に接続するには、以下が必要です。

• Driver のJAR パス：JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。

• Driver クラス

  cdata.jdbc.paylocity.PaylocityDriver
• JDBC URL: URL は、"jdbc: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 を設定することを意味します。

  ビルトイン接続文字列デザイナ

  JDBC URL の構成については、Paylocity JDBC Driver に組み込まれている接続文字列デザイナを使用できます。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

  java -jar cdata.jdbc.paylocity.jar

  接続プロパティを入力し、接続文字列をクリップボードにコピーします。

  

  以下は一般的なJDBC URL です。

  jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例： ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
2. ビルドするには、以下のコマンドを実行してください。 make install USE_PGXS=1

Paylocity のデータをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってPaylocity へのクエリの実行を開始します。

1. データベースにログイン
2. データベースの拡張機能をロード CREATE EXTENSION jdbc2_fdw;
3. Paylocity のオブジェクトを作成 CREATE SERVER Paylocity FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.paylocity.PaylocityDriver', url 'jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.paylocity.jar');
4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成 CREATE USER MAPPING for postgres SERVER Paylocity OPTIONS ( username 'admin', password 'test');
5. ローカルデータベースに外部テーブルを作成 postgres=# CREATE FOREIGN TABLE employee ( employee_id text, employee_FirstName text, employee_LastName numeric) SERVER Paylocity OPTIONS ( table_name 'employee');

おわりに

このようにCData JDBC Driver for Paylocity を使って簡単にPaylocity のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。