StartCyclePeriod macro
The StartCyclePeriod macro is used to start the specified cycle period and change the status from Pending to Running. This macro is executed at the System level.
For executing the macro, the value in the Command field must be specified in this format:
StartCyclePeriod(Cycle, [Cycle Period], [Current Planning 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 started:
| Parameter Name | Description |
|---|---|
| Cycle | The name of the Cycle that includes the Cycle Period to be started. |
| Cycle Period | The Cycle Period to be started using the macro. Note:
|
| Current Planning Period | The current planning period for the cycle period. Note: If
this value is not specified, the first base period within the cycle period (process)
bucket is considered.
|
| 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 StartCyclePeriod macro:
| Requirement | Syntax |
|---|---|
| Start the cycle period with Pending status for the normal cycle, setting the current planning period equal to the first base period in the cycle period bucket, with indefinite time out. | StartCyclePeriod("Normal","","","") |
| Start the Pending cycle period ‘Dec 12’ in Cycle Normal, with the current planning period of Dec 12, with indefinite time out. | StartCyclePeriod("Normal","Dec 12","Dec 12","") |
| Start the Pending cycle period ‘Dec 12’ in Cycle Normal, setting the current planning period equal to the first base period in the period bucket Dec 12 (that is Y12 W48), with a time out of 600 seconds if the setup checker or other blocking process is currently running. | StartCyclePeriod("Normal","Dec 12","","600") |