Dashboard template

Your dashboard template file will be used to link your dashboard to a report and configure its content.

The dashboards are configured in the dashboards templates like dashboard.cson.

In a template, the main keys to fill are entityName, default.

entityName: "{{ zone }}"
default: "{{ default | bool}}"

Important

You should never change id or report_id.

  • entityName will set the name of the dashboard
  • default is a boolean that will tell the engine if a dashboard you be the first one you see when accessing a report. If you have configured multiple dashboards with a default: true value for a given report, the one with the lowest id will be displayed.

In your dashboard you can configure different sections (aka categories), and in each sections you can configure tiles.

Here is the syntax for the categories:

categories: [
  name: "Performance"
  kpis: [
  ]
,
  name: "Evolution"
  kpis: [
  ]
,
  name: "Metrics"
  kpis: [
  ]
,
  name: "Score cards"
  kpis: [
  ]
]

kpis is an array containing your configuration for the tiles.

You can have multiple categories, and multiple kpis, just separate them with a , as shown above. For more details on how to configure the kpis see the Synthetize data chapter.