Functions
Click Show Functions to show the function buttons. If you are defining a new formula, clicking a function button automatically adds the correct syntax to the formula pane.
These functions are available:
| Function | Description |
|---|---|
| If | Returns one result if a specified condition evaluates to true, and another result if that condition evaluates to false. |
| If not cons | Use when you want a formula to execute against leaf members for both untranslated and translated data. Data for non-leaf members reflects consolidated values from children members but does not reflect formula results at the non-leaf members. |
| If rpt | Use when you want a formula to be computed for the reported data only. The calculated data is then translated and aggregated as defined by the line's rate attribute. |
| Of | Adds a member reference. |
These member testing functions enable you to write conditional formulas that are executed only for certain members of a specified dimension. For example, you can define a formula that applies only to the descendants of the unit North America.
| Function | Description |
|---|---|
| MemberIs( [dimension name]:[member name] ) | Tests if the member being consolidated is the referenced member itself. |
| LeafDescOf( [dimension name]:[member name] ) | Tests if the member being consolidated is a leaf node (reporting node) descendent of the referenced member. |
| ChildOf( [dimension name]:[member name] ) | Tests if the member being consolidated is a child (one level below) of the named member. |
| IChildOf( [dimension name]:[member name] ) | Tests the ChildOf function and additionally tests if the member being consolidated is the referenced member itself. |
| DescOf( [dimension name]:[member name] ) | Tests if the member being consolidated is a descendent (any number of levels below) the referenced member. |
| IDescOf( [dimension name]:[member name] ) | Tests the DescendentOf function and additionally test if the member being consolidated is the referenced member itself. |
| CountOf |
Returns a count of the Children, LeafChildren, Descendants, or LeafDescendants of the referenced member. Use CountOf in a conditional or an algebraic statement. You can use the name of any of the hierarchical dimension except the period and schedule dimensions. |
These rules apply to member testing functions:
- Both the dimension name and the member name must be enclosed in brackets.
- For all member testing
functions except
MemberIs, use the name of any of the hierarchical dimensions except the Period or Schedule dimensions. - For
MemberIs, use the name for Period, Year, Version, Unit, or a custom dimension. - These functions assume that a member can exist in more than one hierarchy but that it must have the same set of children in all hierarchies to which it belongs.
- All of the member testing functions are boolean functions and therefore they can only be used within a condition. For example, they cannot be used within an algebraic expression.
- There is no
MemberIsNotfunction. To get this functionality, use the following syntax:If not MemberIs([dimension]:[member]) then [expression]; EndIf