1. Home
  2. Docs
  3. JZR report
  4. Customization
  5. Highlights

Highlights

Highlights are configuration elements which drive the background color display of key elements.

Highlights are basically key / color value pairs.
Highlights are declared within highlights blocks which can itself refer to other highlights blocks stored in files.

<highlights>
<highlight name="work" color="ORANGE"/>
<highlight name="on hold" color="BRIGHT_GREEN"/>
<highlights highlights_config_file="${SHARED_RESOURCES_DIR}/report/highlights/other-shared-values.xml"/>
</highlights>

As an example, if the highlights is used in an action function display rule, the “work” function will be displayed in orange in the related Task Sequence.

In the JZR reports, the legend section will display the key / color value pairs.

Highlights do support regex patterns:
<highlight name="Oracle interaction" regex="Oracle.*" color="ORANGE"/>
In the previous example, any function matching the regex would be highlighted in orange and the associated legend would display the “Oracle interaction” label in orange.

A more advanced version of the highlight is used with the discovery functions :
<highlight regex=".*" color="ORANGE"/>
Displayed names is set dynamically based on the value(s) matching the pattern.
Discovery legend label is set with the “d” letter to distinguish it from other highlights.
Discovery highlight is always applied at last : preset highlight are applied first followed by regex ones.