Requirements Module
- 1 Introduction
- 2 Requirements Module UI
- 3 Managing Requirement Folders
- 4 Requirement Detail Page UI
- 5 Managing Requirements
- 5.1 Creating New Requirement
- 5.2 Importing Requirements
- 5.3 Updating Requirements
- 5.4 Creating a New Version of Requirements
- 5.5 Archiving a Requirement
- 5.6 Unarchiving a Requirement
- 5.7 Archiving a Specific Requirement Version
- 5.8 Deleting a Requirement
- 5.9 Deleting a Specific Requirement Version
- 5.10 Share Requirements with Other Users
- 6 Bulk Operations on Requirements
- 7 Linking Test Cases to Requirements
- 8 Syncing the Latest Requirement Version with Test Cases
- 9 Linking Issues to Requirements
- 10 How to Unlink Issues Linked to a Requirement?
- 11 Associating Releases & Cycles
- 12 Issue Traceability in Requirements
- 13 Requirement Version
- 14 Change Log
- 15 Import Requirements
- 16 Export Requirements
- 17 BDD Editor
- 18 More Features
Introduction
The Requirement module is a central repository for storing test requirements and business specifications. It helps you manage and track requirements throughout the development lifecycle. You can create, organize, and link requirements with test cases and issues to ensure complete test coverage. The module also supports versioning, traceability, and collaboration.
You can create requirements manually or import them via Excel using the Import Wizard or import directly from Jira. You can link existing as well as newly developed test cases to these imported requirements.
Permissions
View, Modify, Create, Delete, Import, Export, Link, Copy, and Versioning permissions are set in Customization under Roles for individual roles.
Ensure that you have the relevant permissions to perform these operations.
Key Features of the Requirements Module:
Add requirements from external development and product management tools.
You can create requirements directly from Jira and maintain sync.
Cover requirements by linking them to existing test cases.
Perform quick ad hoc executions of test cases associated with a particular requirement.
Requirement reports are also available to analyze the application against varied measures.
Requirements Module UI
The Requirement module offers various customization options to create a tailored view.
Sorting and Clear Sorting
You can sort the folder structure alphabetically or by date (newest first or oldest first).
Sorting
Clear Sorting
Filtering Requirements
You can filter requirements based on system or custom fields across all module grids. Basic filters like Summary, Release, and Cycle are available by default. For advanced filtering, click the "+" icon and add custom filter fields.
Basic Filters
Advanced Filters
A. Basic: By default, requirements can be filtered by summary, release, and cycle. Enter specific values in these fields to retrieve requirements that meet the criteria.
B. Advanced: You can also apply advanced filters to refine requirements based on fields beyond the basic options.
To apply advanced filters, perform the following steps:
Expand the Advanced Filters section
Click on the “+” icon.
Select the desired fields for filtering.
Enter the filter values.
Click Save and Apply.
For example, you want to filter requirements based on Priority and Entity Key.
Click on the “+” icon and select the fields on the drop-down list. You can apply an advanced filter on Entity Key to search for test cases using comma-separated entity IDs, without specifying the complete Entity Key.
Filtered views are automatically saved for future use, eliminating the need to reapply the same filters repeatedly.
Applying Filters when Jira is Configured with a Project
Jira Filters are enabled for the requirement module only if your project is synced with at least one Jira project. In such scenarios, you can apply two distinct filters: QMetry Filters and Jira Filters.
To apply Jira Filters, perform the following steps:
Select the Jira Instance and Jira Project configured with the QMetry project.
Click Apply.
If you have only one Jira Instance and Project configured with your current QMetry project, the instance and project will be auto selected.
Click the + button to apply more filters if needed.
The applied filter remains active and reappears when you revisit the screen. However, Jira fields used for filtering, such as Fix Versions, do not appear in the Requirement list view.
Resetting Filters and Clearing Filter Value
The Clear Filter Values clears out the values in the filters without removing the fields.
The Reset Filters option resets the filter to the default. All the selected fields for Advanced Filter are removed from the filter.
Resetting Filters
Clearing Filter Values
Manage Grid Columns
The Arrange Columns option in the Requirements Module grid enables users to customize the asset view.
Refer to the Manage Grid Columns page to know more.
Managing Requirement Folders
QMetry allows testers to organize and manage requirements in a Folder-based hierarchy. You can add a new folder to the root or as a child of an existing folder.
Use Case: The organization has received a bulk amount of project-related requirements from its client. To manage these requirements, they need to be categorized. Requirements of similar categories are added to individual requirement folders.
The count of requirements in the folder hierarchy is displayed alongside the folder name. The count includes active + archived requirements.
For example, this is the folder hierarchy: Folder A → Folder B → Folder C
Folder A has 5 requirements, Folder B has 3 requirements, and Folder C has 2 requirements, then the count will be displayed as follows.
Folder A (10) <------ Parent Folder
Folder B (5) <------Child Folder
Folder C (2) <------Subfolder of Child Folder
Include/Exclude Test Cases from Sub Folders at Parent Folder
You can include or exclude requirements from subfolders at the parent folder level. By default, Include Entities from Sub-folder remains selected, and entities from sub-folders are displayed at the parent folder level on the module list view.
To hide the entities from a sub-folder, open the Options drop-down on the test asset tree at left, and deselect Include Entities from Sub-Folder.
Learn about the available actions for folders in Basic Folder Operations.
Refer to Bulk Copy/Move at the directory level within/across the project.
Requirement Detail Page UI
Click the Requirement Entity Key in the grid view to open the requirement detail page. Right-click the Entity Key to open it in a new tab.
Navigation
You can navigate through the requirements in two ways - using the previous and next buttons or breadcrumb navigation.
Refer to the User Navigation to learn more.
Organize Tabs
You can customize the view of the detail page by changing the order of tabs. The tab order is preserved per user.
For example, the tab order of the Requirements module is changed by user "A" for project "PRO1". Now "A" is switching to another project, "PRO2". The tabs can be seen in the same order as in the project "PRO1".
Tabbed View vs. Combined View
The requirement details page contains:
A. Individual Section Tabs
B. Combined View (Read Only View)
A. Individual Section Tabs
In the requirement module, there are individual tabs for Details, Test Cases, Release & Cycles, Issues, Version, BDD (if configured), Attachments, Comments, and Change Log.
Each tab displays relevant details. The details of the tabs are editable.
B. Combined View (Read Only View)
The tab renders the old view of the details page. You can view the details of all the sections on a single page. The details displayed on the page are read-only and cannot be edited.
Refer to Manage Attachments to know more about the attachments tab.
Managing Requirements
With the necessary permissions, you can create, edit, copy, move, archive, and delete requirements. Admins can grant permissions from the Customization screen under Roles.
Let’s have a detailed look at these features.
Creating New Requirement
To create a new requirement, perform the following steps:
Go to the Requirements module.
Select the folder where you want to create the requirement.
Click the New button.
Enter the details for the system fields in your requirement:
Field Name | Description |
|---|---|
Summary | Provide a brief overview of the test case, outlining its purpose. |
Priority | Assign a priority level to the test case: Minor, Major, Blocker, Critical, or Trivial. |
Labels | Choose one or more labels to classify the test case. |
Status | Select appropriate status: New, Approved, In Progress, and Ready to Review. |
Owner | Assign an owner from users with access to the current project. |
Associated Releases | Link the requirement to one or more releases. |
Associated Cycles | Associate the requirement with cycles corresponding to the selected releases. |
Description | Add a description (plain text or rich text). |
Folder Path | Select a specific folder for storing the assets during creation. (Default is root folder) |
All About Rich Text Editor
Notes
To use rich text, you need to enable the Enable Rich Text parameter for the Project from Project Management under Projects.
Refer to Enable Rich Text Editor for more details.
Rich Text: Rich Text Editor allows you to add images, hyperlinks, and tables to the field.
Image Upload Support in Rich Text Editor: You can add multiple images simultaneously. Images can be added by:
Entering an Image URL.
Browsing the Desktop to upload an image.
Copying and pasting the image directly into the description box. Multiple images can be copied and pasted.
Click on the Edit icon at the right to open the source editor.
Notes
The supported file formats of the image are JPG, JPEG, PNG, and GIF.
The maximum file size should be 1 MB for images uploaded through browsing.
To download the image, click on the image and then click on the Download icon in the top right corner.
User-Defined Fields
If you added UDFs to the Requirements module, they appear on the Create Requirement and Requirement Details screens.
Click Create to save the details.
When you open the requirement detail page, the Path displays the path up to the folder the requirement lies within.
BDD / Gherkin Editor: Refer to BDD Implementation for more details.
Importing Requirements
The Import option allows you to import requirements from Excel and Jira.
Learn more about Importing Requirements from Excel File.
Updating Requirements
You can update a requirement either within the current version or by creating a new version.
Updating the Current Version of the Requirement
To update the requirements without creating a new version, use the in-place editor on the “Details” screen.
To update requirements, perform the following steps:
Navigate to the requirements details screen.
Access the Details tab.
Hover over the values to edit.
Enter the new values and click the checkmark to save your changes.
In-place editing will update the existing requirement.
Changing the folder path moves the asset to a different folder.
Creating a New Version of Requirements
If your role includes Versioning rights, the Create New Version button becomes available. When editing requirement details, users can save the changes as a new version of the requirement.
Many organizations track requirement details by version to monitor changes in specific fields, allowing for effective version management.
Notes
Only users with “versioning” rights will see the Save as New Version button or the Version drop-down.
Others can only update requirements or test cases.
Versioning rights are assigned from Customization under Roles.
To create a new version of a requirement, perform the following steps:
Click on the Create New Version icon on the header.
The next screen opens in editable mode.
Make the necessary changes and click on Save as New Version to create a new version with the updates.
Add a comment for the version.
Enter a description explaining the relevance of the requirement version.
Creating a New Version from the Requirement Grid View
To create a new version of the requirement from the module grid view screen, perform the following steps:
Go to the requirement grid view.
Click on the Cog icon for the requirement and select Create New Version.
Repeat the same steps as mentioned above.
Archiving a Requirement
You can archive a requirement in the following ways:
A. Archiving from the Requirement Details Page
B. Archiving from the Requirements Module List View
Note
Once a requirement is archived, you cannot perform any operations such as adding attachments, linking test cases, issues, or release cycles on it.
A. Archiving from the Requirement detail page
To archive a requirement from the detail page, perform the following steps:
Open the Requirement Details page.
Click on the Archive icon in the top right corner (Refer to the image below).
This will archive all versions of the requirement.
B. Archiving Requirements from the module List view
To archive requirements from the module list view, perform the following steps:
Open the Requirements module to display the list of requirements within the selected folder.
Click the Archive icon for the requirement to be archived and confirm the action.
Confirm to archive the requirement.
Unarchiving a Requirement
To restore an archived requirement, perform the following steps:
Navigate to the Requirements module and click the filter icon.
Select Show Archived Items.
Click on the requirement entity key to unarchive.
On the requirement details page, click the unarchive icon.
Confirm the action by clicking Yes.
Archiving a Specific Requirement Version
Read about Archiving a Specific Requirement Version.
Deleting a Requirement
Deleting a requirement is a two-step process:
Archive a requirement (All the versions of the requirement will be archived.)
Delete a requirement (The requirement will be deleted, including all its versions.)
Deleting Entire Requirement
All the versions of the requirement must be archived to delete that particular requirement.
A. From the Requirement detail page
B. From the Requirement list view
A. From the Requirement detail page
To delete a requirement from the requirement detail page, perform the following steps:
Open the requirement detail page.
Click on the Delete icon at the top right corner of the screen.
Once the requirement is archived, it looks like below.
B. From the Requirement list view
To delete requirements from the requirement list view, perform the following steps:
To view archived requirements, select the Show Archived checkbox above the grid. This will display both archived and active requirements.
To delete an archived requirement, click the Settings icon for the requirement and select Delete.
Deleting a Specific Requirement Version
Read about Deleting a Specific Requirement Version
Share Requirements with Other Users
Share Requirements
QMetry allows easy sharing of requirements with other users. Users can share a requirement summary and a link for easy access to the latest version of the requirement.
To share a requirement, perform the following steps:
Open the Requirement details page.
Click on the Share icon at the top.
Enter one or more email addresses.
Write a message (optional but recommended) describing the requirement or expected action.
Click on the Share button.
Copy Requirement Link
Users can copy the requirement link and share it with other users to provide direct access to a specific requirement. Authorized members can access the requirement directly via the shared link.
URL syntax:
https://<URL>>/#/<AssetType>/<AssetKey>
For example,
To copy a requirement link, perform the following steps:
Open the requirement details page.
Locate and click on the Copy Link icon ( ) on the breadcrumb navigation.
Users can share this link via any preferred communication channel.
Bulk Operations on Requirements
Read about Bulk Operations
Linking Test Cases to Requirements
Test cases can be efficiently linked to their corresponding requirements, enabling users to track the coverage and validation of each requirement throughout the testing process. This linkage facilitates streamlined traceability and ensures comprehensive testing against defined requirements.
Selecting Test Cases to Link
Use Case: Users link the test cases with related requirements for testing. Testers get an idea of what is being developed by studying the requirements, and on that basis, they write test cases to describe how to test the developed application. Thus, linking a test case with a requirement gives relevance between the two as what is developed and what to be tested.
Test Cases can be linked to a requirement from - Requirement Details Page and the Requirement Edit Screen.
To link test cases, perform the following steps:
Navigate to the Test Cases tab on the Requirement details page or the requirement edit page.
Click the Link button to open the Link Test Cases pop-up.
It opens the Link Test Cases pop-up with the list of test cases on it. On this screen, you can:
Resize columns
Sort columns (excluding multi-lookup lists)
Show or hide columns using the Arrange Columns option
Selecting Test Cases Across Projects
Users can link test cases from other projects by selecting the project from the Project drop-down menu. The screen will display the test cases for the selected project. Users can resize columns, apply sorting (excluding multi-lookup lists), and show/hide columns using the Arrange Columns option.
Use Case: Each version of the test case is expandable so that users can view details of all versions in one place. Expand the test case and select the required version to link with the requirement.
Test Cases of Release & Cycle to this Requirement: Select the checkbox for Test Cases of Release & Cycle to this Requirement. This checkbox is unavailable when viewing test assets from other projects. To link test cases across multiple projects, first select a project, search for and link the records.
If you want to link test cases from multiple projects, then first select one project. Search records and link them before moving to other projects. For example, User A is in Project 1 and searches for some records and link them before moving to Project 2. Else, all the selection of Project 1 will be wiped off.
Creating New Test Case
To create a new test case, click on the Create New Test Case link at the top right of the pop-up. This opens the Test Cases module in a new tab where users can create additional test cases. After creating the test cases, refresh the Link Test Cases pop-up to display the new test cases.
Selecting Test Cases to Link
Select the test cases to link and click on the Link Selected Test Cases button. The selected test cases are linked to the requirement and appear on the Test Cases tab grid pane.
The Test Cases count on the Requirement details page shows the number of linked test cases. If any test cases are archived, counts are displayed separately for Unarchived and Archived Test Cases.
If test cases from another project are linked, then the test cases show the Entity Key of the corresponding project.
To view the test case of another project, click on the Test Case Entity Key. It opens the test case detail page in the respective project and changes your current project.
Linking Test Case by Entity Key
The feature allows you to link the latest version of a test case to a requirement using the test case entity key, separated by a comma. A maximum of 500 entities can be linked at a time.
Use Case: The feature is useful to link test cases to a requirement without searching for them individually. For example, users have a list of test case keys to be linked to a requirement, they can use this option to link the test cases directly. This feature will save the users' time in searching test cases in different folders and linking them.
Notes
Test Case key will be ignored if the relevant test case with that key is not found.
If a single key is mentioned multiple times, it will be linked only once.
If an older version of the test case is already linked and trying to link the same test case key, then the latest version can not replace the older version. It will be skipped.
Archived versions will be skipped from linking. Only the latest unarchived version of the test case will be linked.
To link a test case by entity key, perform the following steps:
Go to the Test Cases tab of the requirement page.
Click on the Link By Entity Key button.
It opens the Link Test Cases pop-up. Mention comma-separated test case keys on it.
Click Link.
The test cases with the mentioned keys get linked to the requirement.
Unlinking Test Cases from a Requirement
Go to the Test Cases tab of the requirement details page or the requirement edit page.
It shows a list of test cases linked to the requirement.
Select the test cases you want to unlink and click on the Unlink Selected button.
The test case is unlinked after confirmation.
Syncing the Latest Requirement Version with Test Cases
You can sync the latest version of the requirement to its linked test cases individually or in bulk. The sync feature in the Requirement > Test Case tab allows you to sync the requirement version with individual test cases or with multiple test cases in bulk.
For example, the current version of the requirement is v3. All the test cases are linked to this version of the requirement. Now, a new version of the requirement is created i.e., v4. Users can sync the v4 of the requirement with the linked test case.
Navigate to the Test Case tab in the requirement module.
Syncing the Latest Requirement Version with a Single Test Case
When a new version of the requirement is available, the sync icon under the Requirement Version column turns Blue. You can click on this icon to sync the latest version of the requirement with the test case.
Syncing the Latest Test Case Version with Multiple Requirements in Bulk
When a new version of the requirement is available, the sync icon under the Requirement Version column turns Blue. Select the test cases to sync the latest requirement version and click on the Sync Latest Version of Requirement button.
A confirmation message will appear. Click "Yes" to proceed.
For bulk synchronization, progress will be displayed in the Scheduled Task. You can see that the selected test cases are synced with the latest version of the requirement.
Linking Issues to Requirements
You can link issues to their corresponding requirements. Issues can be linked to requirements through the Issues tab available on the Requirement details page and the Requirement edit screen.
Use Case: An organization is using Jira for managing defects in their system/product. The requirement itself needs to be analyzed and checked for dependencies/limitations, etc. These could be filed as defects and linked with the requirement itself.
Linking Issues from Jira
Use the "Advanced Filter" option to access custom fields configured for the Issue module in Projects under Integration.
The "Arrange Columns" option will display all system and custom fields configured for the Issue module in Projects under Integration.
To link Issues from Jira, perform the following steps:
Go to the Issues tab of the requirement details page or the requirement edit page.
Click on the Link button.
It opens the Link Issues pop-up with the list of issues.
Selecting Issues Across Projects
To link issues from multiple projects, perform the following steps:
Select Project: Use the Project drop-down to choose the project. Issues from the selected project will be displayed.
Link Issues: Select the issues to link to the requirement. Filters will apply only to the selected project.
To link issues from multiple projects, perform the following steps:
Select and link issues from one project first.
Move to the next project to search and link additional issues. Ensure all issues are linked before switching projects, as selections from the current project will be cleared.
If test cases from other projects are linked, they will display the Entity Key of the corresponding project. To view the issue details from another project, click the Issue Entity Key. This will open the issue detail page in the respective project and switch your current project.
Creating New Issue
Users can create a new issue and link it from the link issues page. Click Create New Issue at the top right corner of the pop-up to open the Issue module in a new tab and create issues. Refresh the Link Issues pop-up to see the new issues. Select the issues to link and click Link and Close. The linked issues will appear on the Issues tab of the requirement details page.
When Jira is configured with QMetry
When a Jira project is configured with a QMetry project, users have to select the Jira instance and its project from which they want to link Jira issues to requirements in QMetry.