ArchiveCyclePeriod macro

The ArchiveCyclePeriod macro is used to archive the specified Cycle Period and change the status of the Cycle Period from Completed or Aborted to Archived. This macro is executed at a system level.

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

ArchiveCyclePeriod(Cycle, [Cycle Period], [Time out])
Note: The optional parameters are specified in [ ].

This table lists the parameters that are used in the macro to determine the Cycle Period to be archived.

Parameter Name Description
Cycle The name of the Cycle that includes the Cycle Period to be archived.
Cycle Period The Cycle Period to be archived.
Note: 
  • If this value is not specified, the most recent Cycle Period with Completed status for the specified Cycle is used.
  • If this value is not specified and the specified Cycle does not contain a Completed Cycle Period, an error occurs.
  • If this value is specified, the status of the Cycle Period to abort must be Completed or Aborted.
Time out The time, in seconds, to wait for the cycle period to become available if currently processing (unavailable).
Note: If this value is not specified, the waiting period is indefinite.

This table lists examples of the ArchiveCyclePeriod macro:

Requirement Syntax
Archive the most recently completed cycle period for the Normal Cycle with an indefinite time out. ArchiveCyclePeriod("Normal","","")
Archive the cycle period “Jul20” in Normal Cycle with a time out of 600 seconds. ArchiveCyclePeriod("Normal","Jul20","600")