---
title: "Report Summary"
canonical: "https://wiki.yellowfinbi.com/space/user80/1591978/Report%20Summary"
format: markdown
---
> Macro (anchor)



> Macro (toc)

## Overview

Report Summaries allow the user to build summary level KPI and chart displays into their report. This allows for a row of summary information to be displayed along with a very detailed report, providing to levels of analysis.

![image](media://a3efbcbd-ae43-4c3b-8144-b6359755765e)

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.

![image](media://a9898820-53bb-4b0e-8b79-0372f561cbbc)

 

> Macro (html-bobswift)

 

 

### Exceptions

Report Summaries cannot be used in the following cases:

- Drill Down Reports (the summary will display before the report has been drilled into)
- Drill Anywhere Reports (the summary will display before the report has been drilled into)
- Section Reports
- KPI Reports
- Visible Series Selection Charts
- Time Series Charts with Date Sliders

 

## Preview

When you first start building your Report Summary, you will be taken to the following lightbox:  
 > Macro (inline-media-image)



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.  
 > Macro (inline-media-image)



 

## Settings

You can customise the appearance and use of the Report Summary by clicking on the **Settings** option on the left of the builder.  
 > Macro (inline-media-image)



| **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). |

 

## Primary Metric

The first thing you need to do, when creating your Report Summary, is define the Primary Metric of the report. This is the main measurement in the report.

1. Click on the **+ Setup Primary Metric** link on the left hand side of the builder.
2. 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.
  Once populated, the builder will display a preview of the summary on the top right of the screen.  
> Macro (inline-media-image)
3. Click **Save** to keep your selections and continue building your Report Summary.

 

## Dimensions

In order to provide categorical summaries you can define Dimensions for display in your Report Summary. These display a selected metric, split into categorical values by a dimension field, displayed on a donut chart.

1. Click on the **+ Add Dimensions** link on the left hand side of the builder.
2. Define the options used to build the summary display.
  Once populated, the builder will display a preview of the summary on the top right of the screen.  
> Macro (inline-media-image)
3. Click **Save** top keep your selections and continue building your Report Summary.
4. You can add several dimensions if required.

 

## Secondary Metric

In order to provide additional metric information to the Report Summary you are able to define Secondary Metrics. These don't display as much information as the Primary Metric.

1. Click on the **+ Add Secondary Metric** link on the left hand side of the builder
2. Define the options used to build the summary display.
  Once populated, the builder will display a preview of the summary on the top right of the screen.   
 > Macro (inline-media-image)

  
 Click **Save** to keep your selections and continue building your Report Summary.
3. Click **Submit** to complete your Report Summary and return to the Report Preview page.