RunScenarioMacro at cycle period level

This macro is used to run a scenario macro at cycle period level.
For executing the macro, the value in the Command field must be specified in this format:
RunScenarioMacro(Macro, Module, Scenario, [Filter],[Skip if not present])
Note: The optional parameters are specified in [ ].
This table lists the parameters used to run RunScenarioMacro at cycle period level:
Parameter Name Description
Macro The name of the macro to be run.
Module The module in which the macro is run.
Scenario The scenario in which the macro is run.
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
  • Flase
Note: 
  • If the macro name is an application variable and the application variable does not exist, the macro step is also skipped (when the value is set to True).
  • 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 Cycle Period level:
Requirement Syntax
Run the scenario macro “InitFinanceScenario” in the Finance module for the current cycle period, and the Baseline scenario. RunScenarioMacro("InitFinanceScenario","Finance","Baseline","","").
Run the scenario macro “ImportDemandScenario” in the Demand module for the current cycle period, and the Baseline scenario. RunScenarioMacro("ImportDemandScenario","Demand","Baseline","","").
Run the scenario macro “ClearFcstMeasures” in the Demand module for the current cycle period, and the Baseline scenario, passing the filter "[DPLS_HUNITS] > 0". RunScenarioMacro("ClearFcstMeasures","Demand","Baseline", "[DPLS_HUNITS] > 0","").
Run the scenario macro “InitFinanceScenario” in the Finance module for the current cycle period, and the Baseline scenario. The macro is skipped if not present. RunScenarioMacro("InitFinanceScenario","Finance","Baseline","","True").