@IDESCENDANTS

Function

The @IDESCENDANTS function returns the specified member and either (1) all descendants of the specified member or (2) all descendants down to a specified generation or level. You can use this member set function as a parameter of another function, where that parameter is a list of members.

Syntax

@IDESCENDANTS(mbrName[, genLevNum | genLevName])

mbrName	Any valid single member name or member combination, or a function that returns a single member or member combination.
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

• Hyperion Essbase sorts the generated list of members as follows:
1. The specified member
2. The nearest descendant of the member
3. The next nearest descendant of the member, and so on
Using Sample Basic as an example, if you specify @IDESCENDANTS(100), Hyperion Essbase returns the members: 100, 100-10, 100-20, 100-30 (in that order). This order is important to consider when you use the @IDESCENDANTS member set function with certain forecasting and statistical functions.
• You can use @DESCENDANTS, to exclude the specified member.
• You can use @RDESCENDANTS and @IRDESCENDANTS to include descendants of shared members.

Example

In the Sample Basic database:

@IDESCENDANTS(East)

returns East, New York, Massachusetts, Florida, Connecticut, and New Hampshire (in that order).

@IDESCENDANTS(Profit)

returns Profit, Margin, Sales, COGS, Total Expenses, Marketing, Payroll, and Misc (in that order).

@IDESCENDANTS(Market,2)

returns Market, East, West, South, and Central (in that order).

@IDESCENDANTS(South,-1)

returns South.

See Also

@DESCENDANTS
@IRDESCENDANTS
@RDESCENDANTS
@ISDESC
@ANCESTORS
@CHILDREN
@SIBLINGS

Copyright (c)1991-2000 Hyperion Solutions Corporation. All rights reserved.