Single Version Charts

Current artefact only

Dial

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Dial chart represents the value of the measure associated to an indicator against a backdrop of the scale associated to this indicator. The Dial chart requires one indicator as a sub-element.

Figure 1. Dial Chart

<chart type="DIAL" id="DIAL_EXAMPLE">
	<indicator>ROOT</indicator>
</chart>

The Dial chart element may have the following attributes:

decimals (optional) is the number of decimal places used to display the data.
majorTickIncrement (optional) is the increment between two major ticks on the dial.

The majorTickIncrement and minorTickCount parameters only need to be used if you want to completely control the appearance of the chart. Generally, they can be omitted, as the defaults should be smart enough to show what you need.

You can control the bounds of the axis of this chart using the datBounds attribute on each metric, as explained in For measure and indicator elements.

The indicator element supports excluding certain levels from the chart by using the excludeLevels attribute. For example:

<indicator excludeLevels="LEVELA;LEVELB">LEVEL</indicator>

Key Performance Indicator

This chart is supported only in Artefact Dashboards.

The Key Performance Indicator chart is used to display the rating of the root indicator for artefact.

Figure 2. Key Performance Indicator

<chart type="KPI" id="KPI_EXAMPLE" indicatorId="ROOT" />

The chart accepts the following attributes:

indicatorId is the reference to an Indicator. See Properties files for more information about the indicatorId.

You can configure the image displayed by Key Performance Indicator chart by defining an image per scale level in your model:

<SQUORE_HOME>/configuration/models/shared/Analysis/SQuORE_PerformanceLevels_en.properties:
LOP.LEVELA.IMAGE=../Shared/Images/images/perfA.png
LOP.LEVELB.IMAGE=../Shared/Images/images/perfB.png
LOP.LEVELC.IMAGE=../Shared/Images/images/perfC.png
LOP.LEVELD.IMAGE=../Shared/Images/images/perfD.png
LOP.LEVELE.IMAGE=../Shared/Images/images/perfE.png
LOP.LEVELF.IMAGE=../Shared/Images/images/perfF.png
LOP.LEVELG.IMAGE=../Shared/Images/images/perfG.png

For more information about properties files, consult Properties files.

The Indicator now offers a more dynamic way to display a KPI without the need to create images for every level on a scale. You can find out more about this chart in Indicator .

Kiviat

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Kiviat chart displays three or more indicators in a radar-type chart.

Figure 3. Kiviat

The Kiviat chart takes a set of at least three indicators as sub-elements.

<chart type="KIVIAT" id="KIVIAT_EXAMPLE" isInverted="true" currentLabel="Current" objectiveLabel="Objective">
	<indicator label="My testability" objective="LEVELC">TESTABILITY</indicator>
	<indicator objective="LEVELC">STABILITY</indicator>
	<indicator objective="LEVELC">CHANGEABILITY</indicator>
	<indicator objective="LEVELD">ANALYSABILITY</indicator>
</chart>

The attributes allowed for the chart element are the following:

isInverted (optional, default: true) when set to true, places the highest rank (usually the worst mark) at the centre of the Kiviat instead of on the outside.
currentLabel (optional, default: "Current") to set a custom tooltip label for the current value.
objectiveLabel (optional, default: "Objective") to set a custom tooltip label for the objective’s value.

The indicator element accepts a specific, optional objective attribute that draws a dotted line at the specified level representing the objective line.

The objective attribute accepts:

A scale level (LEVELA)
An indicator ID (TESTABILITY). In this case, both indicators must use the same scale.
A computation (LC+100). The computed value is then used together with the scale of the indicator to define the level to display.

Note that only a scale level is accepted for Kiviat charts in Model/Group Dashboards.

Indicator

This chart is supported only in Artefact Dashboards.

The Indicator displays the rating of the current artefact for a specific indicator.

Figure 4. Indicator with tooltips showing information about the scale for the indicator (left) and the actual rating of the artefact (right)

<chart type="INDICATOR" id="INDICATOR_EXAMPLE" topText="More efficient" bottomText="Less efficient">
	<indicator excludeLevels="UNKNOWN">ROOT</indicator>
</chart>

The chart takes exactly one indicator element and accepts the following attributes:

topText (optional, default Value: More efficient) is the text to display at the top of the scale on the chart.
bottomText (optional, default Value: Less efficient) is the text to display at the bottom of the scale of the chart.

The colours and level names displayed on the by Indicator are taken from the configuration of the scale levels for your indicator in your model:

<SQUORE_HOME>/configuration/models/shared/Analysis/SQuORE_PerformanceLevels_en.properties:

LOP.LEVELA.MNEMO=A
LOP.LEVELA.NAME=Level A
LOP.LEVELA.COLOR=#006893

LOP.LEVELB.MNEMO=B
LOP.LEVELB.NAME=Level B
LOP.LEVELB.COLOR=#00a38a
...

For more information about properties files, consult Properties files.

Optimised Bar

This chart is supported only in Artefact Dashboards.

The Optimised Bar chart is a bar chart that takes several measure as input. It simply displays a bar chart with the values previously computed.

Figure 5. Optimised Bar

