In order to create a Report Summary you will need to be on the Output step of the Report Builder, while it's in draft mode. From here you will find a Summary button on the main formatting toolbar.
<iframe width="700" height="394" src="https://www.youtube.com/embed/pTW64bs4B1I?color=white" frameborder="0" allowfullscreen></iframe> |
Report Summaries cannot be used in the following cases:
Here you are shown all the building options down the left of the page, with the preview pane on the right currently empty. As soon as you build summary content you will see a preview, as below.
Setting | Options | Description |
---|---|---|
Layout Format | Side / Top | Display the summary either at the top or side of the chart. If the report is table only the display will always be 'top'. |
Include Dividers | Off / On | Display dividers between each of the elements in the Report Summary (Primary Metric, Dimensions, Secondary Metrics). |
Dashboard | Off / On | Make the Report Summary available for display on the Dashboard. You will still need to enable it when creating the Dashboard Tab. |
Mobile | Off / On | Make the Report Summary available for display on mobile devices. |
Report | Off / On | Make the Report Summary available for display on the Report Preview page (away from the dashboard). |
Define the options used to build the summary display. Depending on the Target Type settings you select, you may not have all of the options listed here.
Option | Possible Values | Description |
---|---|---|
Display Title | Text Entry | Provide a label to be used in the Report Summary. This does not have to be the same as the Column Name. |
Metric | Metric fields | Select the metric field you wish to assign as the Primary Metric. |
Aggregation | % Change, Average, Change, Count, Count Distinct, Maximum, Minimum, Sum | Select the aggregation you wish to apply to the metric. The Summary is going to look at this figure as a whole, not split by any categories, so it's important to select the correct aggregation. |
Target Type | None, Periodic, Total | If you wish to compare your Primary Metric value to that of a target or budget, define here. |
Display Title | Text Entry | Provide a label to be used in the Report Summary for the target. |
Date Field | Date field | If you have selected a Periodic Target you will need to select a date field to define the periods. |
Set Target | Manual or Metric fields | Define the Target as a field, or a user defined value |
Desired Variance | Above, Below, Range | Define where you want the variance to fall. For example, do you want your metric to be above the target? |
Variance Display | None, Actual, Percentage | Select the display of the variance. |
Sparkline | None, Actual, Variance | Select the display of the variance for each period. |
Once populated, the builder will display a preview of the summary on the top right of the screen.
Define the options used to build the summary display.
Option | Possible Values | Description |
---|---|---|
Display Title | Text Entry | Provide a label to be used in the Report Summary. |
Dimension | Dimension field | Select a dimension field from the report to use as the categories in the donut. |
Metric | Metric field | Select a metric field from the report to use as the size of the segments in the donut. |
Colour | HEX code | Define a colour to use in the donut - shades of this one colour will be applied to segments. |
Max Segments | Text Entry | Define the number of segments displayed in the donut before the 'other' segment. As this is a summary chart 1-3 are recommended, not larger. |
Once populated, the builder will display a preview of the summary on the top right of the screen.
Define the options used to build the summary display.
Option | Possible Values | Description |
---|---|---|
Display Title | Text Entry | Provide a label to be used in the Report Summary. This does not have to be the same as the Column Name. |
Metric | Metric fields | Select the metric field you wish to assign as the Primary Metric. |
Aggregation | % Change, Average, Change, Count, Count Distinct, Maximum, Minimum, Sum | Select the aggregation you wish to apply to the metric. The Summary is going to look at this figure as a whole, not split by any categories, so it's important to select the correct aggregation. |
Variance From | None or Metric fields | Define the Target as a field, or don't use a target at all. |
Desired Variance | Above, Below, Range | Define where you want the variance to fall if you've defined a target. For example, do you want your metric to be above the target? |
Once populated, the builder will display a preview of the summary on the top right of the screen.
Click Save to keep your selections and continue building your Report Summary.