BizTalk でPaylocity にストアドプロシージャを実行する

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

ストアドプロシージャは、SELECT 、INSERT 、UPDATE 、DELETE としては表すことができないPaylocity アクションを実装します。この記事では、ストアドプロシージャ用のスキーマを作成する方法を説明します。このスキーマを使用して、送信ポートからストアドプロシージャを実行できます。

プロジェクトにアダプターを追加する

［Add Adapter］ ウィザードから、アダプターをVisual Studio のBizTalk サーバープロジェクトに追加します。このアダプターは、ストアドプロシージャへの入力とその結果に関するメタデータを返します。このメタデータを使用してスキーマを作成します。

1. ［Solution Explorer］ の［project］ で右クリックし、［Add］ -> ［Add Generated Items］ と進みます。
2. ［resulting dialog box］ の［Add Adapter Metadata］ を選択します。
3. 表示される［Add Adapter］ ウィザードで、リストからアダプターを選択します。
4. ［Port menu］ では、選択を空白のままにします。もしくは、Paylocity アダプターを使用するように構成されている受信場所や送信ポートを選択します。

5. 送信ポートまたは受信場所に、認証資格情報と他の接続プロパティが構成されていない場合、［Connection String］ ページで、それらを入力します。下は一般的な接続文字列です。

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

スキーマを作成する

［Add Adapter］ ウィザードで接続プロパティを入力すると、［Schema］ ウィザードが表示されます。

1. 次の［Schema Information］ のページでは、Paylocity アダプターを使用するために構成した送信ポートを選択します。
2. CData Paylocity アダプターが要請応答送信ポートで構成されている場合、［One-Way］ オプションを無効にします。
3. ［Command Type］ メニューで、ストアドプロシージャを選択します。
4. メニューからストアドプロシージャを選択し、インプットパラメータの値を入力します。
5. ウィザードで表示される概要の設定を確認して［Finish］ をクリックし、schema.xsd ファイルを作成します。

スキーマを処理する

BizTalk アプリでスキーマを使用する際は、こちらのチュートリアルをご覧ください。