Traceability Detail Report

Owned by APPWRK Writer
Last updated: Oct 30, 2024
5 min read

A traceability report is used to track if all the requirements have been mapped to cases, which in turn ensures that the product is being tested thoroughly. AIO Tests has an inbuilt end-to-end traceability report that shows requirements mapped to cases, executions and defects. Requirements from multiple projects can be specified as input to the report for cross-project visibility. Similarly, defects from multiple projects are displayed in the report if they are linked to runs of the project being viewed.

In this documentation, you’ll understand:

Steps to Generate Traceability Detail Report 

Step 1: To generate traceability detail report, simply click on the Chevron option for Traceability Detail.

Group 2 (12).png

Step 2: Once you click on the chevron icon, the Traceability Detail Report input window will be displayed on the screen. Enter the required details into their respective fields. 

Requirements: Specify the requirements for which the report needs to be generated. One or more requirement(s) can be specified via three options (requirements from multiple projects, if linked with cases of the project, can be specified).

  • List: Search list of Jira issues via key or title. Users can filter the list by project name & Jira issue type.

  • JQL (Jira Query Language): Specify requirements meeting criteria using standard JQL. Clicking on the JQL box opens up the standard Jira box which helps in faster JQL creation.

  • Filter: Select a filter created and saved in Jira (the list of filters from Jira is pre-populated and is shown upon clicking inside the search box).

Users have three more options to further refine the requirements criteria: 

  • Include Child Issues: Selecting this checkbox will include the child issues of all the specified requirements. E.g. if the specified requirement is an Epic with multiple stories, all the stories don’t need to be specified separately if this option is checked. If not selected, only the parent issues are displayed in the report.

    • Filter Child issues: Clicking the icon will allow users to specify which issue types to include in the report (e.g., the user might only want to see stories, not task/sub-tasks, so in the dropdown user can select Story).

  • Include all Case Versions: Ticking this checkbox will include data from all the case versions linked to the requirements.

  • Exclude Archived Cases: Selecting this checkbox will exclude the archived cases from the generated report.

Cycles: Specify the project and execution cycles that should be considered for traceability of the selected requirements; multiple cycles can be selected from multiple projects. If all or any of the checkboxes under Cycles are selected, the cycles list will need to be provided.

  • Users can also use the filter option to narrow down the Cycles list. They can filter the Cycles list by Component, Release, Cycle Tags, Folders, or any custom fields (which can be added via the inverted triangle icon).

  • Users also have the option to specify a dynamic filter for cycles by changing ‘List’ to ‘Filter’.

  • Retrieve Runs: Check this box to see the test execution results in the traceability report. If not selected, execution details will not be displayed in the report.

  • Retrieve Defects: Check this box to see the test execution defects in the traceability report. If not selected, defect details will not be displayed in the report.

  • Include only Last Run: Check this box if only the last run of the cases should be considered for the report. If not selected, all runs of the resulting cases will be shown in the report.

By default, all checkboxes are checked.

 

image-20240928-110238.png

 

Step 3: Finally, click on the Generate button. 

Users can also save reports to reuse them later by clicking on the Save button.

 

 

Once you click on the Generate button, the report output will be displayed on the screen. 

 

 

Example

Here's a sample Traceability Detail Report. The below screenshot is when the traceability report is generated via JQL and cycles have not been specified.

 

 

The report shows two columns - Requirement and the Cases that are mapped with the requirements.

  • Requirements are shown with a hierarchy as “Include child issues” was selected. The column also shows the current status of the requirement in Jira and its priority.

  • Cases are shown with their status.

The below screenshot is the report output when cycle 'ADP-CY-1' has been specified along with the ‘Retrieve Runs’ and ‘Retrieve Defects’ checkboxes selected and the ‘Include only last run’ checkbox not selected. The report now shows 4 columns - Requirement, Cases, Test Execution Results and Defects.

  • Requirements and Cases are the same as those above

  • The Test Execution Results column shows the execution status, execution date, and who executed it. However, if multiple runs have been created, they are also shown.

  • The Defects column shows associated defects and their status and priority in Jira.

For further queries and suggestions, feel free to reach out to our customer support via help@aiotests.com.