Functions Overview

Table 11-1 summarizes the Oracle Hyperion Financial Management functions, the objects with which they can be used, and the type of rules in which they can be used. Functions are listed alphabetically. Detailed sections for each function are provided after the table.

Note:

Legacy applications migrated from Financial Management releases prior to 11.1.2.2 can still use the "Custom1...4" objects. All applications created in 11.1.2.2 should use the new Custom(Alias) object syntax to specify which Custom dimension is being referenced using the Custom Alias/short label/long label.

Rules types are abbreviated in this table as follows:

• Alloc - Allocation

• Calc - Calculation

• Con - Consolidation

• Dyn - Dynamic Calculation

• EPU - EquityPickUp

• Tran - Translation

• Trans - Transactions

Table 11-1 Financial Management Functions

Function	Description	Objects	Types of Rules
ABSExp	Executes a calculation expression and stores the result as an absolute value.	HS	Calc, Tran, Alloc
AccountType	Gets the account type for the member.	Account	Calc, Tran, Con, Alloc
AccountTypeID	Gets the account type ID for the member.	Account	Calc, Tran, Con, Alloc
AddEntityToList	Adds the specified entity and parent to a member list.	HS	Member List
AddEntityToListUsingIDs	Using entity and parent IDs, adds the specified entity and parent to an internal list.	HS	Member List
AddMemberToList	Adds the member to the member list.	HS	Member List
AddMemberToListUsingIDs	Using member IDs, adds the specified member to an internal list.	HS	Member List
Alloc	Allocates data to a cell.	HS	Alloc
AllowAdjFromChildren	Determines if journal postings from children are allowed for the member.	Entity, Parent	Calc, Tran, Con, Alloc
AllowAdjs	Determines if journal postings are allowed for the member.	Entity, Parent	Calc, Tran, Con, Alloc
ApplicationName	Returns the name of the application in which rules are running.	AppSettings	Calc, Tran, Con, Alloc
CalculateExchangeRate	Calculates the exchange rate from one currency to another.	HS	Calc, Tran, Con, Alloc, Dyn, Trans
CalculateRate	Gets the current exchange rate for the specified entity.	HS	Calc, Tran, Con, Alloc, Dyn, Trans
CalcStatus	Gets the calculation status for the cell.	HS	Calc, Tran, Con, Alloc
Clear	Removes data from a cell.	HS	Calc, Tran, Con, Alloc
Con	Puts data into the [Proportion] and [Elimination] accounts.	HS	Con
Consol1, Consol2, Consol3	Gets the Consol1...3 system account value for the node.	Node	Calc, Tran, Con, Alloc
ConsolidateYTD	Determines if the scenario is consolidated using the YTD or periodic method.	Scenario	Calc, Tran, Con, Alloc
ContainsCellText	Determines if the cell contains cell text.	HS	Calc, Tran, Con, Alloc
ContainsCellTextWithLabel	Determines if the cell contains cell text for the specified label.	HS	Calc, Tran, Con, Alloc
Currency	Gets the currency type for the application or the value member.	AppSettings, Value	Calc, Tran, Con, Alloc
CustomTop	Gets the CustomTopMember for the account.	Account	Calc, Tran, Con, Alloc
DataUnitItem	Gets the data unit item to process during consolidation, calculation, or translation.	HS	Calc, Tran, Con
Decimal	Gets the number of decimal places for the specified account.	Account	Calc, Tran, Con, Alloc
DefaultFreq	Gets the default scenario frequency.	Scenario	Calc, Tran, Con, Alloc
DefaultParent	Gets the default parent for the member.	Account	Calc, Tran, Con, Alloc
DefaultTranslate	Calculates translation by bypassing rules.	HS	Tran
DefaultView	Gets the default scenario view.	Scenario	Calc, Tran, Con, Alloc
DefCurrency	Gets the default currency for the entity or parent.	Entity, Parent	Calc, Tran, Con, Alloc
DOwn	Gets the percentage of Direct Ownership (DOwn) for the node.	Node	Calc, Tran, Con, Alloc
Dynamic	Specifies the formula for the dynamic accounts that need calculations.	HS	Dyn
Exp	Executes a calculation expression and puts data into a specified point of view.	HS	Calc, Tran, Alloc
GetCell	Gets the data contained in a cell.	HS	Calc, Tran, Con, Alloc
GetCellNoData	Gets the data contained in a cell and indicates if the cell contains no data.	HS	Calc, Tran, Con, Alloc
GetCellRealData	Gets the data contained in a cell and indicates if the cell contains real data.	HS	Calc, Tran, Con, Alloc
GetCellText	Gets the default cell text for a specified Point of View.	HS	Calc, Tran, Con, Alloc
GetCellTextWithLabel	Gets the cell text from the Point of View for the specified cell text label.	HS	Calc, Tran, Con, Alloc
GetCellType	Gets the cell type.	HS	Calc, Tran, Con, Alloc
GetCustomLabelArray	Returns a list of Custom dimension names and aliases.	HS	Calc, Tran, Con, Alloc
GetItem	Gets an individual record to process for consolidation.	DataUnit	Calc, Tran, Con
GetItemIDs2	Gets an individual record to process for consolidation using dimension ID numbers.	DataUnit	Calc, Tran, Con
GetNumItems	Gets the number of records to process for consolidation.	DataUnit	Calc, Tran, Con
GetNumLID	Gets the number of line-item details for the specified POV.	HS	Calc, Tran, Con, Alloc
GetRate	Gets the currency rate for a cell.	HS	Calc, Tran, Con, Alloc
GetSubmissionGroup	Gets the submission group for a cell.	HS	Calc, Tran, Con, Alloc
GetSubmissionPhase	Gets the submission phase for a cell.	HS	Calc, Tran, Con, Alloc
Holding	Gets the holding company for the member.	Entity, Parent	Calc, Tran, Con, Alloc
ICPTopMember	Gets the ICPTopMember of the current Account dimension member or the specified account member.	Account	Calc, Tran, Con, Alloc
ICPWeight	Gets the percentage of ICP entity balances that aggregate to the [ICP Top] value member.	AppSettings	Calc, Tran, Con, Alloc
IDFromMember	Gets the ID number for the specified member.	Account, Custom1 through Custom4, Entity, ICP, Parent, Year, Period, Scenario, Value, View	Calc, Tran, Con, Alloc
ImpactStatus	Changes the status of the specified data unit to impacted.	HS	Calc
Input	Enables input at parent entity level for specified account.	HS	Input
IsAlmostEqual	Checks to see if two values are equal.	HS	Calc, Tran, Con, Alloc, Dyn, Trans
IsBase	Determines if the member is a base member.	Account, Custom1 through Custom4, Entity, Parent, Node	Calc, Tran, Con, Alloc
IsCalculated	Determines if the account is calculated.	Account	Calc, Tran, Con, Alloc
IsChild	Determines if the member is a child of another member.	Account, Custom1 through Custom4, Entity, Parent, Node	Calc, Tran, Con, Alloc
IsConsolidated	Determines if the account is consolidated.	Account	Calc, Tran, Con, Alloc
IsDescendant	Determines if the member is a descendant of another member.	Account, Custom1 through Custom4, Entity, Parent, Node	Calc, Tran, Con, Alloc
IsFirst	Determines if the period or year is the first for the application.	Period, Year	Calc, Tran, Con, Alloc
IsICP	Determines if the member is an ICP.	Account, Entity, Parent	Calc, Tran, Con, Alloc
IsLast	Determines if the year or period is the last for the application.	Period, Year	Calc, Tran, Con, Alloc
IsTransCur	Determines if the value member is a translated currency member.	Value	Calc
IsTransCurAdj	Determines if the value member is a translated currency Adj member.	Value	Calc
IsValidDest	Determines if the specified POV is a valid destination.	HS	Calc, Tran, Con, Alloc
IsZero	Checks to see if the passed in value is zero.	HS	Calc, Tran, Con, Alloc, Dyn, Trans
List	Gets the elements contained in a list.	Account, Custom1 through Custom4, Entity, Parent, ICP, Node, Scenario	Calc, Tran, Con, Alloc
Member	Gets the member name.	Entity, Parent, Period, Scenario, Value, Year, View	Calc, Tran, Con, Alloc
MemberFromID	Gets the member for the specified ID number.	Account, Custom1 through Custom4, Entity, ICP, Parent, Year, Period, Scenario, Value, View	Calc, Tran, Con, Alloc
Method	Gets the consolidation method for the member.	Node	Calc, Tran, Con, Alloc
NoInput	Prevents input into cells.	HS	Noinput
NoRound	Turns off rounding.	HS	Calc, Tran, Con, Alloc
NumBase	Gets the number of base members.	Account, Custom1 through Custom4, Entity, Parent, Node, Period	Calc, Tran, Con, Alloc
Number	Gets the current period number.	Period	Calc, Tran, Con, Alloc
NumChild	Gets the number of children for the member.	Account, Custom1 through Custom4, Entity, Parent, Node	Calc, Tran, Con, Alloc
NumCustom	Gets the number of Custom dimensions defined for the application.	HS	Calc, Tran, Con, Alloc
NumDescendant	Gets the number of descendants for the member.	Account, Custom1 through Custom4, Entity, Parent, Node	Calc, Tran, Con, Alloc
NumPerInGen	Gets the number of periods in the generation for the current period being processed.	Period	Dynamic
NumPeriods	Gets the number of periods defined for the frequency of the specified scenario.	Scenario	Dynamic
OpenCellTextUnit	Returns the cell text for multiple cells.	HS	Calc, Tran, Con
OpenDataUnit	Gets a data unit for consolidation.	HS	Calc, Tran, Con
OpenDataUnitSorted	Gets the data units for calculation, translation, or consolidation, in sorted order.	HS	Calc, Tran, Con
Owned	Gets the Owned entity of the pair currently processed.	Entity	Equity Pickup
Owner	Gets the Owner entity of the pair currently processed.	Entity	Equity Pickup
PCon	Gets the percentage of consolidation.	Node	Calc, Tran, Con, Alloc
PEPU	Gets the percentage of ownership from the EPU table.	HS	Equity Pickup
PeriodNumber	Gets the period number in the view for the data that is being retrieved.	View	Dynamic
PlugAcct	Gets the plug account.	Account	Calc, Tran, Con, Alloc
POwn	Gets the percentage of ownership.	Node	Calc, Tran, Con, Alloc
PVAForBalance	Determines default translation method for BALANCE accounts.	AppSettings	Calc, Tran, Con, Alloc
PVAForFlow	Determines default translation method for FLOW accounts.	AppSettings	Calc, Tran, Con, Alloc
RateForBalance	Gets the default rate for balance.	AppSettings	Calc, Tran, Con, Alloc
RateForFlow	Gets the default rate for flow.	AppSettings	Calc, Tran, Con, Alloc
ReviewStatus	Gets the process management review status for the cell.	HS	Calc, Tran, Con, Alloc
ReviewStatusUsingPhaseID	Gets the process management review status by phase ID for the cell.	HS	Calc, Tran, Con, Alloc
Round	Rounds the data.	HS	Calc, Tran, Con, Alloc
Scale	Gets the scale of the specified currency.	Currency	Calc, Tran, Con, Alloc
SecurityAsPartner	Gets the security class for the ICP entity.	Entity, Parent	Calc, Tran, Con, Alloc
SecurityClass	Gets the security class for a dimension member.	Account, Scenario, Entity, Parent, Custom1 through Custom4	Calc, Tran, Con, Alloc
SetCellTextWithLabel	Writes a text string to cell text for a specified POV and cell text label.	HS	Calc
SetData	Sets an individual record.	HS	Calc, Tran
SetDataWithPOV	Inserts data into the node or currency cube.	HS	Calc, Tran
SubmissionGroup	Gets the process management submission group for a dimension member.	HS	Calc, Tran, Con, Alloc
SupportsProcessManagement	Determines if a scenario supports process management.	Scenario	Calc, Tran, Con, Alloc
SupportsTran	Defines the accounts in the application that require Intercompany Transaction detail support.	Scenario, Year, Entity, Account, C1...4	Trans
SwitchSign	Determines if credits are switched to debits for the member.	Custom1 through Custom4	Calc, Tran, Con, Alloc
SwitchType	Determines if account types are switched for the member.	Custom1 through Custom4	Calc, Tran, Con, Alloc
Trans	Translates using YTD method.	HS	Tran
TransPeriodic	Translates using periodic method.	HS	Tran
UD1...3	Gets the user-defined attribute for the member.	Account, Entity, Parent, Scenario, Custom1 through Custom4	Calc, Tran, Con, Alloc
ValidationAccount	Gets the validation account.	AppSettings	Calc, Tran, Con, Alloc
ValidationAccountEx	Gets the validation account for the process management submission phase.	AppSettings	Calc, Tran, Con, Alloc
XBRLTags	Gets the XBRL tag for the account.	Account	Calc, Tran, Con, Alloc