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

The Issue module allows you to manage issues internally in QMetry. Users can create, view, and modify issues in the QMetry without any integration with external tools to manage the issues. Users can also create custom fields to customize issue details as per business practices.

Users can perform the following tasks in the Issue module:

View, Add, Modify, Delete issues

View and Organize Issue Details

Just click on the Issue Key in the grid view to open the issue detail page on the same page. To open the issue detail page in a new tab/window, right-click on the Issue Key in grid view. Opening issues in different tab/browser make the comparison between issues easier. It also provides quick reference while working on multiple assets. The detail page has one-click access to different sections using organizable tabs.

The details can be view in two ways -

A. Individual Section Tabs

B. Combined View (Read Only View)

image-20240201-083149.png

A. Individual Section Tabs

For Issue: There are individual tabs for Details, Execution Runs, Requirements, Attachments, Comments, Change Log.

Each tab displays relevant details. The details are editable.

Details tab

The Details tab will show you the following details:

Execution Runs

Issues logged from the Test Executions module are displayed here.

View Archived Test Runs

An execution/test run is archived when either Platform/Release/Cycle/Test Suite is archived. When a test suite, platform or Release/Cycle is archived, the test executions having such test suite/platform/release/cycles associated with them will be hidden on the Execution Runs tab of the test case.

The Show Test Runs with Archived Platform(s)/Release(s)/Cycle(s)/Test Suite(s) check box is provided on the Test Executions tab. To view the test runs which are archived either due to platforms/release/cycles, select the check box in the filter.


Execution Time and Remaining Time

Open the issue detail page and open the Execution Runs tab. Users can view Execution Time and Remaining Time calculated for Test Execution.

Use Case: Calculation of Execution Time and Remaining Time for test suite is useful for QA Manager in Test Planning as it gives accurate estimates for the test suite. These test case level estimates refine each time a test suite is executed. Testers can make recommendations to have the test estimates revised based on the last few executions in different environments.

Two columns Execution Time and Remaining Time are added to the grid at the following places in the application:

Calculation of Execution Time of a test suite:

The Execution Time of a test suite is calculated based on the estimated time of all the test cases in that test suite.

Calculation of Remaining Time of a test suite:

Once the test suite is executed, the Remaining Time Is calculated for all “Not Run” test cases. Any test case with “Failed” or “Blocked” status will also be considered as the work still remains on it.

The Remaining Time will be reduced for test cases with “Pass” and “Not Applicable” status accordingly.

Example

The following example shows the calculation of both – Execution Time and 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

Links Requirements

You can link requirements with their relevant issues. You can link single as well as multiple requirements with an issue.

Requirements can be linked to the issue through the Requirements tab of Issue.

Steps

1. Open the Issue details page.

2. Open the Requirements tab.

3. Click on the Link button.

4. It opens the screen with requirements.

You can select requirements on the grid to link to issue. You can filter requirement records to narrow down the list to select from. Labels and Folder path filters are also added for the ease of searching the records.

If you want to link requirements 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.

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.

You can resize columns, apply sorting on columns (other than multi-lookup lists field type), and show/hide columns using the Arrange Columns option.

image-20240130-105842.png

The selected requirements are linked to the issue. The linked requirement records are shown on the screen.

If requirements from other project are linked, then the requirements show Entity Key of the corresponding project.

To view the requirement of other project, click on the Requirement Entity Key. It opens the test case detail page in the respective project and will change your current project.

Link Requirements By Entity Key 

The feature allows you to link latest version of requirement to an issue using requirement key separated by comma. Maximum 500 entities can be linked at a time.

Use Case: The feature is useful to link requirements to an issue without searching them individually. For example, users have list of requirement keys to be linked to an issue, they can use this option to link the requirements directly. This feature will save the users' time in searching requirements in different folders and link them.

Notes:

Steps

1. Go to the Requirements tab of the issue.

2. Click on the Link By Entity Key button.

3. It opens the Link Requirements pop-up. You can apply a filter and search for requirements on Requirement keys.

4. Select the required requirements.

5. Click Link.

The requirements with the mentioned keys get linked to the issue.

Unlink Requirements

Go to the Requirements tab of the issue.

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

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

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 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 can not be edited.

The Previous and Next buttons on the detail page are added for ease of navigation and updation of issues.

Navigation

Once you are on the issue details page, you can go back to the main screen of issues by clicking on the breadcrumbs.

Test cases are added at the Project level. The Issues module main screen displays issues in the Project as per folder selection. You can apply the filter to the columns as mentioned above. Multiple columns can be filtered at once to help users find the required 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.

A. Use of Rich Text Editor allows users to apply text formatting for Description and reduces chances of missing important details. Users can also insert images, hyperlinks, and tables to the field.

B. Source Editor

image-20240201-081431.png

Image Upload Support in Rich Text Editor:

