EditShareScenarios macro

The EditShareScenarios macro is used to make the selected scenarios in a Cycle Period editable. It is also possible to share the scenarios with other users or user roles. 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:
EditShareScenarios(Cycle, [Cycle Period], [Module], [Scenario], [Share], [Users], [Roles], [Time out])
Note: The optional parameters are specified in [ ].
This table lists the parameters that are used to determine the scenarios which can be modified, and shared with other users or user roles:
Parameter Name Description
Cycle The name of the Cycle that includes the Cycle Period wherein the related scenarios are set to be editable.
Cycle Period The Cycle Period for which the scenarios are set to be editable.
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 status Running is not available, an error occurs.
Module The module for which the scenarios are set to be editable.
Note: If this value is not specified, the scenarios (with WIP status) applicable for all the modules in the specified Cycle Period are considered.
Scenario The scenarios are set to be editable.
Note: 
  • If this value is not specified, all scenarios (with WIP status) applicable for the specified module are considered.
  • If a module is not specified, the scenarios (with WIP status) applicable for the specified cycle period are considered.
Share Indicates whether the specified scenarios are to be shared with other users or user roles. Possible values:
  • True
  • False
Note: If this value is not specified, the scenarios are not shared.
Users The name of the users with whom the scenarios are to be shared.
Note: 
  • If this value is not specified and Share is set to True, the scenario is shared with the users sharing the Scenario (if specified). Else, shared with the users specified for the Scenario.
  • Multiple users can be specified in the format “User1”, “User2”.
  • This value is not considered if Share is set to False.
Roles The roles with whom the scenarios are to be shared.
Note: 
  • If this value is not specified and Share is set to True, the scenario is shared with the roles sharing the Scenario (if specified). Else, shared with the user roles specified for the Scenario.
  • Multiple roles can be specified in the format “Role1”, “Role2”.
  • This value is not considered if Share is set to False.
Time out The time, in seconds, to wait for the cycle period or scenario 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 EditShareScenarios macro:
Requirement Syntax
Set all scenarios in the currently running cycle period for the Normal cycle to be editable, without sharing, and with an indefinite time out if the cycle period or scenarios are not available. EditShareScenarios("Normal")
Set all scenarios for the cycle period "Normal"-"Mar-13", to be editable without sharing, and with an indefinite time out. EditShareScenarios("Normal","Mar-13","","","","","","")
Set all scenarios in the currently running cycle period for the Normal cycle to be editable, sharing with all authorised shared users and shared roles (if populated). Else shared with all authorised users and roles for the scenario, with an indefinite time out. EditShareScenarios("Normal","","","","True","","","")
Set Baseline scenario in the Demand module of the currently running cycle period for Normal cycle to be editable, sharing with all authorised shared users and shared roles (if populated). Else shared with all authorised users and roles for the scenario, with an indefinite time out. EditShareScenarios("Normal","","Demand","Baseline","True","","","")
Set Baseline scenario in Demand module of the current running cycle period for Normal cycle to be editable, sharing with all authorised users for the scenario and the DemandAdmin and DemandNormal roles, with an indefinite time out. EditShareScenarios("Normal","","Demand","Baseline","True","","DemandAdmin,DemandNormal","")
Set Baseline scenario in the Demand module of the current running cycle period for Normal cycle to be editable, without sharing and with a time out of 600 seconds, if the cycle period or scenario is not available at the time of execution. EditShareScenarios("Normal","","Demand","Baseline","False","","","600")