Requirement traceability report

This document provides a comprehensive overview of the Requirement Traceability Report feature, its functionality, and implementation details.

A Requirement traceability report provides a detailed overview of the relationship between requirements, test cases, test runs, and defects within a project. Your requirements can be from Jira, Azure or Asana. It offers insights into the following:

• Requirement prioritisation: Visual representation of requirement priority via graphs.
• Automation coverage: Percentage of test cases that are automated.
• Defect logs: Total number of defects associated with test runs and requirements.
• Test run results: Displays only the latest test run result for specific test cases and configurations.
• Configuration details: Information about different configurations used in test runs.
• Test plan association: Links to the test plans associated with the test runs.
• Execution details: Details of the user who executed the test run and the timestamp.

Create a requirement traceability report

You can create requirement traceability report using the following methods:

• Create requirement traceability report from a template
  
• Create a custom requirement traceability report

Create requirement traceability report from a template

Click Requirement Traceability Report tile on the reports dashboard. This automatically fetches requirements from the current project and generates a report.

Create a custom requirement traceability report

To create a custom requirement traceability report:

1. Go to the project where you want to create the Test Run report.
2. Click the Reports tab on the navigation menu.

3. Click Create Report from the reports dashboard.

   

   A Create Report window appears.

4. In the Create Report window, enter the following details:

5. Select Requirement Traceability Report from the Type of Report dropdown.
6. You can generate your Requirement Traceability Report based on:
   • Requirements from Projects / Test Cases / Test Runs: This option allows you to automatically include requirements based on your selection:
     • Current Project: Includes all requirements within the currently selected project in the report.
     • Test Cases: Select specific test cases, and the report will include all requirements linked to those test cases.
     • Test Runs: Select specific test runs, and the report will include all requirements associated with those test runs.

     

   • Specific Requirement IDs: In the Requirements field, select Jira, Azure, Asana or linear to include in the report and enter the IDs.
7. Optionally, to link stories and tasks from Jira requirements, use the following methods:
   
   • Select to add related epics from these linked stories and tasks from the Include from epics (if any) dropdown.
   • Use JQL to select requirements:
     
     • Click Link Requirement using JQL.
     • Enter your JQL query and click Fetch.
     • From the returned requirements, you can choose to add associated linked stories and tasks.
8. Configure scheduling:
   
   • Daily: Select the time (in UTC) for the report to be generated each day.
   • Weekly: Choose the day of the week and the time (UTC) for the report to be sent.
9. Add recipients:
   In the Recipients field, enter the names or emails of the individuals who should receive the scheduled report. You can add multiple recipients.

10. Title and description:
    Provide a descriptive Title for your report. Optionally, you may add a brief Description to provide the context.

    

11. Save your settings:
    After all fields are set, click Create or Update to schedule the report.

A “Report generated successfully” notification appears on the dashboard, and reports are sent to specified recipients. If you have created reports with automatic recurring reports, they will appear in the Reports dashboard.

Here is an example of a requirement traceability report:

• Learn how to use advanced filters in your reports.
• Learn how to share and download your requirement traceability report.