Execute Stored Procedures to Xero WorkflowMax in BizTalk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live Xero WorkflowMax data through standard orchestrations.

Use the Xero WorkflowMax Adapters to synchronize with Xero WorkflowMax Clients, Jobs, Leads, Quotes, etc. Perfect for data synchronization, local back-ups, workflow automation, and more!



You can use stored procedures provided by the CData BizTalk Adapter for Xero WorkflowMax to automate working with Xero WorkflowMax data in BizTalk. Stored procedures implement actions available in the underlying API.

Stored procedures implement Xero WorkflowMax actions that cannot be represented as SELECT, INSERT, UPDATE, and DELETE statements. This article shows how to generate a schema for a stored procedure. You can use the schema to execute the stored procedure from a send port.

Add the Adapter to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. The adapter will return metadata about the inputs of the stored procedure and its results. This metadata is needed to create the schema.

  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 adapter from the list.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the Xero WorkflowMax Adapter.
  5. On the Connection String page, enter authentication credentials and other connection properties if they were not already configured in the send port or the receive location.

    Below is a typical connection string:

    APIKey=myApiKey;AccountKey=myAccountKey;

    To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

    After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

Generate the Schema

After you enter connection properties in the Add Adapter wizard, the Schema wizard is displayed.

  1. On the next page, Schema Information, select the Send Port that you have configured to use the Xero WorkflowMax Adapter.
  2. If you have configured the CData Xero WorkflowMax Adapter in a solicit-response send port, disable the One-Way option.
  3. In the Command Type menu, select Stored Procedure.
  4. Select the stored procedure from the menu and enter the values for the input parameters.
  5. 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.