qTest Manager allows you to manage both standalone requirements and requirements from JIRA. Importing requirements from JIRA allows testers to use up-to-date information from JIRA issues, such as stories and epics (or even custom issue types), to create test cases for coverage. Instructions to import and use requirements from JIRA are the same, whether you are using JIRA Server or JIRA Cloud.
Before importing requirements from JIRA, make sure to complete the setup steps described in the following sections.
Configure JIRA Integration
- On the "Configure Connection" page, select OFF in the Requirement Integration area of the screen to activate the requirement integration feature. (This feature allows you to import requirements from JIRA into qTest Manager.)
The icon is toggled ON.
- Select Add Requirement. The Add Issue Types window is displayed.
- Select the down arrow to the right of the JIRA project field. From the drop-down list, select the applicable JIRA project from which you will import requirements to qTest Manager.
- Select the down arrow to the right of the JIRA Issues types field. Select the issue type you use to represent requirements in the JIRA project selected above (e.g., story, feature, epic, task, work item). This procedure will retrieve that object type, so it is imported into qTest Manager as requirements.
HINT: The purpose of this step is to identify the issue type from the JIRA project and import that object type into qTest Manager as requirements.
- Select OK. A line is created in the Requirement Integration area of the Configure Connection page for the JIRA project and associated JIRA issue type selected in steps 3-4, above.
- Position the arrow cursor on the new line that indicates the JIRA PROJECT and JIRA ISSUE TYPES. Then, move the arrow cursor into the ACTION column on the right side of the window. Three icons are displayed under that column. Select the middle icon, the wrench.
- On the Edit Data Retrieval screen, you can configure three things, (More information is provided in the sections below.)
- Import all issues of that issue type or based on a JIRA filter.
- Establish how requirements from JIRA will be organized, based on one or two JIRA fields.
- Select the JIRA fields you wish to display in qTest Manager.
Import using JIRA Filter
- Choose the Get data from all issues of this type option to import all data for the Issue Type selected above OR choose the Get data from a specific filter option to import a subset of data for the Issue Type selected above by using a filter you previously created in the JIRA project.
HINT: The filter must be a favorite of the username entered above on the Add JIRA 6.0+ Connection page. qTest Manager will not allow you to import requirements using a favorite filter created by another user. To use this option, select the arrow to the right of this option icon and select the desired filter from the drop-down list. If the JIRA username does not "favorite" a filter, it will not show up in this drop-down list. See Add a filter as a favorite in JIRA.
Organize into Folder Structure
One or two fields can be selected to organize imported requirements into a nested folder structure. When a field is selected, qTest Manager will organize requirements by this field value into a child folder below the standard "Imported from JIRA" folder. If another field is also selected for field two, qTest Manager will create yet another level of child folders below the field one folders following this same logic. Using the real-time integration, qTest Manager will automatically reorganize the requirements if any of the fields' values are changed after the initial import (e.g., move requirement from In Progress to Done folder).
- In the Select fields to organize imported Requirements area, select the arrow to the right of Field 1 and select the desired JIRA field in the drop-down list, such as Product.
- Select the arrow to the right of Field 2 and select the desired JIRA field in the drop-down list, such as Status.
By default, the requirements from JIRA are imported into one folder (Imported from JIRA) in qTest Manager. The steps shown above enable you to create a folder structure to help organize your imported requirements according to the two JIRA fields selected here. In the following example, the ‘Status’ option has been selected in Field 1, and the ‘Priority’ option was selected in FIeld 2.
The screenshot below shows a flat structure of JIRA requirements. We do not recommend using this structure for requirements.
The screenshot shown below shows a two-level structure of JIRA requirements. We strongly recommend using this structure for requirements.
Select JIRA Fields to Display on Requirements
- In the JIRA ISSUE FIELDS area of the screen, select any additional data from JIRA you want to import to qTest Manager, such as the Fix Version and Priority. To select a field, including custom fields created in JIRA, select the ACTIVE check-box for the item.
Note: We recommend checking all the checkboxes to import all of this data into qTest Manager.
HINT: For each project you create in qTest Manager, you can customize the JIRA fields to show in qTest Manager. The fields you use in one project may differ from the fields used in another project.
The following screenshot shows the bare minimum of JIRA fields displayed. We do not recommend using this approach.
The following screenshot shows many more JIRA fields displayed. We highly recommend using this approach.
- Select OK. Then, select Save & Activate located at the top right of the Configure Connection: Demo JIRA Account page.
The CONFIRMATION pop-up window dsiplays.
- Select Refresh. The Configure Integration: JIRA 6.0+ page displays. The Configure Connection page is redisplayed.
- Select Retrieve JIRA Data.
The EXTERNAL ISSUES RETRIEVING PROGRESS pop-up window displays. A progress bar is displayed in the window.
When qTest Manager has imported all JIRA requirements, the following message is displayed.
- Select OK. The requirements which were created in JIRA will be accessible to testers in read-only form in qTest Manager.
Review JIRA Requirements After Import
- Select the Requirements module from the header and select the Imported from JIRA folder located in the left panel. The requirements imported from JIRA are listed within this default folder. Each of these objects represents an object in JIRA. Imported Jira's issues are represented by with the Atlassian symbol to differ from internal qTest Requirements.
- If you selected two JIRA fields to organize the requirements (in Integration Settings), you should see two levels of subfolders underneath the default Imported from JIRA folder.
For example, if the two fields are Project and Status, the first level of subfolders is by JIRA Project, and the next level of folders underneath those is by Status.If a requirement changes from the In Progress status to the Done status, the requirement will automatically reorganize itself from the In Progress folder to the Done folder. These changes will reflect in qTest Manager in real time.
- Imported JIRA issues are updated in real-time, but you may have to reload the requirement page if you are on the actual page when a change is made on the issue in JIRA. An imported JIRA issue has two Properties sections - JIRA's Properties and qTest's Properties.
- JIRA Properties contain Active JIRA issue fields configured on the Edit Data Retrieval screen. These Properties are Read-only. Currently, JIRA Properties' fields cannot be used for searching or querying in qTest Manager.
- qTest Properties contain all qTest Requirement's fields, excluding Description.
- To view the actual JIRA issue for a particular requirement, select the ID hyperlink to be redirected into JIRA.
HINT: Make sure to download the qTest Integration Browser Plug-in for your browser so that your JIRA username and password are saved (which will allow you to quickly jump from qTest to JIRA without having to log in each time). This is recommended to be installed on each user's browser.
When a linked Jira Requirement is changed in Jira, qTest will update the content on the linked Requirement, including logging an entry in the Requirement History. Entries in the History will show the qTest username to indicate who it was “Changed By.”
- If a Jira Requirement is automatically synced, it is recorded as having been updated by “Jira Integration.”
- If a user manually selects the Retrieve option to update a Jira Requirement, he/she is recorded as the user who made the change in the Requirement.
In addition to the qTest fields, changes to all Jira fields are recorded in the History tab with the Jira logo next to the Jira Field Name.
Known Limitation: Given you created a new custom field in Jira, but have not selected the Refresh Field Settings to sync the new field to qTest, and there is a Requirement change in qTest with the new field, a record will display in the History tab as "No change." Once you select the Refresh Field Settings, qTest will begin storing the field value in our database, and the History tab will show the value change accordingly.
Copy JIRA Requirements
Copied issues will become a qTest Requirement (and no longer remain integrated with JIRA). It will only retain the Description field from the JIRA issue. We recommend against copying requirements from JIRA. Instead, consider "Clone Connection" from one qTest Manager project to another qTest Manager project so you can reuse the integration configurations and import the same requirements into another qTest Manager project.
Move JIRA Requirements
You can select JIRA requirement(s) and drag and drop them to reorganize into a different folder than the folder it was originally imported into based on the integration settings. When you move the requirement, it will continue to be integrated with JIRA, so that any updates to those issues will be reflected in qTest Manager. If you move a requirement into another folder in qTest Manager, it will remain there instead of the original folder into which it was imported.
Link Requirements to Test Cases
Imported JIRA issues can be linked to qTest Manager test cases, either from the requirement or test case. A JIRA requirement can be linked to multiple qTest Manager test cases; multiple JIRA requirements can be linked to a single test case. For more information, see Linking Test Cases and Requirements.
When you link test cases to a JIRA requirement, you will be able to see the linkage in multiple places.
- qTest: Test Execution add-on in the JIRA Requirement Issue shows the linked Test Case(s) and associated Test Runs.
- qTest Requirement shows the linked test case(s) in the Resources section.
- qTest Test Case shows the linked requirements in the Resources section.
When you remove the link between a test case and a requirement - this is performed in the Resources section of the test case or requirement in qTest - the corresponding issue links in JIRA are also removed.
See the following articles: