RestoreCyclePeriod macro

The RestoreCyclePeriod macro is used to restore the selected Cycle Period and change the status of the Cycle Period to Available from Archived. This macro is executed at the System level.

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

RestoreCyclePeriod(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 restored:

Parameter Name Description
Cycle The name of the Cycle that includes the Cycle Period to be restored.
Cycle Period The Cycle Period to be restored.
Note: 
  • If this value is not specified, the most recent Cycle Period with Archived status for the specified Cycle is considered.
  • If this value is not specified and a Cycle Period with Archived status is not available, an error occurs.
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 RestoreCyclePeriod macro:

Requirement Syntax
Restore the most recently completed cycle period with Archived status for the Normal cycle with an indefinite time out, if the cycle period is processing or no archived cycle period can be found. RestoreCyclePeriod("Normal","","")
Restore the cycle period “Jul13” in the Normal Cycle and a time out of 600 seconds if the cycle period is processing at the time of execution. RestoreCyclePeriod("Normal","Jul13","600")