How to :: customize the settings panel

Warning

This is only available in code mode.

Overview

Navigation customization settings configuration is located in the front-config file.

When you think about navigation cumstomization ou shall already have:

  • structured the point of views of you application
  • built your users’ synthesis
  • built the table of content
  • built the slides

And you’re now trying to improve you user experience. Here is what Toucan can do for you:

  • add context with a glossary
  • activate sharing capacities (csv and pdf exports, chat)
  • add benchmark capacities
settings-panel

settings-panel

By default all these option are setup to true and will be available for all users. It will be displayed on the right panel for all the slides.

The front_config.cson file should look like this:

conf

Settings default panel

When you open the settings panel, you will see multiple tabs (Glossary, Data, etc)

You can customize which tab will be the default opened tab with the option defaultSettingsTab in the front_config:

defaultSettingsTab: 'glossary' # can be "glossary", "data", "share", or "comment"

Glossary

You can specify a Glossary in the front_config.

The Glossary will only be displayed if you have configured a Settings panel.

If you do not have configured a Settings panel add the following in your front_config file:

settings:true

Now you can define your glossary by adding the below in your front-config.cson file:

glossary:
  title: 'Glossary'
  terms: [
    term: "Complex name I need to define"
    meaning: "Crystal clear definition"
  ]

Adding a slide option restrict the glossary to specific screens :

glossary:
  title: 'Glossary'
  'terms': [
      {
        slides: [10000,10001]
        term: 'First term'
        meaning: 'Interesting definition'
      }
      {
        slides: [10002,10003]
        term: 'Second term'
        meaning: 'Interesting definition bis'
      }
    ]

Sharing is caring :)

CSV exports

When on the csv exports allow the user to export the data used for each screnn via the settings panel. By default the CSV sharing option is on and will be available if sharingOptions: true. If you want to disable it just add: exportCSVDisabled: true

PDF

To enable the PDF option for slides, add slidePdfEnabled: true to the front config. Don’t forget to activate the sharing tab in the settings panel (sharingOptions: true). The export will be sent to the email provided by the user. The export corresponds to the current state of the slide (i.e. with current filters and requesters selections…).

To enable the PDF option for dashboards, add dashboardPdfEnabled: true to the front config.

Capture screen

To enable the capture, annotation, and sending of a chart by email, add captureChartEnabled: true to the front config. Unlike the pdf export, this features allows to export the chart only (especially without the header giving some context about the current report/date) Dont’t forget to add sharingOptions: true to the front_config in order to activate this feature.

Embed charts

To enable the ‘embed this chart’ option, add embedCharts: true to the front config. Don’t forget to activate the sharing tab in the settings panel (sharingOptions: true). The option is available only for the following charts: barchart, mapchart, waterfallchart.

Chat made for action

When on the csv the users can add a message on each screen via the app chat. comments: true

To notify a user, simply type his/her username (usually the email address) before your message.

Note that a user can delete it’s own message, but only an admin can delete any message.

If there is any new messages, user will be notified on the dashboard, and by clicking on the link displayed will be automatically redirect to the commented story.