Paylocity データ をHeroku Postgres にレプリケーションして、Salesforce Connect から利用する方法

こんにちは！プロダクトスペシャリストの宮本です。

CData Sync は、いろいろなシナリオのデータレプリケーション（同期）を行うことができるスタンドアロンのアプリケーションです。例えば、sandbox および本番インスタンスのデータをデータベースに同期することができます。Paylocity のデータ をHeroku 上のPostgreSQL に同期することで、Salesforce の通常オブジェクトに加えて、Salesforce 外部オブジェクト（Salesforce Connect）としてPaylocity のデータへのアクセスが可能になります。

要件

本レプリケーション例では、次が必要です:

1. CData Sync (試用版もしくは商用版)、およびPaylocity のレプリケーションに必要なライセンス。
2. Heroku Postgress を含むHeroku app および、Heroku Connect アドオン許可。
3. Salesforce アカウント。

レプリケーション同期先の設定

CData Sync を使って、Paylocity のデータ をHeroku 上のPostgreSQL データベースにレプリケーションできます。本記事では、Heroku 上の既存のPostgreSQL を使用します。PostgreSQL データベースをレプリケーション先に指定するには、［接続］タブから進みます。

1. ［同期先］タブをクリックします。
2. PostgreSQL を同期先として選択します。

   PostgreSQL への接続には、Port（デフォルトでは5432）、およびデータベース接続プロパティを設定し、サーバーに認証するuser およびpassword を設定します。データベースプロパティが指定されていない場合には、ユーザーのデフォルトデータベースに接続します。

3. 接続のテスト］をクリックして、正しく接続できているかをテストします。
4. ［変更を保存］をクリックします。

Paylocity 接続の設定

データソース側にPaylocity を設定します。［接続］タブをクリックします。

1. ［接続の追加］セクションで［データソース］タブを選択します。
2. Paylocity アイコンをデータソースとして選択します。プリインストールされたソースにPaylocity がない場合には、追加データソースとしてダウンロードします。
3. 接続プロパティに入力をします。
   
   

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

4. ［接続のテスト］をクリックして、正しく接続できているかをテストします。
5. ［変更を保存］をクリックします。

Paylocity インスタンス毎のクエリの設定

Data Sync はレプリケーションをコントロールするSQL クエリを簡単なGUI 操作で設定できます。 レプリケーションジョブ設定には、［ジョブ］タブに進み、［ジョブを追加］ボタンをクリックします。 次にデータソースおよび同期先をそれぞれドロップダウンから選択します。

テーブル全体をレプリケーションする

テーブル全体をレプリケーションするには、［テーブル］セクションで［テーブルを追加］をクリックします。表示されたテーブルリストからレプリケーションするテーブルをチェックします。

テーブルをカスタマイズしてレプリケーションする

レプリケーションはテーブル全体ではなく、カスタマイズが可能です。［変更］機能を使えば、レプリケーションするカラムの指定、同期先でのカラム名を変更しての保存、ソースデータの各種加工が可能です。レプリケーションのカスタマイズには、ジョブの［変更］ボタンをクリックしてカスタマイズウィンドウを開いて操作を行います:

• チェックボックスでフィールドを追加もしくは削除
• カラムリストの下に新しく計算されたフィールドを追加する
• フィルタセクションを利用してフィルタを追加する

インターフェースを使って変更を行うと、レプリケーションのSQL クエリは以下のようなシンプルなものから：

REPLICATE [Employee]

次のような複雑なものになります:

REPLICATE [Employee] SELECT [FirstName], [LastName] FROM [Employee] WHERE [EmployeeId] = 1234

レプリケーションのスケジュール起動設定

［スケジュール］セクションでは、レプリケーションジョブの自動起動スケジュール設定が可能です。反復同期間隔は、15分おきから毎月1回までの間で設定が可能です。

レプリケーションジョブを設定したら、［変更を保存］ボタンを押して保存します。複数のPaylocity のデータ のジョブを作成して、Salesforce の外部オブジェクトとして利用可能です。

外部オブジェクトとしてPaylocity データ レプリケーションにアクセス

Paylocity のデータ がHeroku 上のPostgreSQL データベースとしてレプリケーションされたので、Heroku のOData インターフェースを設定し、Salesforce Connect から外部オブジェクトとしてデータ連携できるようにします。

Heroku のOData Service を設定します

まずは、Heroku 上のPostgreSQL データベースに複製されたPaylocity のデータ への接続のために、データベースに対しHeroku External Object を設定します。

1. Heroku ダッシュボードで、［Connect Add-on］ をクリックします。
2. ［External Objects］を指定します。はじめてHeroku External Object を使用する場合には、OData Server のログインクレデンシャルを作成するようにナビゲートされます。
3. OData service URL およびクレデンシャルを確認します。このクレデンシャルをSalesforce Connect 接続時に利用します。
4. ［Data Sources］において、前のプロセスで作成したレプリケーション済みデータベースを設定します。

詳しくは、こちらのHeroku documentation を参照してください。

Salesforce の外部データソースの設定

Heroku のOData サービスの設定が終わったら、Salesforce Connect を使って、複製されたPaylocity のデータ のデータに外部データソースとして連携します。

1. Salesforce で設定をクリックします。
2. Administration (管理)セクションで、［データ］→［外部データソース］をクリック。
3. データソースパラメータプロパティを設定します:
   • External Data Source: Salesforce UI に表示される名前
   • Name: API の一位の識別子
   • Type: Salesforce Connect: OData 4.0
   • URL: Heroku Connect のOData エンドポイント
   • Format: JSON
4. 認証の設定:
   • Identity Type: Named Principal
   • Authentication Protocol: Password Authentication
   • Username: Heroku Connect username
   • Password: Heroku Connect password
5. ［保存］をクリック。

Paylocity オブジェクトの同期

Salesforce の外部データソース登録が終わったら、次の方法でPaylocity 外部データソースに変更を反映させます。Paylocity テーブルの定義とPaylocity 外部オブジェクトの定義を同期します。

1. 作成した外部データソースのリンクをクリック。
2. ［Validate and Sync］をクリック
3. Paylocity テーブルを選択して、［同期］をクリックします。

Salesforce オブジェクトとしてPaylocity データ にアクセス

これで、レプリケーションされたPaylocity エンティティに対して、Salesforce の通常オブジェクトと同じように外部オブジェクトとしてアクセスが可能になりました。

是非、CData Sync の30日の無償評価版 をダウンロードして、Salesforce との連携をお試しください！