Model/Group Dashboards

This specific dashboard displays information relative to all projects analysed with the current analysis model or group of project. It consists of a list of charts and a table with all the projects using this analysis model in this group and some chosen values (columns) to ease comparison between them.

CFG modelDashboard
Figure 1. Analysis Model Dashboard

Its structure is as follows:

<dashboard type="MODEL" nbColumns="2" defaultWidthValue="500" defaultHeightValue="500">
	<charts>
	...
	</charts>
	<table id="PROJECT_SUMMARY" hideLastVersion="false" hideCreator="true" hideLevel="false">
	...
	</table>
</dashboard>

The dashboard element supports the following attributes:

  • id (mandatory) is the id of the highlight definition.

  • onArtefactTypes (optional, default: any) is a semicolon-separated list of artefact types that this item applies to.

  • roles (optional, default: any) is a semicolon-separated list of project roles that are allowed to view and use this item.

  • groups (optional, default: any) is a semicolon-separated list of user groups that are allowed to view and use this item.

  • displayOnlyIf (optional) allows specifying a computation to evaluate whether to show the element. If the result of the computation is more than 0, then the element is displayed. Consult Expressions Syntax for more information about the supported computation syntax.

  • nbColumns (optional, default: 3) sets the number of columns used to display the charts on the dashboard.

  • defaultWidthValue (optional, default: 400) sets the default width of a maximised chart if not specified within the chart itself.

  • defaultHeightValue (optional, default: 400) sets the default height of a maximised chart if not specified within the chart itself.

  • topTablesMaxLines (optional, default: 8) defines the maximum number of lines in the tables displayed in the top row above the charts.

  • rowMaxHeight (optional, default: 250) define the maximum height in pixels of a row of charts on the dashboard.

  • template (optional, default: 1x1 for all charts) allows changing the aspect ratio of charts in the dashboard, using the syntax "position:width x height;". Note that the use of this attribute requires defining a value for the nbColumns attribute. For more details about dashboard templates, refer to Dashboard templates.

  • minSizeForLegend (optional, default: no legends on thumbnails) allows displaying chart legends on the thumbnails for charts whose ratio is above the specified minimum. By default, no chart legends are displayed on thumbnails. If you want to force the legend to be displayed on thumbnails, specify for what chart ratio the thumbnail will be generated. Charts have a ratio of 1x1 by default, so specify minSizeForLegend="1x1" to force legends for all charts. If you want to display legends for all charts that have a width that is twice their height, specify minSizeForLegend="2x1".

  • name (deprecated) is unused.

If a chart has an attribute legend="false", then its legend will not be included on the thumbnail even if its ratio matches the one specified in minSizeForLegend.

The charts area allows displaying a series charts.

The table area shows information about the projects analysed with the current model. Projects that do not belong to the portfolio are not shown.

The first column allows to check or uncheck the projects whose information should be used to compute data on the charts. The information can be aggregated in the charts in several ways using the aggregationType attribute of a measure or indicator element. In Model/Group Dashboards, aggregating has the effect of showing one line per project for each metric defined in the chart. You can find out more about this attribute in For measure and indicator elements.

A series of build-in columns show the project owner, the name of the last version and the project’s rating. They can be shown or hidden using the following attributes of the table element:

  • hideCreator (default: false) hides the Owner column when set to true

  • hideLastVersion (default: false) hides the Version column when set to true

  • hideLevel (default: false) hides the Rating column when set to true

Other columns, showing specific information about the project, are defined manually as follows:

<table id="PROJECT_SUMMARY" hideLastVersion="false" hideCreator="true" hideLevel="false">
	<column indicatorId="BUSINESS_VALUE" labelType="NAME" displayType="VALUE" "decimals="0" />
	<column indicatorId="QUALITY" labelType="NAME" displayType="VALUE" decimals="2" suffix="%"/>
	<column indicatorId="TECH_DEBT" labelType="NAME" displayType="VALUE" decimals="0" />
	<column indicatorId="TECH_DEBT_IDX" labelType="NAME" displayType="VALUE" decimals="2" suffix="/FUNC"/>
	<column indicatorId="SUMSLOC" labelType="NAME" displayType="VALUE" decimals="0" />
</table>

