1. Designer's Guide
  2. Using Member Selection, Variables, Functions, Smart Lists, and Planning Formula Expressions to Design Components
  3. Adding Members and Functions to a Component
  4. Adding Members or Functions from One or More Dimensions to a Component
  5. Functions

Functions

On the Functions, tab select a function or functions, and enter the required values for the function according to this table:

Oracle Hyperion Planning and Oracle Essbase block storage application users only:

Table 8-2 Functions and Values

Function Values to Enter Description
@ALLANCESTORS Member Name Enter the member name or click Member to select a member.
@ANCEST

  • Dimension Name

  • Generation Level Number

  • Member Name

  1. Enter the dimension name you selected in Dimensions.

  2. Enter an integer value that defines the generation or level number from which the ancestor value is returned. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.

  3. Enter any member name or member combination.
@ANCESTORS

  • Member Name

  • Generation Level Number

  • Generation Level Name

  1. Enter a member name or member combination.

  2. Enter an integer value that defines the absolute generation or level number up to which to include members. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.

  3. Enter a level name or generation name up to which to include members in the selection.
@ATTRIBUTE Attribute Member Name For the dimension you entered, enter the attribute member name or member combination you want to include in the selection.
@CHILDREN Member Name Enter a member name or member combination, or a function that returns a member or member combination.
@CURRMBR Dimension Name Enter the dimension name.
@DESCENDANTS

  • Member Name

  • Generation Level Number

  • Generation Level Name

  1. Enter a member name or member combination.

  2. Enter an integer value that defines the absolute generation or level number up to which to include members. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.

  3. Enter a level name or generation name up to which to include members in the selection.
@GENMBRS

  • Dimension Name

  • genName

  1. Enter a dimension name.

  2. Enter a generation name from dimName. A positive integer defines a generation number.
@IALLANCESTORS Member Name Enter a member name or member combination, or a function that returns a member or member combination.
@IANCESTORS

  • Member Name

  • Generation Level Number

  1. Enter a member name or member combination, or a function that returns a member or member combination.

  2. Enter an integer value that defines the absolute generation or level number up to which to include members in the selection. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
@ICHILDREN Member Name Enter a member name or member combination, or a function that returns a member or member combination.
@IDESCENDANTS

  • Member Name

  • Generation Level Number

  1. Enter a member name or member combination, or a function that returns a member or member combination.

  2. Enter an integer value that defines the absolute generation or level number up to which to include members in the selection. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
@ILSIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@IRDESCENDANTS

  • Member Name

  • Generation Level Number

  1. Enter a member name or member combination, or a function that returns a member or member combination.

  2. Enter an integer value that defines the absolute generation or level number up to which to include members in the selection. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
@IRSIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@ISIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@LEVMBRS

  • Dimension Name

  • Level Name

  1. Enter a dimension name.

  2. Enter a level name or an integer value that defines the number of a level. The integer value must be 0 or a positive integer.
@LIST Argument Enter a list of arguments that will be collected and treated as one argument so they can be processed by the parent function. Arguments can be member names, member combinations, member set functions, range functions, and numeric expressions.
@LSIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@MATCH

  • Member, Generation

  • genName

  • Pattern to Match

  1. Enter the default or user-defined name of the member on which to base the selection. The system searches the member names and alias names of the specified member and its descendants.

  2. Enter the default or user-defined name of the generation on which to base the selection. The system searches all member names and member alias names in the generation.

  3. Enter the character pattern to search for, including a wildcard character (* or ?). ? substitutes one occurrence of any character. You can use ? anywhere in the pattern. * substitutes any number of characters. You can use * only at the end of the pattern. To include spaces in the character pattern, enclose the pattern in double quotation marks ("").
@MEMBER String Enter a string (enclosed in double quotation marks) or a function that returns a string.
@MERGE

  • List 1

  • List 2

  1. Enter the first list of members to be merged.

  2. Enter the second list of members to be merged.
@PARENT

  • Dimension Name

  • Member Name

  1. Enter the dimension name.

  2. Enter a member name or member combination, or a function that returns a member or member combination, to be combined with the parent returned.
@RANGE

  • Member Name

  • Range List

  1. Enter a member name or member combination, or a function that returns a member or member combination, to be combined with the parent returned.

  2. Enter a member name, a comma-delimited list of member names, member set functions, or range functions. If rangeList is not specified, the system uses the level 0 members from the dimension tagged as Time.
@RDESCENDANTS

  • Member Name

  • Generation Level Number

  1. Enter a member name or member combination, or a function that returns a member or member combination, to be combined with the parent returned.

  2. Enter an integer value that defines the absolute generation or level number down 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.
@RELATIVE

  • Member Name

  • Generation Level Number

  1. Enter a member name or member combination, or a function that returns a member or member combination, to be combined with the parent returned.

  2. Enter an integer value that defines the absolute generation or level number down 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.
@REMOVE

  • List 1

  • List 2

  1. Enter the first list of members to be merged.

  2. Enter the second list of members to be merged.
@RSIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@SHARE Range List Enter a comma-delimited list of members, functions that return members, or ranges of members. All the members in rangeList must be from the same dimension.
@SIBLINGS Member Name

Enter a member name or member combination, or a function that returns a member or member combination.
@UDA

  • Dimension Name

  • User Defined Attribute

  1. Enter the name of the dimension with which the user-defined attribute is associated.

  2. Enter the name of the user-defined attribute as it appears in the database outline.
@WITHATTR

  • Dimension Name

  • Operator

  • Value

  1. Enter the name of the attribute dimension.

  2. Enter the operator specification, enclosed in quotation marks ("").

  3. Enter a value that, in combination with the operator, defines the condition that must be met. The value can be an attribute member specification, a constant, or a date-format function (that is, @TODATE).
@XRANGE

  • Member Name 1

  • Member Name 2

  1. Enter a member name, member combination, or function that returns a single member.

  2. Enter a member name, member combination, or function that returns a single member. If mbrName1 is a cross-dimensional member (such as Actual->Jan), then mbrName2 must be also, and the dimension order must match the order used in mbrName1.