Top.Mail.Ru
Dimensions and Measures in YAML
CTRL+K

Dimensions and Measures in YAML

In this article
  • Dimensions and Measures in YAML
  • The value Key
  • Predefined Formulas (templateName) by Data Type
  • The value Key in eventMeasures
  • The value Key in transitionMeasures

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.

KeyTypeDefinition
modeenumCalculation mode: TEMPLATE or FORMULA
tableNamestringTable name (only for mode: TEMPLATE)
columnNamestringColumn name (only for mode: TEMPLATE)
templateNameenumPredefined formula (only for mode: TEMPLATE)
formulastringCalculation 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 TypeDimension FormulaMeasure Formula
STRINGcount, countDistinct
INTEGERavg, median, count, countDistinct, min, max, sum
FLOATavg, median, count, countDistinct, min, max, sum
DATEdate, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeekcount, countDistinct, median, min, max
DATETIMEdateTime, date, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeek, hourcount, countDistinct, median, min, max
DATETIME64dateTime, date, year, yearAndQuarter, quarter, yearAndMonth, month, dayOfMonth, week, dayOfWeek, hourcount, countDistinct, median, min, max
BOOLEANcount, countDistinct
OTHERcount, 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.

KeyTypeDefinition
modeenumFormula type:
- TEMPLATE
- FORMULA
templateNamestringTemplate name
(only for TEMPLATE)
Available templates:
1. eventsCount (Number of events)
2. reworksCount (Number of reworks)
formulastringFormula
(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.

KeyTypeDefinition
modeenumFormula type:
- TEMPLATE
- FORMULA
templateNamestringTemplate name
(only for TEMPLATE)
Available templates:
1. transitionsCount (Number of transitions)
2. medianTime (Median time)
formulastringFormula
(only for FORMULA mode)

Was the article helpful?

Yes
No
Previous
Widget Configuration in YAML
We use cookies to improve our website for you.