HFM Rules Basics
HFM Rules Basics
Routine Executed
Calculate() and Dynamic() -- When you calculate or consolidate
data
Translate() -- When you translate data
Allocate() -- When you use the Allocate option in a data
grid
Input() -- When the application is opened.
NoInput() -- When the application is opened.
Automatically
prevent you from entering data in specific
cells
Transactions() -- When the application is opened.
Consolidate() -- When you run a consolidation.
You place the rules for each type in a separate sub procedure
in the
rules file.
Sub Calculate ()
<All calculate rules are displayed here.>
End Sub
Sub Dynamic ()
<All dynamic rules are displayed here.>
End Sub
Sub Translate ()
<All translate rules are displayed here.>
End Sub
Sub Allocate ()
<All allocation rules are displayed here.>
End Sub
Sub NoInput ()
<All no input rules are displayed here.>
End Sub
Sub Consolidate ()
<All consolidate rules are displayed here.>
End Sub
Sub Input
<All input rules are displayed here.>
End Sub
Sub Transactions ()
<All transactions rules are displayed here.>
End Sub
Object Function
HS : ABSExp
Alloc
CalcStatus
Clear
Con
Exp
Dynamic
GetCell
GetCellNoData
GetCellRealData
GetCellType
GetRate
ImpactStatus
Input
NoInput
NoRound
OpenDataUnit
ReviewStatus
Round
SetData
SetDataWithPOV
Trans
TransPeriodic
Account: AccountType
C1...4 Top
IsBase
IsChild
IsConsolidated
IsDescendant
IsICP
List
NumBase
NumChild
NumDescendant
PlugAccount
SecurityClass
UD1...3
ValidationAccount
XBRLTags
AppSettings: Currency
ICPWeight
PVAForBalance
PVAForFlow
RateForBalance
RateForFlow
Currency: Scale
Custom1:
Custom2:
Custom3:
Custom4: IsBase
IsDescendant
List
NumBase
NumChild
NumDescendant
SecurityClass
SwitchSign
SwitchType
UD1...3
DataUnit: GetItem
GetItemIds2
GetNumItems
Entity: AllowAdjs
AllowAdjsFromChildren
DefCurrency
Holding
IsBase
IsChild
IsDescendant
IsICP
List
Member
NumBase
NumChild
NumDescendant
SecurityAsPartner
SecurityClass
UD1...3
ICP: List
Node: Consol1...3
DOwn
IsBase
IsChild
IsDescendant
List
Method
NumBase
NumChild
NumDescendant
PCon
POwn
Parent: DefCurrency
Holding
IsBase
IsChild
IsDescendant
IsICP
List
Member
NumBase
NumChild
NumDescendant
UD1...3
Period: IsFirst
IsLast
List
Member
NumBase
Number
Scenario: ConsolidateYTD
DefaultFreq
DefaultView
List
Member
NumPeriods
SecurityClass
UD1...3
Value: Currency
IsTransCur
IsTransCurAdj
Member
Year: IsFirst
IsLast
Member
Destination Expressions:
The destination for the Exp function is specified by the Account, Custom, and ICP
members specified on the left side of the equal sign. The destination Entity,
Period, Year,
Value, members are determined by the current point of view (POV) members or
by the
cells selected on the data grid or form. The members for the currently selected
cells on
the grid override the current POV members. The destination View member is the
current
Source Expressions:
When you use an account expression on the right side of the equal sign with Exp,
you
can specify any dimension member. If you do not specify a Entity, Period, Year, or
Value
dimension member, the current POV member or the current cells selected on the
grid or
HS.Exp A#ALL=100
The table lists the dimension keywords that you can use to specify dimension
members:
Period and Year Keywords:
Conditional Statements:
Applying the IfThenElse Statement:
Arrays: