BizTalk Serverを使用してSQL Serverで Table-Valued 関数を呼び出す

[アーティクル]
10/14/2023

BizTalk Serverと共に SQL アダプターを使用して、SQL Serverでテーブル値関数を呼び出すことができます。アダプターは、テーブル値関数を、SQL Serverで直接呼び出すことができる操作として公開します。アダプターがテーブル値関数をサポートする方法の詳細については、「SQL アダプターを使用したSQL Serverでの Table-Valued 関数の実行」を参照してください。テーブル値関数を呼び出すための SOAP メッセージの構造については、「プロシージャと関数のメッセージスキーマ」を参照してください。

前提条件

厳密な名前のキーファイルを作成し、ツールを学習する
SQL アダプターとSQL Serverを実行しているコンピューターで MSDTC を構成します。

SQL Server データベースでテーブル値関数を呼び出す

BizTalk Serverと共に SQL アダプターを使用してSQL Server データベースに対して操作を実行するには、「Sql アダプターを使用して BizTalk アプリケーションを開発するための構成要素」で説明されている手続き型タスクが含まれます。 SQL Serverでテーブル値関数を呼び出すには、次のタスクを実行します。

BizTalk プロジェクトを作成し、SQL Serverで呼び出すテーブル値関数のスキーマを生成します。
SQL Serverからメッセージを送受信するためのメッセージを BizTalk プロジェクトに作成します。
SQL Serverで操作を呼び出すオーケストレーションを作成します。
BizTalk プロジェクトをビルドして展開します。
物理送受信ポートを作成して BizTalk アプリケーションを構成します。
BizTalk アプリケーションを起動します。

このトピックでは、これらのタスクを実行する手順について説明します。

スキーマの生成

このトピックでは、BizTalk Serverで SQL アダプターを使用して、SQL Serverでテーブル値関数を呼び出す方法について説明します。この操作を示すために、このトピックでは、TVF_EMPLOYEE関数を実行します。この関数は、従業員の指定をパラメーターとして受け取り、その指定を持つすべての従業員レコードをテーブル型として返します。 Employee テーブルと関数は、サンプルで提供されるスクリプトを実行して作成されます。スクリプトの詳細については、「 SQL アダプターのサンプル」を参照してください。

テーブル値関数を呼び出す方法を示すために、TVF_EMPLOYEEテーブル値関数のスキーマが生成されます。 BizTalk プロジェクトを作成し、アダプターサービスアドインを使用してスキーマを生成する必要があります。スキーマの生成方法の詳細については、「SQL アダプターを使用した Visual Studio でのSQL Server操作のメタデータの取得」を参照してください。

メッセージとメッセージの種類を定義する

先に生成したスキーマは、オーケストレーションのメッセージに求められる "型" を記述します。メッセージは通常、対応するスキーマによって定義された型の変数です。次に、オーケストレーションのメッセージを作成し、前の手順で生成したスキーマにリンクします。

BizTalk プロジェクトにオーケストレーションを追加します。ソリューションエクスプローラーから BizTalk プロジェクト名を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。 BizTalk オーケストレーションの名前を入力し、[ 追加] をクリックします。
BizTalk プロジェクトの [オーケストレーションの種類] ウィンドウを開きます (まだ表示されていない場合)。これを行うには、[ 表示] をクリックし、[ その他のウィンドウ] をポイントして、[ オーケストレーションビュー] をクリックします。
オーケストレーションビューで、[ メッセージ] を右クリックし、[ 新しいメッセージ] をクリックします。
新しく作成したメッセージを右クリックし、[ プロパティウィンドウ] を選択します。

Message_1の [プロパティ] ウィンドウで、次の操作を行います。

プロパティ	目的
識別子	「`Request`」と入力します
メッセージ型	ドロップダウンリストから [ スキーマ] を展開し、[TableFunctions.TableValuedFunction_dbo] を選択します。TVF_EMPLOYEE。TableFunctions は BizTalk プロジェクトの名前です。 TableValuedFunction_dboは、TVF_EMPLOYEE関数に対して生成されるスキーマです。

手順 2 を繰り返して、新しいメッセージを作成します。新しいメッセージの [プロパティ ] ウィンドウで、次の操作を行います。

プロパティ	目的
識別子	「`Response`」と入力します
メッセージ型	ドロップダウンリストから [ スキーマ] を展開し、[TableFunctions.TableValuedFunction_dbo] を選択します。TVF_EMPLOYEEResponse。

オーケストレーションを設定する

