instantiations.dashboard Ant Task

The instantiations.dashboard Ant task will create a dashboard showing the results of one or more code quality measures performed during the build process.

Installation

Download and unzip CodePro Server for Ant in a directory of your choice (e.g. /CodeProServer). To use the instantiations.dashboard Ant task you must add the following lines near the top of your Ant build script...

<property name="CodeProServer.install.dir" location="install-dir"/>
<import file="${CodeProServer.install.dir}/ant-tasks.xml" /> ...

where install-dir is the directory into which you installed CodePro Server for Ant.

Attributes

The following is a list of the attributes supported for the instantiations.dashboard task.

Attribute Description Required
buildNumber The build number of the latest build being displayed in the dashboard. No
configurationDir The location of the Eclipse configuration directory used when generating the dashboard. If not specified, then the configuration defaults to a newly created directory within the temporary directory. This directory will be deleted and recreated from <install-dir>/eclipse/configuration-backup.zip as necessary. No
dataStore The location of the directory containing the data files from which the dashboard will be populated. Yes
dateRanges A comma separated list of date ranges indicating the timespans that should be available for viewing in the dashboard. Each timespan consists of an integer followed by a duration designator, either 'd' for days, 'w' for weeks, 'm' for months, or 'y' for years (with no whitespace between the two). No
eclipseDir The directory containing the installation of Eclipse that should be used to run the audit. If not specified this attribute will default to ${CodeProServer.install.dir}/eclipse. No
jreDir The installation directory for the JRE used to run Eclipse. No
reportDir The directory to which the dashboard is to be written. Yes
tempDir

The absolute path of the temporary directory that can be used by this goal. If not specified this attribute will default to the system temp directory.

No
workspaceDir The location of the Eclipse workspace directory used when performing the analysis. If not specified, then the configuration defaults to a newly created directory within the temporary directory. No

Nested Elements

The following elements can be nested within the instantiations.dashboard task.

<classpathVariable>

The classpathVariable element is used to define a classpath variable within the (possibly newly created) Eclipse workspace. It has two attributes:

name
The name of the classpath variable
value
The value of the classpath variable

<application>

The application element is used to specify what information is to be included in the dashboard.

Examples

The following example shows how to use the instantiations.dashboard task.

Create a Basic Dashboard