HFMCurrency

HFMCurrency is a text function that returns the ID of the currency property for a cell in a Financial Management database connection.

The function syntax is as follows:

<<HFMCurrency("GridName", Row, Col, Page)>>

Argument	Description
GridName	The name of a Financial Management grid. This value must be enclosed in quotation marks
Row	Numeric value representing the row index of the grid. The first row in a grid has an index of 1, the second row has an index of 2, and so forth.
Col	A letter representing the column of the grid. The first column in a grid has an index of A, the second column has an index of B, and so forth.
Page	A numeric value representing the page dimension index of the grid. The first page dimension in a grid has an index of 1, the second page dimension has an index of 2, and so forth.

A designer can map the string returned from Financial Management to another string by way of a properties file change. The mappings are defined in the JConsole file. For example, a designer might add these lines to HFM Entity Currency section:

Note:

For information on JConsole, see the “Property Information” topic in the Oracle Hyperion Financial Reporting Workspace Administrator's Guide..

EntityCurrency_USD=$
EntityCurrency_EUR=_

If USD is returned from Financial Management, the U.S. dollar symbol ( $ ) is displayed; if EUR is returned from Financial Management, the European euro symbol ( _ ) is displayed. The properties file includes these and other examples as comments.

Example

The following syntax displays the currency property for the cell that is in row 21, column B on page 1 of Grid1:

<<HFMCurrency("Grid1",21,B,1)>>

Note:

This function only supports the Current keyword when used in a grid cell; not in a text box object, header, footer or otherwise. For information and examples, see Current / Cur Keyword.