Projects using Rally integration for Issue (Bug) Tracking

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

The Issue module enables bi-directional integration between QMetry and Rally. Users can add and edit issues in QMetry, and these changes will sync with Rally. Similarly, issues added or edited in Rally will be updated in QMetry. Users can create, view, and modify issues in QMetry, with all changes synchronized to Rally.

Users can perform the following tasks in the Issue module:

  • View/ Add/ Modify Rally issue details, Add/Delete comments, Add attachments

  • Map Rally custom fields with QMetry

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

After integrating QMetry project with Rally -

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

  • QMetry issues created and linked from Execution screen before Rally 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

Click the Issue Key in the grid view to view details in the same tab. Right-click the Issue Key to open it in a new tab or window. This allows easier comparison and quick reference, with organizable tabs for different sections.

image-20240807-082417.png

Details tab

The Details tab shows the issue details as per Rally.

  • Name: View the summary of the Issue.

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

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

  • Creation Date: View the date on which the issue is created.

  • Owner: Rally user who has reported the issue.

  • Scheduled State: View Scheduled State of the issue. The list will be displayed as in Rally.

  • Tags: View list of Rally tags in QMetry.

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

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

  • Resolution: View resolution to the issue. The Resolution list will be displayed as in Rally.

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

  • Rally Custom Fields: View Rally custom fields.

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

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

Watcher and Assigned Release are not available for projects integrated with Rally.

Execution Runs

Issues logged from the 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.

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

Linking Requirements to Issues

Users can link individual or multiple requirements to issues using the Requirements tab on the Issue page.

Steps:

  1. Open the Issue details page.

  2. Go to the Requirements tab.

  3. Click the Link button to display the requirements screen.

  4. Select the requirements to link to the issue. Use filters, including Labels and Folder Path, to narrow down the list.

Project Selection:

  • Requirements can be linked from different projects. Choose the project containing the requirements to link. Users can link requirements from multiple projects.

  • To link requirements from different projects, select a project, link the records, and then move to the next project. Be aware that selecting a new project will clear previous selections.

Linking Requirements:

  • Single Requirement: Click the Link icon to attach an individual requirement.

  • Multiple Requirements: Select the desired requirements and click either the Link button or Link & Close button.

The selected requirements are linked to the issue and displayed on the screen. If requirements from other projects are linked, they will show the Entity Key of the respective project.

To view requirements from other projects, click the Requirement Entity Key. This action opens the test case detail page in the corresponding project and switches the current project.

Unlink Requirements

  • Go to the Requirements tab on the issue page.

    • To Unlink a Single Requirement: Click the Unlink icon next to the requirement and confirm the action.

    • To Unlink Multiple Requirements: Select the requirements to unlink and click the Unlink Selected button.

Attachments

Users can view, download and add Rally attachments in QMetry. Attachments can be added while creating as well as editing an issue. Attachments can only be deleted from Rally.

Comments

Users can also view, add and delete Rally comments (i.e. Discussions) in QMetry.

Add Issues / Bugs / Defects

Steps to Log an Issue from the Issue Module to Rally

  1. Open the Issue module.

  2. Click the New button on the toolbar to open the Create Issues screen.

  3. Select the Rally Instance.

→ First-Time Login: When logging an issue for the first time, a pop-up will prompt for Rally authentication. Enter the Rally API Key to authenticate.

→ To Edit/Revoke Authentication: If Rally credentials are changed, follow the Revoke Authentication to update the credentials in QMetry.

4. Select the Rally Instance, Rally Project, and Work Items. The lists will populate based on the Rally configuration with the QMetry project.

Issues created in the Issue module or Execution screen will be added to Rally. Users can click the External Key to view the issue in Rally, or the Entity Key to view it in QMetry.

  • Without Rally Configuration: Enter details in QMetry fields.

  • With Rally Configuration: The add issue screen will display Rally fields for completion.

Defects can be added from both the Issue module and the Execution screen in QMetry.

 

6. Fill the issue details.

  • Name: View the summary of the Issue.

  • Owner: Rally user who has reported the issue.

  • Scheduled State: Select Scheduled State of the issue. The list will be displayed as in Rally.

  • Tags: Select Rally tags in QMetry.

  • Priority: Select priority to the issue. The Priority list will be displayed as in Rally.

  • Resolution: Select resolution to the issue. The Resolution list will be displayed as in Rally.

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

  • Rally Custom Fields: Enter Rally custom fields, if any fields are added.

  • Link Attachments: Users can link attachments while creation of Rally issues from QMetry.

Steps to Add Attachments:

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

  2. Click on the Add Attachment 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 into the designated area.

  • Browse: Click Browse to select and upload files.

  • Paste (Ctrl + V): Paste .png files directly from the clipboard, allowing users to add screenshots without saving them locally.

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

Notes:

  • Up to 100 files can be attached, with a maximum total size of 60 MB.

  • QMetry does not support the following file extensions: .exe, .dll, .sh, .msi, .deb, .bat.

Users can also remove individual attachments at the uploading stage.

Edit Issues / Bugs / Defects

QMetry provides an inline editor to edit issue details.

Attachments and Comments

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

Allowed Operations

Attachments

Comments

Allowed Operations

Attachments

Comments

Can be added while creation of an issue?

Y

N

Can be added while editing the issue?

Y

Y

Can be Edited?

NA

N

Can be Deleted?

N

Y

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

  1. Open the Execution screen and click the bug icon next to the test case or test step.

  2. If this is the first time logging an issue, a pop-up will prompt for Rally authentication.

For detailed steps, 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 automated test run encounters an error, the Error Message and Trace will be shown on the test execution screen. When creating an issue at the test step level, a .txt file with this information will be attached to the issue.

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

Delete Issue

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

When the Rally Configuration is Removed

  • Issues created in QMetry and synced to Rally will no longer appear in the QMetry Issue module.

  • The link between Rally issues and their respective test cases or test steps will be removed.

  • Issues created in the QMetry internal tracker before Rally integration will reappear in the issue grid.

Manage Issue View

  • Resize Columns: Users can adjust the width of the columns.

  • Organize Tabs: The detail page of QMetry assets features customizable tabs. Users can rearrange the tab order, which is saved individually for each user.

  • Filter Issues: Users can easily filter test assets by any system/custom fields on all module grids. Users can search issues by External Key of Rally by adding comma separated keys in the field.

 

Apply Filter

Users can apply both basic and advanced filters to records.

  • Basic Filters: Default fields are provided for filtering records.

  • Advanced Filters: Click the '+' icon to access additional system and user-defined fields for more filtering options. Select the desired field to add it as an advanced filter.

Users can also use the '+' icon to choose the Entity Key field and search for issues using comma-separated entity IDs.

Clear Filter and Sorting

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

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

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

Log Issues/Bugs/Defects from Execution Screen

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

Create Requirement from Issue

To create a requirement from an issue, users can copy field values from the issue to generate a new requirement. The new requirement will have the same name as the issue, which can be modified if needed.

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

Steps 

Follow either of the ways:

  • Open the issue detail page > Click on the cog icon at top right > select Create Requirement from Issue

  • Click on the cog icon for the issue on the grid pane > select Create Requirement from Issue

Edit/Revoke Existing Rally Authentication

When adding an issue for the first time, the Rally Authentication window will appear, prompting users to enter Rally credentials. This pop-up will not reappear for subsequent actions.

If users wish to see the Rally Authentication window again for creating or editing issues, they can revoke the existing Rally credentials.

  1. Go to Integration > Integrations.

  2. Open the cog icon and click Revoke credentials.

Delete Existing Rally Integration

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