Validation and execution

A new planning engine is created for the specified cycle, on successful validation and execution of the macro.

These are the execution rules:

  • The Next Planning Engine name and Next Planning Engine Display Name parameters support the use of parameter variables which assists in the creation of the Planning Engine name and optionally determine the display name. The parameter variables used as follows:
    • %date%: Substituted with UTC date at run-time (format of yyyymmdd).
    • %time%: Substituted with UTC time at run-time (format in 24 hour clock - hhmiss).
    • %datetime%: Substituted with UTC date & time at run-time (format of yyyymmdd hhmiss)
    • %nextperiod%: Substituted with the next period value of the source planning engine.
      Note: 
      • If the [next period] parameter is specified, the %nextperiod% parameter variable is substituted with the specified value.
      • If the [next period] parameter is not specified, the %nextperiod% parameter variable is substituted with the next period as determined by the previous or source planning engine.
    • %planningenginecycle%: Replaced with the planning engine cycle specified in the job scheduler.
      Note: This is available only when the macro is executed within the context of the job scheduler.
    • %planningengine%: Replaced with the planning engine specified in the job scheduler.
      Note: This is available only when the macro is executed within the context of the job scheduler.
    • You can use application variables. The application substitutes each variable during run time.
  • The status of the next planning engine for the cycle is set to Master.
  • The status of the planning engine used for creating the next planning engine is set to Published. The status of the remaining planning engines in the same cycle with a Running or Master status are set to Completed.
  • If the Cycle parameter is only specified, the next planning engine is derived from the planning engine with the Master status and matches the cycle.
    Note: Each cycle can only have one planning engine with the Master status.
  • The next planning engine for the cycle is created using the planning engine definition as defined in the previous planning engine. Possible scenarios:
    • If Refresh is set to True, the planning engine details are derived from the planning engine definition.
      Note: 
      • The application variables stored in the new planning engine are copied from the planning engine cycle when specified. Else, copied from the global application variables.
      • Roles are copied from the planning engine cycle when specified. Else, copied from the planning engine definition.
    • If Refresh is set to False, the planning engine details are copied from the previous Planning Engine Details.
      Note: 
      • The application variables copied to the new planning engine are stored in the source planning engine.
        • Application variables that do not contain a planning engine override are taken from the planning engine cycle override if populated. Else, taken from the global application variable.
        • New application variables are automatically included in the new planning engine. These are taken from the planning engine cycle override if populated. Else, taken from the global application variable.
        • Application variables that are deleted from the global application variables, are removed from the new planning engine.
      • Roles assigned to the new planning engine are copied from the source planning engine.