Skip to main content

Dashboard

.dashboard

Each dashboard must be stored as dashboard_name.dashboard YAML file:

dashboard: dashboard_name
title: 'title in UI'
description: 'description in UI'
access_roles:
- role
- role
- ...
access_users:
- user_alias
- user_alias
- ...

fields:
# List of Filter fields
# - filter: filter_name
# ...

reports:
# List of Reports
# - title: 'report title in UI'
# ...

Dashboard Parameters

NameTypeDefaultDescription
dashboard*string-Dashboard name
titlestring-Dashboard title in UI
descriptionstring-Dashboard description in UI
access_rolesstring[]-If specified, only users with the listed roles will have access to dashboard
access_usersstring[]-If specified, only the listed users will have access to dashboard
fieldsFilter[]-Begin a section of fields (only Filter fields for Dashboard)
reports*Report[]-Begin a section of reports