Text Function Consideration

When a parameter within a text function contains non-alphanumeric characters, we recommend that it be enclosed within quotes. For example, the parameter “NYC, New York” within the function <<MemberName("Grid1", NYC, New York)>> should be re-stated as <<MemberName("Grid1", "NYC, New York")>>.

The following table lists the text functions:

Table 37. Text Functions  

Text Function

Description

Annotation

Returns the requested information about an annotation within a given grid object. Users can define what information about an annotation to return. Multiple syntax are supported.

CalcStatus

Returns the calculation status of a cell in a Financial Management database connection.

CellText

Retrieves the textual content from a Financial Management, Planning, or Oracle Essbase database connection as follows:

  • With Financial Management, retrieves textual content associated with a cell.

  • With Planning, retrieves cell annotations associated with a cell.

  • With Oracle Essbase, retrieves the textual content from a Linked Reporting Object (LRO) from a Oracle Essbase cell (CellText only applies to a Cell note LRO).

DataSource

Returns the server name, application name, database name, or alias table of a grid.

Date

Returns the date and/or time that an online report is populated with data.

Footnote

Returns the requested information about footnotes within a given report object.

GetCell

Returns a data value from a cell in a grid.

GetHeading

Returns text headings in a grid.

GridDimension

Returns the name of a dimension on a grid axis, based on a numeric index or the position of the current cell.

HFMCurrency

Returns the ID of the currency property for a cell in a Financial Management database connection.

ListofCelllDocuments

Returns a list of all cell documents that are selected in a report.

MemberAlias

Returns the alias of the member assigned to a dimension in the grid row, column, or page. Available only for Oracle Essbase and Planning Details.

MemberDescription

Returns the description of the member assigned to a dimension in the grid row, column, or page. Available only for Financial Management.

MemberName

Returns the name of the member assigned to a dimension in the grid row, column, or page.

MemberProperty

Returns the value of member properties within a text cell or text object for a Oracle Essbase, Planning Details, or SAP BW database connection.

MemberQualifiedName

With a Oracle Essbase data source, returns the qualified non unique name of the member assigned to a dimension in the grid row, column, or page.

Note:

This function is supported only for Oracle Essbase 9.0 or later releases.

Page

Returns the current page number in a printed report. This is used in only a text object.

PageCount

Returns the total number of pages in a printed report. This is used only in a text object.

PlanningAnnotations

Retrieves the textual annotations associated with a Planning unit. You can limit your annotations by specifying up to five attribute parameters: author, title, date, text and PlanningUnit. You can also specify certain annotations among all annotations returned.

ProcessManagementStatus

For Financial Management database connection only. Returns the status of a specified cell.

ReportAuthor

Returns the user name of the creator of the report.

ReportCreated

Returns the date the current report was created.

ReportDesc

Returns the text description of the current report.

ReportFolder

Returns the path of the folder where the report is located.

ReportModified

Returns the date the current report was last modified.

ReportModifiedBy

Returns the user name of the last user to save the report.

ReportName

Returns the name of the current report.

ReportRunBy

Returns the name of the user who is running the report.

xbrlContext

Returns the value of the specified of XBRL context property in a column heading.

xbrlLineItem

Returns the value of the specified XBRL line item property in a row heading.