SQL Serverで操作を実行するためにBizTalk Serverを使用する BizTalk オーケストレーションを作成します。このオーケストレーションでは、定義された受信場所に要求メッセージをドロップします。 SQL アダプターはこのメッセージを使用し、SQL Serverに渡します。 SQL Serverからの応答は別の場所に保存されます。 SQL Serverにメッセージを送信したり、応答を受信したりするには、[送信] 図形と [受信] 図形を含める必要があります。テーブル値関数を呼び出すためのサンプルオーケストレーションは、次のようになります。

28ca3930-7ce8-423a-9edd-cb2888eebaac テーブル値関数を

メッセージ図形を追加する

メッセージ図形ごとに次のプロパティを入力します。 [図形] 列に一覧表示される名前は、単一のオーケストレーションに表示されるメッセージ図形の名前です。

図形	図形の種類	プロパティ
ReceiveMessage	受信	- 名前を ReceiveMessage に設定する - Activate をTrue に設定する
SendMessage	Send	- 名前を SendMessage に設定する
ReceiveResponse	受信	- 名前を ReceiveResponse に設定する - Activate をFalse に設定する
SendResponse	Send	- 名前を SendResponse に設定する

ポートの追加

論理ポートごとに次のプロパティを入力します。 [ポート] 列に表示される名前は、オーケストレーションに表示されるポートの名前です。

Port	プロパティ
MessageIn	- 識別子を MessageIn に設定する - 型を MessageInType に設定する - 通信パターンを一方向に設定する - 受信する通信方向を設定する
LOBPort	- 識別子を LOBPort に設定する - 型を LOBPortType に設定する - 通信パターンを Request-Response に設定する - [通信の方向] を [送受信] に設定する
ResponseOut	- 識別子を ResponseOut に設定する - Type を ResponseOutType に設定する - 通信パターンを一方向に設定する - [通信の方向] を [送信] に設定する

アクション図形のメッセージを入力し、ポートに接続する

次の表では、アクション図形のメッセージを指定し、メッセージをポートにリンクするために設定する必要があるプロパティとその値を指定します。 [図形] 列に表示される名前は、前述のオーケストレーションに表示されるメッセージ図形の名前です。

図形	プロパティ
ReceiveMessage	- メッセージを要求に設定する - 操作を MessageIn.TVF.Request に設定する
SendMessage	- メッセージを要求に設定する - 操作を LOBPort.TVF.Request に設定する
ReceiveResponse	- [メッセージ] を [応答] に設定する - 操作を LOBPort.TVF.Response に設定する
SendResponse	- [メッセージ] を [応答] に設定する - 操作を ResponseOut.TVF.Request に設定する

これらのプロパティを指定すると、メッセージの図形とポートが接続され、オーケストレーションが完了します。

次に、BizTalk ソリューションをビルドし、BizTalk Serverに展開します。詳細については、「オーケストレーションのビルドと実行」を参照してください。

BizTalk アプリケーションを構成する

BizTalk プロジェクトを展開すると、前に作成したオーケストレーションが、BizTalk Server管理コンソールの [オーケストレーション] ウィンドウの下に一覧表示されます。アプリケーションを構成するには、BizTalk Server管理コンソールを使用する必要があります。チュートリアルについては、「チュートリアル: 基本的な BizTalk アプリケーションの展開」を参照してください。

アプリケーションの構成には、次の作業が含まれます。

アプリケーションのホストの選択。
オーケストレーションで作成したポートを、BizTalk Server管理コンソールの物理ポートにマッピングします。このオーケストレーションでは、次の操作を行う必要があります。
- ハードディスク上の場所と、要求メッセージを削除する対応するファイルポートを定義します。 BizTalk オーケストレーションは要求メッセージを使用し、SQL Server データベースに送信します。
- ハードディスク上の場所と、BizTalk オーケストレーションがSQL Server データベースからの応答を含む応答メッセージを削除する対応するファイルポートを定義します。
- SQL Server データベースにメッセージを送信する物理 WCF-Custom または WCF-SQL 送信ポートを定義します。また、送信ポートでアクションを指定する必要があります。ポートを作成する方法については、「 SQL アダプターへの物理ポートバインドを手動で構成する」を参照してください。
  
  Note
  
  アダプターサービス BizTalk プロジェクトアドインを使用してスキーマを生成すると、ポートとそれらのポートに設定するアクションに関する情報を含むバインドファイルも作成されます。このバインドファイルをBizTalk Server管理コンソールからインポートして、送信ポート (送信呼び出しの場合) または受信ポート (受信呼び出し用) を作成できます。詳細については、「 SQL アダプターを使用するようにポートバインドファイルを使用して物理ポートバインドを構成する」を参照してください。

アプリケーションを起動する

