Description of dimensional functions
The $ Function
| Element | Description |
|---|---|
| Availability | From CCH Tagetik 3.0912 |
| Applicability | To all dimensions |
| Syntax | $ |
| Parameters | (optional) Boolean: - TRUE: allows you to obtain the lowest level elements of the indicated dimensional object. - FALSE: allows you to obtain the indicated dimensional object. |
| Value returned | Filter defined on the following dimensions: - $Entity.: entity dimension - $Account.: account dimension - $Causal.: causal dimension - $Cust_Dim1…5.: custom dimensions - $Category.: category dimension - $AmountType.: amount type dimension - $Currency.: currency dimension - $Scenario.: scenario dimension - $Period.: period dimension - $PeriodLength.: period length dimension - $ICEntity.: counterparty entity dimension - $ICCust_Dim.: counterparty custom dimension |
Example
$Entity
Returns the entity on which it is possible to operate with attributes.
Example
$Entity.code or $Entity(TRUE).code
With a parameter on a hierarchy of the entity dimension.
| If the following is selected when running the form... | The function will return... |
|---|---|
| a lowest level element of the hierarchy | the code of the selected lowest level element |
| a node of the hierarchy | a string resulting from the concatenation of the codes of all the lowest level elements related to the selected node. |
Example
$Entity(FALSE).code
With a parameter on a hierarchy of the entity dimension, if the user selects a node of the hierarchy, the code of the selected node will be obtained when the form is run.
Particular features of dimensional functions¶
For every dimensional function, there is a corresponding function without the $ symbol. With the $, the function returns the current value associated with a dimension; without the $, it returns a description of the dimension.
Examples
$Entity.desc: returns the string "Tagetik srl".
Entity.desc: returns the string "Entity".
These functions are also useful for recalling elements in forms where the involved dimension is not used. Descriptions are always available and return information on all the system's dimensions, including those not linked to the current filters.
Example
The $Entity.getLeaf("A1").desc function can be used to print a cell field with the description of entity "A1". However, this only works if a starting filter is present on the entity dimension and it is therefore possible to identify the lowest level element with code "A1". If there are no filters on the entity dimension, or if the entity dimension is not included in the form, the $Entity expression will not return anything. In this case, the Entity.getLeaf("A1").desc function will return the desired information.
Functions without the $ are also applicable to hierarchies: hierarchy("G1").Entity.getNode("N1").desc or Entity("G1").getNode("N1").desc
Hierarchy
| Element | Description |
|---|---|
| Availability | From CCH Tagetik 3.0912 |
| Applicability | To all dimensions in which hierarchies can be defined |
| Syntax | Hierarchy("heirarchy_code") |
| Parameters | "heirarchy_code." |
| Value returned | Filter on the dimension hierarchy indicated in "heirarchy_code" |
Example
$Entity(Hierarchy("G1")): returns the filter on hierarchy G1 defined on the entity dimension.