| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
The Requirements module serves as a central repository for storing test requirements and business specifications. You can create requirements manually or import them via Excel using the Import Wizard or directly from Jira.
Once requirements are imported, both existing and newly created test cases can be linked to them.
Permissions for the Requirements module (View, Modify, Create, Delete, Import, Export, Link, Copy, Versioning) are set under Customization > Roles for individual roles. Ensure that relevant permissions are granted to perform these operations.
Key Features of the Requirements Module:
Add requirements from external development and product management tools. Requirements can be created directly from Jira and kept in sync with Jira.
Associate requirements with existing test cases from manual or automated test suites.
Quickly execute test cases linked to specific requirements to perform tests outside of defined test suites.
Requirement reports are also available to analyze the application against varied measures.
Requirements Module UI
The Requirement module offers various customization options to help users create a tailored view of their requirements. Below are the key features of the Requirement Module:
Create New Folder
You can organize requirements into folders and subfolders for improved control and management.
Sorting and Clear Sorting
You can sort the folder structure either alphabetically or by date (newest first or oldest first).
Sorting
Clear Sorting
Include/Exclude Test Cases from Sub Folders at Parent Folder
You can include or exclude requirements from sub folders at parent folder level. By default, Include Entities from Sub-folder remains selected, and entities from sub-folders are displayed at parent folder level on the module list view.
To hide the entities from sub-folder, open the Options drop-down on the test asset tree at left, and select deselect Include Entities from Sub-Folder.
Perform Bulk Operations on Folders
You can perform bulk operations for archiving, unarchiving, copying, and moving folders.
Create New Requirements
You can create requirements directly from the Requirement module UI by clicking on the New button.
Filter Requirements
You can easily filter requirements by any 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, these are the steps:
Click on the '+' icon (Refer below image).
Select the desired fields for filtering.
Enter the filter values.
Click ‘Save and Apply’.
For example, you want to filter requirements 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, as shown below.
| Info |
|---|
Filtered views are automatically saved for future use, eliminating the need to reapply the same filters repeatedly. |
Apply Filter when Jira is Configured with Project
If the QMetry project is synced with at least one Jira project, then only Jira Filters will be enabled for the Requirements module. Two distinct filters: QMetry Filters and Jira Filters options are available to filter requirements.
If you want to apply Jira Filters, first select –
Jira Instance and Jira Project with which the QMetry project is configured and 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.
Once this filter is applied, you can see more filters by clicking onthe + button.
The filter applied to the records will be preserved and rendered again when you visit the screen next time. Jira fields, on which you filter the records, do not appear on the Requirement list view. e.g., Fix versions.
Reset Filters and Clear Filter Value
The Clear Filter Values option provides users with improved flexibility, efficiency, and usability in managing and reusing Advanced Filters for important data that may not be easily accessible by default. This option only clears out the values in the filters without removing the fields themselves. It enables users to start fresh with the same set of fields, allowing them to adjust their filter criteria without having to recreate the entire filter setup each time. It preserves empty fields in the filter just like fields with values and allows users to easily modify and refine the filter criteria without losing the content of the set fields. Here, empty fields in the filter will consider all records.
The Reset Filters option will reset the filter to default. All the selected fields for Advanced Filter will be removed from the filter.
Reset Filters
Clear Filter Values
Manage Grid Columns
All grids within the Requirements, Test Cases, Test Suites, and Issues module have Arrange Columns option that allows you to create a customized view of the requirements. The view is saved for future use.
The following customizations can be applied to the grid view:
Show More Columns: You can customize the grid view by adding necessary columns. To display additional columns beyond the default view, select the relevant fields from the "Arrange Columns" section.
Hide Columns: You can remove columns from the grid view. If certain columns are not needed, deselect them to hide them from the module grid.
Re-arrange: The ability to arrange the columns in a different order through drag and drop functionality.
Search: Quickly locate specific fields using the search box.
Re-arrange: Arrange the columns in a different order through drag and drop functionality.
Select All: Add all available columns to the view.
Clear All: Remove all columns except the default ones.
Restore Default: Revert to the default column settings.
Resize Columns: You can adjust the column width as needed to display the full content. To modify the width of a column, position the cursor between two column headers and drag the boundary on the right side until the desired width is achieved.
Import/ Export
The Import option allows users to import requirement from Excel and Jira, while the Export option enables users to export selected requirements in Excel, CSV, Word, or PDF formats. Learn more about Importing Requirements from Excel File and Exporting Requirements
Bulk Operations on Requirements
QMetry empowers users with the ability to efficiently perform bulk operations on requirements, such as editing, copying, archiving, unarchiving, deleting, sharing, and more.
Operations on Individual Requirement
You can perform several actions such as moving, copying, archiving, or deleting a requirement. You can also create a new version, create a test case or test suite, and generate a test case for that requirement using QI by clicking the cog icon.
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
Adding a Requirement Folder
Open the Requirements module. The tree/folder panel is expandable which facilitates stretching of the area if you want to view longer folder names. You can also hover over the folder to view its full name.
To add a requirement folder, follow these steps:
In the Requirements tree, click the New Folder button.
The Add New Folder pop-up will appear.
Enter the folder name in the Folder Name field.
Click Create to add the new folder, which will then appear on the tree.
Editing a Requirement Folder
To edit an existing test case folder, these are the steps:
Select the folder in the tree.
Click the Edit icon on the toolbar to open the folder detail screen in editable mode.
Edit the folder name and click on update.
Deleting a Requirement Folder
To delete a requirement folder, it must first be archived.
Archive Folder
Refer to the Archive Folders article for details on archiving a requirement folder.View Archived Folder
Archived folders will no longer appear on the tree. To view them, enable the Show Archived Items checkbox in the tree panel filters.Delete Folder
Select the archived folder on the tree and click the Delete icon on the toolbar. The Delete icon is visible only for archived folders.
| Info |
|---|
Deleting a folder will also remove all subfolders and entities within it. However, the root folder can never be deleted. |
Bulk Copy/Move at Folder level
Refer to Bulk Copy/Move at the directory level within/across the project.
Requirement Detail Page UI
The Requirement Detail Page can be accessed from the Requirement module grid view by clicking on the Requirement Entity Key.
To open the requirement detail page in the new tab/window, right-click on the Requirement Key in grid view. Opening requirements in different tab/browsers makes a comparison between requirements easier. It also provides quick references while working on multiple assets.
Navigation
QMetry facilitates seamless navigation within the requirements. You can easily move to the previous or next requirement or access the complete list of requirements through the requirements module.
A. Breadcrumb
You can return to the Requirement module screen by clicking on the breadcrumbs.
B. Previous and Next Button
The Previous and Next buttons on the detail page assists in easy navigation.
Organize Tabs
The detail page of QMetry assets has different tabs . Users 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 project "PRO1".
Tabbed View vs. Combined View
The requirement details page contains -
A. Individual Section Tabs (Editable)
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.
Managing Requirements
QMetry empowers users with comprehensive tools for managing requirements, allowing them to perform a variety of operations such as creating, editing, copying, moving, archiving, and deleting. Let’s have a detailed look at these features.
Create New Requirement
Steps:
Go to the Requirements module.
Select the folder where you want to create the requirement.
Click the New button on the toolbar to open the Create screen.
Enter the following details to your requirement:
Summary: Give a short description of your requirement.
Priority: Assign priority level to the requirement: Blocker, Critical, Major, Minor, Trivial.
Owner: Assign the requirement to one of the active users listed, who holds a role in the current project.
Label(s): Choose one or more labels from the list under Projects > Labels.
Status: Set the status of the requirement to New, In-progress, Archived, or Closed.
Associated Releases: Link the requirement to one or more releases.
Associated Cycles: Associate the requirement with multiple cycles corresponding to the selected releases.
Description:Add appropriate descriptions providing sufficient information about the requirement. You can add the description in Plain Text or Rich Text.
| Info |
|---|
To use rich text, enable the Enable Rich Text parameter for the Project from (Projects > Project / Release / Cycle). Refer to Enable Rich Text Editor for more details. |
Rich Text: Use of Rich Text Editor allows you to apply text formatting for Description and reduces chances of missing important details. Users can also insert 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.
Use Case: An organization is using Rich text for Description field, in which they copy-paste the content from their source in html/xml format. Click on the Edit icon at the right to open the source editor.
| Info |
|---|
Note:
|
To download the image, click on the image and then click on the Download icon at the top right corner.
User Defined Fields: If UDFs are added for the Requirements module, then they are displayed on the Create Requirement and Requirement Details screen. Enable Rich Text and Source Code Editor.
| Info |
|---|
To enable rich text editor, the Enable Rich Text parameter should be enabled for the Project (Projects > Project / Release / Cycle). Refer to Enable Rich Text Editor for more details. |
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.
Update Requirements
To save requirements without creating a new version, use the in-place editor on the 'Details' screen.
Steps
Hover over the field
Click on the edit icon.
Make the required changes.
In-place editing will update the existing requirement. To create a new version of the requirement, follow the steps outlined below.
Create a New Version of Requirement
| Info |
|---|
Users without Versioning rights will not see the Save as New Version button or the Version drop-down. They can only update requirements or test cases. Versioning rights are assigned in Customization > Roles. |
If the user role includes Versioning rights (configured in Customization > Roles), the "Create New Version" button becomes available. When editing requirement details, users can save the changes as a new version of the requirement.
Use Case: Many organizations track requirement details by version to monitor changes in specific fields, allowing for effective version management.
Steps to create a new version of a requirement:
Click on Create New Version.
A. From Requirement Module - Click on the Cog icon for the requirement and select Create New Version.
B. From Details Screen - Open the requirement detail page and click on the Create New Version icon on the header.
The next screen will open in editable mode. Make the necessary changes and click Save as New Version to create a new version with the updates.
A pop up appears asking for version comment. Enter description explaining the relevance of the requirement version.
Archiving a Requirement
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 Details Page
B. Archiving from the Requirements Module List View
A. Archiving from Requirement detail page
To archive a requirement from the detail page, these are the steps:
Open the Requirement Details page.
Click on the Archive icon in the top right corner (Refer the below image).
This will archive all versions of the requirement.
B. Archiving Requirements from module List view
To archive requirements from module list view, these are the steps:
Open the Requirements module to display the list of requirements within the selected project or folder.
Click the Archive icon for the requirement to be archived and confirm the action. The requirement will be archived upon confirmation.
Unarchiving a Requirement
To restore an archived requirement, follow these steps:
Navigate to the Requirements module and click the filter icon.
Select the option to display archived items.
Click on the key of the requirement you wish to unarchive.
On the requirement details page, click the unarchive icon.
Confirm the action by clicking "Yes" in the pop-up window.
Archiving a Specific Requirement Version
Read about Archiving a Specific Requirement Version.
Deleting a Requirement
It 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 should be archived to delete that particular requirement.
A. From Requirement detail page
B. From Requirement list view
A. From Requirement detail page
To delete a requirement form requirement detail page, these are the 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 Requirement list view
To delete requirements from requirement list view, here are the 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 requirement summary and link for easy access to the latest version of the requirement.
Steps
Open the 'Requirement' details page.
Click on the Share icon at the top (refer the image below).
Enter one or more email address(es).
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,
https://qtmtest.qmetry.com/#/requirements/FIT-RQ-9634
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.
LinkSelect 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 test case with requirement gives relevance between the two as what is developed and what to test.
Test Cases can be linked to a requirement from - Requirement Details Page and the Requirement Edit Screen.
To link test cases, these are the steps:
Navigate to the Test Cases tab on the Requirement details page or 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.
| Info |
|---|
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. |
Create 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.
Select 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 other project are linked, then the test cases show Entity Key of the corresponding project.
To view the test case of other project, click on the Test Case Entity Key. It opens the test case detail page in the respective project and will change your current project.
Link Test Case By Entity Key
The feature allows you to link latest version of test case to a requirement using test case entity key separated by comma. Maximum 500 entities can be linked at a time.
Use Case: The feature is useful to link test cases to a requirement without searching them individually. For example, users have 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 link them.
| Info |
|---|
Notes:
|
To link test case by entity key these are the steps:
1. Go to the Test Cases tab of the requirement page.
2. Click on the Link By Entity Key button.
3. It opens the Link Test Cases pop-up. Mention comma separated test case keys on it.
4. Click Link.
The test cases with mentioned keys get linked to the requirement.
Unlink Test Cases from a Requirement
Go to the Test Cases tab of the requirement details page or requirement edit page.
It shows list of test cases linked to the requirement.
Select test case/s you want to unlink and click on the Unlink Selected button.
The test case is unlinked after confirmation.
Sync 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 requirement with the linked test case.
Navigate to:
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Home > Requirement >Test Case tab |
Sync Latest Requirement Version with a Single Test Case
When a new version of requirement is available, the sync icon under the Requirement Version column turns Blue in color. You can click on this icon to sync the latest version of the requirement with the test case.
Sync Latest Test Case Version with Multiple Requirements in Bulk
When a new version of requirement is available, the sync icon under the Requirement Version column turns Blue in color. 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 the selected test case(s) is synced with the latest version of 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 Requirement details page and 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 > Integration.
The "Arrange Columns" option will display all system and custom fields configured for the Issue module in Projects > Integration.
Steps
Go to the Issues tab of the requirement details page or requirement edit page.
Click on the Link button.
It opens the Link Issues pop-up with the list of issues.
Selecting Issues Across Projects:
Users can link issues from multiple projects.
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:
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.
Create 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 QMetry project, users have to select the Jira instance and its project from which they want to link Jira issues to requirements in QMetry.
How to Unlink Issues Linked to a Requirement?
Go to the Issues tab of the requirement details page or the requirement edit page.
It shows the list of issues linked to the requirement.
Select the issue/s you want to unlink and click on the Unlink Selected button.
The issue is unlinked after confirmation.
Associate Releases & Cycles
The tab allows users to associate release and cycle to the requirement. Release and Cycles are added from Projects > Project/Release/Cycle.
Once the requirement is created, the user wants to add it to a particular Scope - release and cycle. For this reason, they edit the requirement and associate new release and cycle to it.
Click on the Add New button to associate the release and cycle with the requirement. The drop-downs are enabled by clicking on the Add New button.
Select the release(s); the cycle list is prompted for the selected release.
Select the cycle. You can select multiple cycles.
Select the version of the entity to associate as you can link releases and cycles to a particular version of the requirement.
Click Save.
The associated release and cycle appear in the grid on the screen.
To remove the release and cycle association with the requirement, click on the Unassociate button for the release and cycle combination.
Issue Traceability in Requirement
In the Requirements module, the issues tab displays issues linked to the requirement either directly or indirectly through the execution of associated test cases.
The following new columns are added to the Issues tab grid.
→ The Priority column on the Issue tab of the requirement shows the priority of issues that need to be fixed.
→ Direct Linkage column:
If the issue is linked from the test execution (i.e. issue linked while execution of the test case to which the requirement is associated), then the Direct Linkage shows “No”.
If the issue is directly logged with the requirement, the Direct Linkage shows “Yes”.
If the issue is linked with the test case without its execution and this test case is associated with the requirement, then the Direct Linkage shows “No”.
If Jira is integrated with the QMetry Project, then the Jira issue will be linked to the requirement only if the Requirement module is synced with a Jira issue type.
Only directly linked issues to requirements can be unlinked using the Unlink icon on the Issue tab.
Issues which are linked from executions can be unlinked from the execution screen.
→ Execution column:
The Execution column on the Requirements > Issues tab shows the count of test executions the issue has been linked to.
Clicking on the count opens the Execution Runs pop-up with execution details of the issue, executed Platform, Release, Cycle, Linkage Level, etc.
The Linkage Level column shows the issue is added on test case level or test step level on the execution screen.
When Jira is integrated with QMetry -
Issue linked while execution appears in the Issues Link section of Jira. It may take upto 15 minutes to reflect in Jira.
The issues logged with requirement appears in the Issue Links section of story in Jira.
If issue is unlinked from QMetry, the jira issue link is also removed.
If Jira issue link is deleted, it only removes the issue link from Jira story, and the issue does not get unlinked/deleted from QMetry.
Requirement Version
Read about Requirement Version
Change Log
Read about Change Log
Import Requirements
You can import requirements into QMetry from an Excel file as well as from Jira.
Importing Requirements from Excel File
Sync Requirements & Issues from Jira
Export Requirements
You can export requirements either as XLSX or CSV Format. Read more about Exporting Requirements.
BDD Editor
You can access BDD / Gherkin Editor in the Requirements module. Read more about BDD Implementation.
More Features
Features common between modules are covered under More Features.