SQL SELECT ステートメントには、クエリ結果を行セットではなく XML として返す FOR XML 句を指定できます。 FOR XML 句を含む SELECT ステートメントを持つストアド プロシージャを作成することもできます。 FOR XML (SQL Server) に関する 詳細情報が含まれます。
WCF ベースの SQL アダプターを使用して、このようなストアド プロシージャを実行できます。
Von Bedeutung
BizTalk Server で使用できる "ネイティブ" SQL アダプターには、ストアド プロシージャに SELECT ステートメントの一部として FOR XML 句が必要です。 このようなストアド プロシージャは、ストアド プロシージャ定義を変更することなく、WCF ベースの SQL アダプターで使用できます。
以前のバージョンの BizTalk Server で提供されている "ネイティブ" SQL アダプターを使用して生成されたスキーマは、いつでも使用できます。 詳細については、「 WCF-SQL アダプターでの FOR XML クエリの使用」を参照してください。
FOR XML 句を使用してストアド プロシージャを呼び出す方法
SQL Server Management Studio で FOR XML 句を使用してストアド プロシージャを呼び出すか、BizTalk Server で使用できる SQL アダプターを使用すると、出力は xml メッセージの形式になります。 WCF ベースの SQL アダプターでこれらのプロシージャを使用するには、出力メッセージのスキーマが必要です。 WCF ベースの SQL アダプターでは、FOR XML 句を使用してストアド プロシージャを実行した後、SQL Server から応答メッセージを受信するときに、このスキーマが必要です。 このストアド プロシージャを呼び出す要求メッセージは、アダプター自体によって生成されることに注意してください。
応答メッセージのスキーマを使用する以外に、WCF ベースの SQL アダプターを使用して FOR XML 句を使用してストアド プロシージャを呼び出す特定のタスクも実行する必要があります。
FOR XML 句を使用して、ストアド プロシージャの応答メッセージのスキーマを生成します。 BizTalk Server で使用できる "ネイティブ" SQL アダプターによって生成された応答スキーマが既にある場合は、この手順をスキップできます。
BizTalk プロジェクトを作成し、生成されたスキーマをプロジェクトに追加します。
WCF ベースの SQL アダプターを使用して、FOR XML 句を使用してストアド プロシージャのスキーマを生成します。 これにより、アダプターが SQL Server に送信してストアド プロシージャを呼び出す要求メッセージのスキーマが提供されます。
SQL Server からメッセージを送受信するメッセージを BizTalk プロジェクトに作成します。 要求メッセージは、アダプターによって生成された要求メッセージのスキーマに準拠している必要があります。 応答メッセージは、"ネイティブ" SQL アダプターを使用するか、SQL Server Management Studio で FOR XML 句を使用してストアド プロシージャを実行して取得した応答メッセージのスキーマに準拠している必要があります。
SQL Server データベースでストアド プロシージャを呼び出すオーケストレーションを作成します。
BizTalk プロジェクトをビルドして展開します。
物理送受信ポートを作成して BizTalk アプリケーションを構成します。
BizTalk アプリケーションを起動します。
ストアド プロシージャの応答メッセージのスキーマの生成
注
BizTalk Server で使用できる SQL アダプターによって生成された応答スキーマがある場合は、この手順を実行する必要はありません。
ストアド プロシージャの SELECT ステートメントに for xml 句を含む xmlschema 句がある場合は、ストアド プロシージャの応答メッセージのスキーマを生成できます。 このトピックでは、特定の従業員 ID の従業員の詳細を取得するGET_EMP_DETAILS_FOR_XML ストアド プロシージャを使用します。 ストアド プロシージャを実行してスキーマを取得するには、SELECT ステートメントは次のようになります。
SELECT [Employee_ID] ,[Name] ,[DOJ] ,[Designation] ,[Job_Description] ,[Photo] ,cast([Rating] as varchar(100)) as Rating ,[Salary] ,[Last_Modified] ,[Status] ,[Address]
FROM [Adapt_Doc].[dbo].[Employee] for xml auto, xmlschema
このストアド プロシージャを実行して、応答メッセージのスキーマを取得します。 ストアド プロシージャからの応答には、スキーマと、ストアド プロシージャの実行からのデータが含まれていることに注意してください。 応答からスキーマをコピーし、テキスト パッドに保存する必要があります。 この例では、このスキーマに ResponseSchema.xsd という名前を付けることができます。 Visual Studio で BizTalk プロジェクトを作成し、このスキーマをプロジェクトに追加する必要があります。
Von Bedeutung
ストアド プロシージャを実行してスキーマを生成した後、必ず xmlschema 句を削除してください。 これを行わない場合、最終的に BizTalk を使用してストアド プロシージャを実行すると、応答メッセージでスキーマが再度生成されます。 そのため、応答メッセージを xml として取得するには、 xmlschema 句を削除する必要があります。
BizTalk プロジェクトにスキーマを追加するには
Visual Studio で BizTalk プロジェクトを作成します。
ストアド プロシージャ用に生成した応答スキーマを BizTalk プロジェクトに追加します。 ソリューション エクスプローラーで BizTalk プロジェクトを右クリックし、[ 追加] をポイントして、[ 既存の項目] をクリックします。 [既存の項目の追加] ダイアログ ボックスで、スキーマを保存した場所に移動し、[ 追加] をクリックします。
Visual Studio でスキーマを開き、次の変更を行います。
スキーマにノードを追加し、この新しく追加されたノードの下に既存のルート ノードを移動します。 ルート ノードに名前を付けます。 このトピックでは、ルート ノードの名前を Root に変更します。
ストアド プロシージャに対して生成された応答スキーマは、sqltypes.xsd を参照します。 https://go.microsoft.com/fwlink/?linkid=31850から sqltypes.xsd スキーマを取得できます。 BizTalk プロジェクトに sqltypes.xsd スキーマを追加します。 このスキーマの詳細については、以下を参照してください。
ストアド プロシージャ用に生成されたスキーマで、
import schemaLocationの値を次のように変更します。import schemaLocation=”sqltypes.xsd”これは、既に sqltypes.xsd スキーマを BizTalk プロジェクトに追加しているためです。
スキーマのターゲット名前空間を指定します。 <Schema> ノードをクリックし、[プロパティ] ウィンドウの [ターゲット名前空間] プロパティで名前空間を指定します。 このトピックでは、名前空間を
http://ForXmlStoredProcs/namespaceとして指定します。
ストアド プロシージャを呼び出す要求メッセージのスキーマの生成
要求メッセージのスキーマを生成するには、Visual Studio の BizTalk プロジェクトからアダプター サービス アドインを使用できます。 このトピックでは、GET_EMP_DETAILS_FOR_XML ストアド プロシージャのスキーマを生成します。 Consume Adapter Service アドインを使用してスキーマを生成する方法の詳細については、「SQL アダプターを使用 した Visual Studio での SQL Server 操作のメタデータの取得」を参照してください。
Von Bedeutung
アダプター サービス アドインの プロシージャ ノードから手順のみを選択して、スキーマを生成する必要があります。
メッセージとメッセージの種類の定義
前に生成したスキーマでは、オーケストレーション内のメッセージに必要な "型" が記述されています。 通常、メッセージは変数であり、対応するスキーマによって定義される型です。 オーケストレーションのメッセージを作成し、前の手順で生成したスキーマにリンクする必要があります。
メッセージを作成し、スキーマにリンクするには
BizTalk プロジェクトにオーケストレーションを追加します。 ソリューション エクスプローラーで、BizTalk プロジェクト名を右クリックし、[ 追加] をポイントして、[ 新しい項目] をクリックします。 BizTalk オーケストレーションの名前を入力し、[ 追加] をクリックします。
まだ開いていない場合は、BizTalk プロジェクトの [オーケストレーション ビュー] ウィンドウを開きます。 これを行うには、[ 表示] をクリックし、[ その他のウィンドウ] をポイントし、[ オーケストレーション ビュー] をクリックします。
オーケストレーション ビューで、[ メッセージ] を右クリックし、[ 新しいメッセージ] をクリックします。
新しく作成したメッセージを右クリックし、[ プロパティ ウィンドウ] を選択します。
Message_1の [プロパティ] ウィンドウで、次の操作を行います。
これを使用する 目的 識別子 「 Request」と入力しますメッセージの種類 ドロップダウン リストから スキーマ を展開し、その後、ForXMLProcedure.Procedure_dbo.GET_EMP_DETAILS_FOR_XML を選択します。この場合、ForXMLProcedure は BizTalk プロジェクトの名前です。 Procedure_dboは、GET_EMP_DETAILS_FOR_XML プロシージャを呼び出すためのスキーマです。 手順 2. を繰り返して、新しいメッセージを作成します。 新しいメッセージの [プロパティ ] ウィンドウで、次の操作を行います。
これを使用する 目的 識別子 「 Response」と入力しますメッセージの種類 ドロップダウン リストから[ スキーマ]を展開し、[ ForXMLProcedure.ResponseSchema]\(ForXMLProcedure.ResponseSchema\)を選択します。ResponseSchema は、ストアド プロシージャの応答 メッセージのスキーマの生成に関する説明に従ってストアド プロシージャを実行して生成される応答スキーマの名前です。
オーケストレーションの設定
SQL Server でストアド プロシージャを実行するために BizTalk Server を使用するには、BizTalk オーケストレーションを作成する必要があります。 このオーケストレーションでは、定義された受信場所に要求メッセージをドロップします。 SQL アダプターはこのメッセージを使用して SQL Server に渡します。 SQL Server からの応答は別の場所に保存されます。 SQL Server にメッセージを送信し、応答を受信するには、送信図形と受信図形をそれぞれ含める必要があります。 プロシージャを呼び出すためのサンプル オーケストレーションは、次のようになります。
ストアド プロシージャ を
メッセージ図形の追加
メッセージ図形ごとに次のプロパティを指定してください。 [図形] 列に一覧表示される名前は、先ほど説明したオーケストレーションに表示されるメッセージ図形の名前です。
| 形 | 図形の種類 | 特性 |
|---|---|---|
| メッセージ受信 | 受け取る | - 名前を ReceiveMessage に設定する - アクティブ化を True に設定する |
| メッセージを送信 | 送信 | - 名前を SendMessage に設定する |
| 応答を受信する | 受け取る | - 名前を ReceiveResponse に設定する - アクティブ化を False に設定する |
| SendResponse | 送信 | - 名前を SendResponse に設定する |
ポートの追加
論理ポートごとに次のプロパティを指定してください。 [ポート] 列に表示される名前は、オーケストレーションに表示されるポートの名前です。
| 港 / ポート | 特性 |
|---|---|
| MessageIn | - 識別子を MessageIn に設定する - 型を MessageInType に設定する - 通信パターンを一方向に設定する - 通信方向を受信に設定する |
| LOBPort | - 識別子を LOBPort に設定する - 型を LOBPortType に設定する - 通信パターンを Request-Response に設定する - 通信方向を送受信に設定する |
| ResponseOut | - 識別子を ResponseOut に設定する - 型を ResponseOutType に設定する - 通信パターンを一方向に設定する - 通信方向を送信に設定する |
アクション図形のメッセージを指定し、ポートに接続する
次の表では、アクション図形のメッセージを指定し、メッセージをポートにリンクするために設定するプロパティとその値を指定します。 [図形] 列に表示される名前は、前述のオーケストレーションに表示されるメッセージ図形の名前です。
| 形 | 特性 |
|---|---|
| メッセージ受信 | - メッセージを要求に設定する - 操作を MessageIn.FOR_XML.Request に設定する |
| メッセージを送信 | - メッセージを要求に設定する - 操作を LOBPort.FOR_XML.Request に設定する |
| 応答を受信する | - メッセージを応答に設定する - 操作を LOBPort.FOR_XML.Response に設定する |
| SendResponse | - メッセージを応答に設定する - 操作を ResponseOut.FOR_XML.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 アダプターへの物理ポート バインドを手動で構成する」を参照してください。
また、送信ポートでアクションを指定する必要があります。 FOR XML 句を含むプロシージャの場合は、アクションを次の形式で設定する必要があります。
XmlProcedure/<schema_name>/<procedure_name>そのため、GET_EMP_DETAILS_FOR_XML プロシージャを実行するこのトピックでは、アクションは次のようになります。
XmlProcedure/dbo/GET_EMP_DETAILS_FOR_XMLアクションの設定の詳細については、 SQL アダプターの SOAP アクションの構成を 参照してください。
FOR XML 句を使用してストアド プロシージャを実行する場合は、次のバインド プロパティも設定する必要があります。
バインド プロパティ名 これを設定する XMLストアドプロシージャルートノード名 ストアド プロシージャの応答メッセージのスキーマの生成の説明に従って、ストアド プロシージャ用に生成した応答スキーマに追加 したルート ノードの名前を指定します。 このトピックでは、これを Root に設定します。 XmlStoredProcedureRootNodeNamespace ストアド プロシージャの応答メッセージのスキーマの生成の説明に従って、ストアド プロシージャ用に 生成した応答スキーマのターゲット名前空間を指定します。 このトピックでは、これを http://ForXmlStoredProcs/namespaceに設定します。バインディング・プロパティーの値の指定の詳細については、 SQL アダプターのバインディング・プロパティーの構成を参照してください。
注
また、Consume Adapter Service BizTalk Project アドインを使用してスキーマを生成すると、それらのポートに設定するポートとアクションに関する情報を含むバインディング ファイルも作成されます。 BizTalk Server 管理コンソールからこのバインド ファイルをインポートして、送信ポート (発信呼び出し用) または受信ポート (受信呼び出し用) を作成できます。 詳細については、「 SQL アダプターを使用するようにポート バインド ファイルを使用して物理ポート バインドを構成する」を参照してください。
アプリケーションの起動
SQL Server データベースでプロシージャを呼び出すには、BizTalk アプリケーションを起動する必要があります。 BizTalk アプリケーションを起動する手順については、「オーケストレーションを 開始する方法」を参照してください。
この段階で、次のことを確認します。
オーケストレーションの要求メッセージを受信する FILE 受信ポートが実行されています。
オーケストレーションからの応答メッセージを受信する FILE 送信ポートが実行中です。
SQL Server データベースにメッセージを送信する WCF-Custom または WCF-SQL 送信ポートが実行されています。
操作の BizTalk オーケストレーションが実行されています。
操作の実行
アプリケーションを実行した後、FILE 受信場所に要求メッセージをドロップする必要があります。 要求メッセージのスキーマは、Consume Adapter Service アドインを使用して生成したプロシージャの要求スキーマに準拠している必要があります。 たとえば、GET_EMP_DETAILS_FOR XML を呼び出す要求メッセージは次のとおりです。
<GET_EMP_DETAILS_FOR_XML xmlns="http://schemas.microsoft.com/Sql/2008/05/Procedures/dbo">
<emp_id>10765</emp_id>
</GET_EMP_DETAILS_FOR_XML>
SQL アダプターを使用して SQL Server データベースでプロシージャを呼び出すための要求メッセージ スキーマの詳細については、「 プロシージャと関数 のメッセージ スキーマ」を参照してください。
オーケストレーションはメッセージを処理し、SQL Server データベースに送信します。 SQL Server データベースからの応答は、オーケストレーションの一部として定義されている他の FILE の場所に保存されます。 たとえば、上記の要求メッセージに対する SQL Server データベースからの応答は次のとおりです。
<?xml version="1.0" encoding="utf-8"?>
<Root xmlns="http://ForXmlStoredProcs/namespace">
<Adapt_Doc.dbo.Employee Employee_ID="10765" Name="John" Designation="asdfaf" Salary="3434.00" Last_Modified="AAAAAAAANso=" Status="0" xmlns="" />
</Root>
ストアド プロシージャを実行して生成されたのと同じスキーマで応答が受信されていることに注意してください。 また、ルート ノードと名前空間は、 それぞれ XmlStoredProcedureRootNodeName と XmlStoredProcedureRootNodeNamespace バインド プロパティの値として指定した値と同じであることに注意してください。
ベスト プラクティス
BizTalk プロジェクトを展開して構成したら、構成設定をバインド ファイルと呼ばれる XML ファイルにエクスポートできます。 バインド ファイルを生成したら、ファイルから構成設定をインポートできるため、同じオーケストレーションの送信ポートや受信ポートなどの項目を作成する必要はありません。 バインディング・ファイルの詳細については、 アダプター・バインディングの再利用を参照してください。