SQL Server データベースでテーブル値関数を呼び出すための BizTalk アプリケーションを起動します。 BizTalk アプリケーションを起動する手順については、「オーケストレーションを開始する方法」を参照してください。

この段階で、次のことを確認します。

オーケストレーションの要求メッセージを受信する FILE 受信ポートが実行されています。
オーケストレーションから応答メッセージを受信する FILE 送信ポートが実行されています。
SQL Server データベースにメッセージを送信する WCF-Custom または WCF-SQL 送信ポートが実行されています。
操作の BizTalk オーケストレーションが実行されています。

操作を実行する

アプリケーションを実行した後、FILE 受信場所に要求メッセージをドロップする必要があります。要求メッセージのスキーマは、前に生成したテーブル値関数のスキーマTVF_EMPLOYEE準拠している必要があります。たとえば、TVF_EMPLOYEE関数を呼び出す要求メッセージは次のとおりです。

<TVF_EMPLOYEE xmlns="http://schemas.microsoft.com/Sql/2008/05/TableValuedFunctions/dbo">  
  <emp_desig>Tester</emp_desig>  
</TVF_EMPLOYEE>

この要求メッセージは、TVF_EMPLOYEE関数を呼び出して、"Tester" という指定の従業員レコードを取得します。 SQL アダプターを使用してSQL Serverでテーブル値関数を呼び出すための要求メッセージスキーマの詳細については、「プロシージャと関数のメッセージスキーマ」を参照してください。

Note

パラメーターの値を指定しない場合、アダプターは DEFAULT キーワード (keyword) を使用して関数を内部的に実行します。つまり、関数定義の一部として使用可能な場合は、パラメーターの既定値を渡すことによってアダプターが関数を実行します。

オーケストレーションによってメッセージが使用され、SQL Server データベースに送信されます。 SQL Server データベースからの応答は、オーケストレーションの一部として定義されている他の FILE の場所に保存されます。たとえば、上記の要求メッセージに対するSQL Server データベースからの応答は次のようになります。

<?xml version="1.0" encoding="utf-8" ?>   
<TVF_EMPLOYEEResponse xmlns="http://schemas.microsoft.com/Sql/2008/05/TableValuedFunctions/dbo">  
  <TVF_EMPLOYEEResult>  
    <TVF_EMPLOYEE xmlns="http://schemas.microsoft.com/Sql/2008/05/Types/TableFunctionReturnTables/dbo">  
      <Employee_ID>10499</Employee_ID>   
      <Name>John</Name>   
      <Designation>Tester</Designation>   
      <Salary>999999.00</Salary>   
      <Last_Modified>AAAAAAAAJBM=</Last_Modified>   
    </TVF_EMPLOYEE>  
    <TVF_EMPLOYEE xmlns="http://schemas.microsoft.com/Sql/2008/05/Types/TableFunctionReturnTables/dbo">  
      ......  
      ......  
    </TVF_EMPLOYEE>  
    ......  
    ......  
  </TVF_EMPLOYEEResult>  
</TVF_EMPLOYEEResponse>

ベストプラクティス

BizTalk プロジェクトを展開して構成したら、構成設定をバインドファイルと呼ばれる XML ファイルにエクスポートできます。バインドファイルを生成したら、ファイルから構成設定をインポートして、同じオーケストレーションの送信ポートや受信ポートなどの項目を作成する必要がないようにすることができます。バインドファイルの詳細については、「アダプターバインドを再利用する」を参照してください。

参照

SQL アダプターを使用して BizTalk アプリケーションを開発する

次の方法で共有

BizTalk Serverを使用してSQL Serverで Table-Valued 関数を呼び出す

前提条件

SQL Server データベースでテーブル値関数を呼び出す

スキーマの生成

メッセージとメッセージの種類を定義する

オーケストレーションを設定する

メッセージ図形を追加する

ポートの追加

アクション図形のメッセージを入力し、ポートに接続する

BizTalk アプリケーションを構成する

アプリケーションを起動する

操作を実行する

ベストプラクティス

参照

フィードバック

フィードバック

その他のリソース

次の方法で共有

BizTalk Serverを使用してSQL Serverで Table-Valued 関数を呼び出す

前提条件

SQL Server データベースでテーブル値関数を呼び出す

スキーマの生成

メッセージとメッセージの種類を定義する

オーケストレーションを設定する

メッセージ図形を追加する

ポートの追加

アクション図形のメッセージを入力し、ポートに接続する

BizTalk アプリケーションを構成する

アプリケーションを起動する

操作を実行する

ベスト プラクティス

参照

フィードバック

フィードバック

その他のリソース

ベストプラクティス