SnapLogic でPaylocity を外部サービスに連携

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

SnapLogic はintegration Platform-as-a-Service（iPaaS）であり、ユーザーはノーコードでデータ連携フローを作成できます。CData JDBC ドライバと組み合わせることで、ユーザーはSnapLogic ワークフローからPaylocity を含む250を超えるSaaS、ビッグデータ、NoSQL データソースのリアルタイムデータに接続できます。

組み込みの最適化されたデータ処理によって、CData JDBC Driver はリアルタイムPaylocity データを高速に扱えます。プラットフォームがPaylocity に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をPaylocity に直接プッシュし、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータソース型を使用してPaylocity データを操作することができます。

SnapLogic からPaylocity に接続する

SnapLogic からPaylocity データに接続するには、CData Paylocity JDBC Driver をダウンロードしてインストールします。インストール画面に従ってください。インストールが完了すると、インストール先のディレクトリ（デフォルトでは、C:/Program Files/CData/CData JDBC Driver for Paylocity/lib）にJAR ファイルが作成されます。

Paylocity JDBC Driver をアップロードする

インストール後、JDBC JAR ファイルをSnapLogic 内のディレクトリ（例えば、projects/Jerod Johnson）にManager タブからアップロードします。

接続を設定する

JDBC Driver がアップロードされると、Paylocity への接続を作成できます。

1. Designer タブに移動します。
2. Snaps から「JDBC」を展開して、「Generic JDBC - Select」snap をdesigner にドラッグします。
3. Add Account をクリック（または既存のものを選択）して、「Continue」をクリックします。
4. 次のフォームでは、JDBC 接続プロパティを設定します。
   • JDBC JARs 以下にアップロードしたJAR ファイルを追加します。
   • JDBC Driver Class をcdata.jdbc.paylocity.PaylocityDriver に設定します。

   • JDBC URL をPaylocity JDBC Driver 用のJDBC 接続文字列に設定します。例えば、

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

     です。

     NOTE： RTK は評価版もしくは製品版のキーです。詳しくは、CData のサポートチームにご連絡ください。

     組み込みの接続文字列デザイナー

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

     java -jar cdata.jdbc.paylocity.jar

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

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

5. 接続プロパティの入力後、「Validate」、そして「Apply」をクリックします。

Paylocity データを読み込む

接続を検証、適用後に開くフォームで、クエリを設定します。

• Schema name を"Paylocity" に設定します。
• Table name を、スキーマ名を使用したPaylocity 用のテーブルに設定します。例えば、"Paylocity"."Employee" です（ドロップダウンを使用して利用可能なテーブルの全リストを確認できます）。
• テーブルから、使用したい項目ごとにOutput fields を追加します。

Generic JDBC - Select snap を保存します。

接続とクエリを設定したら、snap の終端部分（以下のハイライト部分）をクリックしてデータをプレビューします。

結果が期待どおりのものであることを確認したら、他のsnap を追加してPaylocity データを別のエンドポイントに渡すこともできます。

Paylocity データを外部サービスにパイプ

本記事では、データをGoogle Spreadsheet にロードします。他のあらゆるサポートされているsnap が使用でき、Generic JDBC snap を他のCData JDBC ドライバと利用してデータを外部サービスに移すこともできます。

1. まず、「Worksheet Writer」snap を"Generic JDBC - Select" snap の終端部分にドロップします。
2. Google Sheets に接続するアカウントを追加します。
3. Worksheet Writer snap を、Paylocity データをGoogle Spreadsheet に書き込むよう設定します。

これで、接続済みのパイプラインを実行してPaylocity からデータを抽出し、Google Spreadsheet にプッシュできます。

外部データをPaylocity にパイプ

上述のように、JDBC Driver for Paylocity をSnapLogic から使用してデータをPaylocity に書き込むことができます。まずは、Generic JDBC - Insert またはGeneric JDBC - Update snap をダッシュボードに追加します。

1. 既存の「Account」（接続）を選択するか、新しく作成します。
2. クエリの設定。
   • Schema name を"Paylocity" に設定します。
   • Table name をスキーマ名を使用したPaylocity のテーブルに設定します。例えば、"Paylocity"."Employee"（ドロップダウンを使用して利用可能な全テーブルの一覧を確認できます）。
3. Generic JDBC - Insert/Update snap を保存します。

これで、Paylocity にデータを書き込んだり、新しいレコードを挿入したり、既存のレコードを更新するsnap が設定できました。

詳細情報と無償評価版

CData JDBC Driver for Paylocity を使えば、Paylocity データを外部サービスに連携するためのパイプラインをSnapLogic で作成できます。Paylocity への接続に関する詳細については、CData のPaylocity 連携ページを参照してください。30日の無償評価版をダウンロードして今すぐ使い始めましょう。