CData BizTalk Adapter for Paylocity の Receive Location を構成する

この記事の手順に従って、Paylocity のデータに接続し、Static One-Way Receive Location を構成して、シンプルなテスト（Paylocity のデータを取得して XML ファイルに書き込む）を実行できます。

Receive Location は SQL コマンドを実行し、結果を含む BizTalk メッセージを作成できます。Updategram コマンドを実行する場合は、Send Port を使用してください。

Receive Port の作成

アプリケーションに Receive Location を追加するには、まず Receive Port を追加する必要があります。Receive Port は複数の Receive Location からデータを受信できます。

1. まだ行っていない場合は、BizTalk Administration Console でアプリケーションを開きます。
2. アプリケーション内で、Receive Ports を右クリックし、New -> Static One-Way Receive Port をクリックします。Receive Port Properties ダイアログが表示されます。
3. Name メニューで、Receive Port の名前を入力します。

Receive Location の作成

Receive Port を作成したら、Receive Location を作成し、Paylocity アダプターをトランスポートタイプとして使用するよう構成します。

1. Receive Locations を右クリックし、New -> One-Way Receive Location をクリックします。
2. 新しい Receive Location がメンバーとなる適切な Receive Port を選択します。Receive Location Properties ダイアログが表示されます。
3. Name メニューで、Receive Location の名前を入力します。
4. Receive Location プロパティで、Transport Type メニューから CData.Paylocity を選択します。
5. Receive pipeline メニューで、デフォルトオプションの PassThruReceive を選択します。

アダプターの構成

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

1. Receive Location プロパティで、Configure をクリックします。アダプターの Transport Properties ダイアログが表示されます。
2. SQL Command プロパティに、コマンドを入力します。この例では

   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'

   を使用します。

利用可能なアダプター構成プロパティについては、"Adapter Configuration" の章を参照してください。

接続文字列の構成

Connection String Options ダイアログで、認証情報やその他の接続プロパティを設定します。

1. Receive Location プロパティで、Configure をクリックします。アダプタープロパティダイアログが表示されます。
2. Connection String プロパティのボタンをクリックします。
3. Connection String プロパティのボックスをクリックします。Connection String Options ダイアログが表示されます。
4. 接続プロパティを入力します。一般的な接続文字列は以下のとおりです：

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

5. Test Connection をクリックして、接続値を確認し接続をテストします。

各種プロパティとその機能の説明については、ヘルプドキュメントを参照してください。

Send Port を使用してデータを XML ファイルに書き込む

これで Static One-Way Receive Location を Send Port と共に使用する準備が整いました。Receive Location が作成した BizTalk メッセージには Send Port を関連付ける必要があります。データをファイルに書き込むには、File Send Port を作成します。

1. BizTalk Administration コンソールで、Send Ports -> New -> Static One-Way Send Port を右クリックします。

2. 構成ウィンドウの上部に Send Port の名前を入力し、Type メニューから FILE を選択します。

   
3. 宛先フォルダを構成します。これがディスク上にファイルが作成される場所になります。

4. ファイル名には、マクロを使用してファイルが作成された日付を簡単に識別できます。デフォルトでは %MessageId%.xml が使用されます。ただし、これはランダムに生成された BizTalk ID であるため、ユーザーフレンドリーな名前ではありません。Employee_yyyy-MM-dd.xml 形式のファイルを作成するには、Employee_%Date%.xml と入力します。

   注：マクロの詳細については、ヘルプドキュメントの BizTalk Configuration セクションを参照してください。

   
5. OK をクリックします。URI フィールドに値が入力されます。
6. Send Port の構成画面の左側で Filters をクリックします。
7. 以下のプロパティを設定します：

   Property：メニューから "BTS.InboundTransportLocation" を選択します。

   Operator：メニューから "==" を選択します。

   Value：Receive Location の URI を入力します。URI は Receive Location プロパティに表示されています。

これで、Send Port を使用して Receive Location から送信されたファイルを書き込めます。

Location と Port を Enlist および Enable する

最後のステップは、Send Port を Enlist し、Receive Location を Enable することです。Send Port を右クリックして Enlist をクリックします。次に、Receive Location を右クリックして Enable をクリックします。

注：Receive Location は最後に Enable してください。これにより、ファイルが Send Port によって確実に書き込み用にピックアップされます。

トラブルシューティング

エラーが発生しているかどうかを確認するには、Administration Console のナビゲーションツリーで "Event Viewer (Local)" を展開します。Windows Logs を展開し、Applications をクリックします。

ログにはシステム上のすべてのアプリケーションのエラーメッセージが含まれるため、エラーメッセージのソースが "CData BizTalk Paylocity Receive Adapter" であることを確認することが重要です。エラーメッセージの詳細から、エラーが発生している理由がわかります。エラーの解決方法については、[email protected]/jp にお問い合わせください。