Projects using QMetry internal issue module for Issue (Bug) Tracking

This document is applicable only when your project is not configured with external issue tracker like Jira. If Jira project is integrated with your QMetry project, refer to Projects using Jira integration for Issue (Bug) Tracking

Introduction

The Issue module enables internal issue management within QMetry. Users can create, view, and modify issues without external tool integration. Custom fields can be added to tailor issue details to business needs.

Users can:

  • View, add, modify, and delete issues

  • Manage the Issue Grid by displaying or hiding fields

  • Create custom fields and update system-defined values

  • Perform bulk operations

  • Configure email notifications for various triggers

  • Access issues logged during test execution directly in the Issue module

Notes

  • After integrating QMetry with Jira, issues created in the Issues module before the Jira integration will not be visible on the Issue Grid.

  • Issues created and linked from the Execution screen before the Jira integration will be displayed in read-only mode.

  • When linking an internal issue from the Execution screen, the issue will open in read-only mode if users click on the link.

View, Add, Modify, Delete issues

View and Organize Issue Details

To view the issue detail page:

  • Same Tab: Click the Issue Key in the grid view.

  • New Tab/Window: Right-click the Issue Key and select the appropriate option.

Viewing issues in separate tabs or windows makes comparison easier and provides quick reference. The detail page features organized tabs for easy navigation.

The details can be view in two ways -

A. Individual Section Tabs

B. Combined View (Read Only View)

image-20240723-090227.png

A. Individual Section Tabs

The individual tabs display - Details, Execution Runs, Requirements, Attachments, Comments, and Change Log. Each tab displays relevant details in editable format.

Details tab

In the Details tab, users can edit the following fields

  • Summary: View the summary of the Issue.

  • Priority: Assign priority to the issue by selecting appropriate option from the drop-down. It is a mandatory field.

  • Type: Assign a type to the issue e.g. Bug, New Feature. It is a mandatory field.

  • Status: When an issue is created, it has default status Open.

  • Owner: If you want to assign the issue, then use the Owner field and select the user who will be assignee of the issue.

  • Associated Release(s): Assign relevant release to the issue by selecting appropriate option from the drop-down.

  • Labels: Add respective tags as labels to filter or differentiate the issues.

  • Environment: Enter environment details in which the issue was found e.g., Chrome, Firefox, Production, Staging, etc.

  • Description: Enter the description for the issue. Description can be added either in Plain Text or Rich Text.

  • User Defined Fields: If UDFs are added for the Issues module, then they are displayed on the Create Issue and Issue Details screen.

For Rich Text, the super admin must enable the rich text editor for project from Project > General Settings.

Execution Runs

Issues logged from the Test Executions module are displayed here.

View Archived Test Runs

Execution runs are archived when the associated Platform, Release, Cycle, or Test Suite is archived. When a test suite, platform or Release/Cycle is archived, the test executions associated with them will be hidden on the Execution Runs tab of the test case.

To view archived test runs, select the "Show Test Runs with Archived Platform(s)/Release(s)/Cycle(s)/Test Suite(s)" checkbox on the Test Executions tab.


Execution Time and Remaining Time

To view Execution Time and Remaining Time for a test execution, open the issue detail page and navigate to the Execution Runs tab.

The columns Execution Time and Remaining Time are added to the grid in the following locations within the application:

  • Test Suite Detail Page > Test Executions tab

  • Test Case Detail Page > Test Executions tab

  • Issue Detail Page > Execution Runs

Execution Time of a Test Suite: Calculated based on the estimated time of all test cases within the suite.

Remaining Time of a Test Suite: Calculated for all "Not Run" test cases after execution. Test cases marked as "Failed" or "Blocked" are also considered as having remaining work. The Remaining Time is adjusted for test cases with "Pass" and "Not Applicable" statuses.“Not Applicable” status accordingly.

Example

The following example shows the calculation of both – Execution Time and Remaining Time.

 

Execution time

Status

Remaining time

 

Execution time

Status

Remaining time

TC1

2

Pass

-

TC2

3

Not Applicable

-

TC3

4

Failed

4

TC4

5

Blocked

5

 

14

 

9

Execution Time = 14

Remaining Time = 9

Requirements tab

Link Requirements to Issue

Users can link single or multiple requirements to an issue through the Requirements tab on the Issue details page.

Steps:

  1. Open the Issue details page.

  2. Go to the Requirements tab.

  3. Click the Link button.

  4. On the Link Requirement screen, select requirements from the grid to link to the issue.

  5. Use filters such as Labels and Folder path to refine the list (if needed).

Users can link requirements from different projects by selecting the project from the Project drop-down menu. Requirements for the selected project will be displayed.

Linking Requirements across Projects

Users can link requirements from different projects by selecting the project from the Project drop-down menu. Search records and link them before moving to other projects. Requirements for the selected project will be displayed.

For example, User A is in Project 1 and searches for some records. These records should be linked before moving to Project 2. Otherwise, all the selections of Project 1 will be wiped off.

A. Linking a Single Requirement: Click on the  icon to link the individual requirement to the test case.

B. Linking Multiple Requirements: Select requirements that you want to link and click either on the Link button or Link & Close button at the bottom.

View Linked Requirements

The selected requirements are linked to the issue, and the linked records are displayed on the screen.

For requirements from other projects, the Entity Key of the respective project is shown. Clicking on the Requirement Entity Key opens the detail page in the relevant project and changes the current project view.

Link Requirements By Entity Key 

This feature allows users to link the latest version of a requirement to an issue by using the requirement key, with multiple keys separated by commas.

Steps

  1. Go to the ‘Requirements tab’ of the issue.

  2. Click the Link button to open the Link Requirements pop-up.

  3. Use filters to search for and select the required requirements.

  4. Click Link or Link and close.

The selected requirements will get linked to the issue.

Unlink Requirements

To unlink requirements, follow these steps:

  1. Go to the Requirements tab of the issue.

  2. To unlink a single requirement, click on the Unlink icon for the requirement. The requirement is unlinked after confirmation.

To unlink multiple requirements, select the requirements you want to unlink from the issue and click on the Unlink Selected button.

Attachments

Refer to Managing Attachments for details.

Change Log

The Change Log tab shows changes done in the particular entity like the activity log. The Change Log tab is visible if the Audit & Compliance package is enabled for the QMetry Test Management instance.

Change Logs for requirements, test cases, test suites, and issue modules are available.

Each of the records shows the history with the following details:

  • Actor: The user who has made the change to the test entity.

  • Action: The description of the action that took place.

  • Field: The field in which the value is changed.

  • New Value: This is the updated value of the field.

  • Old Value: This is the original value of the field.

  • Date: The date on which the field value has been changed.

Comments

The tab allows you to add and view comments. Refer to Add Comments for more details.

B. Combined View (Read Only View)

The tab displays a read-only version of the details page, showing all sections on a single page. The information is viewable but cannot be edited.

The Previous and Next buttons on the detail page facilitate efficient navigation and updating of issues.

Navigation

On the issue details page, return to the main issues screen by clicking the breadcrumbs.

Test cases are added at the Project level. The Issues module main screen shows issues based on the selected folder. Users can apply filters to multiple columns simultaneously to find specific issues.

Add Issues / Bugs / Defects

A. Steps to log issue from Issue Module

1. Open the Issue module.

2. Click on the New button on the toolbar.

3. The Create Issues screen opens next.

4. Fill the issue details.

  • Summary: Add the summary of the Issue.

  • Priority: Assign priority to the issue by selecting the appropriate option from the drop-down. It is a mandatory field.

  • Type: Assign a type to the issue e.g. Bug, New Feature. It is a mandatory field.

  • Status: When an issue is created, it has the default status Open.

  • Owner: If you want to assign the issue, then use the Owner field and select the user who will be the assignee of the issue.

  • Associated Release(s): Assign relevant releases to the issue by selecting the appropriate option from the drop-down.

  • Labels: Add respective tags as labels to filter or differentiate the issues.

  • Environment: Enter environment details in which the issue was found e.g., Chrome, Firefox, Production, Staging, etc.

  • User Defined Fields: If UDFs are added for the Issues module, then they are displayed on the Create Issue and Issue Details screen.

  • Description: Enter a description for the issue. Description can be added either in Plain Text or Rich Text.

Image Upload Support in Rich Text Editor:

Users can add images up to 1 MB to any Large Rich Text Editor field (System or Custom) using the following methods:

  • Browse and Upload: Upload the image from your device.

  • Insert via URL: Add the image using its URL.

  • Copy and Paste: Directly paste the image into the editor from the clipboard. Multiple images can be pasted at once.

This feature is available for all rich text editor fields in QMetry. Click on an image to preview it.

To download the image, click on the image and then click on the Download icon at the top right corner.

  • Link Attachments: Users can link attachments while creating issues.

Steps

  1. Navigate to the Link Attachments section on the Create Issue page.

  2. Click the Add Attachments button.

Users can attach files, images, and URLs. The Add Attachment pop-up supports multiple file uploads.

Attachments can be added in three ways:

  • Drag and Drop: Drag files and drop them into the designated area.

  • Browse: Click the Browse section to select and upload files.

  • Paste: Directly paste attachments from the clipboard. This method supports pasting only .png files and allows for quick addition of screenshots without saving them locally.

Users can also remove individual attachments at the uploading stage.

Refer to Managing Attachments for more details.

Edit Issues

QMetry provides an inline editor to edit issue details.

Manage Issue Status

Users can update the status of an issue using system-defined options such as Open, Re-opened, Resolved, and Closed. Additional statuses can be configured via the Manage Fields section.

The Status field, a system field found under Administration > Manage Fields, tracks issue workflow and progress. List values for this field can be edited or updated in Administration > Lists.

B. Steps to log issue from Execution screen of Test Suites Module

