This article provides information about specific setups required when configuring the BTS Connector with Jira.
Learn more about working with the BTS Connectors as part of setting up the integration between the Applause platform and your Bug Tracking System (BTS) here. Learn more about integrating with your BTS here.
- Applause Platform’s Jira Connector is compatible with Jira Software version 5.0 or above.
- Both Cloud and Server versions are supported.
- Other Jira products from Atlassian implementing the JIRA REST API version 5.0 or above, such as Jira Align and Jira Core, are supported as well.
You’ll need the following in order to complete the Jira Connector configuration:
- Jira REST API must be enabled.
- Jira user credentials (username, password):
- User must be assigned visibility to the Jira project issues will be exported to.
- User must have Create and Save permissions.
- For easier tracking, use a dedicated user within your user system, named “Applause” or similar. This will help your teams to quickly locate issues exported from the Applause Platform as opposed to those created directly in Jira.
Note that only basic authentication is supported at this time.
- Jira Project: The Connector is able to connect with a single project.
- For Jira Server: Make sure that the Applause Platform can communicate with your Jira instance. Learn more about required configuration in case your Jira instance is behind a firewall here.
Once the BTS Integration was enabled for the product, and Jira was selected as the connector to be set up, You’ll be required to provide the following information:
- URL: Set your web-based access to Jira.
- User: Username of the prerequisite Jira user.
- Field is case sensitive.
- Jira username may be found in the user’s Profile page in Jira
- Note: Newer Jira implementations may be using Atlassian accounts (instead of Jira ones). The username for that is typically the first part of the email address before the “@” symbol. Jira usernames are seldom an email address.
- Important: If using an Atlassian API token for authentication, user here the user’s email address.
- Password/API Token: Password or API Token of the prerequisite Jira user.
- Field is case sensitive.
- Customers using Jira Cloud will need to provide an API Token in this field. Other Jira users will use a password.
- Project Key: Key of the prerequisite Jira project.
- Field is case sensitive
- Project must be set on your Jira instance prior to setting the Connector.
- Issue Type: The default issue type for bugs sent from the Applause platform. Note that the integration currently does not support creating / updating Sub-Task issue types
Hints & Tips
- The integration is already pre-configured to trust all SSL certificates from customer servers, even self-signed, so it’s possible to establish connection to any Jira instance with url starting with “https://”.
- In addition, there is an option to upload a client certificate generated as a collaboration between Applause and the customer. This X.509 SSL certificate requires Applause to first create a private key and a CSR (Certificate Signing Request) fulfilled by the customer. Please work with your Applause representative to complete the certificate prior to uploading it.
- Labels: When using the Labels field on field mapping please note:
- Values are space-separated. You may send multiple labels on each exported issue.
- Values may include an Applause issue field to be dynamically populated, as well as plain text for fixed values.
- Attachments: starting 2019, Jira’s new issue view encodes URLs with special characters, which affects many Applause issue attachment URL links and causes an error upon clicking the link from within your Jira’s new view of an exported bug. Optional workarounds:
- Revert your Jira back to the old issue view
- Copy/paste the attachment URL to a new browser tab instead of directly clicking on the link
- SNI (Server Name Indication): If your Jira Server utilizes SNI make sure to enable this option. You may need to re-establish the connection to the server.
- Two-Way Jira Integration: Learn more about how to set up the Two-Way Integration here.