<chart type="OPTIMIZEDBAR" id="OPTIMIZED_BAR_EXAMPLE" asPercentage="true">
	<measure color="#006893" label="A">A_FILE</measure>
	<measure color="#67C8B9" label="B">B_FILE</measure>
	<measure color="#79C142" label="C">C_FILE</measure>
	<measure color="#FEC422" label="D">D_FILE</measure>
	<measure color="#F6A01B" label="E">E_FILE</measure>
	<measure color="#F48026" label="F">F_FILE</measure>
	<measure color="#F25B21" label="G">G_FILE</measure>
</chart>

The Optimised Bar requires a minimum of two measure elements and supports the following attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
displayEmptyValue (optional, default: false) — Deprecated, should be replaced with displayEmptyData specifies whether categories with no value or a value of 0 are included on the chart
asPercentage (optional, default: false) specifies whether the values are displayed as real values or percentages
displayGlobalPercentage (optional, default: false) allows showing the global percentage value for each bar in the tooltip next to the relative percentage value.

Optimised Pie

This chart is supported only in Artefact Dashboards.

The Optimised Pie chart is a pie chart that takes several measure as input. It simply displays a pie chart with the values previously computed.

Figure 6. Optimised Pie Chart

<chart type="OPTIMIZEDPIE" id="OPTIMIZED_PIE_EXAMPLE" decimals="2">
	<measure label="Source">SLOC_ONLY</measure>
	<measure label="Comment">CLOC_ONLY</measure>
	<measure label="Mixed">MLOC</measure>
	<measure color="YELLOW" label="Blank">BLAN</measure>
</chart>

The Optimised Pie requires a minimum of two measure elements and supports the following attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
displayEmptyData (optional, default: false) forces the display of all levels in the scale when set to true, even if there are no artefacts for that level.
valueOnLabels (optional, default: false) displays the value alongside the labels.

SQALE Pyramid

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

This chart represents the SQALE Pyramid, representing a minimum of two different measures or indicators as a matrix.

Figure 7. SQALE Pyramid

<chart type="SQALEPYRAMID" id="SQALEPYRAMID_EXAMPLE">
	<measure label="My Testability">CLOC</measure>
	<measure label="Stability">LC</measure>
	<measure label="Changeability">BLAN</measure>
	<measure label="Analysability">SLOC</measure>
</chart>

Text Values

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Text Values chart is used to display one or more metrics as a large clickable element in your dashboard. The chart also optionally displays the trend for the displayed metrics.

Figure 8. Text Values

<chart type="TEXTVALUES" id="TEXTVALUES_EXAMPLE" layout="4x3" displayEvolution="true">
	<measure color="#006893">A_FILE</measure>
	<measure color="#00a38a">B_FILE</measure>
	<measure color="#79c142">C_FILE</measure>
	<measure color="#fec422">D_FILE</measure>
	<measure color="#f6a01b">E_FILE</measure>
	<measure color="#f48026">F_FILE</measure>
	<measure color="#f25b21">G_FILE</measure>
</chart>

The chart accepts the following attributes:

