Dimensions and Measures in YAML
Dimensions and measures are defined in YAML format under the value key. This page describes the key-value pairs used within this key for various widget types. Dashboards are built from KPI widgets, process widgets, tables, charts, and auxiliary widgets. For more details, see Widgets.
Process widgets use process stages and associated metrics. Stages and their indicators are configured via eventMeasures and transitionMeasures, which use specific settings.
The value Key
The table below describes parameters for standard dimensions and measures in widgets.
| Key | Type | Definition |
|---|---|---|
mode | enum | Calculation mode: TEMPLATE or FORMULA |
tableName | string | Table name (only for mode: TEMPLATE) |
columnName | string | Column name (only for mode: TEMPLATE) |
templateName | enum | Predefined formula (only for mode: TEMPLATE) |
formula | string | Calculation formula (only for mode: FORMULA) |
Example of dimension/measure usage:
value:
mode: TEMPLATE
templateName: countDistinct
tableName: case_table
columnName: incident_id
Predefined Formulas (templateName) by Data Type
The available set of predefined formulas (templateName) depends on the data type of the dimension or measure.
| Data Type | Dimension Formula | Measure Formula |
|---|---|---|
| STRING | — | count, countDistinct |
| INTEGER | — | avg, median, count, countDistinct, min, max, sum |
| FLOAT | — | avg, median, count, countDistinct, min, max, sum |
| DATE | date, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeek | count, countDistinct, median, min, max |
| DATETIME | dateTime, date, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeek, hour | count, countDistinct, median, min, max |
| DATETIME64 | dateTime, date, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeek, hour | count, countDistinct, median, min, max |
| BOOLEAN | — | count, countDistinct |
| OTHER | — | count, countDistinct |
The value Key in eventMeasures
The eventMeasures key is used in Process Card and Processes Sphere widgets. The dimension and measure parameters configured in eventMeasures are listed in the table below.
| Key | Type | Definition |
|---|---|---|
mode | enum | Formula type: - TEMPLATE- FORMULA |
templateName | string | Template name (only for TEMPLATE)Available templates: 1. eventsCount (Number of events)2. reworksCount (Number of reworks) |
formula | string | Formula (only for FORMULA mode) |
The value Key in transitionMeasures
The transitionMeasures key is used in Process Card and Processes Sphere widgets. The dimension and measure parameters configured in transitionMeasures are listed in the table below.
| Key | Type | Definition |
|---|---|---|
mode | enum | Formula type: - TEMPLATE- FORMULA |
templateName | string | Template name (only for TEMPLATE)Available templates: 1. transitionsCount (Number of transitions)2. medianTime (Median time) |
formula | string | Formula (only for FORMULA mode) |
Was the article helpful?