CData Paylocity BizTalk Adapter の要請応答送信ポートを構成

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

ここでは、CData BizTalk Adapter for Paylocity を使用し、静的な要請応答送信ポートを作成、構成、テストする手順を説明します。静的な要請応答送信ポートを使用してコマンドを実行し、BizTalk の結果にアクセスすることができます。送信ポートを使用することで、アップデートグラムコマンド、SQL コマンド、ストアドプロシージャ操作を実行できます。

送信ポートを作成し構成する

静的な要請応答送信ポートを作成し、アダプタをトランスポートタイプとして使用するように構成します。

1. 未実行の場合、BizTalk 管理コンソールで BizTalk アプリケーションを開きます。
2. BizTalk アプリのノードで、［Send Ports］を右クリックし、［New］->［Static Solicit-Response Send Port］を選択すると、送信ポートプロパティのダイアログが表示されます。
3. 送信ポートのプロパティで、受信ポートの名前を入力します。
4. ［Transport Type］メニューで、CData.Paylocity を選択します。
5. ［Send Pipeline］メニューで、デフォルトオプションの［PassThruTransmit］を選択します。
6. ［Receive Pipeline］メニューで、デフォルトオプションの［PassThruReceive］を選択します。

アダプタを構成する

［Transport Properties］ダイアログで、アダプタが実行するコマンドを定義します。

1. 送信ポートのプロパティで、［Configure］ボタンをクリックします。アダプタのトランスポートプロパティダイアログが表示されます。
2. ［CommandType］プロパティで、実行したいコマンドタイプを選択します。
3. SQL コマンドを実行したい場合は、［SQL Command］のボックスにコマンドを入力してください。

Paylocity への接続を構成する

［Connection String Options］ダイアログで、Paylocity への接続に必要な資格情報とその他のプロパティを設定します。

1. 送信ポートのプロパティで、［Configure］をクリックします。アダプタのプロパティダイアログが表示されます。
2. ［Connection String］プロパティのボタンをクリックします。［Connection String Options］ダイアログが表示されます。
3. 接続プロパティを入力します。下は一般的な接続文字列です。

   OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

   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. ［Test Connection］をクリックして値を確認し、接続を確認します。