Back to bricks list
Introduction
Technical Documentation
Other Classes
Scenario ScenarioRunService
Version

ScenarioRunService

Service used to run scenario

Functions

CREATE_CLI_FOR_SCENARIO - @classmethod

Run an scenario in a non-blocking way through the cli.

Parameters:
NameTypeDefault valueDescription
scenarioScenario
userUser The user who is running the scenario. if not provided, the system will try the get the currently authenticated user `gws.user.`
Return type:
SysProc
CREATE_CLI_FOR_SCENARIO_PROCESS - @classmethod

Run an scenario in a non-blocking way through the cli.

Parameters:
NameTypeDefault valueDescription
scenarioScenario
protocol_modelProtocolModel
process_instance_namestr
userUser The user who is running the scenario. if not provided, the system will try the get the currently authenticated user `gws.user.`
Return type:
SysProc
GET_ALL_RUNNING_SCENARIOS - @classmethod
Return type:
List
RUN_SCENARIO - @classmethod

Run the scenario

Parameters:
NameTypeDefault valueDescription
scenarioScenario
Return type:
Scenario
RUN_SCENARIO_IN_CLI - @classmethod

Method called by the cli sub process to run the scenario

Parameters:
NameTypeDefault valueDescription
scenario_idstr
RUN_SCENARIO_PROCESS_IN_CLI - @classmethod

Method called by the cli sub process to run the scenario

Parameters:
NameTypeDefault valueDescription
scenario_idstr
protocol_model_idstr
process_namestr
STOP_ALL_RUNNING_SCENARIO - @classmethod
STOP_SCENARIO - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Scenario