Descriptions of scenario block parameters

instance id — This is a string that identifies a sub-scenario. An instance ID must be unique within a main scenario. In the main scenario, you set the value of the instance id parameter to indicate the sub-scenario that is the target of the next scenario block operation.

deleteChildrenOnTerminate — Boolean that indicates whether all sub-scenarios terminate when the main scenario terminates. The default behavior is that sub-scenarios remain active if the main scenario terminates. That is, the default is false.

If the main scenario inherits sub-scenarios from other main scenarios, the inherited sub-scenarios would also terminate when the value of the deleteChildrenOnTerminate parameter is true.

inheritExternalInstances — Indicates whether the main scenario inherits sub-scenarios created by other main scenarios. When the main scenario inherits sub-scenarios, it means that the main scenario can operate on inherited sub-scenarios as though it had created those sub-scenarios. For details, see Inheriting sub-scenarios.

input-variables — There is one parameter for each source scenario variable that is marked as input. For example, if the source scenario has a quantity input variable, then a scenario block created from that source scenario has a quantity parameter. The recommendation is that you mark a source scenario variable as input or output and not as both.

When you add a scenario block to a main scenario, the initial value of the instance id parameter is an empty string, "". When you call the create operation on a scenario block and the value of the instance id parameter is an empty string, the scenario block generates the ID that it assigns to the new sub-scenario. This ensures that the instance ID is unique within the main scenario. You can obtain the assigned instance ID from the scenario block output feed.

Generated instance IDs would look something like the following for a scenario block named MyScenarioBlock:

When you want to specify the ID that the scenario block assigns to a new sub-scenario, set the value of the instance id parameter and then call the create operation. If you specify an instance ID that already exists, and call the create operation, the create operation fails.