Connect to JIRA Cloud

qTest offers a seamless connection between qTest OnDemand and your JIRA Cloud instance. There are two ways to establish this connection: using an API token and using an OAUTH token.

This article will walk you through how to set up and configure this connection using both methods.

You must be a Project Administrator to set up this integration between JIRA Cloud and qTest Manager.

Prerequisite Information

Before configuring your connection, you must first install the free JIRA Test Management add-on from the Atlassian Marketplace.

Atlassian will deprecate the username/password method for integrated tools to connect with JIRA Cloud. As a result, qTest customers who use the username/password option must switch to the JIRA API Token or the OAuth method to connect to JIRA Cloud by December 1, 2018.

Configure JIRA Cloud with the API Token

Create a New JIRA Cloud Connection with the API Token Video

Watch in full screen for best picture quality.

Create a New JIRA Cloud Connection with the API Token

Follow these steps to configure a connection between JIRA Cloud and qTest using the API token.

  1. Navigate to the qTest project, and select the gear icon in the toolbar.

  2. Select Integration Settings. The "Configure Integrations" page displays.

  3. Select JIRA in the External Systems panel. The "Configure Integration: JIRA" page displays

  4. Select Add JIRA Connection. The Add JIRA Connection page is displayed.

  5. Enter information in the fields as described below:

    • Connection Name: Enter a name that represents your JIRA instance.

    • Server URL: Enter the URL of your JIRA instance.

    • Web URL: This field is only needed when setting up the connection between qTest Manager and JIRA Server.

    • Username: Enter a JIRA Global Admin username in this field. A global administrator in JIRA is the same as a site administrator. For information on setting up JIRA administrator permissions, please see the JIRA article Manage JIRA Global Permissions.

    • Password or Token: A connection can be established using a JIRA Token or the JIRA username/password of a JIRA Global Admin. However, Atlassian is deprecating the username/password authentication option on December 1, 2018. More details, check out this Atlassian Announcement: Deprecation Notice.

  6. After entering the JIRA connection details, select Test JIRA Connection.

    If the connection between qTest Manager and JIRA is successful, the following message is displayed: "Connected to the server successfully."
  7. Select Save and Configure.
If you receive an error message after clicking the Save and Configure button, see the Common Roadblocks article.

The "Configure Connection" page displays. From this screen, you can both configure Defect integration with JIRA and import requirements from JIRA.

Edit an Existing JIRA Cloud Connection to use the API Token

If you are editing an existing integration, connection follow these instructions:

  1. Navigate to the qTest project, and select the gear icon in the toolbar.

  2. Select Integration Settings. The "Configure Integrations" page displays.

  3. Select JIRA in the External Systems panel. The "Configure Integration: JIRA" page displays

  4. In the Connection Name column, select the blue hyperlink of your JIRA Integration name.

  5. The Add JIRA Connection dialog opens, and select the blue hyperlink for 'Instructions to create an API token' which redirects you to the Atlassian instructions.

  6. Once you retrieve the API Token, enter it in the Password or Token field.

  7. Select the Test JIRA Connection icon.

  8. When the connection is tested, you can select Save and Configure.

If you receive an error message after clicking the Save and Configure button, see the Common Roadblocks article.

The "Configure Connection" page displays. From this screen, you can both configure Defect integration with JIRA and import Requirements from JIRA.

Configure JIRA Cloud with OAuth Token

Configure JIRA Cloud Integration with OAuth Token Video

Watch in full screen for best picture quality.

Configure JIRA Cloud to Use OAuth

The following procedure is an alternative way to allow qTest Manager and the JIRA cloud application to connect.

qTest provides a default private key, but as of Manager 9.1 you have the option to upload your own private key. You will upload your private key in the Security tab of Site Administration before connecting with JIRA OAuth described below.

  1. From your JIRA instance, select JIRA settings in the left navigation pane.

  2. The navigation pane updates, and select Applications.

  3. The navigation pane updates again, and select Applications links in the Integrations section of the navigation pane.

  4. The Configure Application Links page loads.

  5. To create a new application link, enter your qTest Manager instance’s URL in the text field and select the Create new link icon.

  6. The Configure Application URL pop-up loads, and you will select Continue. If you receive an error message, as seen in the screenshot below, select Continue a second time and you will be directed to the next screen.

  7. After the link is created, the Link applications pop-up opens.

  8. Enter a name in the Application Name field.

  9. The Application Type will default to Generic Application. Do not change this.

  10. Select Continue (as no other fields are required for connection on this pop-up).

  11. A 'Processing' message will appear, and once completed you will be sent back to the Configure Application links screen and receive an "Application Link your application name here> created successfully" message.

  12. Locate the application you just created, and in the Action column, select the pencil icon to edit.

  13. The Configure application pop-up opens and select the Incoming Authentication tab.

  14. In the Incoming Authentication tab, and enter the following values in the required fields:

  • Consumer Key: qTest

  • Consumer Name: hardcoded-consumer

  • Public Key:

    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQAB
You will need to scroll to Save, and then Close the pop-up.

Optional: If you want to use your own private key, you will need to update your JIRA configuration to account for the new private key you uploaded in the Security tab of Site Administration in qTest.

Existing OAuth users will need to complete the following if moving to the private key option:

  1. Delete the current Incoming Authentication configuration in JIRA.

  2. Re-enter the Consumer Key, Consumer Name, and Public Key referenced above.

  3. Save.

Create a New JIRA Cloud Connection-OAuth Token

If you are creating a NEW integration connection follow these instructions. If you are editing an existing JIRA integration connection, skip this section and read the "Edit an Existing JIRA Cloud Connection to Use OAuth Token" section.

To create a new connection, follow these steps:

  1. Navigate to the qTest project, and select the gear icon in the toolbar.

  2. Select Integration Settings. The "Configure Integrations" page displays.

  3. Select JIRA in the External Systems panel. The "Configure Integration: JIRA" page displays.

  4. Select Add Connection. The Add JIRA Connection page displays.

  5. Enter the Connection Name and Server URL of your JIRA instance.

    Server URL is the base URL of your JIRA instance and is found in your JIRA System Settings.

  6. Select the Use JIRA OAuth hyperlink and qTest will create an authorization URL.

  7. Select the Authorize URL hyperlink and select "Allow" in the Welcome to JIRA pop-up.

  8. An 'Access Approved' message will display and you will need to obtain the verification code from the text on the webpage.

  9. Enter the Verification Code and select Submit.

    If you are an existing OAuth user and want to use the private key option, you will need to reconfigure your Manager application and authorize the URL again with a new verification code.

  10. Once you Submit the Connection Information, select the Test JIRA Connection button.

  11. Once the connection is tested, you can select Save and Configure.

If you receive an error message after clicking the Save and Configure button, see the Common Roadblocks article.

The "Configure Connection" page displays. From this screen, you can both configure Defect integration with JIRA and import Requirements from JIRA.

Edit an Existing JIRA Cloud Connection to Use OAuth Token

If you are editing an existing integration connection, follow these instructions:

  1. Navigate to the qTest project, and select the gear icon in the toolbar.

  2. Select Integration Settings. The "Configure Integrations" page displays.

  3. Select JIRA in the External Systems panel. The "Configure Integration: JIRA" page displays

  4. In the Connection Name column, select the blue hyperlink of your JIRA Integration name.

  5. The Add JIRA Connection dialog opens, and you will select the Use JIRA OAuth icon.

  6. Once you select the Use JIRA OAuth hyperlink, qTest will create an authorization URL.

  7. Select the Authorize URL hyperlink and choose "Allow" in the Welcome to JIRA pop-up.

  8. An 'Access Approved' message will display, and you will need to obtain the verification code from the text on the webpage.

  9. Enter the Verification Code and select Submit.

    If you are an existing OAuth user and want to use the private key option, you will need to reconfigure your Manager application and authorize the URL again with a new verification code.

  10. Once you Submit the Connection Information, select the Test JIRA Connection button.

  11. Once the connection is tested, you can select Save and Configure.

The "Configure Connection" page displays. From this screen, you can both configure Defect integration with JIRA and import Requirements from JIRA.

Common Roadblocks

If the connection between qTest Manager and JIRA fails, here are some common errors and solutions.

Error Solution
qTest Manager JIRA connection dialog box displays Index:0, Size: 0 error message. Ensure the JIRA account to be used to integrate with qTest Manager has JIRA System Administrator Global Permissions assigned to it. The account used for the integration must have permissions to create objects in JIRA that will be mapped to defects (e.g., issues, tasks, etc.).
qTest Manager JIRA connection dialog box displays Connection failed. Received fatal alert: bad_record_mac message. This error message is displayed when this instance of JIRA uses SSL encryption. Please contact our support team at support@qasymphony.com. We will explore options with you to set up the integration while maintaining the security and integrity of the data in your JIRA instance.
On-Premise JIRA system crashes when setting up qTest for JIRA add-on This error occurs when the JIRA On-Premise version is hosted by a 3rd party provider or hosting service, which will enact stricter timeout limits on record retrievals. We have packaged a separate connector that will resolve issues with this integration. Please contact us at support@qasymphony.com, and we will be happy to help you resolve this issue.
On-Premise JIRA to On-Premise qTest connection is successful, but cannot retrieve requirements into qTest Reinstall qTest On-Premise.
Issue Connecting from JIRA Server to OnDemand qTest This error is usually due to incorrect firewall settings. Please reference the Amazon Server Elastic IP Addresses Master List so you can open the firewall to allow qTest Manager to communicate with your OnPremise JIRA instance.
qTest Manager to JIRA integration fails due to "Invalid Credentials" This error occurs when a customer uses a JIRA account that is validated by single sign-on (Crowd). We recommend that you create a new Admin account directly in JIRA, and use that for the qTest integration.