How to Generate SQL Command Schemas for the CData BizTalk Adapter for SQL Server

The CData BizTalk Adapter makes it easy to process SQL Server data in BizTalk by returning the data as XML. You can use this data in a BizTalk orchestration by creating an XML schema file for the table you want to access in BizTalk.

This article will show how to generate a schema to process SQL Server data retrieved using the CData BizTalk Adapter. You will generate a schema for a SELECT command.

You can use the CData BizTalk Adapter for SQL Server to execute standard SQL commands to SQL Server. You can follow this guide to execute SELECT, INSERT, UPDATE, and DELETE commands.

Add the Adapter for SQL Server to Your Project

Follow the steps below to add the adapter to a BizTalk Server project.

  1. If you have not already done so, create a new BizTalk Server project in Visual Studio.
  2. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  3. Select Add Adapter Metadata in the resulting dialog box.
  4. In the resulting Add Adapter wizard, select the adapter from the list.
  5. In the Port menu, leave the selection blank. You can also select a receive location or send port that has the adapter configured as its transport type.

Generate a Schema for an SQL Command

After you select the adapter in the Add Adapter wizard, the Schema wizard is displayed. Follow the steps below to configure connection properties and retrieve the metadata for the results of the command.

  1. In the Connection String page, enter authentication credentials and other connection properties, if you did not select an adapter that you have already configured in your BizTalk application. Below is a typical connection string:

    User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;

    Connecting to Microsoft SQL Server

    Connect to Microsoft SQL Server using the following properties:

    • Server: The name of the server running SQL Server.
    • User: The username provided for authentication with SQL Server.
    • Password: The password associated with the authenticating user.
    • Database: The name of the SQL Server database.

    Connecting to Azure SQL Server and Azure Data Warehouse

    You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

    • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
    • User: The name of the user authenticating to Azure.
    • Password: The password associated with the authenticating user.
    • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

  2. In the General Options section on the next page, Schema Information, select Send Port or Receive Location, depending on the adapter configuration.
  3. If you want to generate the schema for the entire result set, select the Single Message option in the Message Mode menu. If you want to generate one schema for each row in the result set, select the Message Per Row option and confirm that the root element of the message is 'row'.
  4. In the Command Type menu, select SQL Command.
  5. In the SQL Command Text box on the Statement Information page, enter an SQL command. (If you have configured a receive location or send port, the SQL command you configured is entered in the box.) This example uses the query below:

    SELECT * FROM Orders

  6. Confirm the settings in the summary displayed by the wizard and click Finish to generate the schema.xsd file.

Processing Schemas

To use schemas in a simple BizTalk application, see the tutorial.

 
 
ダウンロード