Dimensions and Measures in YAML
In this article
Dimensions and measures are defined in YAML format under the value key. This page describes the key-value pairs used within this key.
The value Key
The table below lists values for standard dimensions and measures in widgets.
| Key | Type | Definition |
|---|---|---|
| mode | enum | Formula type: - TEMPLATE- FORMULA |
| dbType | enum | Database type Only for TEMPLATE: CH |
| tableName | string | Table name Only for TEMPLATE |
| columnName | string | Column name Only for TEMPLATE |
| templateName | string | Predefined formula name Only for TEMPLATE |
| formula | string | Formula Only for FORMULA mode |
Example of standard dimensions and measures:
value:
mode: TEMPLATE
templateName: countDistinct
dbType: CH
tableName: case_table
columnName: incident_id
The set of available predefined formulas (templateName) depends on the dimension and measure data type.
| 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 |
Settings for process-based dimensions and measures are described separately.
The value Key in eventMeasures
The eventMeasures key is used in the Process explorer and Sphere of processes widgets. The table below lists dimension and measure values defined in eventMeasures.
| Key | Type | Definition |
|---|---|---|
| mode | enum | Formula type: - TEMPLATE- FORMULA |
| dbType | enum | Database type Only for TEMPLATE: CH |
| templateName | string | Template name Only for TEMPLATEAvailable templates: 1. eventsCount (Number of events)2. overtimesCount (Number of overtimes) |
| formula | string | Formula Only for FORMULA mode |
The value Key in transitionMeasures
The transitionMeasures key is used in the Process explorer and Sphere of processes widgets. The table below lists dimension and measure values defined in transitionMeasures.
| Key | Type | Definition |
|---|---|---|
| mode | enum | Formula type: - TEMPLATE- FORMULA |
| dbType | enum | Database type Only for TEMPLATE: CH |
| templateName | string | Template name Only for TEMPLATEAvailable templates: 1. transitionsCount (Number of transitions)2. medianTime (Median time) |
| formula | string | Formula Only for FORMULA mode |
The value Key in Process Metrics
The value block contains information about process metrics used as local indicators.
The value Key in Process Dimensions
Start Time and End Time
| Key | Type | Definition |
|---|---|---|
| templateName | enum | Predefined template (dateTime) |
| mode | enum | Formula type: - START_TIME — start time - END_TIME — end time |
| eventTimeFormula | string | Value specified in the Time parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| eventNameFormula | string | Value specified in the Event parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| caseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| filters | — | Predefined filters (optional key) |
| eventName | string | Event name |
| processName | string | Process name |
Aggregations in Dimensions
Number of Executions or Overtimes
| Key | Type | Definition |
|---|---|---|
| templateName | enum | Predefined template - countExecutions — number of executions- countOvertimes — number of overtimesKey values for custom aggregation: - top — most frequent value in column- firstValue — first value- lastValue — last value |
| mode | enum | Formula type: - AGGREGATION — aggregation |
| eventName | string | Event name |
| processName | string | Process name |
| caseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| eventNameFormula | string | Value specified in the Event parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| filters | — | Predefined filters (optional key) |
Custom Aggregation in Dimension
| Key | Type | Definition |
|---|---|---|
| templateName | enum | Predefined template - top — most frequent value in column- firstValue — first value- lastValue — last value |
| mode | enum | Formula type: - AGGREGATION — aggregation |
| eventName | string | Event name |
| processName | string | Process name |
| caseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| eventNameFormula | string | Value specified in the Event parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| filters | — | Predefined filters (optional key) |
| tableName | string | Table name |
| columnName | string | Column name |
| eventTimeFormula | string | Value specified in the Time parameter of the used process Specified in the format '"Table_Name"."Column_Name"'If the value is absent, specify null |
The value Key in Process Measures
Conversion and Duration
| Key | Type | Definition |
|---|---|---|
| templateName | string | Predefined template Only for DURATIONAvailable templates: - avg — average duration- median — median duration |
| mode | enum | Formula type: - CONVERSION — conversion- DURATION — duration |
| startEventAppearances | enum | Only for DURATIONEvent occurrence - FIRST — first occurrence- LAST — last occurrence |
| startEventProcessName | string | Start process name |
| startEventNameFormula | string | Start event Specified in the format '"Table_Name"."Column_Name"' |
| startEventName | string | Start event name |
| startEventTimeFormula | string | Value specified in the Time parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| startEventFilters | — | Predefined filters for start event (optional key) |
| endEventNameFormula | string | End event Specified in the format '"Table_Name"."Column_Name"' |
| endEventAppearances | enum | Only for DURATIONEvent occurrence - FIRST — first occurrence- LAST — last occurrence |
| endEventProcessName | string | End process name |
| endEventName | string | End event name |
| endEventTimeFormula | string | Value specified in the Time parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| endEventFilters | — | Predefined filters for end event (optional key) |
| endCaseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used end process Specified in the format '"Table_Name"."Column_Name"' |
Aggregations in Measures
Number of Executions and Overtimes
| Key | Type | Definition |
|---|---|---|
| outerAggregation | enum | Used predefined formula Available options: avg, median, count, count (distinct), min, max, sum |
| templateName | enum | Predefined template - countExecutions — number of executions- countOvertimes — number of overtimes |
| mode | enum | Formula type: - AGGREGATION — aggregation |
| eventName | string | Event name |
| processName | string | Process name |
| caseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| eventNameFormula | string | Value specified in the Event parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| filters | — | Predefined filters (optional key) |
Custom Aggregation in Measure
| Key | Type | Definition |
|---|---|---|
| outerAggregation | enum | Used predefined formula Available options: avg, median, count, count (distinct), min, max, sum |
| templateName | enum | Predefined template - top — most frequent value in column- firstValue — first value- lastValue — last value- countIf — count- countIfDistinct — count of distinct selected values |
| mode | enum | Formula type: - AGGREGATION — aggregation |
| eventName | string | Event name |
| processName | string | Process name |
| caseCaseIdFormula | string | Value specified in the CaseTable.CaseID parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| eventNameFormula | string | Value specified in the Event parameter of the used process Specified in the format '"Table_Name"."Column_Name"' |
| filters | — | Predefined filters (optional key) |
| tableName | string | Table name |
| columnName | string | Column name |
| eventTimeFormula | string | Value specified in the Time parameter of the used process Specified in the format '"Table_Name"."Column_Name"'If the value is absent, specify null |
Was the article helpful?
Yes
No