Query Types for the Creation of Rule Templates
Related article: Rule Templates
The following query types are available to create a rule template, each allowing a different form of instantiation.
Name |
Description |
Domain |
Example |
|
Dimension element like |
Set of elements from one dimension where the element name matches a regular expression pattern. Each matching element is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. |
|||
Parameters |
Dimension |
Name of the dimension containing the set of elements. |
db_dimension |
Version |
Pattern |
RegEx pattern to filter elements from Dimension. |
regex |
^(Budget|Forecast) |
|
Result |
Cube |
Name of the current cube. |
||
Dimension |
Name of the queried dimension. |
|||
Element |
Matching element. |
|||
Group1 |
1st matching group (parenthesized subpattern) of the regex pattern. |
|||
Group2 |
2nd matching group (parenthesized subpattern) of the regex pattern. |
|||
... |
Up to 8 additional groups are possible. |
Name |
Description |
Domain |
Example |
|
Dimension element |
Set of elements from one dimension where the element name matches a regular expression pattern. All matching elements are returned as a list in one record. |
|||
Parameters |
Dimension |
Name of the dimension containing the set of elements. |
db_dimension |
Version |
Pattern |
RegEx pattern to filter elements from Dimension. |
regex |
^(Budget|Forecast) |
|
Result |
Cube |
Name of the current cube. |
||
Dimension |
Name of the queried dimension. |
|||
Elements |
Matching elements as a single quoted, comma separated list. |
Name |
Description |
Domain |
Example |
Reference |
|
Dimension element |
Set of elements from one dimension where an attribute matches a regular expression pattern. Each matching element is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. |
||||
Parameters |
Dimension |
Name of the dimension containing the set of elements. |
db_dimension |
Version |
|
Attribute |
Name of the attribute of dimension to be matched against the pattern. |
dimension_attribute |
Factor |
{"dimension": "Dimension"} |
|
Pattern |
RegEx pattern to match attribute values for elements of dimension. |
regex |
^1.0$ |
||
Result |
Cube |
Name of the current cube. |
|||
Dimension |
Name of the queried dimension. |
||||
Attribute |
Name of the attribute. |
||||
Attribute value |
Value of attribute matching the pattern. |
||||
Element |
Element name of the queried dimension. |
||||
Group1 |
1st matching group (parenthesized subpattern) of the regex pattern. |
||||
Group2 |
2nd matching group (parenthesized subpattern) of the regex pattern. |
||||
... |
Up to 8 additional groups are possible. |
Name |
Description |
Domain |
Example |
Reference |
|
Dimension element |
Set of elements from one dimension where an attribute matches a regular expression pattern. All matching elements are returned as list in one record. |
||||
Parameters |
Dimension |
Name of the dimension containing the set of elements. |
db_dimension |
Version |
|
Attribute |
Name of the attribute of dimension to be matched against the pattern. |
dimension_attribute |
Factor |
{"dimension": "Dimension"} |
|
Pattern |
RegEx pattern to match attribute values for elements of dimension. |
regex |
^1.0$ |
||
Result |
Cube |
Name of the current cube. |
|||
Dimension |
Name of the queried dimension. |
||||
Attribute |
Name of the attribute. |
||||
Elements |
Matching elements as a single quoted, comma separated list. |
Name |
Description |
Domain |
Example |
Reference |
|
Actual months |
Returns a list of elements from a time dimension being lower or equal to an actual-months attribute of the version dimension. One record is returned for each version with an actual-months attribute. |
||||
Parameters |
Version dimension |
Name of the version dimension having an actual-month attribute. |
cube_dimension |
Version |
|
Time dimension |
Name of the time dimension containing the month elements. Month elements must match the pattern yyyy-MM or FYyyyy-MM. |
cube_dimension |
Month |
||
Version dimension attribute |
Attribute of version dimension with number of actual months (between 1 and 12). |
dimension_attribute |
Actual Months |
{"dimension": "Version dimension"} |
|
Result |
Cube |
Name of the current cube. |
|||
VersionDimension |
Name of the version dimension. |
||||
TimeDimension |
Name of the time dimension. |
||||
ActualMonths |
Non empty attribute value of the version dimension attribute. |
||||
Version |
Element of the version dimension. |
||||
Elements |
Months elements of the time dimension having a month less or equal to the actual-months attribute as a single quoted, comma separated list. |
Name |
Description |
Domain |
Example |
|
Static format string |
Returns the number format string if the cube is configured for static format string mode. Otherwise the result set is empty. |
|||
Result |
Cube |
Name of the current cube. |
||
FormatString |
Number format string applicable to all cells of the cube. |
Name |
Description |
Domain |
Example |
|
Dimension format string |
Returns the number format string for each element if the cube is configured for dimension format string mode. Otherwise the result set is empty. |
|||
Result |
Cube |
Name of the current cube. |
||
Dimension |
Name of the configured format string dimension. |
|||
Attribute |
Name of the configured format string attribute. |
|||
Element |
Element of the format string dimension having a non-empty format string attribute. |
|||
FormatString |
Number format string applicable to the element. |
Name |
Description |
Domain |
Example |
|
KPI calculation |
Offers sophisticated calculations of a measure or account with a calculation expression. The calculation can optionally be restricted by dependencies. |
|||
Parameter |
Dimension |
This is the name of the dimension containing the calculated elements. |
cube_dimension |
PnL account |
Result |
Cube |
Name of the current cube. |
||
Dimension |
Name of the queried dimension. |
|||
Element |
Element name of the queried dimension. |
|||
Calculation |
Expression in Jedox rule syntax. |
|||
TargetRestriction | Additional restriction to the target area. |
Name |
Description |
Domain |
Example |
|
Attribute like |
Set of attributes of a dimension where the attribute matches a regular expression pattern. Each matching attribute is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. |
|||
Parameter |
Pattern |
RegEx pattern to match attributes. |
regex |
^ID_(Name)$ |
Result |
Cube |
Name of the current attribute cube. |
||
Dimension |
Name of the attributed dimension. |
|||
AttributeDimension |
Name of the attribute dimension. |
|||
Attribute |
Name of the attribute matching the pattern. |
|||
Group1 |
1st matching group (parenthesized subpattern) of the regex pattern. |
|||
Group2 |
2nd matching group (parenthesized subpattern) of the regex pattern. |
|||
... | Up to 8 additional groups are possible. |
Name |
Description |
Domain |
Example |
|
Initial months |
Returns a list of the first periods of each fiscal year from a time dimension. If the fiscal year feature is not used a list of January elements is returned. |
|||
Parameter |
Time dimension |
Name of the time dimension containing the month elements. Month elements must match the pattern yyyy-MM or FYyyyy-MM. |
cube_dimension |
Month |
Result |
Cube |
Name of the current cube. |
||
TimeDimension |
Name of the time dimension. |
|||
Elements |
Months elements of the time dimension being the first periods of each fiscal year as a single quoted, comma separated list. |
Name |
Description |
Domain |
Example |
Reference | |
Global subset element | Set of elements from a global subset. Each matching element is returned as a record. | ||||
Parameter | Dimension | Name of the dimension containing the global subset. | db_dimension | Version | |
Subset | Name of the global subset from Dimension. | dimension_subset | PlanningVersions | { "dimension": "Dimension" } | |
Result | Cube | Name of the current cube. | |||
Dimension | Name of the dimension containing the global subset. | ||||
Subset | Name of the global subset. | ||||
Element | Subset element. |
Name |
Description |
Domain |
Example |
Reference |
|
Global subset element (list) | Set of elements from a global subset. All matching elements are returned as a list in one record. | ||||
Parameter | Dimension | Name of the dimension containing the global subset. | db_dimension | Version | |
Subset | Name of the global subset from Dimension. | dimension_subset | PlanningVersions | { "dimension": "Dimension" } | |
Result | Cube | Name of the current cube. | |||
Dimension | Name of the dimension containing the global subset. | ||||
Subset | Name of the global subset. | ||||
Elements | Subset elements as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. |
Name |
Description |
Domain |
Example |
Reference | |
Dimension element like group by one attribute value | Set of elements from one dimension where the element name matches a regular expression pattern. Combined with sets of elements of one other dimension sharing an attribute value. Each combination of matching element and attribute value is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. | ||||
Parameter | Dimension | Name of the dimension containing the set of elements. | db_dimension | Version | |
Pattern | RegEx pattern to filter elements from Dimension. The example filters for all version starting with Budget or Forecast and will thus match elements like Forecast 3+9 or Budget 2013. | regex | ^(Budget|Forecast) | ||
Attribute dimension 1 | Name of the dimension containing the first joined set of elements. | db_dimension | Version | ||
Attribute 1 | Name of the attribute of attribute dimension 1 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 1" } | |
Attribute pattern 1 | RegEx pattern to match attribute values for elements of attribute dimension 1. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Result | Cube | Name of the current cube. | |||
Dimension | Name of the queried dimension. | ||||
Element | Matching element. | ||||
Group1 | 1st matching group (parenthesized subpattern) of the regex pattern. | ||||
Group2 | 2nd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group3 | 3rd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group4 | 4th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group5 | 5th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group6 | 6th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group7 | 7th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group8 | 8th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group9 | 9th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group10 | 10th matching group (parenthesized subpattern) of the regex pattern. | ||||
Attribute1 | Name of the first attribute. | ||||
Elements1 | Matching elements of the first queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. |
Name |
Description |
Domain |
Example |
Reference | |
Dimension element like group by two attribute values | Set of elements from one dimension where the element name matches a regular expression pattern. Combined with sets of elements of two other dimensions sharing an attribute value. Each combination of matching element and attribute value is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. | ||||
Parameter | Dimension | Name of the dimension containing the set of elements. | db_dimension | Version | |
Pattern | RegEx pattern to filter elements from Dimension. The example filters for all version starting with Budget or Forecast and will thus match elements like Forecast 3+9 or Budget 2013. | regex | ^(Budget|Forecast) | ||
Attribute dimension 1 | Name of the dimension containing the first joined set of elements. | db_dimension | Version | ||
Attribute 1 | Name of the attribute of attribute dimension 1 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 1" } | |
Attribute pattern 1 | RegEx pattern to match attribute values for elements of attribute dimension 1. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Attribute dimension 2 | Name of the dimension containing the second joined set of elements. | db_dimension | Version | ||
Attribute 2 | Name of the attribute of attribute dimension 2 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 2" } | |
Attribute pattern 2 | RegEx pattern to match attribute values for elements of attribute dimension 2. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Result | Cube | Name of the current cube. | |||
Dimension | Name of the queried dimension. | ||||
Element | Matching element | ||||
Group1 | 1st matching group (parenthesized subpattern) of the regex pattern. | ||||
Group2 | 2nd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group3 | 3rd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group4 | 4th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group5 | 5th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group6 | 6th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group7 | 7th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group8 | 8th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group9 | 9th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group10 | 10th matching group (parenthesized subpattern) of the regex pattern. | ||||
AttributeDimension1 | Name of the first queried attribute dimension. | ||||
Attribute1 | Name of the first attribute | ||||
Elements1 | Matching elements of the first queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. | ||||
AttributeDimension2 | Name of the second queried attribute dimension. | ||||
Attribute2 | Name of the second attribute. | ||||
Elements2 | Matching elements of the second queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. |
Name |
Description |
Domain |
Example |
Reference | |
Dimension element like group by three attribute values | Set of elements from one dimension where the element name matches a regular expression pattern. Combined with sets of elements of three other dimensions sharing an attribute value. Each combination of matching element and attribute value is returned as a record. If the regular expression pattern contains groups (also known as parenthesized subpatterns) the matching groups are returned, too. | ||||
Parameter | Dimension | Name of the dimension containing the set of elements. | db_dimension | Version | |
Pattern | RegEx pattern to filter elements from Dimension. The example filters for all version starting with Budget or Forecast and will thus match elements like Forecast 3+9 or Budget 2013. | regex | ^(Budget|Forecast) | ||
Attribute dimension 1 | Name of the dimension containing the first joined set of elements. | db_dimension | Version | ||
Attribute 1 | Name of the attribute of attribute dimension 1 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 1" } | |
Attribute pattern 1 | RegEx pattern to match attribute values for elements of attribute dimension 1. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Attribute dimension 2 | Name of the dimension containing the second joined set of elements. | db_dimension | Version | ||
Attribute 2 | Name of the attribute of attribute dimension 2 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 2" } | |
Attribute pattern 2 | RegEx pattern to match attribute values for elements of attribute dimension 2. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Attribute dimension 3 | Name of the dimension containing the third joined set of elements | db_dimension | Version | ||
Attribute 3 | Name of the attribute of attribute dimension 3 to be matched against the pattern. | dimension_attribute | Factor | { "dimension": "Attribute dimension 3" } | |
Attribute pattern 3 | RegEx pattern to match attribute values for elements of attribute dimension 3. The example filters for all version having 1.0 as attribute Factor. | regex | ^1.0$ | ||
Result | Cube | Name of the current cube. | |||
Dimension | Name of the queried dimension. | ||||
Element | Matching element | ||||
Group1 | 1st matching group (parenthesized subpattern) of the regex pattern. | ||||
Group2 | 2nd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group3 | 3rd matching group (parenthesized subpattern) of the regex pattern. | ||||
Group4 | 4th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group5 | 5th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group6 | 6th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group7 | 7th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group8 | 8th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group9 | 9th matching group (parenthesized subpattern) of the regex pattern. | ||||
Group10 | 10th matching group (parenthesized subpattern) of the regex pattern. | ||||
AttributeDimension1 | Name of the first queried attribute dimension. | ||||
Attribute1 | Name of the first attribute | ||||
Elements1 | Matching elements of the first queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. | ||||
AttributeDimension2 | Name of the second queried attribute dimension. | ||||
Attribute2 | Name of the second attribute. | ||||
Elements2 | Matching elements of the second queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. | ||||
AttributeDimension3 | Name of the third queried attribute dimension. | ||||
Attribute3 | Name of the third attribute | ||||
Elements3 | Matching elements of the third queried attribute dimension as a single quoted, comma separated list. Example: 'Budget','Forecast 3+9','Forecast 6+6','Forecast 9+3'. |
Updated September 27, 2022