RunPlanningEngineMacro at planning engine level

The RunPlanningEngineMacro is used to call Planning Engine level macros within the context of a Planning Engine..

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

RunPlanningEngineMacro(Macro, [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
Macro The name of the macro to run.
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 current Planning Engine. Skip the macro execution if the macro is not found or disabled. RunPlanningEngineMacro("SCO Master","True")