The individual topics for each function include the required syntax for that function. Function names appear in bold; required parameters appear in italics; and optional parameters appear in brackets [ ] and italics. Individual topics also discuss the defaults that are used when optional parameters are not specified. For detailed descriptions of each function, along with examples of usage, please refer to the individual topic.
For information about how Hyperion Essbase checks for and responds to syntax errors in formulas and calc scripts, see the Database Administrator's Guide.
For information on how to use semicolons in formulas and calc scripts, see the Database Administrator's Guide.
The following table provides a brief description of some of the common parameters used in various functions.
attDimName | A single attribute dimension name specification.
@WITHATTR(Ounces,"<",16) |
attMbrName | A single attribute member name specification.
@ATTRIBUTE(Can) @ATTRIBUTEVAL(Ounces) @WITHATTR("Pkg Type","= =",Can) |
dimName | A single dimension name specification.
@CURLEV(Accounts) @CURGEN(Year) @PARENT(Measures,Sales) |
expList | A comma-delimited list of member names, variable names, functions, and numeric expressions, all of which return numeric values.
@MAX(Jan,Feb,100,Apr-May) @MIN(Oct:Dec) @COUNT(SKIPNONE,@RANGE(Sales,@CHILDREN(Product))) |
expression | Any mathematical or numeric expression that is valid within Hyperion Essbase and that, when calculated, returns a numeric value. This definition of expression also includes parameters such as numDigits, generation, and level, and other similar parameters for the financial group of functions, such as rateMbrConst and lifeMbrConst.
@ABS(Actual-Budget) @ROUND(Sales / 10.0 + 100) |
genLevName | Generation or level name specification.
@DESCENDANTS(Market,Regions) @RELATIVE(Qtr1,Month) |
genLevNum | An integer value that defines the number of a generation or level. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
@ANCESTORS(Sales,-2) @SANCESTVAL(Product,2,Sales) |
mbrList | A comma-delimited list of members.
@ISMBR(New_York,Boston,Chicago) |
mbrName | Any valid single member name or member combination, or a function that returns a single member or member combination. This definition also includes similar parameters, such as balanceMbrName, costMbr, and cashflowMbr, for the financial group of functions.
@GEN(Actual) @CHILDREN(Product) @MAXRANGE(@ANCESTORS(Qtr4),Jan:Dec)For functions that expect a single member name (for example, @DESCENDANTS and @CHILDREN), if a member combination is provided, Essbase uses the first member in the combination. For example, if mbrName is Utah->Sales, Essbase uses Utah. |
n | A positive or negative integer value.
@NEXT(2,Jan:Dec) @SHIFT(3) |
rangeList | A valid member name, a comma-delimited list of member names, member set functions, and range functions from the same dimension. If rangeList is optional and is not specified, Hyperion Essbase uses the level 0 members from the dimension tagged as Time. If no dimension is tagged as Time and this parameter is omitted, Hyperion Essbase reports a syntax error. This definition of rangeList also includes mbrList.
@ACCUM(Q189:Q491) @MAXRANGE(Sales,@CHILDREN(Qtr1)) |
tag | Any valid account tag defined in the current database including First, Last, Average, Expense, and Two-Pass.
@ISACCOUNT(EXPENSE) |
Copyright 1991-2002 Hyperion Solutions Corporation. All rights reserved.