Chart Linked Settings: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Linked settings are for binding settings within a chart so that they maintain same values. When configured, the linked settings are kept in synchronization, i.e. when any of the bound settings is changed, other linked settings get also changed. Linked settings are configured as an array of ''setting groups'' which are array of objects. Each object points to an individual setting using the following properties: | Linked settings are for binding settings within a chart so that they maintain same values. When configured, the linked settings are kept in synchronization, i.e. when any of the bound settings is changed, other linked settings get also changed. | ||
* '''type''': One of the following type of chart setting: ''measure'' | |||
* '''index''': When type is a measure or | Linked settings are set in the '''Advanced''' tab of chart/flowchart by clicking '''Linked settings'''. Linked settings are configured as an array of ''setting groups'' which are array of objects. Each object points to an individual setting using the following properties: | ||
* '''type''': One of the following type of chart setting: | |||
** '''measure''': For measure parameters. | |||
** '''dimension''': For dimension and column parameters. | |||
** '''eventtypemeasure''': For flowchart event measures. | |||
** '''flowmeasure''': For flowchart flow measures. | |||
** '''root''': Analyzed objects parameters. | |||
** '''generic''': For other chart settings. | |||
** '''tag''': For binding to a tag. | |||
** '''variable''': For binding to a dashboard variable. | |||
** '''filtervalue''': For binding to certain filter rule parameters. | |||
** '''filterattribute''': For binding to certain filter rule parameters. | |||
* '''index''': When type is a measure, dimension, eventtypemeasure or flowmeasure, the order number of the measure/dimension (starts from 0). | |||
* '''parameter''': Name of the chart setting or parameter. | * '''parameter''': Name of the chart setting or parameter. | ||
* '''tagName''': When ''type'' is ''tag'', defines the linked tag name. The tag can be used in custom expressions similar to variables with syntax <#MyTagName>. | * '''tagName''': When ''type'' is ''tag'', defines the linked tag name. The tag can be used in custom expressions similar to variables with syntax <#MyTagName>. Linking to tags is one-way: when a setting is changed (defined in a linked setting), the tag is changed accordingly (expression is re-evaluated. On the other hand, the tag value itself cannot be changed directly. | ||
* '''variableName''': When linked setting type is ''variable'', defines the variable name. Linking to variables is two-way: when a variable value (defined in a linked setting) is changed, the linked settings are changed accordingly, and when a setting is changed (defined in a linked setting), a linked variable value is changed accordingly. | |||
* '''filterGroupType''': Defines the filter group type (IncludeCases, ExcludeCases, IncludeEvents, ExcludeEvents, IncludeEventTypes, ExcludeEventTypes). | |||
* '''filterRuleType''': Defines the filter rule type. When filter rule type is CaseAttribute, case attribute values. When filter rule type is EventAttribute or Attribute, event attribute values. When filter rule type is EventType, event types. When filter rule type is Case, case id's. | |||
* '''attribute''': Defines the attribute name. Mandatory for filter rule types CaseAttribute, EventAttribute and Attribute. | |||
If referring to an expression level filter, parameters expressionCategory (measure/dimension/eventtypemeasure/flowmeasure) and index are to be defined. When these parameters are not defined, the linked setting refers to a chart level filter rule. Filter rule that matches with the filterGroupType and filterRuleType is used. If no matching filter rule exist, a new filter rule is created, when setting the property. | |||
Example: | Example: |
Revision as of 20:36, 20 December 2022
Linked settings are for binding settings within a chart so that they maintain same values. When configured, the linked settings are kept in synchronization, i.e. when any of the bound settings is changed, other linked settings get also changed.
Linked settings are set in the Advanced tab of chart/flowchart by clicking Linked settings. Linked settings are configured as an array of setting groups which are array of objects. Each object points to an individual setting using the following properties:
- type: One of the following type of chart setting:
- measure: For measure parameters.
- dimension: For dimension and column parameters.
- eventtypemeasure: For flowchart event measures.
- flowmeasure: For flowchart flow measures.
- root: Analyzed objects parameters.
- generic: For other chart settings.
- tag: For binding to a tag.
- variable: For binding to a dashboard variable.
- filtervalue: For binding to certain filter rule parameters.
- filterattribute: For binding to certain filter rule parameters.
- index: When type is a measure, dimension, eventtypemeasure or flowmeasure, the order number of the measure/dimension (starts from 0).
- parameter: Name of the chart setting or parameter.
- tagName: When type is tag, defines the linked tag name. The tag can be used in custom expressions similar to variables with syntax <#MyTagName>. Linking to tags is one-way: when a setting is changed (defined in a linked setting), the tag is changed accordingly (expression is re-evaluated. On the other hand, the tag value itself cannot be changed directly.
- variableName: When linked setting type is variable, defines the variable name. Linking to variables is two-way: when a variable value (defined in a linked setting) is changed, the linked settings are changed accordingly, and when a setting is changed (defined in a linked setting), a linked variable value is changed accordingly.
- filterGroupType: Defines the filter group type (IncludeCases, ExcludeCases, IncludeEvents, ExcludeEvents, IncludeEventTypes, ExcludeEventTypes).
- filterRuleType: Defines the filter rule type. When filter rule type is CaseAttribute, case attribute values. When filter rule type is EventAttribute or Attribute, event attribute values. When filter rule type is EventType, event types. When filter rule type is Case, case id's.
- attribute: Defines the attribute name. Mandatory for filter rule types CaseAttribute, EventAttribute and Attribute.
If referring to an expression level filter, parameters expressionCategory (measure/dimension/eventtypemeasure/flowmeasure) and index are to be defined. When these parameters are not defined, the linked setting refers to a chart level filter rule. Filter rule that matches with the filterGroupType and filterRuleType is used. If no matching filter rule exist, a new filter rule is created, when setting the property.
Example:
[ [ { "type": "measure", "index": 0, "parameter": "Start event" }, { "type": "measure", "index": 1, "parameter": "Start event" } ], [ { "type": "measure", "index": 0, "parameter": "End event" }, { "type": "measure", "index": 1, "parameter": "End event" } ], [ { "type": "measure", "index": 0, "parameter": "Time unit" }, { "type": "measure", "index": 1, "parameter": "Time unit" } ] ]