Functions are predefined routines that perform specialized calculations and return sets of members or data values. Table 48 lists the types of functions you can use in formulas:
Table 48. List of Function Types
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 matches any members specified. See Conditional Tests. | |
Perform specialized mathematical calculations. For example, you can use the @AVG function to return the average value of a list of members. | |
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. | |
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 within a specified range. See Range 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. See Financial Functions. | |
Specifying member lists and ranges | Specify multiple members or a range of members. For example, the @ISMBR function tests to see if a member that is currently being calculated matches any of a list or range of specified members. |
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. | |
Character string manipulation | Manipulate character strings for member and dimension names. For example, you can 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. |
Member combinations across dimensions | Point to data values of specific member combinations by using the cross-dimensional operator (->). |
Interdependent values | For formulas that require values from members of the same dimension, but for which the required values have not yet been calculated. |
Variances and variance percentages | Calculate a variance or percentage variance between budget and actual values. See Calculating Variances or Percentage Variances Between Actual and Budget Values. |
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 children of the parent; the allocation of each child is determined by its share of the sales of the previous year. See Allocating Values. | |
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. | |
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. | |
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. | |
Specify calculation modes that Essbase is to use to calculate a formula—cell, block, bottom-up, and top-down. | |
This type enables you to perform functions that you develop for calculation operations. These custom-developed functions are written in the Java programming language and are called by the Essbase calculator framework as external functions. |