Parameters for Text Functions

The following table describes the parameters that you can use in text functions. Not all parameters can be used in all functions. Refer to the section about a specific function to see which parameters apply to that function.

Table 10-8 Text Function Parameters

Parameter	Definition
Grid	The name of the grid. If the function occurs within a grid, or if the function occurs within a text object and there is only a single grid in the report, the grid parameter is optional. If there is more then one grid in the report, the grid parameter is required when the function occurs in a text object and is optional for text cells in a grid where the "current" grid is assumed if not specified.
Row/Column	Either the row number or the column reference (letter) on the grid. The row/column parameter is optional if the function occurs within a grid. If not provided, the "current" row or column is assumed based on the axis of the given dimension. If the dimension occurs on the POV, the row/column parameter is ignored. If the function occurs in a text object, the row/column parameter is required unless the given dimension occurs on the POV
Row	The row number on the grid. It is optional for the CellText function. It is required for the CellValue function. For the CellText function, if you do not specify the row, the cell text for all rows are returned. The row parameter value must be between 1 and row-count.
Column	The column number on the grid. It is optional for the CellText function. It is required for the CellValue function. For the CellText function, if you do not specify the column, the cell text for all columns are returned. The column parameter value is a letter sequence corresponding the available columns (for example: A to AC in a grid with 29 columns).
Dimension	The dimension name. The dimension parameter is required. If the dimension refers to a dimension which is on the POV, the Row/Column parameters are ignored.
DateFormat	Format of a date field. The date-format parameter is optional. If you do not specify the format, the date-format from the user preference is used.
TimeFormat	Format of a time field. The time-format parameter is optional. If you do not specify the format, the time-format from the user preference is used.
Property	The value of the property parameter is specific to the underlying data source. The property parameter is required. Commonly used property values are "Level", "Gen" or "Generation", "AccountType", "IsExpense", and "UDA".) For dimensions which have member-attributes, the attribute name ( (for example, "Pkg Type" )can be used as a member property. For data sources which have multiple alias tables, an alias table name can be used as a member property.You can also use an alias table name for a property value to return a different alias from the one specified on the user POV (for example, the "LongNames" property for the alias table with the name "LongNames").
SkipEmpty	An optional true/false parameter. When the parameter is true, any text or separator rows/columns would be skipped in the given row or column numbering.For example, if rows 1, 3, and 5 are data rows and row 2 and 4 are text or separator rows, the RowNumber(SkipEmpty) function will return a value of 1, 3, and 5 for the data rows and no value for rows 2 and 4. The RowNumber() function (with no skip-empty parameter) would return a value of 1, 2, 3, 4, and 5 for each respective row. If you do not specify this parameter, the default value is False.
Qualified	An optional true/false parameter. When the parameter is true, the member name shown is the fully-qualified member name. In Oracle Essbase outlines which allow non-unique member names, a member which is not unique will have a unique name which includes enough ancestor members to make the name unique. For example if a member called Coke is a child of a member called Colas and also a child of a member called Sodas, then the member unique name would be either Colas.Coke or [Sodas].[Coke]. If you do not specify this parameter, the default value is False.