DeleteScenarios macro

The DeleteScenarios macro is used to delete the required scenarios from the selected Cycle Period and module, in the specified Cycle. 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:

DeleteScenarios("Cycle", "[Cycle Period]", "[Scenario]", "[Module]")

Note: The optional parameters are specified in [ ].

This table lists the parameters that are used in the macro to determine the scenarios to be deleted:


Parameter Name	Description
Cycle	The cycle from which the scenarios are deleted.
Cycle Period	The cycle period for which the scenarios are deleted. The status of the Cycle period must be set to Running or Completed. Note: If this value is not specified, the selected scenarios are deleted from all the Cycle Periods with Completed status in the specified Cycle.
Scenario	The scenarios to be deleted. The scenario must be available, and the status can be anything other than Published. Note: If this value is not specified, all the unpublished scenarios are deleted. A check is performed to ensure that there is a scenario set to Published status in the Cycle Period. This is required to avoid deletion of all the scenarios.
Module	The module from which the scenarios are deleted. Note: If this value is not specified, then all modules are considered.

This table lists the examples of the DeleteScenarios macro:


Requirement	Syntax
Delete all unpublished scenarios for all Completed cycle periods in the Demand Planning cycle.	DeleteScenarios ("Demand Planning", "", "", "")
Delete scenario ‘baseline’ for all Completed cycle periods in the Demand Planning cycle.	DeleteScenarios ("Demand Planning", "", "baseline", "")
Delete all unpublished scenarios for the cycle period FY17 M08 in the Demand Planning cycle. FY17 M08 must have a status of Running or Completed.	DeleteScenarios ("Demand Planning", "FY17 M08", "", "")
Delete scenario ‘baseline’ for the cycle period FY17 M08 in the Demand Planning cycle. FY17 M08 must have a status of Running or Completed. This deletes all scenarios with the name ‘baseline’ in any module in the FY17 M08 cycle period.	DeleteScenarios ("Demand Planning", "FY17 M08", "baseline", "")