Formula Expressions

Formula expressions can include these predefined variables and functions.

Table 24-10 Variables in Formula Expressions

Variable	Description
OpenInputValueBlock	Generates an IF statement if the application is a multicurrency application, or an empty string if it's one currency application. Used with ClosedInputValueBlock.
CloseInputValueBlock	Generates an End IF statement if the application is a multicurrency application, or an empty string if it's 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 24-11 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 by adding the default prefix of "No" to each dimension name (except Currency, Period and Year), followed by the specified account. For example, in an application with the following dimensions: Account, Period, HSP_View, Year, Scenario, Version, Entity, and Product CrossRef("5800") returns: "BegBalance"->"No HSP_View"->"No Scenario"->"No Version"->"No Entity"->"No Product"->"5800";
CrossRef(accountName, prefix)	Generates a cross-reference by adding the specified prefix to each dimension name (except Currency, Period and Year), followed by the specified account. The prefix should be in double quotes. For example, in an application with the following dimensions: Account, Period, HSP_View, Year, Scenario, Version, Entity, and Product CrossRef("5800", "NoX") returns: "BegBalance"->"NoX HSP_View"->"NoX Scenario"->"NoX Version"->"NoX Entity"->"NoX Product"->"5800";
CrossRef(accountName, prefix, true)	Generates a cross-reference by adding the specified prefix to each dimension name, including Year (except Currency and Period), followed by the specified account. For example, CrossRef("5800", "NoX", true) returns: "BegBalance"->"NoX HSP_View"->"NoX Year"->"NoX Scenario"->"NoX Version"->"NoX Entity"->"NoX Product"->"5800";
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."