CopyPlanningEngineNotes macro

The CopyPlanningEngineNotes macro is used to copy notes from the specified Planning Engine to the current Planning Engine. This macro must be executed in the context of the planning engine for which the notes are to be received.
Note: 
  • You can specify the type of notes to be copied.
  • The notes where the context is available in the destination planning engine are copied.

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

CopyPlanningEngineNote([Source Planning Engine Cycle],[Source Planning Engine],[Note Type])
Note: The optional parameters are specified in [ ].

This table lists the parameters that are used to determine the CopyPlanningEngineNotes macro:

Parameter Name Description
Source Planning Engine Cycle If this value is specified, the most recent Planning Engine published from the specified Planning Engine Cycle is considered.
Note: 
  • This parameter is applicable only if the Source Planning Engine parameter is not specified. Else, this parameter is not considered.
  • If the Source Planning Engine Cycle and Source Planning Engine parameters are not populated, the current Planning Engine Cycle associated with the current Planning Engine is considered.
  • Application and parameter variables can be used in this parameter.
Source Planning Engine The Planning Engine from which the notes are to be copied.
Note: 
  • If this parameter is not populated, the most recent planning engine that is published in the Source Planning Engine Cycle is considered.
  • If the Source Planning Engine Cycle is also not populated, the most recent planning engine that is published in the current Planning engine Cycle is considered.
  • If this parameter is not populated, the current planning engine must be related to a Cycle.
Note Type The type of notes to be copied.
Note: If this parameter is not populated, all notes from the specified planning engine are considered.

This table lists the examples of the CopyPlanningEngineNote macro:

Requirement Syntax
Copy all notes from the Published Planning Engine in the ‘Supply (PW)’ Planning Engine Cycle to the current Planning Engine. The current Planning Engine can belong to a different Cycle. CopyPlanningEngineNote("Supply (PW)","","")
Copy Action Plan notes from the Planning Engine (SCO FY21 W28) to the current Planning Engine. CopyPlanningEngineNote("","SCO FY21 W28","Action Plan")
Copy all notes from the most recent published Planning Engine in the current Cycle to the current Planning Engine. CopyPlanningEngineNote("","","")