@ICHILDREN

The @ICHILDREN() function returns the specified member and all of its children. This member set function can be used as a parameter of another function, where that parameter is a list of members.

Syntax

@ICHILDREN(mbrName)

mbrName Any valid single member name or member combination, or a function that returns a single member or member combination.

Notes

Hyperion Essbase sorts the generated list of members starting with the specified member, followed by its children in ascending order. Using Sample Basic as an example, if you specify 100 for mbrName, Hyperion Essbase returns 100, 100-10, 100-20, 100-30 (in that order). This order is important to consider when you use the @ICHILDREN member set function with certain forecasting and statistical functions.

Examples

In the Sample Basic database:

@ICHILDREN(Market)

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

@ICHILDREN(Margin)

returns Margin, Sales, and COGS (in that order).

See Also

@CHILDREN, which excludes the specified member.