Planning Engine parameter variables

This table lists the parameter variables that can be used in macros, plansheets, and interface services:
Parameter Variable Example Interface services Plansheets Macros
Horizon start (based on SCP Calendar) %horizon-start% 01-12-13 Yes No No
Horizon end (based on SCP Calendar) %horizon-end% 31-12-15 Yes No No
User Name %user% sopadmin@pmm.com Yes (Used in Export constants No No
Application Variables %app_var_VarName% %app_var_apsco_default_engine_name% Yes No Yes (all)
Planning Engine context %planningengine% SCO Yes No

System level macros - Substitute if the macro is run within the context of a planning engine or from the job scheduler where the planning engine is specified, else is not substituted.

Planning Engine level macro - substitutes when value is passed to the macro or determined by the context where the macro is run (for example, Process / Planning Engines / details), or job scheduler where planning engine is specified.
Passes cells Resource/Item Context %passedvalue% [Products At Locations]@[Products]:[%passedvalue%] No Yes No

UTC runtime Date

(In yyyymmdd format)

 %date% 20200730 No No Yes

UTC runtime Time

(In hhmiss format)

 %time% 230530 No No Yes

UTC runtime Date & Time

(In yyyymmdd hhmiss format)

 %datetime% 20200730 230530 No No Yes
Planning Horizon start date (based on SCP Calendar) %planning-horizon-startdate% 01-12-20 Yes No No
Planning Horizon end date (based on SCP Calendar) %planning-horizon-enddate% 31-12-20 Yes No No
Planning Engine Cycle context %planningenginecycle% SCO Yes No

System level macros - Substitute if the macro is run within the context of a planning engine or from the job scheduler where the planning engine is specified, else is not substituted.

Planning Engine level macro - substitutes when value is passed to the macro or determined by the context where the macro is run (for example, Process / Planning Engines / details), or job scheduler where planning engine is specified.
Start Period %startperiod% FY20 M11 Yes No Yes. (Substituted with the start period from the planning engine context.)
Next Period %nextperiod% FY20 M12 Yes No Only applicable for NextPlanningEngine macro. Substituted with the next period as specified in the source planning engine.
Period context start as defined in global period selector %periodcontextstart% 1 (numeric representation of the context start period) No Yes No
Count of periods in global period selector (end period - start period %periodcontextcount% 3 (The number of additional periods from the periodcontextstart to include in the plansheet) No Yes No

Source Planning Engine Name.

 %pesource% SP_SCO.FY21 W27 No No Yes. NextPlanningEngine, copyplanningengine macro only. Substituted with the name of the source Planning Engine.