Paylocity データをBoomi AtomSphere で連携利用する方法：CData JDBC Driver

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

Boomi AtomSphere https://boomi.com/は、Boomi 社が提供する、 シングルインスタンス、マルチテナントアーキテクチャを特徴としているデータ統合サービス（iPaaS）です。データ統合機能だけでなく、マスターデータのハブ機能、EDI、APIManagement、WorkFlow　といったビジネスユースに必要なデータ連携のすべてを実現する機能をシングルプラットフォームで提供しています。

この記事では、Boomi AtomSphere のオンプレミスAtom deployment 機能を使って、CData JDBC ドライバ経由でPaylocity データにアクセスする方法を紹介します。CData Drivers を使うことで、RDB のようにBoomi 内でPaylocity データを扱うことができるようになります。

Boomi のon-Premise Atom depleyment の作成

on-Premise Atom deployment （右上の青部分）を利用する構成としました。この機能を利用することでOn-Premise 側に配置したCData JDBC ドライバ経由でのSaaS 連携を実現します。

• ブラウザからBoomi Atom のManage > Atom Management のタブを開きます。
• +New > Atom を開きます。
• Atom Setup ダイアログが開くので、ブラウザを開いているマシンのOS（本例ではWindows10Pro 64bit）のSetup ファイルをダウンロードします。
• ダウンロードした「atom_install64.exe」を実行するとインストーラが起動します。
• Setup Wizard を進めます。
• ブラウザからBoomi Atom へのログインする時のUser・Password をセットして、Atom Name はデフォルトのまま、次に進みます。
• on-Premise Atom deployment のインストールディレクトリ（デフォルト）を指定して次に進みます。
• Setup Wizard を終了（Finish）します。
• ブラウザからBoomi Atom のManage > Atom Management のタブを開いて、上記で作成したon-Premise Atom Deployment が起動していることを確認します。なお、Windows マシンの場合、サービスからも起動を確認できます。on-Premise Atom deployment の作成は以上です。

Boomi on-Premise Atom deployment モジュールへのJDBC ドライバの配置

次に別途ダウンロード・インストールしたCData JDBC Driver for Paylocity をBoomi on-premise Atom モジュールに配置していきます。

JDBC Drivers ファイルをCData 製品のインストールフォルダからon-Premise Atom deployment インストールパス配下のパスにコピーします。
• cdata.jdbc.paylocity.jar
• cdata.jdbc.paylocity.lic （試用版では.lic ファイルは不要）

• コピー元：C:\Program Files\CData\CData JDBC Driver for Paylocity 2019J\lib
• コピー先：C:\Boomi AtomSphere\Atom - 10.211.55.9\lib

コピーしたらBoomi Atom をブラウザからリスタート(Restart Atom)してください。作成したon-Premise Atom deployment のInstalledLibraries にJDBCの.jar ファイルが表示されれば成功です。

Paylocity のConnectionの作成

Boomi Atom からPaylocity データソースに接続するためのConnection を作成します。

• Welcom 画面の「Component > Connetion」を選択するとCreate Component ウィザードが開きます。
• Paylocity への接続用のConnection 設定として以下の値をセットします。
  • Type: Connection
  • Component Name: ConnectionCDataPaylocity
  • Folder: 任意のパス
  • Connector: Database
• そしてJDBC Driver の接続設定を行います。

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

  • Driver Type: Custom
  • Class Name: cdata.jdbc.paylocity.PaylocityDriver
  • User Name: 本来であれば不要ですが、空のままだと後の手順でバリデーションエラーが発生するので適当な値をセットします
  • Password: 本来であれば不要ですが、空のままだと後の手順でバリデーションエラーが発生するので適当な値をセットします
  • Connection URL: jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
• Connection の値を設定したら接続テストを行います。右上のTest Connection ボタンをクリックします。実行するAtom を選択する画面が表示されるので、上記手順で作成したon-Premise Atom deployment を選択します。
• テスト接続が成功することを確認してFinish ボタンでウィザードを閉じます。
• 作成した Paylocity データ への接続Connection を保存（Save）します。

Boomi Atom でのPaylocity データ Profile の作成

次にProfile を設定していきます。ProfileとはSQL（SELECT/INSERT/UPDATE/DELETE）実行時のフィールド定義です。

• Paylocity データ のテーブルをSELECT するProfile を作成していきます。
• • Type: Profle
  • Component Name: ProfileCDataPaylocity
  • Folder: 任意のパス
  • Connector: Database
• 二つのパラメータに、Display Name: デフォルト, Type: Select と値をセットしたら右上のImportボタンをクリックします。
• Database Import Wizardが開くので、以下のパラメータをセットして次に進みます。
  • Browse in: 上記手順で作成したon-Premise Atom deployment
  • Connection: 上記手順で作成した接続Connection
• Paylocity データ 内のオブジェクトがテーブル一覧として表示されます。取得するテーブルにチェックをオンにして次に進みます。
• テーブル内のカラム一覧が表示されます。使用する項目のチェックをオンにして次に進みます。
• Import ウィザードが完了します。
• DataElements のField アイコンをクリックすると選択テーブル内のカラムが定義されていることを確認できます。また、SQL Script には取得時のSQL（SELECT）が表示されています。作成したProfile を保存します。
• これでPaylocity データ がBoom Atom で利用できるProfile として登録されました。

Boomi AtomSphere でのPaylocity データ の利用

あとは、設定されたProfile はRDB と同じようにBoomi Atom 内で利用することができます。カラムにマッピングを行うこともできます。

このようにCData JDBC ドライバをアップロードすることで、簡単にBoomi AtomSphere でPaylocity データ データをノーコードで連携し、使うことが可能です。

是非、CData JDBC Driver for Paylocity 30日の無償評価版 をダウンロードして、お試しください。