RunPlanningEngineMacro at system level

The RunPlanningEngineMacro is used to call Planning Engine level macros.

For executing the macro, the value in the Command field must be specified in this format:

RunPlanningEngineMacro([Planning Engine Name],Macro,[Cycle],[skip if not present])
Note: The optional parameters are specified in [ ].

This table lists the parameters that are used to determine the planning engine macros to be executed:

Parameter Name Description
Planning Engine Name The planning engine for which the macro is to be run.
Macro The name of the macro to run.
Cycle The planning engine cycle in which the planning engine macro is run. The Macro is run against the master planning engine for the Cycle.
Note: 
  • This value is not considered if the Planning Engine Name is populated.
  • The Planning Engine Name or Cycle parameter must be populated.
Skip if not present The macro step is not executed if the specified macro is not available or disabled. Possible values:
  • True
  • False
Note: 
  • If the macro is skipped, an 'Information' level log is reported and the macro step execution is displayed as successful.
  • If this parameter is not populated or Null, the default value is set to False.

This table lists the examples of the RunPlanningEngineMacro:

Requirement Syntax
Run the planning engine macro ‘SCO Master’ for the Planning Engine ‘SCO FY20 M11’. Skip the macro execution if the macro is not found or disabled. RunPlanningEngineMacro("SCO FY20 M11","SCO Master","","True")
Run the planning engine macro ‘SCO Master’ for the Master Planning Engine in the cycle ‘SCO’. Skip the macro execution if the macro is not found or disabled. RunPlanningEngineMacro("","SCO Master","SCO","True")