Highlighting in KPI Scorecards

The highlightings structure in a kpiscorecard configures how rows and comparisons should be highlighted or colorized in the KPI scorecard portlet. Highlighting makes results more visible.

Each highlighting option in the highlightings structure is represented by the highlighting structure. The following is an example of a highlightings structure that uses a single highlighting option:

              ...
    <highlightings>
        <highlighting>
            <kpiindex>1</kpiindex>
            <condition>ALWAYS</condition>
            <threshold>2.0</threshold>
            <rangeindex>1</rangeindex>
            <backgroundcolor>000000</backgroundcolor>
            <bold>T</bold>
            <foregroundcolor>FF0000</foregroundcolor>
            <headline>T</headline>
            <icon>DOLLAR_SIGN_3</icon>
        </highlighting>
    </highlightings>
    ...

Set the kpiindex value to the KPI that the highlighting should apply to. This is an integer-based value that’s determined by how the KPIs appear in the kpis structure of the kpiscorecard, starting with the number 1. By default, the highlighting applies to all KPIs.

Set the condition element to any of the following values to indicate how the result should be compared to the threshold value:

ALWAYS
GREATER_THAN
LESS_THAN
MAGNITUDE_GREATER_THAN
MAGNITUDE_LESS_THAN

Set the threshold element to a floating point value. The highlighting takes effect when the criteria of the condition is met against the threshold value.

Set the rangeindex value to a range. This is an integer-based value that’s determined by how the ranges appear in the ranges structure of the kpiscorecard, starting with the number 1. This range determines whether highlighting should be applied when the comparison with the threshold is performed. By default, the highlighting applies to all ranges.

Set any of the following elements to specify the highlighting that should be applied when the criteria of the condition is met against the threshold value:

icon: Displays an icon with the highlighted results. For more information about possible icon values, see kpiscorecards_highlight_icons.
foregroundcolor: Changes the text color of the highlighted result. This value must be set to a valid 6-digit hexadecimal RGB value between #000000 and #FFFFFF, where #000000 represents black and #FFFFFF represents white. The # prefix is optional.
backgroundcolor: Changes the background color of the highlighted result. This value must be set to a valid 6-digit hexadecimal RGB value between #000000 and #FFFFFF, where #000000 represents black and #FFFFFF represents white. The # prefix is optional.
bold: Set this Boolean value to T to bold the text of the highlighted result.
headline: Set this Boolean value to T to display the highlighted result as a headline, in large bold text at the top of the KPI scorecard portlet.

For more information about highlighting elements, see highlighting.

Related Topics