How to Generate SQL Command Schemas for the CData BizTalk Adapter for Dynamics 365 Business Central

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

This guide shows how to use the CData BizTalk Adapter for Dynamics 365 Business Central to execute SQL commands to Dynamics 365 Business Central.

Add the Adapter for Dynamics 365 Business Central 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: OrganizationUrl=https://myaccount.financials.dynamics.com/;

   To authenticate to Dynamics 365 Business Central, you must provide the User and AccessKey properties.

   To obtain the User and AccessKey values, navigate to the Users page in Dynamics 365 Business Central and then click on Edit. The User Name and Web Service Access Key values are what you will enter as the User and AccessKey connection string properties. Note that the User Name is not your email address. It is a shortened user name.

   To connect to data, specify OrganizationUrl. If you have multiple companies in your organization, you must also specify the Company to indicate which company you would like to connect to. Company does not need to be specified if you have only one company.

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 accountid, Name FROM Accounts

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.