ResumeCyclePeriod macro

The ResumeCyclePeriod macro is used to resume the selected Cycle Period. This macro command is executed at the System level.

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

ResumeCyclePeriod(Cycle, [Cycle Period], [Refresh], [Current Planning Bucket], [Time out])
Note: The optional parameters are specified in [ ].

This table lists the parameters that are used to determine the Cycle Period to be resumed:

Parameter Name Description

Cycle

The name of the Cycle that contains the Cycle Period to resume.

Cycle Period

The Cycle Period to be resumed using the macro.

If the value is not specified, the current Paused Cycle Period for the specified Cycle is considered.

If the parameter is not specified and the Cycle does not contain a Cycle Period with the status paused, the macro fails.

Note: Only one cycle period can be paused for a cycle.

Refresh

Determines whether the cycle period configuration data is updated to the latest version.

Note: If the value is not specified, the cycle period configuration data is not updated.

Current Planning Bucket

The new planning period for the cycle period.

Note: 
  • This parameter is applicable if Refresh is set to True.
  • If this value is not specified, the existing planning period is considered.
  • This parameter supports %NextPeriod% variable which determines the next period in the calendar, at the corresponding level, after the current planning period. For example, if the current planning period is Y 13 W01, %NextPeriod% selects Y13 W02 as the next planning period.

Time out

The time, in seconds, to wait for the setup check or other blocking processes to complete, if currently processing.

Note: If the value is not specified, the waiting period is indefinite.

This table lists the examples of the ResumeCyclePeriod macro:

Requirement Syntax
Resume the Paused Cycle Period for the Normal Cycle with an updated configuration, maintaining the current planning period and with an indefinite time out. ResumeCyclePeriod("Normal","","True","","")
Resume the Cycle Period ‘Nov 12’ for Normal Cycle without an updated configuration, maintaining the current planning period and with an indefinite time out. ResumeCyclePeriod("Normal","Nov 12","","","")
Resume the Cycle Period ‘Oct 12’ for Normal Cycle updating the configuration data for the cycle period and setting the current planning period to ‘Y12 W40’ with an indefinite time out. ResumeCyclePeriod("Normal","Oct 12","True","Y12 W40","")
Resume the Cycle Period ‘Sep 12’ for Normal Cycle without updating the configuration data, with a time out of 600 seconds if the setup check is processing at the time of execution. ResumeCyclePeriod("Normal","Sep 12","False","","600")
Resume the Paused Cycle Period for the Normal Cycle updating the configuration data for the cycle period and setting the current planning period to the next period in the calendar with indefinite time out. ResumeCyclePeriod("Normal","","True","%NextPeriod%","")