PauseCyclePeriod macro

The PauseCyclePeriod macro is used to pause the specified Cycle Period for the selected Cycle. This macro is executed at the System level.

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

PauseCyclePeriod(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 paused:

Parameter Name Description
Cycle The name of the Cycle that includes the Cycle Period to pause.
Cycle Period The Cycle Period to be paused using the macro.
Note: 
  • If this value is not specified, the currently running Cycle Period for the specified Cycle is considered.
  • If this value is not specified and the Cycle Period with Running status is not available, the macro fails.
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 the examples of the PauseCyclePeriod macro:

Requirement Syntax
Pause the running cycle period of the Normal cycle, with indefinite time out, if the cycle period is unavailable. PauseCyclePeriod("Normal","","")
Pause the cycle period ‘Oct12’ in the Normal cycle with a time out of 600 seconds, if the cycle period is unavailable at the time of execution. PauseCyclePeriod("Normal","Oct 12","600")