Projects using Azure integration for Issue (Bug) Tracking

This document is applicable only when the QMetry project is configured with a Azure project.

Issue module allows you to have bi-directional integration between QMetry and Azure, which  means you can add and edit issues from QMetry to Azure. Issues added / edited in Azure will be reflected in QMetry. Users can create, view, and modify issues in the QMetry that will be synced in Azure.

Users can perform the following tasks in the Issue module:

  • View/ Add/ Modify Azure issue details, comments and attachments

  • Map Azure custom fields with QMetry

  • Issues logged from the execution screen while execution will be available in the Issue module.

After integrating QMetry project with Azure -

  • QMetry issues added from the Issues module before Azure integration will not be displayed on the Issue grid.

  • QMetry issues created and linked from Execution screen before Azure integration will be displayed in read-only mode.

  • If users click on the link of an internal issue which is linked from the execution screen, its detail window open in read-only mode.

View, Add, Modify 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 makes a 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.


For Issue: There are individual tabs for

  • Details

  • Execution Runs

  • Requirements

  • Attachments

  • Comments

Details tab

The Details tab displays the issue details as per Azure.

  • External Key: This is the Azure issue key number clicking on which takes users to the Azure issue page.

  • Title: View the summary of the Issue.

  • Priority: View priority to the issue. The Priority list will be displayed as in Azure.

  • Work Item Type: View the issue type synced with the Issue module while integration.

  • Tags: View the list of Azure tags in QMetry.

  • Stack Rank: View list of Azure in QMetry.

  • Effort: View list of Azure in QMetry.

  • Assigned To: This will be the Azure Assignee.

  • Area Path: Browse the folder in Azure and select the path.

  • Iteration Path: Browse the folder in Azure and select the path.

  • State: View Azure workflow Status of the issue in QMetry. This is a Read-only field.

  • Created By: Azure user who has reported the issue.

  • Team Project: This is a read-only field synced from Azure.

  • Description: Enter the description for the issue in plain text.

  • Azure Custom Fields: View Azure custom fields, if any.

  • Created Date: The date on which the issue was created in Rally.

  • Changed Date: The date on which the issue was updated in Rally.

Note: Watcher, Owner and Assigned Release are not available for projects integrated with Azure.

Execution Runs

Issues logged from Test Executions module are displayed here.

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 displayed on the grid at the following places in the application:

  • Test Suite detail page > Test Executions tab

  • Test Case detail page > Test Executions tab

  • Issue detail page > Execution Runs tab

Calculation of Execution Time of a test suite:

Execution Time of a test suite is calculated based on Estimate 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 of 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.

Requirements tab

Link Requirements to Issue

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

  • Project: You can link requirements from across projects. Select the Project the requirements of which you want to link with the issue. You can link requirements from multiple projects.

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

 

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

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 requirements you want to unlink from the issue and click on the Unlink Selected button.

 

Attachments

Users can also view, download, and add attachments in QMetry.

Comments

Users can also view, add, edit, delete Azure comments (Discussions) in QMetry.

Add Issues / Bugs / Defects

A. Steps to log issue from Issue Module to Azure

1. Open the Issue module.

2. Click on the New button on the toolbar. The Create Issues screen opens next.

3. Select Azure Instance.

Logging an issue for the First Time

You will be asked for Azure authentication through pop-up.

Enter Azure API Key to authenticate the user.

 

To Edit/Revoke Authentication

If your Azure credentials are changed, then follow Revoke Authentication to modify the credentials in QMetry.

4. Select Azure Project and Work Items.

 

Issues added from the Issue module or from the Execution screen will be created in Azure only.

Users can click on the External Key in the Issue module, which opens the issue detail page in Azure, while the Entity Key opens the issue detail page in QMetry.

The issue details to enter depends on whether you are adding issues in the internal tracker of QMetry or in Azure.

  • If you do not have Azure configured with the project you are currently working on, then enter details in the QMetry fields.

  • If you have configured Azure with the project you are currently working on, then the add issue screen contains Azure issue fields that you need to enter. You can add defects from the Issue module as well as the Execution screen of QMetry.

5. Fill in the issue details.

  • Summary: View the summary of the Issue.

  • Priority: View priority to the issue. The Priority list will be displayed as in Azure.

  • Work Item Type: View the issue type synced with the Issue module while integration.

  • Tags: View list of Azure tags in QMetry.

  • Stack Rank: View list of Azure in QMetry.

  • Effort: View list of Azure in QMetry.

  • Assigned To: This will be the Azure Assignee.

  • Area Path: Browse the folder in Azure and select the path.

  • Iteration Path: Browse the folder in Azure and select the path.

  • State: View Azure workflow Status of issue in QMetry. This is a Read-only field.

  • Created By: Azure user who has reported the issue.

  • Team Project: This is a read-only field synced from Azure.

  • Description: Enter description for the issue in plaint text.

  • Azure Custom Fields: View Azure custom fields, if any.

 

Edit Issues

QMetry provides an inline editor to edit issue details.

Note: Azure issue State is a read-only field in QMetry and can not be edited.

 

Attachments and Comments

The following table describes what operations can be performed on Attachments and Comments when Azure is integrated with QMetry project.

Allowed Operations

Attachments

Comments

Allowed Operations

Attachments

Comments

Can be added while creation of an issue?

N

N

Can be added  while editing the issue?

Y

Y

Can be Edited?

NA

Y

Can be Deleted?

N

Y

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

Users can log issues at the 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 the test case/test step. Refer to Adding/Linking Issues to Test Case and Test Step for more details.

 

Creating Issues at Step Level for Automated Test Cases

If an error encounters while an automated test run, the generated Error Message and Trace are displayed in the respective columns on the test execution screen. When users create an issue at the test step level from the execution screen, a .txt file containing this Error Message and Trace gets attached to the issue.

On opening the issue in QMetry, the Attachment tab in QMetry shows the .txt file attached to it which contains Error Message and Trace generated while the automated test run.

Delete Issue

  • Users can not delete Azure issues from QMetry. If an issue is deleted from Azure, then it will get deleted from QMetry and its linkages to the QMetry test case/test step will be removed as well.

When Azure Configuration is Removed

  • On removing the integration of Azure project with QMetry project, all the issues that are created from QMetry Issue module into Azure will not be visible in the Issue module in QMetry.

  • For Azure issues logged while execution, the association of such Azure issues with respective test case/test step will be removed.

  • Issues created in QMetry internal tracker before Azure integration will start displaying in the issue grid.

Manage Issue View

The following columns are displayed on the list view:

  • Entity key

  • Title

  • External Key

  • Type

  • Status

  • Priority

  • Resolution

  • Assignee

  • Reporter

  • Created Date

  • Changed Date

 

  • Resize Columns: The ability to expand and reduce column width. If you want to display the full content of the column, then you may want to change the column width. To change the width of one column, just place the cursor in between the columns and drag the boundary on the right side of the column heading until the column gains the width that you want.

 

Organize Tabs

The detail page of QMetry assets has different tabs on it as described above. Users 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 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 fields 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.

External Key: You can search issues by External Key of Azure by adding comma-separated keys in the field.

 

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 systems and user-defined fields corresponding to the module. 

Select the field you want to apply a 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).

Clear Filter and Sorting

Users can clear the applied filter and sorting on 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.

Map Azure custom fields with QMetry

System fields are mapped automatically and displayed as selected. These fields are displayed as read-only. Users can select custom fields they want to map. All the fields that are selected on this screen will be displayed in the Issue module.

If you want to make the Reporter field mandatory then keep the flag On.

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.

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:

  • 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

Edit/Revoke Existing Azure Authentication

If you are adding an issue very first time, then Azure Authentication window pops up asking for Azure credentials to authenticate the operation. The pop-up does not appear next time.

Now you have already provided Azure credentials very first time but you still wish to display the Azure Authentication window again while creating a new issue or editing an issue, then you can revoke the set Azure credentials.

  1. Go to Integration > Integrations.

  2. Open the cog icon and click Revoke credentials.

Status:

Once the Issue is added, you can see the following tabs:

  • Details

  • Execution Runs

  • Requirements

  • Attachments

  • Comments

Edit Issue Details

Once the issues is added, open the Issue details page to view / edit the details.

Note: Users can not edit the field values of Work Item Type and State fields of external issues. The fields appear in read-only mode.

Delete Existing Azure Integration

If the Azure Integration configuration is not required any more, then you can delete the configuration.

  1. Go to Integration > Integrations.

  2. Open the cog icon and click Delete for the configuration you want to delete.