Returns the first descendant of a layer, or the first child of the Time dimension.
Syntax
OpeningPeriod ( [ layer [,member ]] )
Parameter | Description |
---|---|
A layer specification. If omitted, the first descendant of member is used. If member is omitted, the first child of the Time dimension is assumed. | |
Optional. A member specification. If omitted, the first child of the Time dimension is assumed (for example, Qtr1 in Sample Basic). |
Notes
The return value of this function varies depending on the input.
When no arguments are specified, the input member is assumed to be the current member of the Time dimension, and Openingperiod returns the first child of that member. Do not use this function without arguments if there is no dimension tagged as Time.
When both layer and member arguments are given as input, Openingperiod returns the first descendant of the input member at the input layer. For example, Openingperiod(Year.generations(3), Qtr3) returns Jul. If the input member and layer are the same layer, the output is the input member. For example, Openingperiod(Year.generations(3), Jul) returns Jul.
When only the layer argument is specified, the input member is assumed to be the current member of the dimension used in the layer argument. Openingperiod returns the first descendant of that dimension, at the input layer. For example, Openingperiod(Year.generations(3)) returns Oct.
See Also