The top element of the highlights bundle consists of a Bundle
top element in which two elements are allowed:
Role
defines the user roles allowed to use the predefined highlight categories for this model using the name
attribute (mandatory) and the default artefact type selected in the UI using the preSelectedType
attribute (optional).Filters
defines a list of highlight categories for certain types of artefact types, defined using the type
attribute.There are several types of predefined highlights categories:
TopArtefacts
is used to retrieve artefacts with
the biggest value for a given measure.TopDeltaArtefacts
is used to retrieve artefacts
with the biggest variation in the value of a given measure since an earlier version.TopBorderlineArtefacts
is used to retrieve
artefacts that are closest to the upper limit of a given scale level, and therefore
most likely to be easy to improve with the smallest effort.TopNewArtefacts
is used retrieve artefacts that
are new in the current version, sorted according to the value of a given measure.TopModifiedArtefacts
is used to retrieve the artefacts
modified in the current version, sorted according to the value of a given measure.
TopArtefacts
allows the following attributes:
id
(mandatory): the id of the filter.name
(deprecated): unused.artefactTypes
(optional): the types of artefacts to filter on.excludingTypes
(optional, default: none): the artefact types for which the metric should not be displayed. This allows refining the types entered in the main filter above.measureId
(optional, default: the measureId associated with the root indicator): the name of the measure Id to filter on.order
(optional, default: ASC): the sort order for the list according to the reference measure ID. Valid values are ASC and DESC.altMeasureId
(optional, default: empty): The second measure ID to use for sorting.altOrder
(optional, default: empty): The sort order for the second measure ID. Valid values are ASC and DESC.resultSize
(mandatory): the number of results to include in the list. Use 10 to display 10 artefacts or * to display all artefacts.
altMeasureId
and altOrder
shall be both set or not set.
TopDeltaArtefacts
allows the following attributes:
id
(mandatory): the id of the filter.name
(deprecated): unused.artefactTypes
(optional): the types of artefacts to filter on.measureId
(optional, default: LEVEL): the name of the measure Id to filter on.order
(mandatory): the sort order for the list according to the reference measure ID. Valid values are ASC and DESC.resultSize
(mandatory): the number of results to include in the list. Use 10 to display 10 artefacts or * to display all artefacts.
TopBorderlineArtefacts
allows the following attributes:
id
(mandatory): the id of the filter.name
(deprecated): unused.artefactTypes
(optional): the types of artefacts to filter on.indicatorId
(optional, default: LEVEL): the name of the measure Id to filter on.minLevel
(optional, default: empty): The name of the rank to be used as the threshold for results. If you want to exclude artefacts above LEVELC, set minLevel to LEVELC.order
(mandatory): the sort order for the list according to the reference measure ID. Valid values are ASC and DESC.resultSize
(mandatory): the number of results to include in the list. Use 10 to display 10 artefacts or * to display all artefacts.
TopNewArtefacts
allows the following attributes:
id
(mandatory): the id of the filter.name
(deprecated): unused.artefactTypes
(optional): the types of artefacts to filter on.measureId
(optional, default: LEVEL): the name of the measure Id to filter on.order
(mandatory): the sort order for the list according to the reference measure ID. Valid values are ASC and DESC.resultSize
(mandatory): the number of results to include in the list. Use 10 to display 10 artefacts or * to display all artefacts.
TopModifiedArtefacts
allows the following attributes:
id
(mandatory): the id of the filter.name
(deprecated): unused.artefactTypes
(optional): the types of artefacts to filter on.order
(mandatory): the sort order for the list according to the reference measure ID. Valid values are ASC and DESC.resultSize
(mandatory): the number of results to include in the list. Use 10 to display 10 artefacts or * to display all artefacts.
All highlights categories support the following nested elements, to customise output:
Column
allows the following attributes:
measureId
(optional): the ID of the measure.indicatorId
(optional): the ID of the indicator.artefactTypes
(optional, default: the parent value of artefactTypes
): the artefact types for which the metric should be displayed. This allows refining the types entered in the main filter above.excludingTypes
(optional, default: the parent value of excludingTypes
): the artefact types for which the metric should not be displayed. This allows refining the types entered in the main filter above.headerDisplayType
(optional, default: NAME): the label to display in the header.
NAME
is the measure's nameMNEMONIC
is the measure's mnemonicdisplayType
(optional, default: VALUE): the value display type.
VALUE
is the measure's numeric value.RANK
is the indicator's rank.ICON
is the indicator's rank icon.DATE
is the measure's value, displayed as an UTC date.DATETIME
is the measure's value, displayed as an UTC date and time.TIME
is the measure's value, displayed as an UTC time.dateStyle
(optional, default: DEFAULT): the date formatting style,
used when the displayType is one of DATE or DATETIME.
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.
decimals
(optional, default: 2): the number of decimals, used when
the displayType is VALUE.suffix
(optional, default: empty): the text to display after the measure.
Where
allows the following attributes:
OrderBy
allows the following attributes: