@GROWTH

Calculates a series of values that represent a linear growth of the first nonzero value encountered in principalMbr across the specified XrangeList. Growth is calculated by multiplying the growth rate in rateMbrConst by the original principalMbr. This value is then added to the previous time period's result, yielding the new value.

Syntax

@GROWTH (principalMbr, rateMbrConst [, XrangeList])

Parameters

principalMbr

Single member specification that represents the initial value of the value to grow. The first nonzero value encountered is the initial value. Other principalMbr values after the first are ignored.

rateMbrConst

Single member specification, variable name, or numeric expression providing a constant value that represents the decimal growth rate to be applied (for example, 10% = .1).

XrangeList

Optional parameter specifying the range over which the function is calculated. If a range is not specified, Essbase uses the level 0 members from the dimension tagged as Time.

Can be a valid member name, a comma-delimited list of member names, cross dimensional members, or a return value from a member set function or range function (including @XRANGE).

For more information about rangeList and XrangeList, see Range List Parameters.

Notes

Financial functions never return a value; rather, they calculate a series of values internally based on the range specified.

Example

The following example calculates the growth of Principal Amount, using the rate found in Growth Rate for each fiscal year. The results are placed in Growth Amount.

"Growth Amount"=@GROWTH("Principal Amount","Growth Rate",FY1998:FY2003);

This example produces the following report:

                   FY1998 FY1999 FY2000 FY2001 FY2002 FY2003
                   ====== ====== ====== ====== ====== ======                     
Principal Amount    1,000      0  2,000      0      0      0
Growth Amount       1,050  1,120  1,200  1,280  1,380  1,480
Growth Rate          0.05   0.07   0.08   0.08    0.1    0.1

The following example assumes a Year dimension is added to Sample Basic. It calculates growth using a multidimensional range.

FIX ("100-10", "New York")
"Growth Amount" = @GROWTH("Principal Amount","Growth Rate",@XRANGE("2011"->"Sep", "2012"->"Mar"));
ENDFIX

The above calculation is performed across the following multidimensional range specified by XrangeList:


2011->Sep
2011->Oct
2011->Nov
2011->Dec
2012->Jan
2012->Feb
2012->Mar