Configuring the Header Rule

Use the Format Header Properties frame to specify the rule for the header that is displayed for each dashboard frame.

The rule consists of three parts.

  1. Static title—A title is displayed in the Format Header text label regardless of whether filters are set for the dashboard.

  2. Prefix header—One or more filter columns can be set as prefix headers for the frame. If a value from a filter is set, the set value is displayed as a prefix for the specified static title. A default prefix value can also be specified.

  3. Suffix header—Filters are specified to display as suffixes for the static title.

When header columns are selected, the order in which columns are listed is the order in which values are displayed in the Format Header text label. By default, prefix and suffix filter values are displayed unconditionally. However, an option is available to include a group of columns as part of a hierarchy. In a hierarchy, only one filter is displayed on the header at a time. The value for the lowest set filter is shown in the header. A combination of hierarchical or non-hierarchical columns in a prefix or suffix specification is possible. For example, if locality and city are set as header columns and [H] Part of Hierarchy is selected for the columns:

However, if locality and city are set as header columns and [H] Part of Hierarchy is not selected, CA and Long Beach are displayed in the header.

A format can be applied to one or more header columns. Header formats can be applied unconditionally or only if a value from a prior filter is set.

For example, if year and quarter are set as header columns and [F] Show if Prior filter exists is selected for quarter, applying quarter = Q1 as a filter results in:

  1. Q1 (with formatting) is added to the header if a year filter is set.

  2. Q1 (with no formatting) is added to the header if no year filter is set.

Spaces are inserted between the three header parts. However, to allow for formatting such as comma separators, no space is inserted between the columns inside the prefix or suffix.

*  To configure the Format Header feature:

  1. In Interactive Reporting Studio, open a dashboard that contains the Format Header component.

  2. Navigate to Format Header Properties.

    To access the configuration frame, use Sections or the Configuration drop-down list found in Dashboard Studio.

  3. From Define Format Header, select the frame to configure.

    The listed frames vary depending upon which option is selected:

    • All dashboards—All frames are available from the list

    • Configured dashboards—Only frames with applied headers are available

    • Unconfigured dashboards—Only frames without applied headers are available

      If a selected dashboard does not contain a Format Header text label, a message is displayed requesting that the text label must be configured.

  4. Optional: Perform an action:

    • To view the selected section, click View button

    • To copy the Format Header specifications from one frame to another, click Copy button, select another dashboard, and click Paste button to paste

  5. Optional: Enter a Static Heading for the dashboard.

  6. In Configure Header Columns, select an option to configure the Prefix or Suffix header.

  7. In Define Format, perform an action:

    • Select [F] Show if prior filter exists, to apply the format only if a value from a prior filter in the list is set (If this option is not selected, the format is displayed)

    • Enter the left and right format characters to apply to the filter values (For example, enter ( in Left format characters and ) in Right format characters)

    For example, to define the format:

    1. From Configure Header Columns, select Suffix.

    2. From Filters Columns, select an item and click Next button to move it to Suffix Filter Columns.

      For example, [- : -] Year is displayed, where [- : -] indicates that Year is always displayed.

    3. Select [F] Show if prior filter exists, and enter ( in the Left format characters and ) in the Right format characters.

    4. From Filters Columns, select another item and click Next button to move it to Suffix Filter Columns.

      For example, [- :F] (Quarter) is displayed, where (Quarter) indicates that it is a suffix to the Year filter; for example, 2000 (Q4).

  8. In Select Header Columns, select the filter columns to set as prefix or suffix headers for the frame.

  9. Optional: Perform one or all of these actions:

    • Select [H] Part of Hierarchy to make a filter part of a hierarchy (Selected Filter Columns are displayed in Prefix or Suffix Filter Columns with [H:-])

    • Move selected columns between Filter Columns and Prefix or Suffix Filter Columns, by clicking Next button and Back button

    • Reorder the Prefix or Suffix Filter Columns by selecting a column and clicking Move Up button or Move Down button (Moving columns may affect the outcome of the header, if [F] Show if prior filter exists or [H] Part of Hierarchy options are set for the columns)

  10. Optional: Enter a Default Prefix or Suffix for the frame.

  11. Perform an action:

    • To reload the original settings, click Restore

    • To clear current entries, click Clear

    • To save the configured header specifications, click Apply