dashboard.web

Web dashboard

type

object

properties

  • description

The description of the dashboard

type

string

  • folders

The folders that this dashboard belongs to. Separate the folders using a ‘/’ (ie. a folder Sites/Fribourg)

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The id of the module using this dashboard

type

string

  • searchBarDashboardDisplayBehavior

Define the display behavior of the search bar. If EMPTY_SEARCH is selected, the search bar will show the dashboard when no search text is provided or when search content matches its content. If SEARCH_REQUIRED is chosen, the search bar will only be displayed when there is a matching search text. If HIDDEN is selected, the dashboard will never be displayed in the search bar area.

Default value is [“EMPTY_SEARCH”]

type

string

enum

EMPTY_SEARCH, SEARCH_REQUIRED, HIDDEN

default

EMPTY_SEARCH

  • tags

The tags of the dashboard. It can be used to search a dashboard and to classify the dashboard.

type

array

items

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • title

The title of the dashboard

type

string

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False