Back to QMetry All Products Help Page
Requirements Module
- 1 Organizing Requirements
- 2 Managing Requirement Folders
- 3 Adding and Managing Requirements
- 4 Bulk Operations on Requirements
- 5 Linking Test Cases to Requirements
- 6 Linking Issues to Requirements
- 7 Associate Releases & Cycles
- 8 Issue Traceability in Requirement
- 9 Requirement Version
- 10 Change Log
- 11 Import Requirements
- 12 Export Requirements
- 13 BDD Editor
- 14 More Features
Organizing Requirements
The Requirements module serves as a central repository to store test requirements or business specifications. Users can create requirements manually, or import using Excel using import wizard or from Jira.
Once requirements are imported, existing test cases can be linked to these requirements.
Key Features of the Requirements Module:
Integration with External Tools: Add requirements from external development and product management tools.
Link Test Cases: Associate requirements with existing test cases from manual or automated test suites.
Ad Hoc Test Executions: Quickly execute test cases linked to specific requirements to perform tests outside of defined test suites.
Requirement Reporting: Generate reports to analyze the application based on various measures.
Requirements Module UI
The Requirement module offers various customization options to help users create a tailored view of their test assets. Below are the key features of the Requirement Module:
Manage Grid Columns
QMetry offers the "Arrange Columns" feature in the requirement module, enabling users to personalize their view, which is automatically saved for future sessions. Users can manage their view using the 'Arrange Column' icon () located at the top right of the screen (Refer below image).
The following customization can be applied:
Show More Columns: The ability to add columns in the view. If there are other columns that you think are important to display on the module grid apart from the default view, then you can just select those columns to add them to the view.
Hide Columns: The ability to remove a column from view. If you do not want to include columns of less importance on the module grid view, then remove column selection to hide those columns on the view.
Re-arrange: The ability to arrange the columns in a different order through drag and drop functionality.
Resize Columns: Users can adjust column widths by dragging the boundary between column headings to expand or reduce width, as needed (Refer below image).
Organize Tabs: The QMetry asset detail page includes multiple tabs that users can customize by rearranging their order. Each user's tab arrangement is saved individually.
Search: Users can locate specific columns using the search box. The Arrange Columns menu provides options to select all columns, clear all selected columns, and restore the default column selection.
Requirement Detail Page
To view the requirement detail page, click on the Requirement Key in the grid view.
Combined View vs. Grouped View
The requirement details page contains -
A. Individual Section Tabs
B. Combined View (Read Only View)
A. Individual Section Tabs
Individual tabs includes - Details, Test Cases, Release & Cycles, Issues, Version, BDD (if configured), Attachments, Comments, and Change Log. Each tab displays relevant details that are editable.
B. Combined View (Read Only View)
The tab displays the previous version of the details page. Users can view information from all sections on a single page. The details shown are read-only and cannot be edited.
Users can easily navigate between requirements by using the previous (<) and next (>) buttons.
Filter Requirements
Users can filter test assets by any system or custom field across all module grids, which also facilitates bulk operations.
Apply Filter
Users can apply basic and advanced filters to records.
Basic Filters: Default filter fields are provided for standard record filtering.
Advanced Filters: To access additional filtering options, click the '+' icon. Select the desired field to add it as an Advanced Filter and apply it according to your needs.
Users can click on the '+' icon and select the field Entity Key to search requirements using comma-separated entity IDs (i.e without specifying the complete Entity Key as described below).
Apply Filter when Jira is Configured with Project
If the QMetry project is synchronized with at least one Jira project, Jira Filters will be enabled for the Requirements module. Two filtering options are available: QMetry Filters and Jira Filters.
To apply Jira Filters:
Select the Jira Instance and Jira Project associated with the QMetry project and click Apply. If only one Jira Instance and Project are configured, they will be auto-selected.
After applying this filter, additional filtering options can be accessed by clicking the '+' button.
Notes:
Filters applied to records are saved and will be automatically reapplied when revisiting the screen.
Jira fields used for filtering, such as Fix Versions, do not appear in the Requirements list view.
Clear Filter and Sorting
Users can reset filters and sorting applied to records as follows:
Clear Filter: Click the Clear Filters button located above the module grid or in the left pane. This action will reset the view to its default state.
Clear Sorting: Click the Clear Sorting button above the module grid to remove any sorting applied.
A. Clear Filter Values
The Clear Filter Values option enhances flexibility and usability by clearing only the filter values while retaining the filter fields. This allows users to start with the same set of fields and adjust their criteria without recreating the entire filter setup. Empty fields will include all records, and users can easily modify and refine their filter criteria without losing the existing fields.
B. Reset Filters
The Reset Filters option will reset the filter to default. All the selected fields for Advanced Filter will be removed from the filter.
Include/Exclude Requirements from Sub-Folders
Users can include or exclude test assets from sub-folders in the parent folder.
By default, Include Entities from Sub-folder is selected, displaying entities from sub-folders at the parent folder level in the module list view.
To exclude entities from sub-folders, open the Options drop-down on the test asset tree on the left and deselect Include Entities from Sub-Folder.
Navigation
On the requirement details page, users can return to the main screen of the requirement by clicking on the breadcrumbs.
Managing Requirement Folders
Users can organize requirements by creating folders. New folders can be added either at the root level or as sub-folders within existing folders.
Adding a Requirement Folder
Open the Requirements module. The tree/folder panel is expandable to accommodate longer folder names. Hover over a 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.
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.
Editing a Requirement Folder
Select the folder on the tree and click the Edit icon on the toolbar. The folder detail screen will open in editable mode, allowing users to make the necessary changes.
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.
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.
Adding and Managing Requirements
Users can easily add and manage new requirements in QMetry through an intuitive interface that allows for seamless integration, organization, and tracking of requirement-related information.
Adding a Requirement
Users can easily add and manage new requirements in QMetry through an intuitive interface that allows for seamless integration, organization, and tracking of requirement-related information. Adding a Requirement
To add a requirement, here are the steps:
Open the Requirements module.
Select the folder where the requirement will be created.
Click the New button on the toolbar to open the Create screen.
Enter the requested details.
Click Create to create a new requirement.
Details for Creating a Requirement
Summary: Enter the requirement name.
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: Provide a detailed description using either Plain Text or Rich Text format. Rich Text Editor enables users to format text, insert images, hyperlinks, and tables. Users can upload an image or copy-paste the image in jpg, jpeg, png, or gif format.
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.
To download the image, click on the image and then click on the Download icon at the top right corner.
Notes:
The supported file formats to upload/copy-paste the image are jpg, jpeg, png, and gif.
Images up to 1 MB can be uploaded.
To preview or download an image, click on it and use the options provided.
For HTML/XML content, use the Source editor for the Large Text field type.
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 test asset. To create a new version of the test asset, follow the steps outlined below.
Create a New Version of Requirement
If the user role has Versioning rights (set in Customization > Roles), the Create New Version button will be visible. When editing requirement details, users can save the changes as a new version of the requirement.
B. 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. The modifications will be reflected in the new version.
Version Comment: Enter description explaining the relevance of the requirement version.
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.
Archiving a Requirement
Once a requirement is archived, further operations such as adding attachments, linking test cases, issues, or release cycles cannot be performed.
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.
To unarchive an archived requirement, click on the Unarchive icon at the top right corner.
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.
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,
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.
Link Test Cases
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 or edit page.
Click the Link button to open the Link Test Cases pop-up.
In the pop-up, users can:
Resize columns
Sort columns (excluding multi-lookup lists)
Show or hide columns using the Arrange Columns option
Filtering Test Cases
Users can apply Basic and Advanced Filters on the Link Test Cases screen to efficiently filter test cases for linking with requirements.
Basic Filters: Default filter fields are available for initial filtering.
Advanced Filters: Click the + icon to access additional system and user-defined fields. Select the fields for filtering and apply as needed.
A. Clear Filter Values
The Clear Filter Values option allows users to reset filter values while retaining the filter fields. This feature enables users to adjust filter criteria without recreating the filter setup. Empty fields in the filter will include all records.
B. Reset Filters
The Reset Filters option will reset the filter to default. All the selected fields for Advanced Filter will be removed from the filter.
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.
For test cases with multiple versions, users can expand the test case to view all versions 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 users switch projects before linking, any selections made in the current project will be lost. For example, if User A is working in Project 1 and searches for records, these must be linked before moving to Project 2.
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.
Count of Linked Test Cases
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.
Notes:
Test Case key will be ignored if 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 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 latest unarchived version of test case will be linked.
To link test case by entity key these are the 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 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
Users can synchronize the latest version of a requirement with its linked test cases either individually or in bulk. The synchronization feature allows users to update the requirement version for individual test cases or for multiple test cases simultaneously.
Navigate to:
- 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. Users 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 a requirement is available, the sync icon under the Requirement Version column turns blue. Users should select the test cases they want to update with the latest requirement version, then click 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. Users can view which selected test cases have been updated with the latest requirement version.
Linking Issues to Requirements
Users 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.
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.
Users can use both Basic and Advanced Filters on the Link Issues screen to refine their search by system or custom fields.
Basic Filters: These are provided by default to filter records.
Advanced Filters: For additional filtering options, click the '+' icon to access a drop-down list of extra system and user-defined fields. Select the desired field to add it as an Advanced Filter and apply it as needed.
Clear Filter Values
The Clear Filter Values option allows users to reset filter values while retaining the filter fields. This feature enables users to adjust filter criteria without recreating the filter setup. Empty fields in the filter will include all records.
Reset Filters
The Reset Filters option will reset the filter to default. All the selected fields for Advanced Filter will be removed from the filter.
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, then the test cases show the Entity Key of the corresponding project.
To view the issue of other projects, click on the Issue Entity Key. It opens the issue detail page in the respective project and will change 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.
Back to QMetry All Products Help Page