DeletePlanningEngine macro

The DeletePlanningEngine macro deletes the Planning Engine and clears the data from the specified planning engine. This macro is executed at a system level.

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

DeletePlanningEngine([Planning Engine name], [Category],[Stop on End Status])
Note: The optional parameters are specified in [ ].

This table lists the parameters used to execute the DeletePlanningEngine macro:

Parameter Name Description
Planning Engine name

The name of the Planning Engine to be deleted.

Note: If not defined (Null), all the Planning Engines are deleted.
Category

If specified, the Planning Engine with specified Category is deleted.

Note: If no category is defined (Null), Category is ignored.
Stop on End Status

Stop on End Status decides the status of the macro which cause the macro to stop. Stop on End Status can be set as specified:

  • None = Macro step is ignored if any validation fails.
  • Warning = Macro step fails if validation at levels Warning or Error are encountered.
  • Error = Macro step fails only if validation of level Error is encountered.
    Note: If not defined (Null), Stop on End Status is set to Error.

This table lists the examples of the DeletePlanningEngine macro:

Requirement Syntax
Delete all planning engines DeletePlanningEngine("","","")
Delete the planning engine "Weekly Supply Plan FY19 W29" DeletePlanningEngine("Weekly Supply Plan FY19 W29","","")
Delete all planning engines with the Category "Weekly Supply" DeletePlanningEngine("","Weekly Supply","")