layout (optional, default: 1x1) defines how to display the metrics on the chart in terms of rows and columns.
titleColor (optional, default: #707070) is the color of the label for chart’s title.
displayEvolution (optional, default: false) allows displaying trends next to the metric value on the chart.

Current artefact descendants

When working with single-version data visualisation charts that considers the current artefact descendants, you need to define the set of descendant artefacts from which you want to display the data.

Defining Artefact Set

The set of artefacts is defined by the use of embedded paths and path elements, as follows:

<chart id="TICKETS_SATUSES_DISTRIBUTION" type="SimplePie">
  <paths>
    <path scope="CHILDREN" targetArtefactTypes="TICKETS">
      <path targetArtefactTypes="TICKET" />
    </path>
  </paths>
  ...
</chart>

The paths element only accepts one path element as a direct sub-element. Then each path element can accept another unique path element as a sub-element.

This construction allows to recursively retrieve artefacts based on the resulting artefacts set of the parent path element.

The path element supports the following attributes:

scope (mandatory) allows to define the artefact perimeter into which to look. Accepted values are:
- DESCENDANTS allows to consider all children of the current artefact and their descendants. Accepts the following additional attributes when defined:
  targetArtefactTypes (mandatory) allows to filter descendants according to their type. You can use one or more types. Concrete and abstract types are supported, so it is possible to use an alias, as described in Artefact Types.
  
  excludingTypes allows refining targetArtefactTypes to exclude certain types that may have been included via an alias.
- CHILDREN allows to consider only the direct children if the current artefact.
  targetArtefactTypes (mandatory) allows to filter descendants according to their type. You can use one or more types. Concrete and abstract types are supported, so it is possible to use an alias, as described in Artefact Types.
  
  excludingTypes allows refining targetArtefactTypes to exclude certain types that may have been included via an alias.
- LINKS allows to consider all artefacts linked to the current artefact. Accepts the following additional attributes when defined:
  linkType allows to filter artefacts linked to the current artefact according to their link type. For more information about links, refer to Artefact Links.
  
  linkDirection (optional, default: OUT) is used to specify the link direction to consider. Accepted values are:
  
  OUT to consider links from the current artefact towards other artefacts
  
  IN to consider links from other artefacts towards the current artefact

Filtering Artefact Set

The use of a where clause allows you to filter out artefacts based on a measure, indicator or textual information.

Squore checks if the metric/indicator/information specified is within the defined bounds for the artefact, in order to know if it should be included or not in the artefacts set.

The where clause is used as follows:

<chart id="TICKETS_SATUSES_DISTRIBUTION" type="SimplePie">
  <paths>
    <path scope="CHILDREN" targetArtefactTypes="TICKETS">
      <path targetArtefactTypes="TICKET">
        <where>
          <indicator id="STATUS" levels="TICKET_CLOSED;TICKET_IMPLEMENTING" />
          <measure id="AGE" bounds="[1;10]" />
          <info id="HANDLER" patterns="Harry*;Nadine" />
        </where>
      </path>
    </path>
  </paths>
  ...
</chart>

The where element accepts the following sub-elements:

measure to filter based on a measure. Following attributes are supported:
- id (mandatory) is the entity identifier in the analysis model
- values|bounds (mandatory) is respectively, a semicolon-separated list of values or an interval, to test for the specified metric
- invert (optional, default: false) allows checking for the invert of a condition when set to true
indicator to filter based on an indicator. Following attributes are supported:
- id (mandatory) is the entity identifier in the analysis model
- levels (mandatory) is a semicolon-separated list of scale levels to test for the specified metric
- invert (optional, default: false) allows checking for the invert of a condition when set to true
info to filter based on an information. Following attributes are supported:
- id (mandatory) is the entity identifier in the analysis model
- values|patterns (mandatory) is a semicolon-separated list of respectively, values or wildcard patterns, to test for the specified metric
- invert (optional, default: false) allows checking for the invert of a condition when set to true

Artefact Pie

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Artefact Pie offers a graphical representation of the values of a specific measure for each child artefact in a pie chart. The Artefact Pie requires one measure to define the size of the pie slice and accepts a colorFromIndicator attribute to pick the colors of the pie slices based on a scale. Clicking a pie slice takes you to the dashboard of the corresponding artefact.

Figure 9. Artefact Pie

<chart type="ARTEFACTPIE" id="ARTEFACT_PIE_EXAMPLE" colorFromIndicator="ROOT">
	<paths>
		...
	<paths>
	<measure>LC</measure>
</chart>

The chart tag accepts the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
valueOnLabels (optional, default: false) displays the value alongside the labels.

This chart can be used in Model/Group Dashboards. In this case, the only value allowed for targetArtefactTypes is APPLICATION. The chart displays the value of the specified metric for the last version of all projects in this model.

Artefact Scrumboard

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Artefact Scrumboard offers a graphical representation of child artefacts organised into categories that can be either levels on a scale, or different values for textual information or a measure. Each artefact is represented as a sticky note and is clickable, so you can reach the artefact’s dashboard directly from the scrumboard.

Figure 10. Artefact Scrumboard

<chart type="ARTEFACTSCRUMBOARD" id="ARTEFACT_SCRUMBOARD_EXAMPLE" postitByColumn="2" displayEmptyData="true" orderByMeasure="SLOC" invertedLevels="true">
	<paths>
		...
	<paths>
	<indicator excludeLevels="UNKNOWN;LEVELG">ROOT</indicator>
</chart>

Figure 11. Artefact Scrumboard based on the PRIORITY textual information

<?xml version="1.0" encoding="UTF-8"?>
<chart id="SCRUMBOARD_ISSUES" type="ArtefactScrumBoard" colorFromIndicator="STATUS" invertedLevels="true">
	<paths>
		...
	<paths>
  <info>PRIORITY</info>
</chart>

The Artefact Scrumboard requires one indicator, measure or info element to build the scrumboard categories.

The chart tag accepts the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
invertedLevels (optional, default: false) reverses the order of the scale levels on the board when set to true.
postitByColumn (optional, default: 3) specifies the minimum number of sticky notes to display per line in each category.
maxPostitWidth (optional, default: dynamic) specifies the maximum width to draw sticky notes. This setting may override the value of postitByColumn in some cases.
displayEmptyData (optional, default: false) forces the display of all levels in the scale when set to true, even if there are no artefacts for that level.
orderByMeasure (optional) allows ordering sticky notes in a category according to a specific measure.
inverted (optional, default: false) reverses the order of sticky notes in each category when set to true (still using the measure defined by orderByMeasure).

Artefact Series

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Artefact Series chart displays one or more metrics from descendant artefacts. The measure representation is defined by a renderer attribute (as explained in Using Datasets and Renderers ). The chart also allows clicking on an artefact to display its dashboard.

Figure 12. Artefact Series showing test statistics for child requirements

<chart type="ARTEFACTSERIES" id="ARTEFACT_SERIES_EXAMPLE" inverted="true" orderByMeasure="NUM_FAILING_TESTS" renderer="BAR" orientation="HORIZONTAL">
	<paths>
		...
	<paths>
	<measure color="CYAN">NUM_TESTS_CODE</measure>
	<measure color="GREEN">NUM_PASSING_TESTS</measure>
	<measure color="RED">NUM_FAILING_TESTS</measure>
</chart>

The Artefact Series can also be used to draw a stacked bar chart for child artefacts and include a line via the use of several datasets, as shown below:

Figure 13. An alternate representation of the same data in an Artefact Series chart

<chart type="ARTEFACTSERIES" id="ARTEFACT_SERIES_STACKED_BAR_EXAMPLE" inverted="true" orderByMeasure="NUM_FAILING_TESTS" orientation="VERTICAL">
	<paths>
		...
	<paths>
	<dataset renderer="STACKED_BAR">
		<measure color="RED" >NUM_FAILING_TESTS</measure>
		<measure color="GREEN" >NUM_PASSING_TESTS</measure>
	</dataset>
		<dataset renderer="LINE" rangeAxis="TOTAL">
		<measure color="CYAN">NUM_TESTS_CODE</measure>
	</dataset>
	<rangeAxis id="TOTAL" color="CYAN" min="0" location="left" type="number" numberFormat="INTEGER" />
</chart>

The chart element supports the following attributes:

asPercentage (optional, default: false) specifies whether the values are displayed as real values or percentages
displayEmptyData (optional, default: false) forces the display of artefacts for which there is no corresponding data.
renderer (optional, default: BAR) allows setting a common renderer for all measures in te chart. This can be omitted and overridden for individual datasets, as explained in Using Datasets and Renderers.
orderByMeasure (optional, default: the first measure in the chart definition) allows ordering the artefacts on the chart according to the specified measure.
inverted (optional, default: false) allows reversing the default order of artefacts

You can specify as many measure sub-elements as necessary for each artefact, using the syntax detailed in For measure and indicator elements.

Artefact Table

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Artefact Table allows displaying a list of child artefacts and one or more of their characteristics in table format, as shown below:

Figure 14. Artefact Table

<chart type="ARTEFACTTABLE" id="ARTEFACT_TABLE_MEASURE" xLabel="X axis"yLabel="Y axis">
	<paths>
		...
	<paths>
	<indicator>LC</indicator>
	<indicator displayValueType="NAME">TESTABILITY</indicator>
	<indicator displayValueType="RANK">STABILITY</indicator>
	<indicator displayValueType="MNEMONIC">CHANGEABILITY</indicator>
</chart>

In the example above, the indicators use different displayValueType to show all the supported values.

Figure 15. Artefact Table displaying LC for each direct FILE child

<chart id="ARTEFACT_TABLE_ID" type="ArtefactTable" xLabel="X axis" yLabel="Y axis">
	<paths>
		...
	<paths>
  <measure>LC</measure>
</chart>

The Artefact Table chart element may have the following attributes:

orderByMeasure (optional, alphabetical if omitted) allows sorting the list of artefacts according to the value of the specified measure ID.
inverted (optional, default: false) allows reversing the sort order defined by the orderByMeasure attribute.
displayEmptyData (optional, default: false) forces the display of artefacts for which there is no corresponding data.

The Artefact Table chart takes one or more indicator, measure or info sub-elements. Note that the table cells are automatically coloured according to the corresponding scale level colour when the metric displayed in the table is an indicator. This behaviour can be overridden by using the colorFromScale attribute, which takes a scale ID to apply colour from according to the rank of the value displayed.

In addition, you can add a row and column to aggregate the results found in each table row or column using the row or column element. Each of these elements accepts the following attributes:

aggregationType (optional, default: SUM) defines how the values are aggregated. Supported values are:
- MIN: minimal value
- MAX: maximal value
- OCC: number of data points
- AVG: average value
- DEV: standard deviation
- SUM: sum of values
- MED: median value
- MOD: modal value
label (mandatory) is a string that is displayed as the legend of the row or column.
color (optional, default: GREY) is the fill colour for the row or column.Working With Colours
colorFromScale (optional, default: empty) allows filling cells with a colour taken from a specific scale.

Artefact Time Series

This chart is supported only in Artefact Dashboards.

The Artefact Time Series chart displays one or more metrics from descendant artefacts on a timeline. It offers the same features as the Artefact Series chart and also provides options to aggregate by time period.

Figure 16. Artefact Time Series showing a daily timeline of files

<chart type="ArtefactTimeSeries" id="ARTEFACTTIMESERIES_EXAMPLE" timeMeasure="DATE_FILE" timeInterval="DAY" timeIntervalAggregationType="SUM" byTime="true" renderer="STACKED_BAR">
	<paths>
		...
	<paths>
	<dataset renderer="STACKED_BAR">
		<measure>SLOC</measure>
		<measure>CLOC</measure>
		<measure>BLAN</measure>
	</dataset>

	<dataset renderer="LINE">
		<measure color="ORANGE">LC</measure>
	</dataset>
</chart>

In the example above, files are sorted by creation date on a daily timeline, with bars representing daily aggregates of several line count metrics for each file.

The chart element supports the following attributes:

timeMeasure (mandatory) is the measure ID (of type DATE) used to place an artefact on the timeline
byTime (optional, default: false) enforces the timeline display

For interval and aggregation settings, refer to Temporal Charts.

You can specify as many measure sub-elements as necessary for each artefact, using the syntax detailed in For measure and indicator elements.

Cell Artefact Table

This chart is supported only in Artefact Dashboards.

The Cell Artefact Table offers a tabular representation of descendant artefacts of a certain type with added grouping and filtering possibilities compared to other table charts.

Figure 17. Cell Artefact Table

<chart	type="CellArtefactTable" id="CELLARTEFACTTABLE_EXAMPLE" colorFromIndicator="ROOT" orderByMeasure="RUN_DATE" enabledAxisLabels="true" insideAxisLabels="false" artefactNameAsColumn="true">
	<paths>
		...
	<paths>
	<groups>
		<group type="LINE" ancestorLevel="2" orderBy="NAME" />
	</groups>
</chart>

Figure 18. The test tree represented in the example chart shows each test suite as a cell, grouped on the same line by ancestor level -2 (the type of testing activity)

The test tree represented in the example chart shows each test suite as a cell, grouped on the same line by ancestor level -2 (the type of testing activity).

The chart tag accepts the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
orderByMeasure (optional, alphabetical if omitted) allows sorting the list of artefacts according to the value of the specified measure ID.
enabledAxisLabels (optional, default: true) allows showing (true) or hiding (false) axis labels
insideAxisLabels(optional, default: false) allows printing the axis labels to the right of the y-axis (true) instead of to the left (false)
artefactNameAsColumn (optional, default: false) allows printing the artefact names inside the cells (false) or at the top of each column (true)

Grouping can be achieved via a group element defining an ancestorLevel:

<groups>
	<group type="COLUMNS" ancestorLevel="1" />
	<group type="LINE" ancestorLevel="2" orderBy="NAME" />
	<group type="LINES" ancestorLevel="1" orderBy="NAME" />
</groups>

Distribution Table

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Distribution Table is a matrix-like visualisation of two characteristics of an artefact’s descendants

Figure 19. Distribution Table

<chart type="DISTRIBUTIONTABLE" id="DIST_TABLE_FIXED_COLOR_EXAMPLE" xLabel="Testability" yLabel="Number of Artefacts" topColor="ORANGE" bottomColor="BLUE">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
	<indicator>TESTABILITY</indicator>
	<row aggregationType="SUM" label="Total Col" color="GRAY" />
	<column aggregationType="SUM" label="Total Line" color="GRAY" />
</chart>

The Distribution Table chart element may have the following attributes:

color (optional, default: WHITE) is the colour used to fill all the cells in the table. An example Distribution Table using color is shown later in this section.Working With Colours.

Instead of using a single colour for the entire table, you can use topColor, middleColor and bottomColor to colour the top, middle and bottom sections of the chart respectively in different colours, as in the main example above.Working With Colours

colorFromScale (optional, default: none) is the colour scale used to fill the cells in the table according to the rank of each cell. An example Distribution Table using colorFromScale is shown later in this section.

Instead of using a single scale for the entire table, you can use topcolorFromScale, middlecolorFromScale and bottomcolorFromScale to colour the top, middle and bottom sections of the chart respectively using different colour scales.

If several colour attributes are found, they are applied in this order:

top|middle|bottomColorFromScale
top|middle|bottomColor
colorFromScale
color

The Distribution Table chart takes two indicator sub-element that will be used to build a matrix of scale levels.

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

In addition, you can add a row and column to aggregate the results found in each table row or column using the row or column element. Each of these elements accepts the following attributes:

aggregationType (optional, default: SUM) defines how the values are aggregated. Supported values are:
- MIN: minimal value
- MAX: maximal value
- OCC: number of data points
- AVG: average value
- DEV: standard deviation
- SUM: sum of values
- MED: median value
- MOD: modal value
label (mandatory) is a string that is displayed as the legend of the row or column.
color (optional, default: GREY) is the fill colour for the row or column.Working With Colours
colorFromScale (optional, default: empty) allows filling cells with a colour taken from a specific scale.

Some simpler examples of Distribution Table charts can be found below:

Figure 20. Simple Distribution Table

<chart type="DISTRIBUTIONTABLE" id="DIST_TABLE_EXAMPLE" xLabel="Testability" yLabel="Number of Artefacts">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
	<indicator>ANALYSABILITY</indicator>
</chart>

Figure 21. Distribution Table with cells coloured according to a scale

Chart:
<chart type="DISTRIBUTIONTABLE" id="DIST_TABLE_SCALE_COLOR_EXAMPLE" xLabel="Testability" yLabel="Number of Artefacts" colorFromScale="SCALE_TEST_BASIC">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
	<indicator>TESTABILITY</indicator>
</chart>


Scale:
<Scale scaleId="SCALE_TEST_BASIC">
	<ScaleLevel levelId="LEVELA" bounds="];1]" rank="1" />
	<ScaleLevel levelId="LEVELB" bounds="]1;2]" rank="2" />
	<ScaleLevel levelId="LEVELC" bounds="]2;4]" rank="3" />
	<ScaleLevel levelId="LEVELD" bounds="]4;8]" rank="4" />
	<ScaleLevel levelId="LEVELE" bounds="]8;16]" rank="5" />
	<ScaleLevel levelId="LEVELF" bounds="]16;32]" rank="6" />
	<ScaleLevel levelId="LEVELG" bounds="]32;[" rank="7" />
</Scale>

Figure 22. Simple Distribution Table with red/green

Chart:
<chart type="DISTRIBUTIONTABLE" id="DIST_TABLE_SCALE_COLOR_TWO_COLORS_EXAMPLE" xLabel="Testability" yLabel="Number of Artefacts" topColorFromScale="SCALE_GREEN" middleColorFromScale="SCALE_RED" bottomColorFromScale="SCALE_RED">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
	<indicator>TESTABILITY</indicator>
</chart>


Scales:

<Scale scaleId="SCALE_GREEN">
	<ScaleLevel levelId="BLANK" bounds="];1[" rank="-1" />
	<ScaleLevel levelId="LEVELA" bounds="[1;[" rank="1" />
</Scale>

<Scale scaleId="SCALE_RED">
	<ScaleLevel levelId="BLANK" bounds="];1[" rank="-1" />
	<ScaleLevel levelId="LEVELG" bounds="[1;[" rank="1" />
</Scale>

Gantt

This chart is supported only in Artefact Dashboards.

The Gantt chart is usually used to illustrate a project schedule. It can be helpful to plan, coordinate and track specific tasks in said project.

Figure 23. Gantt chart

<chart id="Gantt">
  <paths>
    ...
  <paths>
  <start>START</start>
  <end>END</end>
  <completed>COMPLETED</completed>
  <dependency linkType="CHILD_OF" linkDirection="OUT" />
  <groups groupByAncestors="true" />
  <milestones>
    <measure color="#da8989">M1</measure>
    <measure>M2</measure>
    <measure>M3</measure>
    <measure label="Milestone 20%">M4</measure>
    <measure label="Milestone 80%">M5</measure>
  </milestones>
  <markers>
    <marker isVertical="true" value="VERSION_DATE()+DAYS(1967)+IS_NEW_ARTEFACT()*79200000" color="#db5050" label="Date: {start}" labelAnchor="TOP_LEFT" labelFontSize="11" labelFontStyle="ITALIC" labelColor="#ff5656" />
  </markers>
</chart>

The chart element may have the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.

The chart takes the following elements :

start is the start date of the task.
end is the end date of the task.
completed is the level of completion of the task.
dependency allows to display the tasks dependencies between each others. Following attributes are required :
- linkType allows to filter artefacts linked to the current artefact according to their link type. For more information about links, refer to Artefact Links.
- linkDirection (optional, default: OUT) is used to specify the link direction to consider. Accepted values are:
  
  OUT to consider links from the current artefact towards other artefacts
  
  IN to consider links from other artefacts towards the current artefact
groups allows to group the tasks according to their ancestors.
milestones allows to display milestones icons in tasks. Following elements are supported :
- measure is used to specify the measure to consider for displaying the milestone. Following attributes are supported :
  - label is the label that will be displayed in the milestone’s tooltip when hoovering over its icon.
  - color is the color of the milestone’s icon.
  - alpha is the transparency level of the milestone’s icon.

Gantt chart does not support the LINKS value for the scope attribute of path element. See Current artefact descendants to know more about path element.

Histogram

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

A typical Histogram that shows the repartition of a value for the children of the selected artefact It requires one measure element.

Figure 24. Histogram

<chart type="HISTOGRAM" id="HISTOGRAM_EXAMPLE" nbBars="10">
	<paths>
		...
	<paths>
	<measure color="ORANGE">LC</measure>
</chart>

The chart element may have the following attributes:

nbBars sets the number of bars desired in the chart.

You can control the bounds of the axis of this chart using the datBounds attribute on each metric, as explained in For measure and indicator elements.

Network

This chart is supported only in Artefact Dashboards.

The Network chart allows to display data using a series of nodes and links. It is useful to visualize the interconnections and relationships between the elements of a given set of data.

Figure 25. Network chart showing Mars project artefacts

<chart type="Network" id="NETWORK_LINKS" animation="true" fixedRootNode="true">
	<paths>
		<path scope="DESCENDANTS" targetArtefactTypes="REQ_FOLDER">
			<path scope="CHILDREN" targetArtefactTypes="REQ">
				<path scope="LINKS" linkTypes="SATISFIED_BY;IMPLEMENTED_BY;TESTED;TESTED_BY" />
			</path>
		</path>
	</paths>
	<measure>TEST_DURATION</measure>
</chart>

The chart element accepts the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
animation (optional, default: true) to enable animation while chart is loading.
fixedRootNode (optional, default: true) to center the current artefact node in the drawing area.
maxDisplayableLabels (optional, default: 30) to specify the maximum number of nodes for which the label will be displayed.
artefactsLimit (optional, default: 2000) to specify the maximum number of nodes to display. (No data is displayed in case the number of artefacts is over the limit).

The chart element accepts the following sub-elements:

measure (optional) to specify the measure to use for computing the nodes size. Only a measure valid for all the types of every artefact set elements returned by the last level can be used.

In addition to the common attributes of the path element, this charts also accepts the following:

displayAncestorNodes (optional, default: true) to display the ancestors of the artefact returned by the artefacts set (even though they do not match the conditions of the artefacts set).
hideLeaves (optional, default: false) to hide the nodes without any relationships with any of the elements returned by the artefacts set of the level below (dead-end nodes).

Pivot Table

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Pivot Table displays, combines and summarises information from several metrics, grouping them by indicator level. The Pivot Table displays a column per included metric and additional columns showing the min, max, count or data aggregates for each line.

Figure 26. A Pivot Table crossing results of two indicators for all functions in a project

<chart id="PIVOT_TABLE_EXAMPLE" type="PIVOTTABLE">
	<paths>
		...
	<paths>
  <indicator>ANALYSABILITY</indicator>
  <indicator>LC</indicator>
</chart>

Figure 27. A Pivot Table displaying ticket counts and age information

<chart id="PIVOT_TABLE_ADVANCED" type="PivotTable" inverted="true">
	<paths>
		...
	<paths>
  <indicator excludeLevels="TICKET_CLOSED">STATUS</indicator>
  <columns>
    <column measureId="AGE" aggregationType="MIN" label="newest (MIN of Age)" />
    <column measureId="AGE" aggregationType="MAX" label="oldest (MAX of Age)" />
  </columns>
</chart>

The chart takes one or more indicator, measure or info elements and accepts the following attributes:

colorFromScale (optional, default: empty, uses the scale from the first column of the chart) allows filling cells with a colour taken from a specific scale.
orderByCount (optional, default: false) allows ordering the table according to the count column when set to true instead of using the scale of the first column of the chart.
countBounds (optional, default: none) allows to restrict the considered values to a specific interval. If the value is outside the defined interval, it is not included in the computation.
inverted (optional, default: false) allows reversing the sort order of lines in the chart.
displayEmptyData (optional, default: false) forces the display of artefacts for which there is no corresponding data.

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

Extra columns can be added to the columns block, where each column supports the following attributes:

measureId is the identifier of the measure to display in the colum
aggregationType (optional, default: SUM) defines how the values are aggregated. Supported values are:
- MIN: minimal value
- MAX: maximal value
- OCC: number of data points
- AVG: average value
- DEV: standard deviation
- SUM: sum of values
- MED: median value
- MOD: modal value
valueType (optional, default: VALUE) allows changing the value that is displayed, using one of the following:
- VALUE displays the measure’s value in the current version
- REFERENCE displays the measure’s value in the selected reference version
- DELTA displays the measure’s delta value based on the selected reference version
countBounds (optional, default: none) allows to restrict the considered values to a specific interval. If the value is outside the defined interval, it is not included in the computation.

Using columns that display aggregated MOD and MED values of metrics requires a version of PostgreSQL that supports the mode() and median() functions, which are only available from PostgreSQL 9.4 and up.

Quadrant

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Quadrant chart displays information about the descendants of the current artefact. Three measures are required to construct the chart: one for the X-axis, one for the Y-axis one for the size of the bubbles. The chart also allows to set markers to define coloured areas.

Figure 28. Quadrant Chart

<chart type="QUADRANT" id="QUADRANT_EXAMPLE">
	<paths>
		...
	<paths>
	<xmeasure>CLOC</xmeasure>
	<ymeasure>SLOC</ymeasure>
	<zmeasure>LC</zmeasure>
	<markers>
		<marker value="15" color="BLACK" alpha="50" isVertical="true" />
		<marker value="200" color="BLACK" alpha="50" isVertical="false" />
	</markers>
</chart>

The chart element may have the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.

The chart requires the following sub-elements:

xmeasure is the measure used on the X-axis.
ymeasure is the measure used on the y-axis.
zmeasure is the measure used to scale the bubbles respective to each other.

Simple Bar

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Simple Bar chart presents the aggregation of the different ratings found in all the children of the selected artefact as a histogram.

Figure 29. Simple Bar

<chart type="SIMPLEBAR" id="SIMPLE_BAR_EXAMPLE">
	<paths>
		...
	<paths>
	<indicator>LEVEL</indicator>
</chart>

The Simple Bar chart element may have the following attributes:

decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
displayEmptyValue (optional, default: false) — Deprecated, should be replaced with displayEmptyData specifies whether categories with no value or a value of 0 are included on the chart
asPercentage (optional, default: false) specifies whether the values are displayed as real values or percentages

The Simple Bar chart takes only one indicator or info as a sub-element.

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

Simple Pie

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Simple Pie chart presents the aggregation of the different ratings found in all the children of the selected artefact.

Figure 30. Simple Pie

<chart type="SIMPLEPIE" id="SIMPLE_PIE_EXAMPLE">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
</chart>

The chart also allows you to use multiple indicators or informations to build a doughnut chart, or a clickable chart to let users click pie sections to drill down data.

A maximum of 4 indicators is supported

Figure 31. Simple Pie with several categories displayed as a doughnut

<chart type="SIMPLEPIE" id="SIMPLE_PIE_DOUGHNUT">
	<paths>
		...
	<paths>
	<indicator>STATUS</indicator>
	<indicator>DETAILED_STATUS</indicator>
</chart>

Figure 32. The same Simple Pie with the drill-down option enabled makes it possible to click each pie section to get deeper into the data

<chart type="SIMPLEPIE" id="SIMPLE_PIE_DRILLDOWN" drilldown="true">
	<paths>
		...
	<paths>
	<indicator>STATUS</indicator>
	<indicator>DETAILED_STATUS</indicator>
</chart>

The Simple Pie chart takes one or more indicator or info sub-elements.

The Simple Pie chart element may have the following attributes:

drilldown (optional, default: false) allows you to configure the Simple Pie as interactive chart where users can click pie slices to drill down deeper into the data.
displayEmptyValue (optional, default: false) — Deprecated, should be replaced with displayEmptyData specifies whether categories with no value or a value of 0 are included on the chart
decimals (optional, default: 0) is the number of decimals places to be used for displaying values.
valueOnLabels (optional, default: false) displays the value alongside the labels.

The indicator element supports excluding certain levels from the chart by using the excludeLevels attribute. For example:

<indicator excludeLevels="LEVELA;LEVELB">LEVEL</indicator>

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

Note: This chart is equivalent to using an Optimised Pie Chart with the definition shown below. The pie chart is optimised because the measures it uses have already been computed during the analysis and do not need to be calculated on the fly.

<chart type="OptimizedPie" decimals="2" >
	<measure color="0,81,0" label="A">A_FILE</measure>
	<measure color="3,127,3" label="B">B_FILE</measure>
	<measure color="133,182,2" label="C">C_FILE</measure>
	<measure color="255,255,0" label="D">D_FILE</measure>
	<measure color="255,150,0" label="E">E_FILE</measure>
	<measure color="255,80,0" label="F">F_FILE</measure>
	<measure color="255,0,0" label="G">G_FILE</measure>
</chart>

Stacked Bar

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Stacked Bar crosses the performance levels of two indicators, measures or textual infos for the children of the selected artefact along two axes.

Figure 33. Stacked Bar chart

<chart type="STACKEDBAR" id="STACKED_BAR_EXAMPLE">
	<paths>
		...
	<paths>
	<indicator>ROOT</indicator>
	<indicator>TESTABILITY</indicator>
</chart>

The chart element may have the following attributes:

displayEmptyData (optional, default: false) forces the display of artefacts for which there is no corresponding data.
inverted (optional, default: false) reverses the order of the bars on the chart when set to true.
asPercentage (default: false) displays the values as percentages when set to true.

The chart support two indicator, measure or info elements.

It also supports the common distributed charts grouping and aggregating features defined in Distributed Charts section.

Treemap

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Treemap offers a graphical representation of child artefacts as a set of tiled rectangles. The Treemap requires one measure to define the size of the tiles and accepts a colorFromIndicator attribute to pick the colors of the tiles. Tiles are generated from largest to smallest, and from top left to bottom right. Clicking a tile takes you to the dashboard of the corresponding artefact.

Figure 34. Treemap

<chart type="TREEMAP" id="TREEMAP_EXAMPLE" colorFromIndicator="ROOT">
	<paths>
		...
	<paths>
	<measure>LC</measure>
</chart>

The chart tag accepts the following attributes:

colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
defaultColor (optional, default: RANDOM colour based on artefact name) uses an indicator’s colour scale to assign a colour to each drawn tile. Working With Colours
artefactsLimit (optional, default: 2000) allows limiting the number of child artefacts to include.
maxDisplayableLabels (optional, default: 250) allows you to limit the number of tiles that get a label on a treemap. This is only useful if you have large treemap charts that cause performance issues.

X/Y-Cloud

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The X/Y-Cloud chart is a visual representation of the values of two measures or indicators for the children of the selected artefact. For each child of the requested type, a dot is drawn with the value found for the selected measure.

Figure 35. X/Y-Cloud Chart

<chart type="CORRELATEDCLOUD" id="CORRELATED_CLOUD_EXAMPLE" coeff="1" colorFromIndicator="LEVEL">
	<paths>
		...
	<paths>
	<xmeasure>TESTABILITY</xmeasure>
	<ymeasure>STABILITY</ymeasure>
</chart>

The chart element may have the following attributes:

showPolynomialRegression (optional, default: true) Whether the polynomial regression is drawn (true) or not drawn (false) on the chart.
coeff (optional, default: 1) the degree of the drawn polynomial. Supported values are:
- 1 for linear
- 2 for quadratic
- 3 for cubic
colorFromIndicator (optional, default: none) uses the specified indicator’s colour scale to assign a colour to each item drawn on the chart.
shape (optional, default: SQUARE) defines the shape of the points on the chart. The supported values are:
- SQUARE
- CIRCLE
- DIAMOND
- UP_TRIANGLE
- DOWN_TRIANGLE
- RIGHT_TRIANGLE
- LEFT_TRIANGLE
- HORIZONTAL_RECTANGLE
- VERTICAL_RECTANGLE
- HORIZONTAL_ELLIPSE
- VERTICAL_ELLIPSE
shapeWidth (optional, default: 4.0) defines the width of the point on the maximised chart.
miniShapeWidth (optional, default: 2.0) defines the width of the point on the chart thumbnail.

The chart takes one xmeasure element and one ymeasure with the following attributes.

label (optional) is the label used for the axis associated to the indicator. If omitted, the indicator’s name is used by default.

Y-Cloud

This chart is supported in Model/Group Dashboards and Artefact Dashboards.

The Y-Cloud chart is a visual representation of the values of a measure or indicator for the children of the selected artefact. For each child of the requested type, a dot is drawn with the value found for the selected measure. The chart requires one indicator element.

Figure 36. Y-Cloud Chart

<chart type="YCloud" id="YCLOUD_EXAMPLE">
	<paths>
		...
	<paths>
	<indicator color="RED">LC</indicator>
</chart>