Learn more
 

Ready to get started?

Learn more:

Dynamics AX Connectivity Solutions

In this article

Related articles

How to Generate SQL Command Schemas for the CData BizTalk Adapter for Dynamics AX


The CData BizTalk Adapter makes it easy to process Dynamics AX 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 Dynamics AX 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 AX to execute SQL commands to Dynamics AX.

Add the Adapter for Dynamics AX 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;Domain=MyDomain;objectserver=MicrosoftDynamicsAX@WIN-1IP52JPQVJS:2712;

    To connect to DynamicsAX, specify User, Domain, and ObjectServer. You can also surface tables for a specific Company; when this property is blank, the default company is used.

    Alternatively, you can use the .NET Business Connector to connect on behalf of DynamicsAX users. You can obtain the ProxyUser and ProxyDomain properties on the System service accounts form: Click System Administration -> Setup -> System -> System Service Accounts. Additionally, set ProxyPassword.

    By default, only transaction data and base information from the TRANSACTION and MAIN table groups is returned. You can specify which groups to return with TableGroups.

    Set Language to use the same language you use in your DynamicsAX labels.

  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 Name, Qty FROM CustInvoiceTrans

  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.