How to :: create a PDF report

Note

Formerly known as Executive Summary

Warning

Disclaimer : This is a paid feature ! Also collaboration is not possible on the PDF report. App builders can update the PDF report only one at a time

Overview

The PDF report 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.

pdf report

When activated, the PDF report 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 PDF report 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 🚨 !

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 a PDF report, a 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 📝. By default, default filters/requesters values will be used. ⚠️ Also, master/slave and double charts are not available in the PDF Report.

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 PDF report is correct. And you can even preview the PDF report with different permissions and visibility settings.

Convention over configuration

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

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.
pdf report header

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

Advanced story configurations

The PDF report 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 PDF report is supposed to be a snapshot of the application. You should not be recreating charts here.

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

overrides: {}
📌 Set a filter value
filters

filters

You can set filters in stories to show a specific value when the PDF report 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.

📌 Set a requester value
requesters

requesters

You can set requesters in stories to show a specific value when the PDF report 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.

📌 Set the legend on a specific value

You can set the legend to show a specific value when the PDF report 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
📌 Override report’s visibilities

You can override report’s visibilities to change who can see the stories in the PDF report.

overrides:
  visibility:
    mode: "report"
    allowedEntries: [
      {
        Label: [
          "my_label"
        ]
      }
    ]
📌 Override production’s visibilities

Let say you created stories just for the PDF report. These stories are hidden in production, so by default they won’t show in the PDF report. Unless you override it.

overrides:
  visibility: true

Advanced header configuration

You can overwrite the default behavior of the PDF report 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"

Complete PDF report

From the PDF report toolbar you can access the advanced mode. The advanced mode allows you to create a complete PDF report.

pdf report complete

This complete PDF report will automatically generate a PDF with all the stories of your application :

  • Chapters will start on a new page, and the chapter names will be visible on the header
  • Subchapters will appear in the pages, and subchapter names will be visible in a gray line
  • A table of content can be added to the complete PDF report, but is not editable
  • Page of a complete PDF report are not editable. You can’t modify stories order or delete a story from a page
  • New stories will automatically be added to your complete PDF report
  • Master-slave stories will be added to the complete PDF report using only the Master chart
  • Filters/requesters will be set on the default defined value in the story
  • Only stories with filers/requesters will be editable in order to define another filter/requester value and update the story title’s accordingly if necessary
  • The complete PDF report is not sendable by email (either from the end-user toolbar or the scheduled actions) for performance purposes