Ready to get started?

Learn more about the CData BizTalk Adapter for Dynamics 365 Business Central or download a free trial:

Download Now

Use Updategrams with Dynamics 365 Business Central Data

You can use updategrams to insert, update, and delete Dynamics 365 Business Central data. This guide shows how to use the CData BizTalk Adapter for Dynamics 365 Business Central to generate updategram schemas and instances.

In this article, you will create updategrams that can be executed by the CData BizTalk Adapter for Dynamics 365 Business Central. You will design a schema and use it as a template for generating insert, update, and delete updategrams.

Add the Adapter for Dynamics 365 Business Central to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. You will use the adapter to query Dynamics 365 Business Central for metadata about the table you want to modify.

  1. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  2. Select Add Adapter Metadata in the resulting dialog box.
  3. In the resulting Add Adapter Wizard, select the CData BizTalk Adapter for Dynamics 365 Business Central from the list view.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the adapter.
  5. When you click Next, the Schema Wizard is displayed.

Generate a Schema for an Updategram

Follow the steps below to create a schema in a BizTalk Server project in Visual Studio.

  1. If you have not already done so, add the Dynamics 365 Business Central adapter to your project.
  2. On the Connection String page of the Add Adapter wizard, enter authentication credentials and other connection properties, if they were not already configured in the send port or receive location. 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.

    See the "BizTalk Configuration" chapter in the help documentation for more information on the required connection properties.

  3. On the Schema Information page, click Send Port in the General Options section. Select Updategram from the CommandType menu. If you are using the adapter in a solicit-response send port, disable the One-Way option.
  4. On the next page, Statement Information, select the type of the updategram: Insert, Update, or Delete. Select the Table name and the columns you want to include in the schema. If you want to update or delete, the Id column is required.

    Note: When you create the updategram, you are limited to modifying the columns you include in the schema.

  5. Click Next to view a summary of the schema and finish the wizard to create the schema. The resulting .xsd file is added to your project.

Generate Insert, Update, and Delete Instance Messages

After you create the updategram schema, you can use the .xsd file to generate the updategram: Right-click the .xsd file and select Generate Instance. You can also use this file as a template to manually create updategrams. Below are example generated updategram instances for inserts, updates, and deletes:

Insert

An example of INSERT is below. In this instance, there is only an after block, which specifies how the data will change.

<ns0:parameters xmlns:ns0="http://www.cdata.com/D365BusinessCentralProvider"> <ns0:sync> <ns0:before></ns0:before> <ns0:after> <ns0:Accounts accountid="accountid_0" Name="Name_1" /> </ns0:after> </ns0:sync> </ns0:parameters>

Update

An example of UPDATE is below. In this instance, there is both a before block (how the data currently exists in the table) and an after block (how the data will change).

<ns0:parameters xmlns:ns0="http://www.cdata.com/D365BusinessCentralProvider"> <ns0:sync> <ns0:before> <ns0:Accounts Id=001d000000YBRseAAH></ns0:Accounts> </ns0:before> <ns0:after> <ns0:Accounts accountid="accountid_0" Name="Name_1" ></ns0:Accounts> </ns0:after> </ns0:sync> </ns0:parameters>

Delete

An example for DELETE is below. The after block will be empty to show that it is removing the item.

<ns0:parameters xmlns:ns0="http://www.cdata.com/D365BusinessCentralProvider"> <ns0:sync> <ns0:before> <ns0:Accounts Id=001d000000YBRseAAH></ns0:Accounts> </ns0:before> <ns0:after></ns0:after> </ns0:sync> </ns0:parameters>

Processing Schemas

To use updategrams to insert, update, or delete Dynamics 365 Business Central records, see the tutorial.