Report Metrics are KPI Chart components that live natively inside a Report, displaying a numeric measure with variance calculations, status indicators (Stoplight), overlays, and a Summary Panel. They are the modern successor to standalone Metrics. This article describes how to configure a Report Metric from Report Editor.
PREREQUISITES:
- Admin, or a Power User with the Create content using Datasets Privilege and Edit Access to the Report.
- A Dataset with a date column, or a Snapshot Dataset.
1. Configure Measures
Access Content > Report Name Link > Content tab
- Report Metric: Drag a component from the Components Panel onto the Report layout.
- Title: Enter a descriptive phrase.
- Date Column: Choose the Dataset column that supplies the X-axis (the Metric's date dimension). For a Snapshot Dataset, you can choose Snapshot Date.
- [+Measure]: Add a numeric column and its aggregation function if needed to plot as the Y-axis values.
- For each entry in the Measure fields you can:
- flag one measure as Primary: the KPI the visualization leads with, when more than one measure exists;
- enable Default Overlay in Tile and Default Overlay in Full Chart: show this measure in the Tile image and in emailed images. By default, images show only the Primary measure;
- set its color;
- relabel it (gear icon to the right).
- NOTE: With Aggregation "None", the Dataset must have one row per date. Otherwise, the chart shows only the first row for each date.
- For each entry in the Measure fields you can:
- Each filter value is a new series: Enable to draw one line for each value selected in a Report Filter, e.g., one line per country.
NOTE: Values printed on the chart use the display mask of the underlying measure column, so on-chart formatting matches the formatting applied to the Dataset column.
2. Add Alert Rule
- [+Alert Rule]: Add an Alert Rule pre-configured via the Report Editor.
- NOTE: Reports built from a saved Dataset View cannot have new Alert Rules. Build the Report from the Dataset's "All data" View instead.
- For instructions on how to configure Alert Rules, refer to Adding Alert Rules to Dataset Report.
3. Configure Stoplight Status
Stoplight adds status indicators to the Metric based on how the current value compares to a threshold, a prior value, or a target.
- Include Stoplight: Enable.
- More is better?: Enable if higher values are favorable.
- Calculate Stoplight by comparing: Choose what the thresholds are based on:
- A fixed value: Fixed numbers.
- Prior values: A percentage below and above the average of earlier values.
- NOTE: Compare value to and Use Value recorded do not affect the Stoplight in v7.2.2.
- A target: A percentage below and above a target. In Use this target, choose an aggregation and a column, e.g., "Sum" of "sales_target".
- Favorable Color: Choose the color for favorable values.
- Unfavorable Color: Choose the color for unfavorable values.
- If value is: Enter the unfavorable threshold in the first row and the favorable threshold in the second, e.g., "< 100" and "> 150". For Prior values and A target, enter percentages.
If Stoplights are configured for the Report Metric, the Show Stoplight toggle appears in both Editor and Viewer as exemplified below.
4. Configure KPI Variance
KPI Variance shows how much the Primary measure's latest value changed. It appears in the chart's summary.
- Include KPI Variance: Enable to turn on the calculation.
- Calculate variance by comparing: Choose one of:
- A prior value: In Compare to value [N] [unit] ago, enter the period, e.g., 7 days. With 0, no variance is shown.
- A target: In Use this target, choose an aggregation and a column, e.g., "Sum" of "sales_target".
- Show variance as: Controls the display for either comparison basis:
- % Change (default) shows the change as a percentage.
- Difference shows the raw numeric change in the measure's own units, formatted with the measure's display mask. In this mode, the row and suffix labels drop percentage wording, and if the prior value is zero, the numeric change is still shown.
5. Add Overlays
Overlays add Report Metrics from other Reports to this chart for comparison. Each viewer's overlays are visible only to them.
- Select the Overlay icon in the upper right of the Report Metric Viewer to open Manage Overlays.
- Change Axis Display Masks to control axis formatting if needed.
- [+Add Overlay]
- Select the Report Metrics.
- [Add Selected]
5.1. Edit Overlays
- Click the gear icon.
- Color: Single-click a new color from the palette to select it. If several charts are laid over the original one, every additional Metric is going to get its own color.
- Type: Select how the chart is displayed.
- Line Type: This field is shown only if "Line" value is selected in the field above. The line of the Overlay Metric can be dashed, dotted, etc. Select different line types for different overlay charts.
- Axis: It is recommended to place the Axis of the Overlay Chart on the right side of the original chart.
- Click [Save].
6. Set Additional Options
- Height (px): Set the pixel height of the chart.
- Show in Viewer: Control whether the component displays to users viewing the Report.
- Show Metric Summary: Only visible while Show in Viewer is on; make the Summary Panel available.
- Show in Email: Include the Metric when the Report is sent via email or Burst.
- Include as Attachment: Include the Metric as a file attachment (PPT/PDF/Excel) when emailed. Configured on the Distribution tab.
- Get Embed Code: Retrieve an embed code of the chart for development purposes.
7. Configure Filtering
- In the Report editor, click [Edit Filters] and select a filter to open the Column Edit sidebar.
- For instructions on how to configure Filters, refer to Applying Filters in Dataset Reports.