Traceability Summary Report

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

The Traceability Summary report gives a quick summary when you want to view the current testing status. For QAs, this report may be very useful to get a high-level summary of whether a requirement has been covered with a case or not. If requirements from multiple cases are linked to the cases of the project being viewed, they can be reported on too. Similarly, if defects from multiple projects are linked to runs of the project being viewed, they will be included in the report too.

In this documentation, you’ll understand:

Steps to Generate Traceability Summary Report 

Step 1: To generate a traceability summary report, simply click on the Chevron option for Traceability Summary.

Group 1 (80).png

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

Requirements: Specify the requirements for which traceability needs to be reviewed. 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. You 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 four more options to further refine the requirements criteria: 

  • Include Child Issues: Selecting this checkbox will include the child issues of all the specified requirements.

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

  • Cumulate Requirements Data: On selecting this checkbox, data of all the sub-tasks (the child issues), with specified requirements will be percolated up to the parent issue. It can be checked only if the 'Include Child Issues' checkbox is checked.

  • 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 search for cycles using filter options like component, release, tags, and folder. 

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

While running multiple cycles (maybe in two different environments), you could use one of the two strategies to merge them:

  • Last Run: Check this box if only the latest run, across all cycles, is to be considered for the report. So, the status shown will be the last run’s status only. E.g. a case was executed in cycle 1 on Jan 2 and in cycle 2 on Jan 3; then only Jan 3 run will be considered).

  • All Runs: Check this box if you want to view the statuses of runs across all cycles. E.g., if a case is executed in 3 different cycles with result statuses as passed, failed, and passed, respectively. The final status, after merging, will depend on all 3 statuses that will be filed in this case (and not the status of the last run, which would be passed for this example).

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

Traceability Summary Report Output - Overview

The top section of the report (shown in the below screenshot) gives a quick glimpse of the number of requirements specified, the coverage count (requirements mapped with cases) and percentage, the non-coverage percentage along with count, the count of cases associated with covered requirements and defects logged while executing the associated cases. The Cases and Defects boxes are also clickable allowing you to get detailed information for these boxes.

 

The next section shows three pie charts:

  1. Case Priority Distribution: When cases were created, they were associated with a priority- lowest, low, medium, and critical. The first pie chart distributes the cases in the specified cycles based on priority.

  2. Execution Distribution: This pie chart displays the execution status of the cases (Not Run, In Progress, Blocked, Passed, and Failed).

  3. Defect Distribution: This pie chart displays the status of the defects that were raised as part of the execution of the cases.

The count for each category is displayed by hovering over the segments of the pie charts.

 

 

The last section of the report gives a tabular view of the:

  • Requirements (listed according to their priorities).

  • Whether the requirement is covered (case/s are associated with the specified requirement) or not.

  • Clickable Case Count (number of cases associated with the story/ epic/ requirement).

  • Execution results bar (hovering upon which gives detailed numbers).

  • Percentage of cases in passed or failed status (done) in the specified cycles.

  • Clickable defect count (defects found as part of the testing done in the cycles specified in the input).

 

 

Note: Users can add more columns to the report table by clicking on the Select Columns button.

 

 

Note: Users can sort the Requirements by Summary, Status and Key options by clicking on the List icon.

 

 

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