There are two basic types of reports: Source code reports which appear in the Reports topic of the portal, and Audits/Metrics reports which appear in various dashboards. All reports are customizable in the Administration perspective by means of XML configuration files. This section explains the basics of how to configure the different types of reports.
You can configure source code reports for each project. If you are not familiar with the basics of the different scopes, you may want to review Administration Basics: The Administration Interface.
You can configure which reports appear in the Reports topic, specifying the calculation for each report. You can also customize the calculation of each report. The default reports are:
Maven Site
Unit Test Coverage
Unit Tests
Javadoc
XRef
Two additional reports are available, but are commented out in the default reports configuration file:
PMD
Checkstyle
There are 2 files involved in this configuration:
reports-config.xml: defines the list of source code reports shown in the Reports topic of the portal.
descriptors.xml: configures the calculations used by the reports defined in reports-config.xml.
To access the configuration files for source code reports:
Log in with administrative rights for the project you want to configure.
Enter the Administration perspective.
Navigate to and select the project in the Projects portlet.
In the Topics portlet, expand the topic.
To access the reports-config.xml file, click on the Source Code Reports topic.
To access the descriptors.xml file, click on the Report Descriptors topic.
Use the appropriate link in the Configuration portlet of the respective configuration page to download the configuration file to your local system, or edit online with the text editor provided.
If you edit the file offline, use the controls in the Upload New Project Configuration portlet to upload the modified file back to the Polarion repository.
You will find comments in the configuration file that explain the various elements and attributes of the configuration.
Note that source code reports can be computed only if the build artifact (containing Java sources) is a maven2 build artifact, and the build process is running without errors.
You can configure work item metrics for each project. If you are not familiar with the basics of the different scopes, you may want to review Administration Basics: The Administration Interface.
This configuration contains elements that define values that may be shown on a dashboard, or used in the definition of a trend chart.
Workitem metric are configured in the workitem-metrics.xml file. To access this file:
Log in with administrative rights for the project you want to configure.
Enter the Administration perspective.
Navigate to and select the project in the Projects portlet.
In the Topics portlet, expand the topic.
Click on the Workitem Metrics topic.
Use the appropriate link in the Configuration portlet to download the configuration file to your local system, or edit online with the text editor provided.
If you edit the file offline, use the controls in the Upload New Project Configuration portlet to upload the modified file back to the Polarion repository.
The configuration file contains comments that explain the elements, their use, and options for customization.
You can configure the Package Reuse metric for each project. If you are not familiar with the basics of the different scopes, you may want to review Administration Basics: The Administration Interface.
Workitem metric are configured in the package_reuse.xml file. To access this file:
Log in with administrative rights for the project you want to configure.
Enter the Administration perspective.
Navigate to and select the project in the Projects portlet.
In the Topics portlet, expand the topic.
Click on the Package Reuse topic.
Use the appropriate link in the Configuration portlet to download the configuration file to your local system, or edit online with the text editor provided.
If you edit the file offline, use the controls in the Upload New Project Configuration portlet to upload the modified file back to the Polarion repository.
You can configure the Workitem Quality report for each project. If you are not familiar with the basics of the different scopes, you may want to review Administration Basics: The Administration Interface.
This configuration enables you to define which of the available metrics should appear in the dashboard.
Workitem metrics are configured in the workitem-quality-report.xml file. To access this file:
Log in with administrative rights for the project you want to configure.
Enter the Administration perspective.
Navigate to and select the project in the Projects portlet.
In the Topics portlet, expand the topic.
Click on the Workitem Quality Report topic.
Use the appropriate link in the Configuration portlet to download the configuration file to your local system, or edit online with the text editor provided.
If you edit the file offline, use the controls in the Upload New Project Configuration portlet to upload the modified file back to the Polarion repository.
You can configure the Project Quality report for each project. If you are not familiar with the basics of the different scopes, you may want to review Administration Basics: The Administration Interface.
Workitem metric are configured in the rule-settings.xml file. To access this file:
Log in with administrative rights for the project you want to configure.
Enter the Administration perspective.
Navigate to and select the project in the Projects portlet.
In the Topics portlet, expand the topic.
Click on the Process Quality Report topic.
Use the appropriate link in the Configuration portlet to download the configuration file to your local system, or edit online with the text editor provided.
If you edit the file offline, use the controls in the Upload New Project Configuration portlet to upload the modified file back to the Polarion repository.