RunScenarioMacro at system level

This macro is used to run a scenario macro at system level.
For executing the macro, the value in the Command field must be specified in this format:
RunScenarioMacro(Macro, Cycle, [Cycle Period], Module, Scenario, [Timeout],[Filter],[Skip if not present])
Note: The optional parameters are specified in [ ].
This table lists the parameters used to run the RunScenario macro at system level:
Parameter Name Description
Macro The name of the macro to be run.
Cycle The cycle in which the macro is run.
Cycle Period The cycle period in which the macro is run.
Note: 
  • If this value is not specified, the currently running cycle period in the specified Cycle is considered.
  • If this value is not specified and there is no current running cycle period in the specified Cycle available, an error occurs.
Module The module in which the macro is run.
Scenario The scenario in which the macro is run.
Time out The time, in seconds, to wait for the Cycle Period or scenario to become available, if currently processing (unavailable).
Note: If this value is not specified, the waiting period is indefinite.
Filter If specified, the filter condition is applied to the macro.
Note: This parameter is applicable only for the macros that use the filter condition.
Skip if not present The macro step is skipped if the macro named in the step is not available or disabled. Possible values:
  • True
  • False
Note: If a macro step is skipped, the related information is displayed in the log and the macro step execution is successful.
This table lists examples of RunScenarioMacro at the System level:
Requirement Syntax
Run the scenario macro “InitFinanceScenario” in the Finance module for the currently running cycle period in the Normal cycle, and for the Baseline Scenario. The macro is skipped if not present. RunScenarioMacro("InitFinanceScenario","Normal","","Finance","Baseline","","","True")
Run the scenario macro “InitDemandScenario” in the Demand module for the currently running cycle period in the Normal cycle, and for the Baseline scenario. RunScenarioMacro("InitDemandScenario","Normal","","Demand","Baseline","","","")
Run the scenario macro “ExportLastPeriodDemand” in the Demand module for the cycle period Normal-Dec 12, and the Baseline scenario. The macro is skipped if not present. RunScenarioMacro("ExportLastPeriodDemand","Normal","Dec 12","Demand","Baseline","","","True")
Run the scenario macro “ExportLastPeriodDemand” in the Demand module for the cycle period Normal-Dec 12, and the Baseline scenario, with a time out of 600 seconds if the cycle period or scenario is unavailable at the time of execution.
Run the scenario macro “ClearFcstMeasures” in the Demand module for the currently running cycle period in the Normal cycle, and for the Baseline scenario, passing the filter "[DPLS_HUNITS] > 0".RunScenarioMacro("ExportLastPeriodDemand","Normal","Dec 12","Demand","Baseline","600","",""). RunScenarioMacro("ClearFcstMeasures","Demand","Baseline", "","","","[DPLS_HUNITS] > 0","").