Configure a Solicit-Response Send Port for the CData BizTalk Adapter for Excel Online

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!



Use the adapter for Excel Online with a solicit-response send port to execute updategrams and data manipulation SQL in BizTalk.

This section provides step-by-step instructions for creating, configuring, and testing a static solicit-response send port using the CData BizTalk Adapter for Excel Online. You can use a static solicit-response send port to execute commands and access the results in BizTalk. You can use send ports to execute updategram commands, SQL commands, and stored procedure operations.

Create and Configure the Send Port

Create a static solicit-response send port and configure it to use the adapter as its transport type.

  1. If you have not already done so, open your BizTalk application in the BizTalk Administration Console.
  2. In the node for your BizTalk application, right-click Send Ports and select New -> Static Solicit-Response Send Port. The Send Port Properties dialog is displayed.
  3. In the Send Port properties, enter a name for the receive port.
  4. In the Transport Type menu, select CData.ExcelOnline;.
  5. In the Send pipeline menu, select the default option, PassThruTransmit.
  6. In the Receive pipeline menu, select the default option, PassThruReceive.

Configure the Adapter

Define the command the adapter will execute in the Transport Properties dialog.

  1. In the send port properties, click the Configure button. The Adapter Transport Properties dialog is displayed.
  2. In the CommandType property, select the command type you want.
  3. If you want to execute an SQL command, enter the command in the SQL Command box.
Refer to the "Adapter Configuration" chapter in the help documentation for a description of the various properties and their functions.

Configure the Connection to Excel Online

Configure credentials and other properties required to connect to Excel Online in the Connection String Options dialog.

  1. In the send port properties, click Configure. The adapter properties dialog is displayed.
  2. Click the button in the Connection String property. The Connection String Options dialog is displayed.
  3. Enter the connection properties.

    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.

  4. Click Test Connection to verify the values and test connectivity.
Refer to the "Connection String Options" chapter in the help documentation for a description of the various properties and their functions. The updategram tutorial for the adapter for Excel Online walks through the steps to create a simple application that uses a solicit-response send port to execute an insert updategram to Excel Online.