Requirements Module

Introduction

The Requirement module is a central repository for managing test requirements. It allows you to track requirements throughout the development lifecycle and ensure complete test coverage by linking them to test cases. You can create requirements manually, import them via Excel using the Import Wizard, or import them directly from Jira.

Key Features of the Requirements Module

• Add requirements from external development or product management tools.

• Create requirements directly from Jira.

• Link requirements to test cases for coverage.

• Run quick ad hoc executions of linked test cases.

• Generate requirement reports.

Requirements Module

The requirement module grid view offers various customization options.

Managing Grid View

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.

Filtering Assets

Filter requirements using system or custom fields across all modules. To learn more about filters, refer Filtering Assets document.

Folder Management

Organize your requirements in a hierarchical structure using folders. To learn more about available actions, refer to Basic Folder Operations document.

Bulk Operations

Perform bulk copy or move actions at the folder level within or across projects. To learn more, refer to the Bulk Copy/Move document.

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

Displaying Entities from Sub-Folders at Parent Folder

You can include or exclude requirements from sub-folders at the parent folder level.

To hide the entities from the sub-folder:

• Open the Options drop-down as shown in image.

• Deselect Include Entities from Sub-Folder.

Open

Requirements Detail

To access the requirement detail page, click the Requirement Entity Key in the grid view or Right-click the Entity Key to open it in a new tab. The requirement details page contains

A. Individual Section Tabs (Editable)

B. Combined View (Read Only View)

Open

Managing Requirements

Creating New Requirements

To create a new requirement:

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 requirement details.

5. Click Create to save the details.

Requirement Details

1. System Fields

2. User-Defined Fields

You can add user-defined fields to the requirements from Lists under Customization. The user defined fields appear on the Create Requirement and Requirement Details screen.

3. BDD Section

This section appears only if you have added a version control repository under BDD Configuration section in Projects.

4. Risk Analysis

Enter risk analysis details like Risk Type, Risk Category, Likelihood, and Impact. Based on these values, the system calculates the risk priority number, and the extent of testing required. These values help in setting the priority in the right order.

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

Open

To update requirements without creating a new version, perform the following steps:

1. Navigate to the requirements detail screen.

2. Access the Details tab.

3. Hover over the values to edit and use the in-place editor.

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

Creating a New Version of the Requirement

While editing a requirement, you can save the updates as a new version. This helps organizations track changes to specific fields across different versions of the requirement.

Open

To create a new version of a requirement:

1. Click Create New Version.

2. Make the necessary changes and click Save as New Version.

3. Add a comment for the version.

4. Enter a description explaining the relevance of the requirement version.

You can also create a new version of the requirement from the requirement grid view:

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

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 the Share icon.

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

Archiving a Requirement

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:

1. Open the Requirement Details page.

2. Click Archive at the top right corner.

Open

B. Archiving Requirements from the module List view

To archive requirements from the module list view:

1. Select the requirement to archive.

2. Click Archive.

3. Click Yes to Confirm.

Open

Unarchiving a Requirement

To restore an archived requirement, perform the following steps:

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

2. Select Show archived items.

3. Click on the requirement entity key to unarchive.

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

5. Click Yes to confirm.

Open

Also read about Archiving a Specific Requirement Version.

Deleting a Requirement

You can delete a requirement from:

A. The Requirement detail page

B. The Requirement module list view

In both cases, you have to enable Show Archived Items from filters.

Open

A. To Delete from the Requirement Detail Page

1. Click the Requirement Entity Key.

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

Open

B. To Delete from the Requirement list view

1. Select the requirement from the list view.

2. Click the cog icon.

3. Select Delete.

Open

Also Read about Deleting a Specific Requirement Version

Linking Test Cases to Requirements

You can link test cases to their corresponding requirements to track coverage and validation throughout the testing process. This helps ensure full traceability and comprehensive testing against all requirements.

Selecting Test Cases to Link

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

To link test cases:

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

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

3. Select the project and the test cases.

4. Expand each version of the test case by clicking on the + icon and select the specific version to link with the requirement.

5. Click Link to continue linking more test cases.

6. Click Link and Close.

Open

Selecting Test Cases Across Projects

Link test cases from other projects by selecting the project from the Project drop-down menu.

Open

Test Cases of Release and Cycle to this Requirement: When selected, it allows you to link test cases that belong to a specific Release and Cycle to a given Requirement.

Linking Test Cases from Multiple Projects

To link test cases from multiple projects, follow these steps:

• Start by selecting one project, search for the required test cases, and click Link.

• Switch to the next project, search for additional test cases, and click Link and Close.

Creating and Linking New Test Cases

Open

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

1. Click Create New Test Case.

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 and click Link Selected Test Cases.

Linking Test Case by Entity Key 

You can link the latest version of a test case to a requirement using the test case entity key separated by comma. This feature helps link test cases to a requirement without searching them individually.

To link test cases by entity key

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

2. Click Link by Entity Key button.

Open

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

Open

4. Click Link.

Unlinking Test Cases from a Requirement

To unlink test cases from a requirement:

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

2. Select the test cases you want to unlink.

3. Click Unlink Selected.

4. Click Yes to confirm.

Syncing the Latest Requirement Version with Test Cases

The Sync feature in the Test Cases tab allows user to update the linked test cases with the latest version of the requirement, either individually or in bulk.

When a new requirement version is available, the Sync icon in the Requirement Version column turns blue.

• To sync a single test case, click the blue Sync icon next to the test case to update it with the latest requirement version.

• To sync multiple test cases in bulk, select the test cases and click Sync Latest Version of Requirement.

Open

For bulk synchronization, the system displays progress in the Scheduled Task. It shows that the selected test cases are synced with the latest version of the requirement.

Linking Issues to Requirements

You can link issues to requirements through the Issues tab on the Requirement details page and the Requirement edit screen.

Linking Issues from Jira:

• Use the Advanced Filter option to access custom fields configured for the Issue module in Integrations under Projects.

Open

To link Issues from Jira, perform the following steps:

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

2. Click Link.

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

Selecting Issues Across Projects

You can link issues from multiple projects.

• Select Project: Use the Project drop-down to choose a project. The system displays only the issues from the selected project.

• Link Issues: Select the issues to link to the requirement.

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 you have linked issues from other projects, the system displays the Entity Key of the respective project. To view issue details from another project, click the Issue Entity Key. The system opens the issue detail page in that project and switches the current project automatically.

Creating New Issue

Open

You can create a new issue and link it from the link issues page. To create a new issue:

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

• Click the Refresh Icon to see the new issues.

• Select the issues and click Link and Close.

When you have configured a Jira project with a QMetry project, you must select the Jira instance and its project to link Jira issues to requirements in QMetry.

Open

Unlinking 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 issues you want to unlink.

4. Click on the Unlink Selected button.

Associating Releases and Cycles

Open

Once you create the requirement, you can associate release and cycle.

1. Go to requirement detail page.

2. Select the Release & Cycle tab.

3. Click Add New.

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

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

6. Select the requirement version.

7. Click Save.

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

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 Issues tab under Requirements 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.

Bulk Operations on Requirements

You can perform bulk operations on multiple requirements at once. Learn more about available Bulk Operations.

More Features

Features common between modules are covered under More Features.