Execute Stored Procedures to Jira Service Desk in BizTalk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live Jira Service Desk data through standard orchestrations.

Use the Jira Service Desk Adapters to synchronize with Jira Service Desk Customers, Organizations, Requests, etc. Perfect for data synchronization, local back-ups, workflow automation, and more!



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

Stored procedures implement Jira Service Desk 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 Jira Service Desk 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;User=MyUser;InitiateOAuth=GETANDREFRESH

    You can establish a connection to any Jira Service Desk Cloud account or Server instance.

    Connecting with a Cloud Account

    To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

    Supply the following to connect to data:

    • User: Set this to the username of the authenticating user.
    • APIToken: Set this to the API token found previously.

    Connecting with a Service Account

    To authenticate with a service account, you will need to supply the following connection properties:

    • User: Set this to the username of the authenticating user.
    • Password: Set this to the password of the authenticating user.
    • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

    Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

    Accessing Custom Fields

    By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

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 Jira Service Desk Adapter.
  2. If you have configured the CData Jira Service Desk 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.