The column sub-element has the following attributes:

  • measureId, indicatorId or infoId (mandatory) is the ID of the measure, indicator or textual information to display.

  • labelType (optional, default: NAME) defines how the metric is shown in the interface. Supported values are:

    • NAME

    • MNEMONIC

    • DESCRIPTION

    • CUSTOM which accepts the following additional attribute when defined:

      • label to define the string that must be displayed.

  • displayOnlyIf (optional) allows specifying a computation to evaluate whether to show the element. If the result of the computation is more than 0, then the element is displayed. Consult Expressions Syntax for more information about the supported computation syntax.

  • displayedValue (optional) allows overriding the indicator to display another measure instead. The attribute takes a measure ID (displayedValue="SLOC").

  • displayType (optional, default: NAME) defines how the metric is shown in the interface. It may be one of:

    • NAME the metric name

    • MNEMONIC the metric mnemonic

    • DESCRIPTION the metric description

  • displayValueType (optional, default: VALUE) defines how the metric value is shown in the interface. It may be one of:

    • NAME the level’s name

    • MNEMONIC the level’s mnemonic

    • RANK the level’s rank

    • VALUE the measure’s value

    • PERCENT to automatically convert a value between 0 and 1 into a percentage (also appending '%' as a suffix)

    • ICON the level’s icon

    • DATE the measure value converted to date format

    • DATETIME the measure value converted to datetime format

    • TIME the measure value converted to time format

    • TEXT when the metric you are trying to display is textual information

      For DATE,DATETIME and TIME, you can specify the required format using the dateStyle, timeStyle and datePattern attributes described below.

  • unknownValue (optional, default: "?") defines what text to display if the level of the indicator is UNKNOWN or outside the specified dataBounds. Set this to OFF to use the old behaviour (which display the rank -1).

  • emptyValue (optional, default: "-") defines what text to display if there is no value in the database for the specified metric, or if a date is not specified. This is usually useful if a date has not been set yet manually in a form (and is therefore equal to 0), or if you have just added a new metric to your model you want to display specific text for the versions of your project where this metric did not exist yet.

  • dataBounds (optional, default:[;[) allows overriding the normal range of values that would trigger the display of the unknownValue text. This allows you to display the unknown value if the metric associated to the indicator is not within the defined bounds.

  • dateStyle (optional, default: DEFAULT) : the date formatting style, used when the displayType is one of DATE or DATETIME.

    • SHORT is completely numeric, such as 12.13.52 or 3:30pm.

    • MEDIUM is longer, such as Jan 12, 1952.

    • DEFAULT is MEDIUM.

    • LONG is longer, such as January 12, 1952 or 3:30:32pm.

    • FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

  • timeStyle (optional, default: DEFAULT): the time formatting style, used when the displayType is one of DATETIME or TIME. See above for available styles.

  • datePattern (formerly dateFormat) (optional, default: empty) : the date pattern, used when the displayType is one of DATE, DATETIME or TIME.

    • "yyyy.MM.dd G 'at' HH:mm:ss z" is "2001.07.04 AD at 12:08:56 PDT".

    • "EEE, d MMM yyyy HH:mm:ss Z" is "Wed, 4 Jul 2001 12:08:56 -0700".

      If this attribute is set, both dateStyle and timeStyle attributes are ignored. The date is formatted using the supplied pattern. Any format compatible with the Java Simple Date Format can be used. Refer to http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html for more information.

  • suffix (optional, default: empty) is the label displayed after the value of the metric in the UI

  • decimals (optional, default: 0) is the number of decimals places to be used for displaying values.

  • roundingMode (optional, default: HALF_EVEN) defines the behaviour used for rounding the numerical values displayed. The supported values are:

    • CEILING to round towards positive infinity.

    • DOWN to round towards zero.

    • FLOOR to round towards negative infinity.

    • HALF_DOWN to round towards "nearest neighbour" unless both neighbours are equidistant, in which case round down.

    • HALF_EVEN to round towards the "nearest neighbour" unless both neighbours are equidistant, in which case, round towards the even neighbour.

    • HALF_UP to round towards "nearest neighbour" unless both neighbours are equidistant, in which case round up.

    • UP to round away from zero.

    For more examples of rounding mode, consult http://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html