CopyPlanningEngine macro

The CopyPlanningEngine macro is used to create a copy of the existing Planning Engine. This macro is executed at system level.

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

CopyPlanningEngine([Source Planning Engine name], Planning Engine Name, [Planning Engine Display Name], [Category],[Stop on End Status], [Cycle]).
Note: The optional parameters are specified in [ ].

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

Parameter Name Description

Source Planning Engine name

The source Planning Engine based on which the new Planning Engine is to be created.

Allows application variables and ‘%planningengine%’ parameter variable.

Note: The %planningengine% parameter variable must be used only if the macro runs through the job scheduler or within the context of a planning engine on the Planning Engine Detail screen. Else, the %planningengine% variable cannot be replaced.

Planning Engine name

The name of the Planning Engine to be created.

Allows variables such as %pesource%, %planningengine%, %date%, %time%, %datetime%, %PlanningEngineCycle% and application variables. For example, Weekly Supply_%date%, can be used to create a Planning Engine "Weekly Supply_20200327".

Note: 
  • The %planningengine% or %pesource% variable must be used in conjunction with a text string or another variable. Else, the Planning Engine cannot be created since the variable is trying to create a planning engine with an existing name.
  • The %pesource% variable refers to the name of the Source Planning Engine.
  • The %pesource% variable is replaced with name of the planning engine to be copied.
  • The %planningengine%, %planningenginecycle% parameter variables must be used only when the macro is run through the job scheduler or within the context of a planning engine on the Planning Engine Detail screen. Else, the variable cannot be replaced.

To view the list of available parameter variables, See Analysis Cycle parameter variables.

Planning Engine Display name

The display name of the Planning Engine to be created.

Allows variables such as %planningengine%, %pesource%, %date%, %time%, %datetime%, %PlanningEngineCycle% and application variables. For example, Weekly Supply_%date%, can create Planning Engine "Weekly Supply_20200327".

Note: 
  • The %pesource% variable must be used in conjunction with a text string or another variable to ensure the uniqueness of the display name.
  • The %pesource% variable is replaced with the name of the planning engine to be copied.
  • The %planningengine%, %planningenginecycle% parameter variables must be used only when the macro is run through the job scheduler or within the context of a planning engine on the Planning Engine Detail screen. Else, the variable cannot be replaced.

To view the list of available parameter variables, See Analysis Cycle parameter variables.

Category

The category name of the Planning Engine to be created.

Note: If this value is not specified, the category defined for the source Planning Engine is used.

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.

Cycle

The name of the cycle where the planning engine is to be copied.

When specified, the master planning engine for the specified cycle is copied.

Allows application variables and the %planningenginecycle% parameter variable.

Note: 
  • If the Source Planning Engine parameter is specified, this parameter is not considered.
  • The %planningenginecycle% parameter variable must be used only when the macro is run through the job scheduler or within the context of a planning engine on the Planning Engine Detail screen. Else, the variable cannot be replaced.

This table lists the examples of the CopyPlanningEngine macro:

Requirement Syntax
Make a copy of "Weekly Supply Plan 2020-03-17" called "Weekly Supply Plan 20200324" (where 20200324 is today's UTC date) with the same category of the source. The display name of the planning engine is set to null. CopyPlanningEngine("Weekly Supply Plan 2020-03-17","Weekly Supply Plan %date%","","","","")
Make a copy of the Master planning engine for "SCO" cycle. The new planning engine is called "baseline" with the same category of the source. The display name of the planning engine is set to null. CopyPlanningEngine("","baseline","","","","SCO")