Users can log issues at test case as well as test step level. Users can also log issues in bulk. Open the Execution screen and click on the bug icon for test case/test step. Refer to Adding/Linking Issues to Test Case and Test Step for more details.

Delete Issues

Users can only delete issues created in QMetry. Issues can be deleted from the grid or from the detail page.

Delete an Issue from Details tab


Delete an Issue from List View

Delete an Issues in Bulk

Open the Bulk Operations menu.

 

Select the Delete option.

Manage Issue View - Show/Hide fields, Filter issues,  Arrange columns

Grids in the Requirements, Test Cases, Test Suites, and Issues modules feature an Arrange Columns option for customizing the view of test assets.

This view is saved for future use. Customizations include:

  • Show More Columns: Add additional columns to the view.

  • Hide Columns: Remove less important columns from the view.

  • Re-arrange: Change column order using drag and drop.

Users can search for specific columns via the search box. Options to select all columns, clear selections, and restore default settings are available.

The Issue module now includes Associated Release(s) and Associated Cycle(s) columns. These can be enabled or disabled through the Arrange Columns menu.

  • Resize Columns: Users can resize the column width.

  • Organize Tabs - Users can customize the view of the detail page by changing the order of tabs. The tab order is preserved per user. 

Filter Issues

Users can easily filter test assets by any system/custom field on all module grids. It also helps users in carrying out bulk operations. Filters placed horizontally above the grid earlier, are now placed on the tree panel at left.


Apply Filter

Users can apply basic as well as advanced filters to the records.

A. Basic Filters: By default, basic filter fields are provided to filter the records.

B. Advanced Filters: If users need more fields to filter test assets then click on the '+' icon. It opens the drop-down with a list of additional system and user-defined fields corresponding to the module. 

Select the field you want to apply the filter on. The filter parameter is added as Advanced Filters. Apply filter as per your requirement.

Users can click on the '+' icon and select the field Entity Key to search issues using comma-separated entity IDs.

For example, users want to filter test assets on Entity Key, Created By, and Owner, then click on the '+' icon and select the fields on the drop-down list as shown below.

Filter on Release and Cycle

For projects using the internal Issue module, users can now filter issues by the Associated Release field. Advanced Filters in the filter menu include options for Associated Release(s) and Associated Cycle(s).

Users can also filter issues with "None" for Associated Releases to find those not linked to any releases. This allows filtering by specific releases and cycles.

Clear Filter and Sorting

Users can clear the applied filter and sorting to the records.

A. Clear Filter: Click on the Clear Filters button above the module grid or left pane. It will reset the view to default.

B. Clear Sorting: Click on the Clear Sorting button above the module grid.

A. Clear Filter Values

The Clear Filter Values option lets users reset filter values without removing the fields. This allows users to start fresh with the same fields, adjust criteria, and retain empty fields to 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.

Share Issues with Other Users

Share Issues

Users can share issues with other users via email, which includes the issue summary, a personalized message, and a link to the specific issue for easy access.

Steps

  1. Open the ‘Issue’ details page.

  2. Click on the Share icon at the top (refer the image below).

  3. Enter one or more email address(es).

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

  5. Click on the Share button.

Copy Issue Link

Users can copy the issue link and share it with other users to provide direct access to a specific issue. Authorized members can access the issue directly via the shared link.

URL syntax:

https://<URL>>/#/<AssetType>/<AssetKey>

For example,

Steps

  1. Open the issue details page.

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

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

Add new custom fields, add new values to system-defined fields

Users can add custom fields and new values to system fields as per your business practices from the Manage Fields section. Refer to Manage Fields for more details.

Set e-mail Notifications for multiple triggers

Refer to Notifications for more details.

Log Issues/Bugs/Defects from Execution Screen

Issues logged from the execution screen while execution will be available in the Issue module. Refer to Adding/Linking Issues to Test Case and Test Step for more details.

Import Issues

Importing Issues from Excel File

Export Issues

Exporting Issues to CSV Format /XLSX Format

Create Requirement from Issue

To create a requirement from an issue:

  1. Select the issue and add a new requirement.

  2. The new requirement will copy common field values and use the same name, which can be edited.

The original issue will be linked to the new requirement. On the Issue details page, the Requirements tab shows this new requirement, and on the Requirement details page, the Issues section shows the originating issue. Only users with "Create" rights for Requirements can perform this action.

Steps 

Follow either of the ways:

  • Select an issue on grid pane and click Add on the toolbar > point to From Issue > select Requirement

  • Right click an issue on the grid pane > point to From Issue > select Requirement

Email Issue Details to Other Users

Users can send defect/issue details to both QMetry and external users. The details include QMetry system fields, and attachments are included based on the issue tracker.

Internal Tracker: Attachments are sent in a zip file (up to 25 MB) if using a QMetry internal issue tracker.

Steps:

  1. Open the issue details page.

  2. Click the email icon at the top right.

  3. Enter recipient email addresses (separated by commas) and send the email.a and send it as an email.