How to :: create an Executive Summary

Warning

Disclaimer : This is a paid feature !

Overview

The Executive Summary is a static & printable summary of the application.

With the Studio, you just have to select some stories from your application to create a clean pdf 🤩.

Don’t need to thing about the layout 📐, we take care of it for you.

executive summary

When activated, the executive summary will be available for all users from the bottom of the dashboard ⬇️.

Some advice

Follow the placeholders in front of you to create a splendid executive summary in no time.

Below are some best practices, guidelines, cool tips to help you get the best of this crazy feature 💛 :

One rule! : Don’t forget to push to production your changes 🚨 ! You can preview the production version by removing the ``&stage=staging`` from the url in the preview mode.

Short is good : For a better user experience, we recommend not to exceed 8 charts by page (4 rows, 2 charts by rows). Remember it’s an executive summary, if your users need more, why not give access to the application? Oh and, less pages, more 🌳

Paper is not dynamic : Keep in mind that stories with filters/requesters won’t be usable on paper 🤔, so make sure to switch to code mode to select a filter/requester value. See below for more info on how to do it 📝. Also, master/slave and double charts are not available in the executive summary.

Put a name on it : Pages can me named, so use it to make your layout clear. It won’t be seen anywhere, it’s just here to help you 😉.

Take a look at me : Before sending or pushing to production, always take a look at what you created 🤳. With the preview button, it’s easy as “abc” 🕺 to ensure your executive summary is correct. And you can even preview the executive summary with different permissions and visibility settings.

executive summary creation

Convention over configuration

By default, the executive summary is generated with the sender’s point of view. Meaning, the sender’s report and date selection will be used in the executive summary. But also visibility and permission settings will be applied. If a story in the executive summary is not visible by the sender, it won’t appear in the executive summary.

The header is configured by default as follow,

  • if a date requester is configured in the application, it will appear on the right side of the header 📅
  • the application title will be shown in the header, unless a report is configured. If a report selector is setup, the report name will appear in the header.
executive summary header

Only the first two highlighted KPIs will be displayed in the story’s title. They will be displayed by default.

Code mode configuration

The executive summary is reusing existing charts with the ability to override some options in order to better customized your pdf.

You can switch to code mode to update some of your chart’s configuration. Templating is accepted 🔥

Note

Use this carefully, the executive summary is supposed to be a snapshot of the application. You should not be recreating charts here.

executive summary

Add your overrides inside the following block to start updating your chart’s configuration.

overrides: {}
📌 Fix a filter value
filters

filters

You can fix filters in stories to show a specific value when the executive summary is generated. By default, the first value will be selected. Please note that for checkbox filters, all values are shown by default.

overrides:
  charts: [
    {
      filters:
        "upper-right":
          default : "value selected"
        "upper-middle":
          default : "value selected"
    }
  ]
filters:
  "bottom-right":
      default : "value selected"

Please refer to filters’ default advanced configuration if needed.

⚠️ first and last selections are not available for sliders filters.

📌 Fix a requester value
requesters

requesters

You can fix requesters in stories to show a specific value when the executive summary is generated. By default, the first value will be selected.

overrides:
  charts: [
    {
      requesters:
        "upper-right":
          default : "value selected"
        "upper-middle":
          default : "value selected"
    }
  ]
requesters:
  "bottom-right":
      default : "value selected"

It won’t be possible to fix different value to a requester with the same id. If stories are using the same requesters, with the same id, the selected requester value will be fixed for all of these stories.

📌 Fix the legend on a specific value

You can fix the legend to show a specific value when the executive summary is generated. By default, the first value will be selected.

overrides:
  charts: [
    {
      defaultSelected: 'Label to select'
    }
  ]

This is available only for the following charts :

- barchart
- barlinechart
- bubblechart
- mapchart (new)
- radarchart
- stackedbarchart

Advanced header configuration

You can overwrite the default behavior of the executive summary header.

You can do so from the Files interface, while editing the front_config file.

Add the following fields inside the execsumConfig: block. It will overwrite the existing title or date.

execsumConfig:
  customTitle : "My new title"
  customDate : "My new date"