Configure Jira Defects

After establishing a connection between qTest Manager and Jira, you must configure your Defect integration with Jira. This provides developers with comprehensive details from Test Execution, such as the steps to reproduce and the environment.

The setup steps in this article, help you determine the Jira issue type that the Defect will represent, and the Jira fields that will be auto-filled when submitting a Defect.

Prerequisites

Before configuring your Jira Defect Integration, make sure to complete the setup steps described below.

For questions on the Jira sync message at the top of the Defects tab, see What Do The Jira Sync Messages Mean?

Required Permissions

  • qTest Manager Project Administrator permissions to access the project’s integration settings.

  • The Jira username in the connection must have the Create Issue permission in the Jira project. For more information, refer to Manage Project Permissions.

  • You can set up your qTest Manager project to be able to submit Defects into multiple Jira projects. If so, the Jira project will be selectable when the Defect is logged by the tester.
  • You can select multiple Jira issue types (such as Bug or even custom issue types) to be mapped as Defects. Mapped Jira issues will be referred to as Defects in qTest Manager.
  • qTest Manager requires that at least one Jira issue is mapped as a Defect.

How to get here

  1. Within the qTest Project that you are configuring your Jira integration, select the Gear icon.

  2. Select Integration Settings from the drop-down menu and the Configure Integrations page loads.

  3. In the External Systems panel on the left, select Jira.

  4. Locate your Jira connection in the Connections List section and in the Action column, select the wrench icon to configure.

configure_Jira_connection_list.png

Configure Jira Defect integration

  1. From the Configure Connection page, select the Add Defect Type button.

    The Add Issue Type dialog displays.

  2. In the The Jira Project drop-down menu, select the Jira project in which to submit the Defect.

  3. In the Jira Issue Types drop-down menu, choose the applicable Jira issue type. The selectable issue types in this field automatically show the issue types that are available in the Jira project you selected.

    The Bug issue type is a very popular choice, but you can also select other issue types, such as tasks or even custom issue types that exist in the Jira project.

  4. Select the OK button and the Defect Integration section displays the Jira project and Jira issue type you selected.

Auto-fill Defect fields

To automatically fill in Jira fields when submitting a Defect, use the Defect Auto Fill feature as follows.

  1. In the Actions field of the new line created in the Defect Integration area, select the wrench icon to configure.

  2. The Edit Auto Filling instructions vary depending on whether you are connected to Jira Cloud or Jira Server. More details are provided below.

Jira Cloud auto-fill

This screen allows you to select the Jira Defect fields to auto-fill using qTest Manager field values. When you create a Defect in qTest Manager, the information you select on the Edit Auto Filling screen is automatically populated in the Jira Create Issue window. The tester does not need to manually enter the information in Jira.

  1. Select the fields you want to auto-fill on the Jira Defect.

    The auto-filling of Defect fields is optional, but highly recommended to save time and provide more information from the qTest Manager test.

  2. Select the values to auto-fill. For example, select the hyperlinked Description field. The Edit Field dialog is displayed.

  3. In the Input Option field, you can either select the Auto Fill option or the Default Value option. Consider the following:

    • Selecting the Auto Fill option means the data is taken from qTest Manager and dynamically filled into Jira. Selecting the Default Value option means the Jira field will always fill with the same pre-defined value.

    • Only fields in Text format can be auto-filled. Other fields can be configured for Default values only (instead of dynamic auto-fill).

    • You can select multiple qTest Manager fields to auto-fill into one Jira field. For example, the Description of the Jira issue can be auto-filled with Description (Test Steps), Assigned To (Test Run), and Environment (Test Run).

  4. To add additional fields for auto-fill, select the Add button and select from a drop-down menu of other available qTest Manager fields, such as Assigned To (Test Run).

  5. Select the OK button. You can add as many additional fields as you like.

Jira Server auto-fill

  1. The Edit Auto-Filling form displays. By default, qTest Manager will load all available fields of the mapped Jira issue type to the Defect Field column.

  2. Set Auto-Filling for mapped Jira issue's fields. qTest Manager will auto-fill data from the Test Run or Test Case into the mapped Jira issue's field as settings.

  3. Drag the available qTest Manager Test Run fields and drop to the corresponding Jira fields in the Auto-Filled With column.

    Edit_Auto_Filling_for_Local_Jira.png

  4. Select the OK button to complete the Auto-Filling configuration.

Add additional field for auto-fill

You can add additional fields to qTest for auto-filling, from your external Defect system.

  1. Select the Add Field button, from the Edit Auto Filling dialog.

  2. The Add Field dialog opens, and in the text box, format the field name as ex: customfield_#####.

  3. Select the Populate button, and a confirmation message appears when the field values are found in Jira.

  4. The details from Jira are retained once qTest retrieves the newly add field information.

Send Test Log attachments to linked Defects in Jira

Attachments for Test Logs and Test Step Logs can be automatically uploaded to linked Defects in Jira. This feature is enabled by default, but you can disable it by selecting the 'send attachments' check box.

This image is for Jira Cloud.

  • If you link a Defect to a Test Log, attachments of the overall Test Log and each Test Step Logs will be uploaded to the Defect.

  • If you link a Defect to a Test Step Log, only attachments from the Test Step Log and its previous steps are uploaded to the Defect.

Attachments sent from qTest will have the following identifiers in the Jira Defect:

  • a prefix of "qTest" or "qTest_[Test Step#]"

  • comment with the name of the attachment and the qTest user who sent the attachment

  • comment in the event the attachment failed to upload properly

The maximum attachment size for qTest is 50MB, so you will need to configure your "Jira Attachment Size" to be at least 50MB. If you remove an attachment in qTest, it will not remove the corresponding attachment from Jira.

Store unlinked Jira Defects in Manager to be reported in Insights

You can use Insights to report on Jira Defects that are not linked to a Test Run in qTest Manager. To use this enhancement you will need to enable Jira to provide unlinked Jira Defects. You can fetch the data manually or through auto-sync which will then be stored in the Manager database.

Unlinked Jira Defects will not be shown in Manager in the following areas:

  • Reports

  • Linked Defect Dialog

  • Defect Summary

To enable Jira to provide unlinked Defects, do the following:

  1. In qTest Manager, navigate to the qTest project for which you would like to enable Jira to provide unlinked Defects.

  2. From the Gear icon drop-down, select Integration Settings.

  3. Select Jira from the External Systems panel on the left side of the screen.

  4. Locate the Jira integration name you would like to provide unlinked Defects for, and select the wrench icon in the Action column. The Configure Connection page loads.

  5. In the Defect Integration section, select the Also populate JIRA defects that are not linked to Manager Test Runs check box.

  6. Save and then select the Fetch Jira Defect icon.

    unlinked_Jira_defects_checkbox_in_manager.png

Next Steps

See the following articles: