Metrics Dashboards

We've seen that metrics provide a limited graphing capability for viewing their values. What if you want to create enhanced dashboards for viewing your metrics? Rock ships with several blocks to help you create rich dashboards based off of metrics.

Anatomy of a Dashboard

  1. Theme - While dashboard blocks can be placed on any page in Rock, we do ship with a special theme designed for dashboards called Dashboard Stark. This a very basic starter theme for you to use as a starting point for creating your own. When you do create new dashboard themes, we highly recommend you prefix their name with Dashboard to help keep them grouped together in lists.
  2. Dashboard Widgets - The widgets are simply Rock blocks on the page. We discuss each type of block below in detail.
  3. Context Setter - While optional, a context setting on the page allows you to filter the metric values by their Series Partition. Many times, this is a campus selector or group selector.

Dashboard Blocks

Rock ships with several dashboard widget blocks. Each of these blocks is shown below.

Line Chart

This block displays a line chart for the selected metric. Options include:

TitleDescription
NameThis is the block name. It is not displayed anywhere on the output of the block.
TitleThe title that is displayed for the metric.
SubtitleThe subtitle for the metric.
Column WidthThe number of Bootstrap columns the chart should use for its width. (A Bootstrap row, by default, has 12 columns.)
Chart StyleThe chart style to use. These styles are defined under Admin Tools > Settings > Defined Types > Chart Styles.
MetricThe metric to use for the chart.
Partition FilterDetermines how the chart will get the series partition value. It can be either hard coded or determined from the page context.
Date RangeDetermines which values are displayed on the graph.
Detail PageThis optional setting will determine which page will be loaded when the graph is clicked.

Pie Chart

This block displays a pie chart for a given metric. Options include:

TitleDescription
NameThis is the block name. It is not displayed anywhere on the output of the block.
TitleThe title that is displayed for the metric.
SubtitleThe subtitle for the metric.
Column WidthThe number of Bootstrap columns the chart should use for its width. (A Bootstrap row, by default, has 12 columns.)
Chart StyleThe chart style to use. These styles are defined under Admin Tools > Settings > Defined Types > Chart Styles.
Metric Value TypeDetermines what metric value types should be displayed on the chart, goals and/or measures.
MetricsThe metrics to use for the chart. Each metric will represent one slice of the pie chart.
Date RangeDetermines which values are displayed on the graph.
Detail PageThis optional setting will determine which page will be loaded when the graph is clicked.

Lava Dashboard Widget

This block renders the metric values using a Lava template. Options include:

TitleDescription
NameThis is the block name. It is not displayed anywhere on the output of the block.
TitleThe title that is displayed for the metric.
SubtitleThe subtitle for the metric.
Column WidthThe number of Bootstrap columns the chart should use for its width. (A Bootstrap row, by default, has 12 columns.)
Round ValuesRound Y values to the nearest whole number. For example, display 25.00 as 25.
MetricThe metrics to use for the chart.
Lava TemplateThe Lava template to render the output for display.

See our Lava documentation for more information.

Warning

Under Construction
Work is still being done on the metrics dashboard features. Expect changes that may impact configuration settings. Feel free to play with these features but don't roll them out in production just yet.