DownloadPlanningEngine macro

The DownloadPlanningEngine macro is used to download the Planning Engine to a specified File Data Source. This macro is executed at system level.

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

DownloadPlanningEngine(Planning Engine name, File Data Source, [file name], [Stop on End Status]).
Note: The optional parameters are specified in [ ].

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

Parameter Description
Planning Engine name

The name of the Planning Engine to be downloaded.

Allows the use of variable %date% and application variables. For example "Weekly Plan_%date%" can locate and download a Planning Engine with the name "Weekly Plan_20200521" (Assuming today's date is the 21st May 2020).
File Data Source

The name of the Data Source used to download the Planning Engine. Possible values:

  • File
  • S3
  • FTP
File name

The name of the zip file in which the Planning Engine to be stored.

The variables such as %Source%, %date%, %time%, %datetime% and application variables may be used. For example %Source%_%date% can create a zip file of the Planning Engine name + the UTC Date.

Note: If the value of this parameter is not specified, the Planning Engine name is used as the file name.
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 DownloadPlanningEngine macro:

Requirement Syntax
Download a copy of the "Weekly Supply Plan 20200519" (where 20200519 is today's date) and save to a file data source "BackupFtp" with the same name at the Planning engine. For example, Weekly Supply Plan 20200519.zip. DownloadPlanningEngine("Weekly Supply Plan_%Date%","BackupFtp","","")