AbortCyclePeriod macro

The AbortCyclePeriod macro is used to stop the specified Cycle Period and change the status of the Cycle Period from Pending, Paused or Running to Aborted. This macro is executed at the system level.

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

AbortCyclePeriod(Cycle, [Cycle Period], Reason, [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 stopped:


Parameter Name	Description
Cycle	The name of the Cycle that includes the Cycle Period to be stopped.
Cycle Period	The Cycle Period to stop. Note: If this value is not specified, the Cycle Period with status Running, for the specified Cycle is considered. If this value is not specified and the Cycle Period with status Running is not available, an error occurs.
Reason	The reason to stop the Cycle Period.
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 AbortCyclePeriod macro:


Requirement	Syntax
Stop the Cycle Period with status Running for the Normal cycle with reason "re-do" and an indefinite time out, if the cycle period is unavailable.	AbortCyclePeriod("Normal","","re-do","")
Stop the cycle period “Normal-Oct12” with reason "Rebudgetting" and a time out of 600 seconds if the cycle period is unavailable at the time of execution.	AbortCyclePeriod("Normal","Oct 12","Rebudgetting","600")