Users can add images to any Large Rich Text Editor field (System as well as Custom) up to 1 MB. The images can be uploaded in the fields (A) by browsing and uploading the image (B) by inserting the image through the URL. (C) by copying and pasting the image directly into the editor/text field without saving it first on the local machines. Multiple images can be copied and pasted at a time.

It is applicable to all the fields across QMetry wherever the rich text editor is available.

You can preview the image just by clicking on it.

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 are jpg, jpeg, png, and gif.

→ The maximum file size should be 1 MB (for images uploaded through browsing).

B.  Users can paste the html/xml content into the Source editor of the "Large Text" field type and it auto-renders the code to show the text outputs on the screen.

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 right to open the source editor.

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

Steps

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

2. Click on the Add Attachments button.

You can attach different types of attachments: files, images, and URL.

The Add Attachment pop-up allows you to upload multiple files at a time.

Add attachments in three ways:

Notes: 

You 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

For example, users can edit the status of the issue. These are system defined status available to add - Open, Re-opened, Resolved, Closed. You can add more status from Manage Fields section. Select the work flow status of the issue. The Status field is a System Field that you can see under Administration > Manage Fields. The list values for the field can be edited/updated from Administration > Lists. The Status field is added to track the issue workflow and its progress.

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

You 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

All grids within the Requirements, Test Cases, Test Suites, and Issues module have an Arrange Columns option that allows users to create a customized view of their test assets.

The view is saved for future use.

The following customization can be applied:

You can search for a particular column through the search box.

Options to select all columns, clear all selected columns, and restore default column selection are provided on the Arrange Columns menu.

Associated Release(s) and Associated Cycle(s) columns are added to the list view of the Issue module to enable the users to view the associated releases and cycles of the issues. You can enable/disable the Associated Release(s) and Associated Cycle(s) columns from the arrange columns option.

image-20240201-081900.png

Organize Tabs

The detail page of QMetry assets has different tabs on it as described above. Users can customize the view of detail page by changing the order of tabs. The tab order is preserved per user. 

For example, the tab order of the Issues 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".

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 (i.e. without specifying the complete Entity Key as described below).

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.

An ability to filter issues on the Associated Release field is added for the projects that are using the internal Issue module.
Use Case: The QA Manager wants to analyze the issues logged for a particular release and, therefore, wants to filter issues of the associated release. It helps them to identify in which release the issues were detected.

The Associated Release(s) and Associated Cycle(s) filters are provided in Advanced Filters on the filter menu. You can also filter the issues on the “None” value for Associated Releases to filter out issues that are not linked to any releases.

Users can filter issues based on the specific release and cycle.

image-20240201-082656.png

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

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 the issues with other users over email. The recipient user will receive an email containing the issue summary with the Message written while sharing the issue and a link navigating to the particular issue. It helps the recipient users easily access the issue.

Steps

  1. Open the issue details page.

  2. Click on the Share icon at the top. The Share pop-up opens.

  3. Enter the Email Address of the user with whom you want to share the asset. You can mention multiple email addresses to share the test asset with multiple users at a time.

  4. Enter the required message that you want to convey to the recipient of the email.

  5. Click on the Share button.

Copy Issue Link

You can copy the link of the test asset to share it further with other team members. It helps you to get the specific test asset and share it with other users through email or chat. The other users with whom the link is shared can access the test asset directly from the link.

→ The following is the syntax of the URL:

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

For example,

https://qtmtest.qmetry.com/#/requirements/FIT-RQ-9634

Steps

  1. Open the issue details page.

  2. Click on the Share icon at the top. The Share pop-up opens.

  3. Click on the Copy Link button.

The issue link gets copied to the clipboard. You can share this link with other team members, whom you want to work on the test asset, either through email or chat or any other communication means.

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

You 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

If user wants a particular issue to be considered as requirement, then the user can add a new requirement from that issue. A requirement is created from the selected issue by copying common field values. This new requirement is created with the same name, which can then be changed as per requirement.

The Issue from where requirement is being created, also get automatically linked to the newly added requirement. On the Issue details page, the Requirements tab displays the requirement created from the issue. On the Requirement details page, the Issues section displays the issue the requirement has been created from. Users with “Create” rights for Requirement can create requirement from issue.

Use Case: User wants to create a requirement with the values similar to an existing issue or user wants to associate a requirement with an existing issue. Hence, users select the issue and create a requirement from it to create linkage between the two.

Steps 

Follow either of the ways:

Email Issue Details to Other Users

Users can send the details of defect/issue to other QMetry users as well as to users outside QMetry. The issue details contain system fields of QMetry. Inclusion of issue attachments depend on the issue tracker.

Steps

1. Open the issue details page the details of which you want to share with other users.

2. Click on the email icon at the top right. A pop-up opens to enter the recipient email addresses separated by comma and send it as an email.