Rules gives the wings to HFM application and are incredibly powerful & flexible way to add calculations to the applications. Rule file extension is .RLE
What is a Rule?
Ans: Rules are Combination of Objects & Functions/Methods
Hs is the namespace, Entity is the object, DefCurrency is the function, and E#SpecificEntity is the argument, to define the dimension in the argument, HFM requires the dimension label and a number sign (#).
# We load all rules in single file as there is only replace option available and No merge option.
# Rules start with "SUB" and ends with "ENDSUB"
9 Rules are:
Calculation -------------------HS.Exp
Translation -------------------HS.Trans
Consolidation -------------------Call HS.Con
Allocation -------------------Call HS.Alloc
Input -------------------HS.Input
NoInput -------------------HS.NoInput
DynamicCalculation -------------------HS.Dynamic
TransactionsICP -------------------HS.SupportTran
EquityPickup ------------------- HS.PEPU
What is HS. ?
HS. = Hyperion Solution
HFM Rules
There are 2 main Functions
Load to the Database ---- HS.Exp
Retrieve from the Database-------HS.GetCell
Most Common |
Less Common |
Infrequent |
Calculate |
Allocate |
ICP |
Translate |
Input |
EPU |
Consolidate |
|
|
NoInput |
|
|
Dynamic |
|
|
List of Dimensions Valid on both the sides of the equation.
Data is written only to the base level elements for the following dimensions:
- Account
- ICP
- Custom1
- Custom2
- Custom3
- Custom4 So only base members on the left hand side
Formatting the rules also means using the underscore (_) and colon (:) symbols. When using the underscore, you are telling the script that the line ending with an underscore is continuing on the next line. For example:
StrAccount = HS.GetCell ("A#7999.C1#Sales") + _
HS.GetCell ("A#7999.C1#Marketing")
The colon allows you to combine two lines. For example:
strSalesAccount = "A#7999.C1#Sales" : strMktAccount = "A#7999.C1#Marketing"
HS.Exp "A#Account3.C1#Chips = A#Account4"
HS.Exp "A#Account3.C1#Olap = A#Account4"
Same formulae Reversed
HS.Exp "A#Account3 = A#Account4.C1#Chips"
HS.Exp "A#Account3 = A#Account4.C1#Olap"
To be Continued in HFM Rule Basics part 2....