Requirements Module

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, making it easier for teams to align testing with business needs.

You can create requirements manually or import them via Excel using the Import Wizard or import directly from Jira. Once requirements are imported, existing and newly created test cases can be linked to them.

Open

Key Features of the Requirements Module

• Add requirements from external development and product management tools.

• Create requirements directly from Jira and maintain sync with Jira.

• Link requirements to existing test cases that are part of manual or automated test suites.

• Perform quick ad hoc executions of test cases associated with a particular requirement. This can help you do quick tests based on pure requirements that might not be covered in a defined test suite.

• Requirement reports are also available to analyze the application against varied measures.

Requirements Module UI

The requirement module grid view offers various customization options.

Sorting and Clear Sorting

You can sort the folder structure either alphabetically or by date (newest first or oldest first).

Sorting

Open

 

Clear Sorting

Open

Filtering 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

Open

 

Advanced Filters

 

Open

To apply advanced filters, perform these steps:

1. Click on the “+” icon.

2. Select the desired fields for filtering.

3. Enter the filter values.

4. 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.

Applying Filters 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, will be available to filter requirements.

If you want to apply Jira Filters, first select –

1. 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.

2. Once this filter is applied, you can see more filters by clicking on the + button.

Open

The filters applied to the records will be retained 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.  For example, Fix versions.

Resetting Filters and Clearing Filter Value 

The Clear Filter Values clears out the values in the filters without removing the fields themselves.

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

Open

 

Clear Filter Values

 

Open

 

Managing 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

Open

Include/Exclude Entities from Sub-Folders at Parent Folder

You can include or exclude requirements from sub-folders 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 the sub-folder, open the Options drop-down on the test asset tree at left, and select deselect Include Entities from Sub-Folder.

Open

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

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 the grid view. Opening requirements in different tab/browsers makes a comparison between requirements easier. It also provides quick references while working on multiple assets.

Open

Navigation

QMetry enables seamless navigation within requirements. Refer to the QMetry User Navigation page for details.

Organizing 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 project "PRO1".

Open

Tabbed View vs. Combined View

The requirement details page contains

A. Individual Section Tabs (Editable)

B. Combined View (Read Only View)

Open

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 in these tabs are editable.

Open

Refer to the Manage Attachments to learn more about the attachments tab.

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

Manage your requirements within the requirement module by creating, editing, copying, moving, archiving, and deleting them to stay organized and aligned.

Creating New Requirements

To create a new requirement, perform the following steps:

1. Go to the Requirements module.

2. Select the folder where you want to create the requirement.

3. Click the New button.

Open

4. Enter the following details on the creation screen:

System Fields

All About Rich Text Editor

• 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.

Open

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.

5. 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.

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 an Excel File.

Open

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.

Open

To update requirements, perform the following steps:

1. Navigate to the requirements details screen.

2. Access the Details tab.

3. Hover over the values to edit.

4. Enter the new values and click the checkmark to save your changes.

In-place editing will update the existing requirement.

Creating a New Version of the Requirement

If the user 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.

Use Case: Many organizations track requirement details by version to monitor changes in specific fields, allowing for effective version management.

To create a new version of a requirement, perform the following steps:

Open

1. Click on the Create New Version icon on the header.

2. The next screen opens in editable mode.

3. Make the necessary changes and click on Save as New Version to create a new version with the updates.

4. Add a comment for the version.

5. 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:

1. Go to the requirement grid view.

2. Click on the Cog icon for the requirement and select Create New Version.

3. Repeat the same steps as mentioned above.

Open

Archiving a Requirement

Once a requirement is archived, you cannot perform any operations on it. You can archive a requirement in two ways:

A. Archiving from the Requirement Details Page

B. Archiving from the Requirements Module List View

A. Archiving from the Requirement detail page

To archive a requirement from the detail page, perform the following steps:

1. Open the Requirement Details page.

2. Click on the Archive icon in the top right corner.

3. This will archive all versions of the requirement.

Open

B. Archiving Requirements from the module List view

To archive requirements from the module list view, perform these steps:

1. Open the Requirements module to display the list of requirements within the selected folder.

2. Click the Archive icon for the requirement to be archived and confirm the action.

3. The requirement will be archived upon confirmation.

Open

Unarchiving a Requirement

To restore an archived requirement, perform these steps:

1. Navigate to the Requirements module and click on the filter icon.

2. Select the option to display archived items.

3. Click on the requirement entity key you wish to unarchive.

4. On the requirement details page, click the unarchive icon.

5. Confirm the action by clicking "Yes".

Open

Archiving a Specific Requirement Version

Read about Archiving a Specific Requirement Version.

Deleting a Requirement

To delete a requirement, you need to perform the following:

1. Archive a requirement (All the versions of the requirement are archived).

2. Delete a requirement (The requirement will be deleted, including all its versions).

All the versions of the requirement should 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:

1. Open the requirement detail page.

2. Click on the Delete icon at the top right corner of the screen.

Once the requirement is archived, it looks like below.

Open

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.

Open

Deleting a Specific Requirement Version

Read about Deleting a Specific Requirement Version

Sharing Requirements with Other Users

You can share requirements summary and other details with other users through a link for easy access to the latest version of the requirement.

To share a requirement, perform the following steps:

1. Open the “Requirement” details page.

2. Click on the Share icon at the top.

3. Enter one or more email addresses.

4. Write a message (optional but recommended) describing the requirement or expected action.

5. Click on the Share button.

Open

You 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:

To share a requirement, perform the following steps:

1. Open the requirement details page.

2. Locate and click on the Copy Link icon on the breadcrumb navigation.

3. You can share this link via any preferred communication channel.

Open

Bulk Operations on Requirements

Read about Bulk Operations

Linking Test Cases to Requirements

Test cases can be 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 the test case with the requirement gives relevance between the two as to what is developed and what to test.

Test Cases can be linked to a requirement from - The requirement Details Page and the Requirement Edit Screen.

To link test cases, perform the following steps:

1. Navigate to the Test Cases tab on the Requirement details page or Requirement edit page.

2. Click the Link button to open the Link Test Cases screen.

3. Select the test case from the current project or cross-project.

4. Click Link to continue linking more test cases.

5. Click Link and Close.

Open

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.

Open

• 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.

Creating and Linking New Test Cases

You can also create a new test case from the Link Test Cases Screen.

Open

To create a new test case from this screen, perform the following steps:

1. Click on the Create New Test Case link at the top right of the pop-up.

2. This opens the Test Cases module in a new tab.

3. Perform the steps for Creating Test Cases.

4. Click Create to save the test case.

5. After creating the test cases, refresh the Link Test Cases pop-up to display the new test cases.

6. Select the test cases to link and click on the Link Selected Test Cases button.

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 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 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 link them.

To link test cases by entity key, perform the following steps:

1. Go to the Test Cases tab of the requirement page.

2. Click on the Link By Entity Key button.

Open

3. It opens the Link Test Cases pop-up. Mention comma-separated test case keys on it.

Open

4. Click Link.

The test cases with the mentioned keys get linked to the requirement.

Unlinking Test Cases from a Requirement

1. Go to the Test Cases tab of the requirement details page or the requirement edit page.

2. It shows a list of test cases linked to the requirement.

3. Select the test case/s you want to unlink and click on the Unlink Selected button.

4. 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 requirements with the linked test case.

Navigate to the Requirement module. Go to the Test Case tab.

Syncing the Latest Requirement Version with a Single Test Case

When a new version of a 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.

Open

Syncing the 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. Select the test cases to sync the latest requirement version and click on the Sync Latest Version of Requirement button.

Open

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 case(s) 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 to manage 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.

Open

Steps

1. Go to the Issues tab of the requirement details page or the requirement edit page.

2. Click on the Link button.

3. It opens the Link Issues pop-up with the list of issues.

Selecting Issues Across Projects:

Users can link issues from multiple projects.

1. Select Project: Use the Project drop-down to choose the project. Issues from the selected project will be displayed.

2. 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:

1. Select and link issues from one project first.

2. 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.

Open

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

Open

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. 

Open

How to Unlink Issues Linked to a Requirement?

1. Go to the Issues tab of the requirement details page or the requirement edit page.

2. It shows the list of issues linked to the requirement.

3. Select the issue/s you want to unlink and click on the Unlink Selected button.

4. The issue is unlinked after confirmation.

Associating Releases & Cycles

The tab allows users to associate release and cycle to the requirement. Release and Cycles are added from Project Management > Releases & Cycles.

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 releases, and cycle to it.

1. Click on the Add New button to associate the release and cycle with the requirement. The dropdowns are enabled by clicking on the Add New button.

2. Select the release(s); the cycle list is prompted for the selected release.

3. Select the cycle. You can select multiple cycles.

4. Select the version of the entity to associate as you can link releases and cycles to a particular version of the requirement.

5. Click Save.

The associated release and cycle appear in the grid on the screen.

Open

To remove the release and cycle association with the requirement, click on the Unassociate button for the release and cycle combination.

Issue Traceability in Requirements

In the Requirements module, the issues tab displays issues linked to the requirement either directly or indirectly through the execution of associated test cases.

Open

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 the test case level or test step level on the execution screen.

Open

When Jira is integrated with QMetry -

• Issue linked while execution appears in the Issues Link section of Jira. It may take up to 15 minutes to reflect in Jira.

• The issues logged with requirements appear in the Issue Links section of the story in Jira.

• If the issue is unlinked from QMetry, the Jira issue link is also removed.

• If the Jira issue link is deleted, it only removes the issue link from the 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 in 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.