Ready to get started?

Learn more about the CData BizTalk Adapter for Confluence or download a free trial:

Download Now

Configure a One-Way Send Port for the CData BizTalk Adapter for Confluence

Use the adapter for Confluence with a one-way 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 one-way send port using the CData BizTalk Adapter for Confluence. You can use static one-way send ports to execute updategrams, SQL commands, and stored procedures. Send ports are useful for operations that modify Confluence data but do not have any response data. Typically, this would be DELETE or UPDATE SQL commands or updategrams, and occasionally stored procedure operations.

If you want to trigger actions that will return a response, such as executing SELECT commands or retrieving the Id of a record that you have created, use a solicit-response send port.

Create and Configure the One-Way Send Port

Create a static one-way send port and configure it to use the Confluence 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 One-Way Send Port. The send port properties dialog is displayed.
  3. In the Name menu, enter a name for the send port.
  4. In the Type menu, select CData.Confluence.
  5. In the Send Pipeline menu, select the default option, PassThruTransmit.

Configure the Adapter

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

  1. In the send port properties, click the Configure button. The CData.Confluence 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 Confluence

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

  1. In the send port properties dialog, click Configure. The adapter properties dialog is displayed.
  2. Click the button in the Connection String property.
  3. Click the box in the Connection String property. The Connection String Options dialog is displayed.
  4. Enter connection properties. Below is a typical connection string: User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

    Obtaining an API Token

    An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

    Connect Using a Confluence Cloud Account

    To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

    • User: The user which will be used to authenticate with the Confluence server.
    • APIToken: The API Token associated with the currently authenticated user.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

    Connect Using a Confluence Server Instance

    To connect to a Server instance, provide the following:

    • User: The user which will be used to authenticate with the Confluence instance.
    • Password: The password which will be used to authenticate with the Confluence server.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

  5. 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.

After you connect successfully and define the command the adapter will execute, the send port is ready for use. See the following section for an example of using a one-way send port in a simple application. The application reads updategram commands contained in a file and uses a send port to execute the command.

In the example, filters are used to move the messages that contain the updategram from the receive location to the send port. See the following section for more information on filters.

Create Filters to Route BizTalk Messages Through an Application

To associate a send port with the messages you want, create a filter rule in the Filters section of the properties for that send port. Messages matching the criteria will be routed to the send port. See the following example to filter on a receive location.

Example: Execute Updategrams with a One-Way Send Port

This section shows how to use a one-way send port in a simple application. The application reads updategram commands contained in a file and executes the commands:

  1. A one-way receive location picks up the XML document containing the updategram.
  2. The receive location creates a BizTalk message containing the results of the command.
  3. A one-way send port filters on the URI of the receive location. The document is routed to the one-way send port.
  4. The send port executes the updategram command.

As in the preceding example, the followings steps show how to set up a receive location to read updategrams from a file and use a send port to execute the commands:

  1. Create and configure a static one-way receive location. Use the File transport type. You can follow the same procedure to create and configure a receive location for the CData BizTalk Adapter for Confluence.
  2. Create a static one-way send port.
  3. In the send port properties, click Filters.
  4. In an empty property, set the following values:
    Property
    Select BTS.InboundTransportLocation from the menu.
    Value
    Enter the URI of the newly created one-way receive location.