Dashlet Dictionary Section

This section of the configuration is a object whose keys correspond to the dashletIds of the dashlets found in availableDashlets. Each key is mapped to an object which will have some mandatory and optional properties, depending on the needs of the particular dashlet.

In general, the following are the properties that make up a dashletDictionary object, but each Dashlet can have a different combination of these properties. If you wish to learn about the current supported Dashlets and their configuration setups, please visit the relevant Dashlet page.

singleQuery

This property must be provided unless the 'queries' property is used.

This is the query template that will be used by the dashlet to retrieve data. Please see CubeJs query for more information about the query format. The template will be further populated with the user's desired values through the settingsFields. Generally speaking, in order for dashlets to function as expected, the query should not be modified once setup.

here's what a singleQuery may look like:

singleQuery:
  order:
    ClosedCases.priority_sort: desc
  filters:
    - values:
        - aml
      operator: equals
      dimension: ClosedCases.caseType
  measures:
    - ClosedCases.averageTime
  dimensions:
    - ClosedCases.priority
    - ClosedCases.priority_sort
  timeDimensions:
    - dimension: ClosedCases.closed

queries

Used instead of singleQuery if the dashlet needs to support the ability to switch between different data sources in its settings, such as in the case of the SummaryTile Dashlet, where the data source of the query depends on the 'Summary Type' field in its settings.

Here's an example:

queries:
      newCases:
        order: {}
        filters:
        - values: []
        operator: equals
        dimension: NewCases.caseType
        - values:
        - $currentTenant
        operator: equals
        dimension: NewCases.tenant
        measures:
        - NewCases.count
        timeDimensions: []
      openCases:
        order: {}
        filters:
        - values: []
        operator: equals
        dimension: CmsCase.caseTypeName
        - values:
        - closed
        - alert
        - dismissed
        operator: notEquals
        dimension: CmsCase.caseStatusName
        - values:
        - $currentUser
        operator: equals
        dimension: CmsCase.assignee
        measures:
        - CmsCase.count
        timeDimensions: []
      updatedCases:
        order: {}
        filters:
        - values: []
        operator: equals
        dimension: UpdatedCases.caseType
        - values:
        - $currentUser
        operator: equals
        dimension: UpdatedCases.assignee
        measures:
        - UpdatedCases.count
        timeDimensions: []

Each key in the queries object is mapped to a singleQuery.

settingsFields

This property contains the an array of SettingFields that will be generated inside of the settings form that appears when the user is creating/editing a dashlet.

Please see the SettingsFields page for more details for each of these fields.

description

This is the description text that will be seen at the top of the dashlet settings form for this dashlet.

enableTitleBar

This boolean property toggles whether to show the title bar. Value can be true or false. If not passed, the value defaults to false.

enableTimeFrameSelector

If the titleBar is enabled, this property toggles whether to show the timeframe selector, for dashlets that needs to support changing the data timeframe on the fly. Note that the timeframe selector is currently only shown when not editing a dashboard.

Value can be true or false. If not passed, the value defaults to false.

showGranularity

If the timeframe selector is enabled, this property toggles whether or not the timeframe is affected by granularity.

Value can be true or false. If not passed, the value defaults to false.

drillDownBucketSize

This very specific property is only used by dashlets that have a drilldown functionality to get more detailed information. Value can be a decimal from 0-1. For example, passing in a value of 0.02 means that in the drillDown, data will be grouped like [0, 0.019, 0.02, 0.039...]