Requirements Traceability Report
Requirement Traceability Report is a snapshot of the relationship between your test cases and requirements from the external issue trackers like Jira.
Last updated
Requirement Traceability Report is a snapshot of the relationship between your test cases and requirements from the external issue trackers like Jira.
Last updated
Understanding the relations between test cases and requirements is essential for ensuring the success of any project.
By analyzing this connection, teams can gain valuable insights into the effectiveness of their testing efforts and can make informed decisions to improve quality.
A Requirement Traceability Report provides insight into how each test case aligns with project requirements, allowing for better tracking and management of testing efforts.
Requirement Traceability Report is a snapshot of the relationship between your test cases and requirements from the external issue trackers like Jira.
At its core, the report provides insights into the number of linked requirements and identifies any un-linked ones, providing you with a clear overview of the test coverage status.
Furthermore, it offers detailed insights for each linked requirement, showcasing the specific test cases associated with them, as well as the testing status of each test case.
If a test case has failed during a recent run, the report also highlights any associated defects, providing visibility into the defect status.
The Report enables you to quickly assess the current state of testing for each requirement, identifying any failed tests and corresponding defect statuses, thus empowering teams to prioritize and address critical issues effectively.
Tracking changes
In addition to capturing a snapshot of testing status at a specific point in time, you have the flexibility to generate new versions of the report, as needed.
This helps track changes in test coverage, and execution status status over time providing a historical record of testing progress and improvements.
Generate new versions to compare different snapshots, identify trends, and measure the impact of changes in testing efforts.
To generate a new report, go to the Traceability Reports section and click on the Create a new report button.
Give a title to your report, and select the integration app. Then, choose the specific project/repository, type of issue/milestone and proceed to generate the report. (You can choose multiple projects and issue types)
For Jira - Select your Projects, and Issue types.
For GitHub - Select your repositories, and the milestone.
Allow a few moments for the the report to be generated, you can leave this page and come back to view the report later.
Example report for Jira
Each report can have multiple versions generated at different points in time. You can easily switch between these versions from this drop-down.
Click on 'Create new version' to generate a fresh snapshot of the report.
View the External projects in the integration (eg: Jira) that are used to create the current report, along with the number of total, linked and unlinked requirements.
Switch between the linked and unlinked issues from this tab section.
Search your requirements, and filter your requirement, test case, and defect statuses
View the requirement name and external ID. (click on the Id to open the requirement in a new tab)
Status and timestamp for the latest update of the requirement at the time of generating the report.
View the number of linked test cases and their associated defects with statuses.
Click on this area to expand and collapse each requirement.
View the latest Run result for the test cases, along with their Name, and caseID.
View all associated defects for the specific test cases, along with their Name, Defect ID, and status.
Monitor the status of your test cases based on the most recent update to your requirement. The report includes a link to edit the test case or mute it if no changes are necessary.
The report dashboard provides a quick glance at all available report versions. You can identify each version by its date of generation.
Additionally, the dashboard highlights the number of linked and unlinked requirements, offering insights into test coverage and alignment with project requirements.
💡 Linked issues show alignment with project goals, while unlinked ones signal potential testing gaps. Monitor changes with each report version for comprehensive testing insights.
You can also create a new version of the report from here.
Edit or Delete a specific version from the (---) menu.
You can access all available reports here. Quickly scan through the list of reports, each accompanied by its corresponding projects from the external integration.
Additionally, the overview displays the latest version of each report, along with the total number of versions available.
You can create a new Report from here.
View the external integration's projects that are used to create the report.
View the date and time of the latest report version generated.
View the total versions available for the report.
From the (---) menu of each report, you can Generate a new version, edit report name, or Delete it.
To link your test case to an external requirement, go to your project repository and click on the test case to open a preview.
Switch to the Properties tab and scroll down to find the option to link the external issue.
To share the report with external stakeholders or for in-depth data analysis, click the 'Export' button in the upper right corner. You'll be presented with two options:
CSV: This format is best suited for when we need to process the data from the report further using data analysis tools.
PDF (beta): This format is ideal for quickly sharing the report with key stakeholders
Currently, the report can be only generated from the following integrations.
We'll be adding support of other integrated issue trackers in the coming months.
