@ANCESTORS

The @ANCESTORS calculation function for Essbase returns ancestor members.

This function returns all ancestors of the specified member (mbrName), or, those up 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

@ANCESTORS (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 up 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 up to which to select the members.

Notes

The generated list of members is sorted starting with the nearest ancestor of the member, followed by the next nearest ancestor of the member, and so on. Using Sample Basic as an example, if you specify @ANCESTORS(200-30), Essbase returns 200, Product (in that order). This order is important to consider when you use the @ANCESTORS member set function with certain forecasting and statistical functions.

Example

In the Sample Basic database:

@ANCESTORS("New York")

returns East, Market (in that order).

@ANCESTORS(Qtr4)

returns Year.

@ANCESTORS("100-10",1)

returns 100, Product (in that order).

@ANCESTORS(Sales,-2)

returns Margin, Profit (in that order).