In this section:
Introduction
If the External System Traceability Report has been deployed to your system (see Configuring Parasoft to Jira Traceability), you can add widgets to your dashboard to monitor traceability from requirements to tests, static analysis, code reviews for your project. The widgets also drill down to a report that includes additional details.
Adding and Configuring the Widgets
The widgets will appear in a separate Traceability category when adding widgets to your DTP dashboard. See Adding Widgets for general instructions on adding widgets.
You can configure the following settings:
Title | You can enter a new title to replace the default title that appears on the dashboard. |
---|---|
Filter | Choose Dashboard Settings to use the dashboard filter or choose a filter from the menu. See Configuring Filters for additional information about filters. |
Target Build | This should be set to the build ID you executed the tests and code analysis under. You can use the build specified in the dashboard settings, the latest build, or a specific build from the menu. Also see Configuring Dashboard Settings. |
Type | Pie widget only. Choose either a Tests, Violations, or Reviews from the menu to show a pie chart detailing the status by type. Add instances of the widget configured to each type for a complete overview in your dashboard. |
Jira Project | Choose a Jira project from the menu. |
JQL Query | Specify a query to define which work items are presented in the widget. If left blank, the JQL specified in the integration settings will be applied (see Connecting DTP to Jira). Queries defined in this field override the JQL configured in the integration settings. If a JQL is specified, it will appear in the header of the Requirement Traceability report. |
Requirements Widget
The widget shows the number of requirements from the specified Jira project.
Click on the widget to open the Requirement Traceability report.
Test Coverage Widget
This widget shows the percentage of requirements covered by tests against all requirements in the project.
Click the center of the widget to open the main Requirement Traceability report.
The colored-in segment represents the requirements covered by tests. Click on the segment to open the Requirement Traceability report filtered to the With Tests category.
Pie Widget
Unit testing, functional testing, static analysis, and peer reviews are common activities for verifying that requirements have been properly and thoroughly implemented. This widget shows the overall status of the project requirements in the context of those software quality activities. You can add a widget for each type of quality activity (tests, static analysis violations, reviews) to monitor the progress of requirements implementation for the project.
Mouse over a section of the chart to view details about quality activity type status. Click on the widget to open the Requirement Traceability report filtered by that type.
Requirements Implementation Status by Tests
Requirements Implementation Status by Violations
Requirements Implementation by Reviews
Understanding the Requirement Traceability Report
The report lists the JIRA requirements and data associated with them.
You can perform the following actions:
- Disable or enable Show files/reviews if you want to hide the Files and Reviews columns in the report. The Files and Reviews columns will only contain data if the requirements have been mapped to source files (see Configuring Parasoft to Jira Traceability). Disabling the Files and Reviews columns on this screen hides the related tabs in the Requirement Details report.
- Click on a link in the Key column to view the Requirement Details report for the requirement.
- Click on a link in the Summary column or one of the Test columns to view the test-related information associated with the requirement in the Requirement Details report.
- Click on a link in one of the Files columns to view the static analysis-related information associated with the requirement in the Requirement Details report.
- Click on a link in one of the Reviews columns to view the change review-related information associated with the requirement in the Requirement Details report.
Requirement Traceability Report by Type
Clicking on a section of the Requirements - Pie widget opens a version of the report that includes only the quality activity type selected in the widget. You can use the menus to switch type and status. You can also disable or enable Show files/reviews if you want to hide the Files and Reviews columns in the report. The Files and Reviews columns will only contain data if the requirements have been mapped to source files (see Configuring Parasoft to Jira Traceability). Disabling the Files and Reviews columns on this screen hides the related tabs in the Requirement Details report.
Understanding the Requirement Details Report
The Requirement Details report provides additional information about the files and tests associated with the Jira requirement. You can open this report by click on a requirement in the Requirement Traceability report.
The first tab shows the results of the tests that were executed to verify the specific work item.
You can click the View results in Test Explorer link to view all of the tests associated with the requirement in the Test Explorer.
You can also click individual test names in the table to view each test in the Test Explorer.
The second tab shows the files associated with the specific requirement, as well as the static analysis violation detected in the files. You can click the link the Violations column to view the violations in the Violations Explorer, which provides additional details about the violations.
This tab will only contain data if the requirements have been mapped to source files (see Configuring Parasoft to Jira Traceability). If you did not map requirements to files, you can hide this tab by disabling Show files/reviews on the main traceability report page and reloading the details report.
If the files include any change reviews or review findings, they will be shown in the third tab with links to view them in the Change Explorer.
This tab will only contain data if the requirements have been mapped to source files (see Configuring Parasoft to Jira Traceability). If you did not map requirements to files, you can hide this tab by disabling Show files/reviews on the main traceability report page and reloading the details report.