dashboard:dashboard

Note: This Mojo should be used as a Maven report.

Full name:

org.codehaus.mojo:dashboard-maven-plugin:1.0.0-beta-1:dashboard

Description:

A Dashboard report which aggregates all other report results.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
outputDirectory File - Directory containing The generated DashBoard report Datafile "dashboard-report.xml".

Optional Parameters

Name Type Since Description
configLocation String -

Specifies the location of the XML configuration to use.

Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Dashboard Maven plugin ) configuration .

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory}/default-dashboard-config.xml file before being passed to dashboard as a configuration.

There are 1 predefined config.

  • config/default-dashboard-config.xml: default config.
Default value is: config/default-dashboard-config.xml.
connectionUrl String - Hibernate connection URL
dialect String - Hibernate dialect
driverClass String - Hibernate driver class
generateGraphs boolean -

This parameter is used to disable the graphics generation to avoid unexpected error when X11 window server not installed on Linux/Unix machine.

  • If set as "true" or not set (default value is used) , all graphics will be generated.
  • > If set as "false", the Dashboard won't generate graphics for summary and detailled reports and the historic report will be disabled.


Default value is: true.
keepVersionAsDiscriminantCriteria boolean - This parameter is used to keep the version as a discriminant criteria of a project. If set as "true", the data of reports will be specific to this version of a project. If set as "false", the data of reports will be associated with the project regardless of its version. Default value is: true.
m1LikeRendering boolean - Used to generate a dashboard report as Maven 1, only for multi-modules project. It also merges the 2 reports (Summary and detailled) as only one. Default value is: false.
nbExportedPackagesSummary int - number of XRef JDepend/Cobertura packages to export in dashboard summary page Default value is: 10.
password String - Hibernate database password
username String - Hibernate database username

Parameter Details

configLocation :

Specifies the location of the XML configuration to use.

Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Dashboard Maven plugin ) configuration .

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory}/default-dashboard-config.xml file before being passed to dashboard as a configuration.

There are 1 predefined config.

  • config/default-dashboard-config.xml: default config.

  • Type: java.lang.String
  • Required: No
  • Expression: ${configLocation}
  • Default: config/default-dashboard-config.xml

connectionUrl :

Hibernate connection URL

  • Type: java.lang.String
  • Required: No
  • Expression: ${connectionUrl}

dialect :

Hibernate dialect

  • Type: java.lang.String
  • Required: No
  • Expression: ${dialect}

driverClass :

Hibernate driver class

  • Type: java.lang.String
  • Required: No
  • Expression: ${driverClass}

generateGraphs :

This parameter is used to disable the graphics generation to avoid unexpected error when X11 window server not installed on Linux/Unix machine.

  • If set as "true" or not set (default value is used) , all graphics will be generated.
  • > If set as "false", the Dashboard won't generate graphics for summary and detailled reports and the historic report will be disabled.


  • Type: boolean
  • Required: No
  • Expression: ${generateGraphs}
  • Default: true

keepVersionAsDiscriminantCriteria :

This parameter is used to keep the version as a discriminant criteria of a project. If set as "true", the data of reports will be specific to this version of a project. If set as "false", the data of reports will be associated with the project regardless of its version.

  • Type: boolean
  • Required: No
  • Expression: ${keepVersionAsDiscriminantCriteria}
  • Default: true

m1LikeRendering :

Used to generate a dashboard report as Maven 1, only for multi-modules project. It also merges the 2 reports (Summary and detailled) as only one.

  • Type: boolean
  • Required: No
  • Expression: ${m1LikeRendering}
  • Default: false

nbExportedPackagesSummary :

number of XRef JDepend/Cobertura packages to export in dashboard summary page

  • Type: int
  • Required: No
  • Default: 10

outputDirectory :

Directory containing The generated DashBoard report Datafile "dashboard-report.xml".

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

password :

Hibernate database password

  • Type: java.lang.String
  • Required: No
  • Expression: ${password}

username :

Hibernate database username

  • Type: java.lang.String
  • Required: No
  • Expression: ${username}