Functions are predefined routines that perform specialized calculations and return sets of members or data values. The following list describes the types of functions you can use to help you design business rules, business rule sequences, macros, and variables. See the Essbase Technical Reference.
Boolean functions – Provide a conditional test by returning a TRUE (1) or FALSE (0) value. For example, you can use the @ISMBR function to determine whether the current member is one that you specify.
Mathematical functions – Perform specialized mathematical calculations. For example, you can use the @AVG function to return the average value of a list of members.
Relationship functions – Look up data values within a database during a calculation. For example, you can use the @ANCESTVAL function to return the ancestor values of a specified member combination.
Range functions – Declare a range of members as an argument to another function or command. For example, you can use the @SUMRANGE function to return the sum of all members that lie within a specified range.
Financial functions – Perform specialized financial calculations. For example, you can use the @INTEREST function to calculate simple interest or the @PTD function to calculate period-to-date values.
Member Set functions -–Generate a list of members that is based on a specified member. For example, you can use the @ICHILDREN function to return a specified member and its children.
Allocation functions – Allocate values that are input at a parent level across child members. You can allocate values within the same dimension or across multiple dimensions. For example, you can use the @ALLOCATE function to allocate sales values that are input at a parent level to the parent's children; each child's allocation is determined by its share of the previous year's sales.
Forecasting functions – Manipulate data for the purposes of smoothing or interpolating data, or calculating future values. For example, you can use the @TREND function to calculate future values that are based on curve-fitting to historical values.
Statistical functions – Calculate advanced statistics. For example, you can use the @RANK function to calculate the rank of a specified member or a specified value in a data set.
Date and Time functions -– Use date and time characteristics in calculation formulas. For example, you can use the @TODATE function to convert date strings to numbers that can be used in calculation formulas.
Miscellaneous functions – Provide two different kinds of functionality:
You can specify calculation modes that Essbase should use to calculate a formula: cell, block, bottom-up, and top-down
You can manipulate character strings for member and dimension names; for example, to generate member names by adding a character prefix to a name or removing a suffix from a name, or by passing the name as a string.
Custom-Defined functions – Enable you to perform functions that you develop for your calculation operations. These custom-developed functions are written in the Java programming language and are called by the Essbase calculator framework as external functions.