Use the Requirements Traceability Matrix gadget to see which Test Cases cover your Jira work items, the matching execution results, and work items linked during testing. It helps you review requirement coverage and follow up on gaps or defects.
Earlier versions call this the Work Item Traceability Matrix or Issue Traceability Matrix, abbreviated ITM or RTM.
Before you begin
Use a Jira dashboard you can edit to add or configure the gadget.
Make sure you can access the Jira work items and relevant Vansah testing information.
Link Test Cases to the requirements you want to report on. See Link Test Cases to a Jira Work Item.
1. Add the gadget
Open your Jira dashboard and enter dashboard editing if required.
Select Add gadget and search for Vansah - Requirements Traceability Matrix.
Add the gadget and open its configuration.
For general dashboard setup, see Set Up Vansah Gadgets on a Jira Dashboard.
2. Choose the work items
Select the Jira space or spaces you want to use for your work item selection.
Under Work Item(s) selection, choose List, Filter, or JQL, then supply the matching selection described below.
Choose whether to include child work items and work items linked in Jira.
Selection | What to do | Example |
List | Search for and select specific work items. | Select DEMO-123 and DEMO-124 to review two requirements. |
Filter | Choose an accessible saved Jira filter. | Choose your team’s release requirements filter. |
JQL | Enter a Jira search query for the work items you want. |
|
Replace DEMO with your Jira space key and use a work item type that exists in your Jira configuration. Jira’s JQL field name project refers to the Jira space.
Include Child Work items adds relevant child work items to the report scope. Include Linked Work items includes work items connected through Jira work item links. These options extend the report scope; they do not create links between Test Cases and requirements.
3. Choose properties and filters
Use View settings to select any additional work item properties you want displayed.
Use More to add available testing filters, then choose the values for each filter. For example, select a Test Environment to review testing in that environment.
Check the work item selection and filters, then select Save.
Wait for the report to load and confirm that the intended work items appear.
Changing the Jira space selection resets several testing filters. Review the filters again after changing spaces.
Read the matrix
Column | What it shows |
Work items | The requirement’s key, status, summary, and selected properties. Child and linked work items are shown with their relationship context. |
Test Case | Linked Test Case keys and headlines, with execution result information. Select a case key to open the case. |
Work items/bugs | Jira work items linked to the matching Test Run’s logs, such as defects raised during testing. |
A work item can occupy several rows when it has multiple linked Test Cases. A work item with no matching tests can still appear with an empty test area.
The result comes from the latest matching execution for the case version linked to that work item, subject to the report filters. A run from another context or version may not be included. Use the result details to check the execution context before comparing it with another report.
Use the search box above the matrix to narrow the loaded work item rows by key, summary, or supported displayed properties. This search also narrows spreadsheet exports.
Export the matrix
Open the More menu (three dots) inside the matrix and select Export.
Choose XLSX or HTML in the file type dialog.
Select Export to download the report.
See Export Requirements Traceability Gadgets for file contents, search scope, and download help.
Review or restore a saved configuration
Open the matrix’s More menu and select Configuration History.
Choose a version to review its saved settings and who updated it.
To apply that configuration, select Restore and wait for the report to refresh. Select Close to leave the current settings in place.
Restoring changes the gadget configuration. It does not restore older Test Cases, test results, or Jira work item data.
If the matrix does not show what you expect
Confirm that List contains selected work items, Filter has a saved filter, or JQL contains a query. A selection method by itself is not enough.
Check the selected Jira spaces, work item access, child/linked options, and report filters. Clear the matrix search box if rows are hidden.
Confirm the expected Test Case version is linked to the work item and that a matching execution exists in the intended context.
If the data still looks incorrect after refreshing, contact Vansah support with the gadget name, work item and case keys, filters, and an example of the unexpected result.