Execute Stored Procedures to Excel Online in BizTalk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Excel Online BizTalk Adapter

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

Use the Excel Online Adapters to synchronize with Excel Online Spreadsheet data. Perfect for data synchronization, local back-ups, workflow automation, and more!



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

Stored procedures implement Excel Online 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 Excel Online 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.

    You can connect to a workbook by providing authentication to Excel Online and then setting the following properties:

    • Workbook: Set this to the name or Id of the workbook.

      If you want to view a list of information about the available workbooks, execute a query to the Workbooks view after you authenticate.

    • UseSandbox: Set this to true if you are connecting to a workbook in a sandbox account. Otherwise, leave this blank to connect to a production account.

    You use the OAuth authentication standard to authenticate to Excel Online. See the Getting Started section in the help documentation for a guide. Getting Started also guides you through executing SQL to worksheets and ranges.

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 Excel Online Adapter.
  2. If you have configured the CData Excel Online 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.