Compatibility

• 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

With any BTS Connection, be sure to thoroughly validate your integration to make sure All Fields and Values are properly matched. Example: Applause may identify Severity level 1 as Low, whereas your company may use level 1 as Critical.

Prerequisites

You’ll need the following to complete the Jira Connector configuration:

• Jira REST API must be enabled
• Jira user credentials (username, password):
  
  • The user must be assigned access to the Jira project issues will be exported to
  • The user must be assigned with a role that includes the following permissions:
    
    • Work on <Project> issues:
      
      • Assign any issue
      • Edit any issue
      • Link any issue
      • Transition any issue
    • Create <project> issues
    • Collaborate on <project> issues:
      
      • Add attachments
      • Add comments
  • 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
• When using a Scoped Token, the following scopes should be enabled:
  • Recommended Scopes (Classic - Simplest)
    • read:jira-work - Read projects, issues, statuses, transitions, attachments
    • write:jira-work - Create issues, add comments, upload attachments, change status
    • read:jira-user - Search users for assignee field, fetch Cloud ID
  • If Using Granular Scopes (More Restrictive)
    • Issues - read:issue:jira, create:issue:jira, update:issue:jira
    • Attachments - write:attachment:jira
    • Comments - write:comment:jira
    • Users - read:user: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

Jira API Endpoints

If necessary, the following Jira API Endpoints need to be whitelisted:

• POST /rest/api/2/issue/{issueIdOrKey}/attachments
• POST /rest/api/2/issue
• PUT /rest/api/2/issue/{issueIdOrKey}
• GET /rest/api/2/issue/createmeta
• GET /rest/api/2/issue/createmeta/{projectIdOrKey}//issuetypes
• GET /rest/api/2/issue/createmeta/{projectIdOrKey}//issuetypes/{issueTypeId}
• GET /rest/api/2/user/assignable/multiProjectSearch
• GET /rest/api/2/project/{projectIdOrKey}/statuses
• POST /rest/api/2/issue/{issueIdOrKey}/comment
• GET /rest/api/2/issue/{issueIdOrKey}/transitions
• POST /rest/api/2/issue/{issueIdOrKey}/transitions
• GET /rest/api/2/issue/{issueIdOrKey}
• GET /api/2/status/{idOrName} (Server REST API)

 

Jira Connector

Once the connector name was entered and Jira was selected as the connector type, you’ll be required to provide the following information:

 

URL

Set your web-based access to Jira.

User

This is the username of the prerequisite Jira user.

• Field is case sensitive
• Jira username may be found in the user’s Profile page in Jira
• 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 you’re using an Atlassian API token for authentication, the user here is the user’s email address

Jira Hosting

Select the Jira Hosting option for the connector:

• If Jira Cloud:
  • The user will be able to choose whether the API Token was defined with Scopes or not (Enable Scoped API Token - disabled by default)
  • The checkbox “Authenticate with Personal Access Token” will be hidden
• If Jira Server / Data Center:
  • The checkbox “Authenticate with Personal Access Token” will be displayed

Password/API Token

This is the 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

This is the 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

This is 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.

 

Notes and Tips

Note the following hints and tips while setting up the integration with Jira and hints on BTS general.

General

• 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

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.