1. Administrator's Guide
  2. Working with Planning Application Administration
  3. Using Smart Lists, UDAs, and Member Formulas
  4. Working with Member Formulas
  5. Working with Formula Expressions
  6. Formula Expressions

Formula Expressions

Oracle Hyperion Planning formula expressions can include these predefined variables and functions.

Table 12-18 Variables in Formula Expressions

Variable Description

OpenInputValueBlock

Generates an IF statement if the Planning application is a multicurrency application, or an empty string if it is one currency application. Used with ClosedInputValueBlock.

CloseInputValueBlock

Generates an End IF statement if the Planning application is a multicurrency application, or an empty string if it is one currency application. Used with OpenInputValueBlock.

NumberOfPeriodsInYear

Returns the number of time periods in the year

NumberOfYears

Returns the number of years in the application

Table 12-19 Functions in Formula Expressions

Function Description

Dimension(dimTag)

Returns the name of a predefined dimension. The dimtags are:

  • DIM_NAME_PERIOD

  • DIM_NAME_YEAR]

  • DIM_NAME_ACCOUNT

  • DIM_NAME_ENTITY

  • DIM_NAME_SCENARIO

  • DIM_NAME_VERSION

  • DIM_NAME_CURRENCY

Period(periodName)

Returns the specified period. The periodName options are:

  • FIRST_QTR_PERIOD

  • SECOND_QTR_PERIOD

  • THIRD_QTR_PERIOD

  • FOURTH_QTR_PERIOD

  • FIRST_PERIOD

  • LAST_PERIOD

CrossRef(accountName)

Generates a cross reference for the account

CrossRef(accountName, prefix)

Generates a cross-reference for the account. The account name contains a prefix that you define. The default prefix is No, followed by a blank space and the account name, for example, No Salary.

getCalendarTPIndex()

Generates a member formula that returns an index for the time period; the index is based on the calendar year.

getFiscalTPIndex()

Generates a member formula that returns an index for the time period; the index is based on the fiscal year.

CYTD(memberName)

Generates a calendar year-to-date formula for the member

CYTD(memberName, calTpIndexName, fiscalTpIndexName)

Generates a calendar year-to-date formula for the member, and the time period index based on the calendar year and fiscal year. Use when members are renamed. The default member names are "Cal TP-Index" and "Fiscal TP-Index."