Introduction
You can add widgets to your dashboard to monitor traceability from your requirements in an external system to test results in Parasoft DTP system for your project. DTP reads these requirements from a CSV file generated from your external system and uploaded to a pre-configured location. The widgets also drill down to a report that includes additional details. This artifact is shipped with the Parasoft Traceability Pack.
Requirements
You will need to export basic information about your project requirements from your RMS into a CSV file. The first line of your CSV should be just the following column headers:
req-id,req-name,req-url
where:
req-idis the requirement IDreq-nameis the requirement namereq-urlis the requirement URL
Each subsequent line should be data for each requirement, one requirement per line. The requirement URL is optional, but each requirement should have at least an ID and a name.
The CSV file needs to be placed on an HTTP server that DTP can access via HTTP without authentication.
Installation
This artifact is installed as part of the Parasoft Traceability Pack, which contains a collection of configuration files and assets that enable traceability. To install the Traceability Pack:
Deploying the Traceability Report
You should deploy the report components to your DTP environment after installing the Traceability Pack. To do so:
- Open Extension Designer and click on the Services tab.
- Choose an existing service to deploy the artifact or create a new service in the DTP Workflows category. Refer to Working with Services for additional information on organizing services and artifacts.
- If you are adding the artifact to an existing service, add a new Flow tab (see Working with Flows) and choose Import from the ellipses menu.
- Choose Local > Flows > Workflows > Traceability Pack > External System Traceability Report and click Import.
- Click inside the Flow tab to drop the nodes into the service and click Deploy.
Deploying the External System Traceability Report adds new widgets to Report Center, as well as a drill-down report. See below for instructions on adding the widgets and viewing the report.
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 | Choose Tests, Violations, or Reviews. |
| CSV File URL | Enter the URL to the CSV file published on your HTTP server from which DTP should draw data about the requirements. The server should not require authentication. See CSV Requirements below for information concerning the format requirements of this file. |
Requirements Widget
This widget shows the number of requirements read from the specified CSV file exported from your external system project.
Click on the widget to open the Requirement Traceability report.
Test Coverage Widget
This widget shows the percentage of the external system requirements covered by tests in Parasoft DTP against all requirements in the external system 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 external system project requirements in the context of those software quality activities in Parasoft DTP. 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 the selected type.
Understanding the Requirement Traceability Report
The report lists the external system requirements provided in CSV file and data associated with them in Parasoft DTP.
You can filter the report by type using the options in the Type menu. Enable or disable Show files/reviews to show or hide those columns. Click on a link in the Key column to go to the requirement URL defined for that requirement.
