Node Properties Explanation
Last updated
Last updated
[NODE].PARENT refers to the parent node of the NODE. This cannot be used seperately and should be used along with other functions while referring to the Parent node.
If the node Sales has child nodes, East, West, South and Central, the node Sales can be referred to as [East].PARENT, [West].PARENT, [South].PARENT or [Central].PARENT.
[NODE].CHILDREN refers to the children nodes of the NODE. This cannot be used seperately and should be used along with other functions while referring to the Child nodes.
If the node Sales has child nodes, East, West, South and Central, the child nodes of Sales can be referred to using [Sales].CHILDREN.
We will use the following dataset for explaining the below functions.
[NODE].VISIBLE_CHILDREN refers to the children nodes of the NODE, that are visible and not hidden. This cannot be used separately and should be used along with any aggregation functions like SUM, Product, Subtract etc.
For example, if we want to calculate the sum of visible children of the Profit node, we will use the formula SUM([Profit].VISIBLE_CHILDREN)
[NODE].HIDDEN_CHILDREN refers to the children nodes of the NODE, that are hidden. This cannot be used separately and should be used along with any aggregation functions like SUM, Product, Subtract etc.
If we want to calculate the sum of hidden children of the Expenses node, we will give the formula as,
SUM([Expenses].HIDDEN_CHILDREN)
[NODE].TITLE returns the node's TITLE.
Note: *This function's development is in progress.
This is a dataset of [Sales] node. This is used for the below examples.
[NODE].ACT refers to the Simulated Series of the node. This can only be used along with other functions like SUM, GET(CPI).
SUM([Sales].act) will return the simulated values of the sales node.
[NODE].TGT refers to the Comparison Series of the node. This can only be used along with other functions like SUM, GET(CPI).
SUM([Sales].tgt) will return the comparison values of the sales node.
[NODE].BASE refers to the Baseline Series of the node. This can only be used along with other functions like SUM, GET(CPI).
SUM([Sales].base) will return the baseline values of the sales node.
This is a dataset of [Cost of Sales] node. This is used for the below examples.
[NODE].ALL_PERIODS refers to all period values. This can only be used along with other functions like SUM, GET(CPI).
[Cost of Sales].ALL_PERIODS.GET(CPI) will return baseline values of all periods.
[NODE].SIM_PERIODS refers to simulated period values. This can only be used along with other functions like SUM, GET(CPI).
The periods in a model are defined from Jan to Dec and the active simulation period is from Jun to Dec.
[Cost of Sales].SIM_PERIODS.GET(CPI) will return Simulated values of all Sim periods.
This is a dataset of [Sales] node. This is used for the below examples.
[NODE].act.ALL_PERIODS returns all period values of the simulated series. This can only be used along with other functions like SUM, GET(CPI).
[Sales].act.ALL_PERIODS.GET(CPI) will return Simulated values of all periods.
[NODE].tgt.ALL_PERIODS returns all period values of the comparison series. This can only be used along with other functions like SUM, GET(CPI).
[Sales].tgt.ALL_PERIODS.GET(CPI) will return Comparison Series value of all periods.
[NODE].base.ALL_PERIODS returns all period values of the baseline series.This can only be used along with other functions like SUM, GET(CPI).
[Sales].base.ALL_PERIODS.GET(CPI) will return Baseline Series value of all periods.
[NODE].act.SIM_PERIODS returns simulated period values of the simulated series.This can only be used along with other functions like SUM, GET(CPI).
The periods in a model are defined from Jan to Dec and the active simulation period is from Jun to Dec.
[Sales].act.SIM_PERIODS.GET(CPI) will return simulated period values of the simulated series.
[NODE].tgt.SIM_PERIODS returns simulated period values of the comparison series.This can only be used along with other functions like SUM, GET(CPI).
The periods in a model are defined from Jan to Dec and the active simulation period is from Jun to Dec.
[Sales].tgt.SIM_PERIODS.GET(CPI) will return simulated period values of the comparison series.
[NODE].base.SIM_PERIODS returns simulated period values of the baseline series.This can only be used along with other functions like SUM, GET(CPI).
The periods in a model are defined from Jan to Dec and the active simulation period is from Jun to Dec.
[Sales].base.SIM_PERIODS.GET(CPI) will return simulated period values of the baseline series.
This is a dataset of [Sales] node. This is used for the below examples.
[NODE].TOTAL returns the all period aggregated value of the node.
[Sales].TOTAL
[NODE].PTD returns the period till date aggregated value of the node. The seleted months in Simulte tab will be considered for the PTD calculation and value display should be Sim Months. If Full Year is selected Full Year Values will be Shown instead of PTD.
Here Sim Months is selected and the period is set From Jan to Mar.
[Sales].PTD
[NODE].SEL returns the simulation period aggregated value of the node.
[Sales].SEL
This is a dataset of [Sales] node. This is used for the below examples.
[NODE].RANGE(start_index,end_index) returns selected range values of the node. The Value display should be selected as Sim.months and the number of periods should be selected in Sim periods. If we keep it as Jan to Apr it will give us 4 month's value. If we keep it as Jan to may it will give us 5 month's value.
SUM([Sales].RANGE(9,12)) will return the values of Sept to Dec as the full period value.
[NODE].act.RANGE(start_index,end_index) returns selected range values of Simulated Series.
SUM([Sales].act.RANGE(9,12)) will return the simulated values of Sept to Dec as the full period value.
[NODE].base.RANGE(start_index,end_index) returns selected range values of Baseline Series.
SUM([Sales].base.RANGE(9,12)) will return the baseline values of Sept to Dec as the full period value.
[NODE].tgt.RANGE(start_index,end_index) returns selected range values of Comparison Series.
SUM([Sales].tgt.RANGE(9,12)) will return the comparison values of Sept to Dec as the full period value.
[NODE].GET(period_index) returns the selected period value of the node.
[Sales].GET(6) will return the value of 6th month which is June
[NODE].act.GET(period_index) returns the selected period value of the Simulated Series.
[Sales].act.GET(6) will return the simulated value of the month June
[NODE].base.GET(period_index) returns the selected period value of the Baseline Series.
[Sales].base.GET(6) will return the baseline value of the month June
[NODE].tgt.GET(period_index) returns the selected period value of the Comparison Series.
[Sales].tgt.GET(6) will return the comparison value of the month June
[NODE].LastNPeriods(n) returns selected range values of the node. This cannot be used seperately and should be used along with other aggregate functions like SUM,PRODUCT,SUBTRACT.
If we want to calculate the sum of previous two periods, the formula should be SUM([Sales].LastNPeriods(2))
[NODE].act.LastNPeriods(n) returns selected range values of the Simulated Series.This cannot be used seperately and should be used along with other aggregate functions like SUM,PRODUCT,SUBTRACT.
SUM([Sales].act.LastNPeriods(2)) will return the Sum of the simulated values of the previous two periods.
[NODE].base.LastNPeriods(n) returns selected range values of the Baseline Series.This cannot be used seperately and should be used along with other aggregate functions like SUM,PRODUCT,SUBTRACT.
SUM([Sales].base.LastNPeriods(2)) will return the Sum of the baseline values of the previous two periods.
[NODE].tgt.LastNPeriods(n) returns selected range values of the Comparison Series.This cannot be used seperately and should be used along with other aggregate functions like SUM,PRODUCT,SUBTRACT.
SUM([Sales].tgt.LastNPeriods(2)) will return the Sum of the comparison values of the previous two periods