Connecting qTest Manager and JIRA allows testers access to JIRA information, such as requirements and defects, in real-time. This integration provides developers access to information about defects, including the steps leading to the error so that developers can reproduce the defect. If you are using JIRA Cloud, please refer to the Connect to JIRA Cloud Integration guide.
Connect to JIRA Server
Connecting qTest Manager and JIRA Server gives testers access to JIRA information in real-time for requirements and defects and provides developers access to information about defects, including the steps leading to the error so that developers can reproduce the defect.
To use the integration, connect qTest Manager and JIRA Server at the project level. You must be a Project Administrator to use this functionality.
Prerequisites for qTest Cloud + JIRA Server
The following is required to establish a connection between qTest Cloud and JIRA Server. If you are using qTest OnPremise and JIRA Server, you will skip this section. You may need to incorporate your IT infrastructure team to help with the connection.
IP Address and Firewall Configuration
- Verify your JIRA server's IP address is configured to be a public IP address, so your JIRA instance is accessible publicly.
Note: If your company wants to have 1 JIRA URL for public communication with qTest and another URL for local access only you will need to set up a reverse proxy. Follow these instructions from Atlassian.
- Please ask your IT department to configure your Jira server and firewall's settings to accept accesses/requests to/from the following specific Amazon servers elastic IPs. This must be a bi-directional set up accepting inbound and outbound requests between the qTest Amazon Elastic IPs and your JIRA Server.
The reason for doing this is that we have APIs to send to Jira to receive information and use other Jira APIs to be notified of changes in Jira for auto-sync of objects to qTest. Only when you allow the communication between 2 servers, the integration between qTest and Jira is successful.
Please reference the Amazon Elastic IP Addresses Master List.
To establish the connection between JIRA Server and qTest Manager OnDemand:
- Review the qTest OnPremise Product and Integrating App Compatability matrix to determine the appropriate version of the add-on to use.
- If you plan to use the add-on version of 6.11.14 or 8.0.4 review the release notes first.
- Install the free qTest for JIRA Test Management add-on from the Atlassian Marketplace.
Important: If your JIRA Server protocol is HTTP (80. 8080) or https (443), make sure you open the correct ports.
Configure JIRA Server Integration without using OAuth Token
- From the qTest project, position the arrow cursor over the gear icon located in the top right area of the screen and select the Integration Settings option.
- The Integration Settings page loads. In the External Systems section, select JIRA.
- The Configure Integration information for Jira is displayed, as shown below.
- Select the Add JIRA Connection button, and the Add JIRA Connection dialog opens.
- Connection Name: Enter a name that represents your JIRA instance.
- Server URL: Enter the URL of your JIRA server, which will likely contain the IP address and port information.
IMPORTANT: The Server URL must match your JIRA Base URL. This is the official address for traffic and APIs communication between qTest and JIRA.
- Go to JIRA >> Administration >> System to verify your JIRA Base URL. You must whitelist your JIRA Base URL.
- Web URL: Enter the JIRA URL your company uses. For a reverse proxy, enter the JIRA URL for local access here.
- Username: Must input a JIRA username in this dialog.
- Password: Password for the JIRA Username entered above.
- After entering the JIRA connection details, select the Test JIRA Connection button. If the connection between qTest Manager and JIRA is successful, the following message is displayed.
'Connected to server successfully.'
- When you select the Test JIRA Connection button, qTest backend services running on the provided IPs will try to send a REST API call to your JIRA instance at the provided endpoint. Therefore, make sure that you have changed your system and network firewall to accept inbound connections coming from those IPs, which is entirely different from allowing traffic to flow to these IPs from your JIRA server (outbound).
- When it comes to outbound traffic from your JIRA server, our webhook services do not have a static public IP address and it's strongly advisable for you to allow outbound traffic to your qTest domain instead, which should be https://<domain>.qtestnet.com
- Select the Save and Configure button.
- The Configure Connection information displays. From this screen, you will configure the defect integration with JIRA and then import requirements from JIRA.
NOTE: If you receive an error message after clicking the Save and Configure button, see the ‘Common Roadblocks’ section, below.
See the article Configure Defect Integration with JIRA.
Configure JIRA Server using OAuth Token
The following procedure is an alternative way to allow qTest Manager and JIRA server applications 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.
- From your Jira instance, navigate to the Jira Administrator drop down.
- Select Applications and the Jira Administration page loads.
- Select Application links in the Integrations section of the left panel.
- Enter the URL of the application you want to link with. In the case, your qTest instance URL, and select Create New Link.
- In the next dialog, select Continue.
- The "Link Applications" dialog displays. Enter information for only the Application Name.
The Application Type should automatically be set to Generic Application. Keep this, and select continue.
- You will be sent back to the "Configure Application Links" dialog with a list of items. Select Edit to configure.
- The Configure Application Links page loads.
- To create a new application link, enter your qTest Manager instance’s URL in the text field and select the Create new link button.
- After the link is created, configure the connection as follows. Select the Incoming Authentication tab from the Configure dialog and enter the following:
Consumer Key: qTest
Consumer Name: hardcoded-consumer
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQABImportant: If you are an existing customer and 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.
- Delete the current Incoming Authentication configuration in Jira.
- Re-enter the Consumer Key, Consumer Name, and Public Key referenced above.
- Navigate to qTest Manager, and select Add Connection. The Add JIRAConnection page is displayed.
Important: If you are using the private key option, you will need to reconfigure your Manager application and authorize the URL again with a new verification code.
- 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.)
- Select the Use JIRA OAuth hyperlink and qTest will create an authorization URL.
- Select the Authorize URL hyperlink and select "Allow" in the Welcome to JIRA pop-up.
- An 'Access Approved' message will display and you will need to obtain the verification code from the text on the webpage.
- Enter the Verification Code and select Submit.
- Submit the Connection Information,and select the Test Jira Connection button.
- The connection is tested, you can select Save and Configure.
NOTE: If you receive an error message after clicking the Save and Configure button, see the Common Roadblocks section near the end of this article.
- The "Configure Connection" page displays. From this screen, you can both configure defect integration with JIRA and import requirements from JIRA.
See the following articles:
If the connection between qTest Manager and JIRA fails, here are some common errors and solutions.
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 firstname.lastname@example.org. 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 email@example.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 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.