CData SmartHR BizTalk Adapter に一方向送信ポートを構成

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

ここでは、CData BizTalk Adapter for API を使用して静的な一方向送信ポートを作成、構成、テストする手順を説明します。静的な一方向送信ポートを使用することで、アップデートグラム、SQL コマンド、ストアドプロシージャを実行できます。送信ポートは、 返答データを持たない SmartHR のデータ変更の操作に役立ちます。通常、これはDELETE またはUPDATE のSQL コマンドか、アップデートグラムですが、場合によっては、ストアドプロシージャになります。

SELECT コマンドの実行や、作成したレコードId の取得のような、応答するアクションをトリガーする場合は、要請応答送信ポートを使用します。

一方向送信ポートを作成し実行する

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

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

アダプタを構成する

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

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

SmartHR への接続を構成する

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

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

   Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;''

   SmartHR に接続するには、SmartHR API トークンとTenantId が必要です。API トークンはSmartHR のアプリケーション統合ページで生成できます。トークンを取得したら、ProfileSettings API Key 接続プロパティに指定してください。TenantId は自身のSmartHR ページのURL「https://1234567890.smarthr.jp/」で確認できます（ここでは「1234567890」）。もしSandbox 環境を使用する場合は、接続プロパティにUseSandbox=true を設定してください。

   次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

5. ［Test Connection］をクリックして値を確認し、接続を確認します。

接続に成功し、アダプターが実行するコマンドを定義することで、送信ポートを使用できるようになります。アプリケーションで一方向送信ポートを使用する例については、次のセクションを参照してください。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、送信ポートを使用してコマンドを実行します。

この例ではフィルターを利用して、アップデートグラムを含むメッセージを受信場所から送信ポートに移動します。フィルターについてのより詳しい説明は次のセクションを参照してください。

フィルターを作成し、アプリケーションを介してBizTalk メッセージをルーティングする

送信ポートを必要なメッセージに関連付けるには、その送信ポートのプロパティの［Filters］セクションでフィルタールールを作成します。条件に一致するメッセージは、送信ポートにルーティングされます。受信場所でのフィルタリングに関しては、次の例を参照してください。

例：一方向送信ポートでアップデートグラムを実行する

このセクションでは、一方向送信ポートをアプリケーションで使用する方法について説明します。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、コマンドを実行します。

1. 一方向受信場所はアップデートグラムを含むXML ドキュメントをピックアップします。
2. 受信場所は、コマンドの結果を含むBizTalk メッセージを作成します。
3. 一方向送信ポートは、受信場所のURI をフィルタリングします。ドキュメントは一方向送信ポートにルーティングされます。
4. 送信ポートは、アップデートグラムコマンドを実行します。

前の例と同様に次のステップでは、ファイルからアップデートグラムを読み取るための受信場所を設定し、送信ポートを使用してコマンドを実行する方法を説明します。

1. 静的な一方向の受信場所を作成、構成します。転送タイプのファイルを使用します。「CData BizTalk Adapter for API の受信場所を作成、構成する」と同じ手順に従います。
2. 静的な一方向送信ポートを作成します。
3. 送信ポートのプロパティで、［Filters］をクリックします。
4. 空のプロパティで、次の値を設定します。

   プロパティ

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

   値

   新しく作成された一方向受信場所のURI を入力します。