Parameter variable

This table describes the parameter variables used in macros, worksheet and interface services:

Parameter Variable Example Calculation Rules Interface Services Worksheets Macros
Cycle name %cycle Normal Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro).
Cycle context %cyclecontext% Normal Yes Yes (scenario values interface) Yes

Yes (cycle period or scenario macro).

RunScenarioMacro (system macro from worksheet).

RunCyclePeriodMacro (System macro from worksheet)

Cycle Period label %cycleperiod FY08 M06 June Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro).
Cycle Period context %cycleperiodcontext% FY08 M06 June Yes Yes (scenario values interface) Yes

Yes (cycle period or scenario macro).

RunScenarioMacro (system macro from worksheet).

RunCyclePeriodMacro (System macro from worksheet)

Scenario name %scenariocontext% Demand-Baseline Yes (scenario values interface) Yes

Yes (scenario macro).

RunScenarioMacro (cycle period or system macro from worksheet) .

Item context %itemcontext% {[All Items].children} Yes Yes (scenario macro from worksheet) .
Location context %locationcontext% [All Customers].[EMEA] Yes Yes (scenario macro from worksheet)
Period context %periodcontext% [Rolling Periods] Yes Yes (scenario macro from worksheet).
Measure context %measurecontext% [DPLS_FOBSE] Yes (panel link with Pass Measure = TRUE) Yes (cycle period or scenario macro) run from within a destination multipanel (panel link with Pass Measure = TRUE)
Cube name %cube 'Normal.July 08.D' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Previous cube name %previouscube(i)

%previouscube(1): ‘Normal.June 08.D’

%previouscube(2): 'Normal.May 08.D'

Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Item dimension name %items 'Normal.July 08.D.I' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Location dimension name %locations 'Normal.July 08.D.L' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Period dimension name %periods 'Normal.July 08.D.P' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Scenarios dimension name %scenarios 'Normal.July 08.D.S' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Measure dimension name %measures 'Normal.July 08.D.M' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Item pivot dimension name (i=1..5) %itemsai 'Normal.July 08.D.IA1' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Location pivot dimension name (i=1..5) %locationsai 'Normal.July 08.D.LA1' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Item pivot dimension names %itemsax

No additional pivot dimensions: empty set

Two additional item pivot dimensions: !'Normal.July 10.D.IA1',!'Normal.July 10.D.IA2' (note the ! in front of every pivot dimension)

Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Location pivot dimension names %locationsax

No additional pivot dimensions: empty set

Two additional location pivot dimensions: !'Normal.July 10.D.LA1',!'Normal.July 10.D.LA2' (note the ! in front of every pivot dimension).

Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
First period (current planning period @ Cycle.Calendar level to store scenario values) %firstperiod FY08 W27 Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Next period (current planning period + 1 @ Cycle.Calendar level to store scenario values) %nextperiod FY08 W28 Yes (cycle period or scenario macro)
This cycle period (cycle period label) %thiscycleperiod FY08 M07 Jul Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Previous cycle period (cycle period's previous cycle period label) %previouscycleperiod FY08 M06 June Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Previous published scenario (for current module. Status=Published or Approved and linked to Published) %previouspublishedscenario Integrated-Baseline Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Item top node (primary hierarchy) %itemtopnode All Items Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Location top node (primary hierarchy) %locationtopnode All Customers Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
All Item dimension top nodes, including pivots %itemtopnodex 'All Items', 'ABC Class', 'XYZ Class' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
All Location dimension top nodes, including pivots %locationtopnodex 'All Customers' Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Period top node (primary hierarchy) %periodtopnode Weekly Calendar Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
All item constant nodes, including pivots %iconstx

2 item pivots: 'iconst','iA1const','iA2const'

no item pivots: 'iconst'

Yes Yes Yes (cycle period or scenario macro)
All location constant nodes, including pivots %lconstx

1 location pivot: 'lconst','lA1const'

no location pivots: 'lconst'

Yes Yes Yes (cycle period or scenario macro)
Cycle Period start date (Cycle.Periodicity) %cycleperiod-startdate 01-12-14 Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Cycle Period end date (Cycle.Periodicity) %cycleperiod-enddate 31-12-14 Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Previous Cycle Period start date (Cycle.Periodicity) %previouscycleperiod-startdate 01-11-14 No Yes (scenario values interface) No No
Previous Cycle Period end date (Cycle.Periodicity) %previouscycleperiod-enddate 30-11-14 No Yes (scenario values interface) No No
Horizon start (Cycle.Calendar level to store scenario values) %horizon-start 01-12-13 Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Horizon end (Cycle.Calendar level to store scenario values) %horizon-end 31-12-15 Yes Yes (scenario values interface) Yes Yes (cycle period or scenario macro)
Base Periods Before First Period (Cycle.Calendar level to store scenario values) %periods:{{BasePeriodsBeforeFirstPeriod}} {{[FY08 W26],[FY08 W25], ...}} Yes
Consolidated Periods (all aggregate periods, including additional hierarchies & rolling periods) %periods:{{ConsolidatedPeriods}} {{[Weekly Calendar],[FY 2008],[FY08 Qtr1] ...}} Yes
Parents of First Period (parents of current planning period, including additional hierarchies & rolling periods)) %periods:{{ParentsOfFirstBasePeriod}} {{[Weekly Calendar],[FY 2008],[FY08 Qtr3],[FY08 M06 June]}} Yes
Periods in Cycle Period (Period at Cycle.Periodicity and children) %periods:{{PeriodsInFirstCyclePeriod}} {[FY11 M11], [FY11 W44],[FY11 W45],[FY11 W46],[FY11 W47]} Yes
First Periods in Year (periods in the first period of each year, including additional hierarchies and rolling periods) %periods:{{FirstPeriodsPerYear}} {[FY 2011],[FY11 Qtr1],[FY11 M01],[FY11 W01],[FY 2012],[FY12 Qtr1],[FY12 M02],[FY12 W01],[FY 2013],[FY13 Qtr1],[FY13 M01],[FY13 W01]} Yes
User Name %user% Sopadmin@pmm.com No Yes (used in Export Constants) No No
History cube name %history% Normal.FY17.M04.D.H No No Yes No
Application Variables %app_var_VarName% %app_var_CycleName% No Yes No Yes (all)
AS Model %modelcontext% ModelA No No No Yes (System macro from within Advanced Scheduling mode)l
Period top nodes (primary calendar) {[%periodtopnodes%]} {[Weekly Calendar (PW)],[Weekly Calendar (PW)_CalMonths]} Yes Yes