Description of the attributes shared by all dimensions
Attribute 1, ..., Attribute 5
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | All dimensions for which custom attributes can be managed (Entity, Account, Custom Dimensions) |
| Syntax | Attribute1 |
| Value returned | String with the value of the custom attribute defined in the elements table of the dimension to which it is applied. |
Example
$Entity.Attribute1
Returns the value of the entity's attribute 1.
Code
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | All objects, dimensional and otherwise |
| Syntax | code |
| Value returned | String with the dimensional object element code |
Example
$Entity.code
Returns the entity code specified in the filter (row/column, matrix, sheet, form).
Desc
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | All objects, dimensional and otherwise |
| Syntax | Desc([language]) |
| Parameters | - language: (Optional) Code of the table language indicated as a whole number. |
| Value returned | String with the description of the dimensional (or non-dimensional) object element. The optional parameter is only supported if there are multiple descriptions. If omitted, the user's table language is used. |
Example
$Entity.desc(2)
Returns the description of the entity, specified in the filter (row/column, matrix, sheet, form), in table language 2.
DictionaryTerm
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Applicability | All dimensional objects (lowest level elements and nodes) |
| Syntax | DictionaryTerm([language]) |
| Parameters | - language: (Optional) Code of the table language indicated as a whole number. |
| Value returned | Any dictionary items associated with the filter (row/column, matrix, sheet, form) or an empty string. The optional parameter is only supported if there are multiple descriptions. If omitted, the user's table language is used. |
Examples
- $Entity.dictionaryTerm
Returns the description of the dictionary item in the user's table language related to the filter (row/column, matrix, sheet, form) on the entity.
- $Entity.dictionaryTerm(2)
Returns the description, in table language 2, of the dictionary item related to the filter (row/column, matrix, sheet, form) on the entity.
Dimension
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | All dimensional objects (lowest level elements and nodes) |
| Syntax | Dimension |
| Attributes | - code - desc - hierarchyCode |
| Value returned | Dimension or hierarchy to which the filter (row/column, matrix, sheet, form) belongs |
Examples
- $Entity.dimension.code
Returns the string "AZI", which identifies the entity dimension.
- $Entity.dimension.desc
Returns the name assigned to the entity dimension in configuration, e.g. "Legal Entity".
- $Entity.dimension.hierarchyCode
Returns the code of the hierarchy to which the entity specified in the filter (row/column, matrix, sheet, form) belongs.
Link
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Applicability | All dimensional objects (lowest level elements and nodes) |
| Syntax | link |
| Value returned | Any link to the documentation related to the element of the dimensional object |
Example
$Entity.link
Returns any link to the documentation related in the table to the entity specified in the filter (row/column, matrix, sheet, form).
LowestReference
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | All nodes of a hierarchy |
| Syntax | lowestReference |
| Value returned | Reference lowest element relative to the node |
Example
$Entity(Hierarchy(“01”)).lowestReference.desc
Returns the description of the reference entity relative to the node used as a filter (row/column, matrix, sheet, form) on the entity's hierarchy 01.
Path
| Element | Description |
|---|---|
| Availability | From 4.2.0 |
| Applicability | All dimensions and forms |
| Syntax | Path([level], [separator], [cellField]) |
| Parameters | - level. (Optional) The number of levels to go up in the hierarchy (1 = parent, 2 = grandparent, etc.). If omitted or zero, it will go down to the root of the hierarchy. - separator. (Optional) Separator to be used between each element in the returned string. If omitted, the backslash "\" will be used. - cellField. (Optional) Cell field-type expression to be defined on each node of the hierarchy belonging to the path. If omitted, the code will be used. If the path function is applied to the form object, this field is not supported and only the code of the group's nodes belonging to the path will be used. |
| Value returned | String obtained from the concatenation of expressions defined on the nodes of the current element's path. |
Examples
The following examples look at a filter on the "AG - Geographical area" hierarchy of the entity dimension and presume that the city of Lucca (LU) is related to the Tuscany (TOS) node followed by the Italy (ITA) / Europe (EU) nodes:
- $Entity.path
Returns the string "AG\EUR\ITA\TOS\LU".
- $Entity.path(0)
Returns the string "AG\EUR\ITA\TOS\LU".
- $Entity.path(2)
Returns the string "TOS\LU".
- $Entity.path(".")
Returns the string "AG.EUR.ITA.TOS.LU".
- $Entity.path(3,".")
Returns the string "ITA.TOS.LU".
- $Entity.path(3,".","$Entity.desc")
Returns the string "Italy.Tuscany.Lucca".
With a form related to the "DE - Data Entry" \ "P&L - Profit And Loss" nodes of form group "$", the following behaviour is obtained:
- Report.path
Returns the string "$\DE\CE".
- Report.path(2)
Returns the string "DE\CE".
- Report.path(".")
Returns the string "$.DE.CE".
Segment Type
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Applicability | All hierarchy nodes |
| Syntax | segmentType |
| Value returned | Segment type applied to the filter (row/column, matrix, sheet, form) |
Example
$Entity(Hierarchy(“01”)).segmentType.desc
Returns the description of the segment type relative to the node used as a filter (row/column, matrix, sheet, form) on the entity's hierarchy 01.