@RDESCENDANTS
The @RDESCENDANTS calculation function for Essbase returns all descendants of the specified member, or those down to the specified generation or level, including shared members, but excluding the specified member.
You can use this function as a parameter of another function, where that parameter is a list of members.
In the absence of shared members, @RDESCENDANTS and @DESCENDANTS return the same result.
Syntax
@RDESCENDANTS (mbrName [, genLevNum| genLevName])Parameters
- mbrName
-
Any valid single member name, or a function that returns a single member.
- genLevNum
-
Optional. An integer value that defines the absolute generation or level number down to which to select the members. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
- genLevName
-
Optional. Level name or generation name down to which to select the members.
Notes
-
The order of members in the result list is important to consider when you use this function with certain forecasting and statistical functions. Essbase generates the list of members in the following sequence: If a shared member is encountered, the above steps are repeated on the member being shared.
-
The specified member
-
The nearest descendant of the member
-
The next nearest descendant of the member, and so on.
-
-
You can use @IRDESCENDANTS to include the specified member in the member list.
Example
Example 1
Assume a variation of the Sample Basic database such that the Product dimension includes the following members:
Product
100
100-10
100-20
100-30
200
200-10
200-20
200-30
200-40
Diet
100 (Shared Member)
200 (Shared Member)Diet has two children "100" and "200". The members "100" and "200" are shared members.
@RDESCENDANTS(Diet)returns the members: 100, 100-10, 100-20, 100-30, 200, 200-10, 200-20, 200-30, 200-40 (in that order).
Example 2
@RDESCENDANTS(Profit)returns Margin, Sales, COGS, Total Expenses, Marketing, Payroll, and Misc (in that order) and is identical to @DESCENDANTS(Profit).