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

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

You can use the CData BizTalk Adapters to execute standard SQL commands to on-premises and cloud-based data sources. This guide shows how to execute SELECT, INSERT, UPDATE, and DELETE commands. Salesforce is used as an example, but the same process can be followed for any CData adapter.

Add the Adapter 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 CData BizTalk Adapter for Salesforce 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 for Salesforce 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. The metadata is needed to create the schema.

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. Required connection properties are User, Password, and Access Token.
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 the adapter in a receive location or send port, the SQL command you configured is entered in the box.) This example uses the query below:

   SELECT * FROM Account

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 Tutorial: Create and Process Updategrams with the BizTalk Adapter for Salesforce.