Menu

Connect to JIRA Integration

Overview

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.  

Connect to JIRA Cloud 

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

Follow these steps to set up a connection with JIRA Cloud:

Install the free qTest for JIRA Test Management add-on from the Atlassian Marketplace.

IMPORTANT: 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 API Token

Create a New JIRA Connection

  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

    Select_JIRA_in_the_External_Systems_panel.png

  4. Select Add JIRA Connection.  The Add JIRA Connection page is displayed.  
  5. Enter information in the fields as described below:
    configure_jira_cloud_v9.3.png
    • 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. 

      IMPORTANT:
      Customers who are already connected to Jira Cloud MUST edit their existing connection to switch from their basic password to use either the OAuth or the API Token. To avoid duplicating data, we recommend that users not create brand new connections. Read the instructions below to edit your existing connection. 

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

 

Edit an Existing JIRA 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

    Select_JIRA_in_the_External_Systems_panel.png
  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.
    configure_jira_cloud_v9.3.png
  6. Once you retrieve the API Token, enter it in the Password or Token field. 
  7. Select the Test JIRA Connection button.
  8. When 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.
  9. 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

The following procedure is an alternative way to allow qTest Manager and the JIRA cloud application to connect. These instructions are for a new JIRA Integration connection only. 

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 button.  
    jira_integrations_cloud.png

  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 2nd time and you will be directed to the next screen.
    configure_app_link_jira_cloud_2.png
  7. After the link is created, the Lin 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 inks 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.
    configure_jira_cloud.png
  14. In the Incoming Authentication tab, and enter the following values in the required fields:
    C
    onsumer Key: qTest
    Consumer Name: hardcoded-consumer
    P
    ublic Key:
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6
    OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQAB
    HINT: You will need to scroll to Save, and then Close the pop-up.

    jira_cloud_incoming_auth.png
  15. 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:
    • Delete the current Incoming Authentication configuration in Jira.
    • Re-enter the Consumer Key, Consumer Name, and Public Key referenced above.
    • Save.
      configure_qtest_and_jira_private_key.png

Create a New Integration Connection

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 

  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

    Select_JIRA_in_the_External_Systems_panel.png
  4. Select Add Connection.  The Add JIRAConnection page is displayed.
  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.
    Important: 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.
    jira_oauth_authorize_url_cloud_connection.png
  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.
    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.

Edit an Existing JIRA Integration Connection

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

    Select_JIRA_in_the_External_Systems_panel.png
  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 button.
    use_jira_oauth_button.png
  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.
    Important: 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.
    jira_oauth_authorize_url_cloud_connection.png
  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.
    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.
  12. The "Configure Connection" page displays.  From this screen, you can both configure defect integration with JIRA and import requirements from JIRA.


NEXT STEPS:

See the following articles:

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

  1. 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.


  2. 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.
Virginia
  • 54.225.178.215
  • 54.221.246.6
  • 54.221.246.5
  • 54.227.244.234
  • 54.83.57.143
  • 54.83.57.153
Oregon
  • 34.217.197.132
  • 35.162.90.17
Ireland
  • 52.213.200.88
  • 52.214.114.20

Important: If your JIRA Server protocol is HTTP (80. 8080) or https (443), make sure you open the correct ports.  

If you encounter an issue, please see the articles FAQs for JIRA troubleshooting and Permissions Issues needed for JIRA troubleshooting 

To establish the connection between JIRA Server and qTest Manager OnDemand, do the following:

Install the free qTest for JIRA Test Management add-on from the Atlassian Marketplace.                 

Configure JIRA Server Integration without using OAuth Token

  1. 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.



  2. The Integration Settings page loads. In the External Systems section, select JIRA.
     
  3. The Configure Integration information for Jira is displayed, as shown below.



  4. 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.
       
  5. 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.'

    Note: 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).

    Note: 
    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

  6. Select the Save and Configure button.
  7. 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.


NEXT STEP
:

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.

  1. From your Jira instance, navigate to the Jira Administrator drop down.
  2. Select Applications and the Jira Administration page loads.
  3. Select Application links in the Integrations section of the left panel.
  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 button.   
     

  6. After the link is created, configure the connection as follows.  Select the Incoming Authentication tab from the Configure dialog and enter the following:

    C
    onsumer Key: qTest
    Consumer Name: hardcoded-consumer
    P
    ublic Key:
    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxZDzGUGk6rElyPm0iOua0lWg84nOlhQN1gmTFTIu5WFyQFHZF6OA4HX7xATttQZ6N21yKMakuNdRvEudyN/coUqe89r3Ae+rkEIn4tCxGpJWX205xVF3Cgsn8ICj6dLUFQPiWXouoZ7HG0sPKhCLXXOvUXmekivtyx4bxVFD9Zy4SQ7IHTx0V0pZYGc6r1gF0LqRmGVQDaQSbivigH4mlVwoAO9Tfccf+V00hYuSvntU+B1ZygMw2rAFLezJmnftTxPuehqWu9xS5NVsPsWgBL7LOi3oY8lhzOYjbMKDWM6zUtpOmWJA52cVJW6zwxCxE28/592IARxlJcq14tjwYwIDAQAB
    Important: 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.
    1. Delete the current Incoming Authentication configuration in Jira.
    2. Re-enter the Consumer Key, Consumer Name, and Public Key referenced above.
    3. Save.
      configure_qtest_and_jira_private_key.png
  7. Navigate to qTest Manager, and add a connection to your JIRA instance, as follows:
    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.
    1. Select Add Connection.  The Add JIRAConnection page is displayed.
    2. 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.)
    3. Select the Use JIRA OAuth hyperlink and qTest will create an authorization URL.
    4. Select the Authorize URL hyperlink and select "Allow" in the Welcome to JIRA pop-up.  
    5. An 'Access Approved' message will display and you will need to obtain the verification code from the text on the webpage.
    6. Enter the Verification Code and select Submit.
    7. Submit the Connection Information,and select the Test Jira Connection button.
    8. 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.
    9. 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 open the firewall to the following IPs to allow qTest Manager to communicate with your OnPremise JIRA instance:

  • 54.225.178.215
  • 54.221.246.6
  • 54.221.246.5
  • 54.227.244.234
  • 54.83.57.143
  • 54.83.57.153
  • 34.217.197.132
  • 35.162.90.17
  • 52.213.200.88
  • 52.214.114.20

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.








 

Powered by Zendesk