RunCyclePeriodMacro macro

The RunCyclePeriodMacro macro is used to run the specified cycle period macro. This macro command is executed at the system level.

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

RunCyclePeriodMacro(Macro, Cycle, [Cycle Period], [Timeout], [Skip if not present])

Note: The optional parameters are specified in [ ].

This table lists the parameters used to determine the cycle period macro to run:

Parameter Name Description
Macro The name of the macro to be run.
Cycle The name of the Cycle in which the macro is run.
Cycle Period The Cycle Period in which the macro is run.
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, 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.
Skip if not present The macro step is not executed if the macro named in the step is not available or disabled. Possible values:
  • True
  • False
Note: 
  • If the macro name is an application variable and the application variable does not exist, the macro step is not executed (when the value is set to True).
  • If a macro step is not executed, the related information is displayed in the log and the macro step execution is successful.
  • If this value is not specified, the default value is FALSE.

This table lists the examples of the RunCyclePeriodMacro macro:

Requirement Syntax
Run the Cycle Period macro "CreateUpsideScenario" in "Normal" cycle for the "Nov 12" Cycle Period. If the macro does not exist, do not consider this step. RunCyclePeriodMacro("CreateUpsideScenario","Normal","Nov 12","","True").

Run the Cycle Period macro "CopyBaselineScenario" in "Normal" cycle for the "Nov 12" Cycle Period. The wait period is 600 seconds for the cycle period to become available.

The macro fails to execute, if the macro does not exist.

 RunCyclePeriodMacro("CopyBaselineScenario","Normal","Nov 12","600"," ").