Send a scenario to a lab

Typing name : TASK.gws_core.SendScenarioToLab

Brick : gws_core

Send a scenario to another lab using lab credentials

Task to send a scenario to another lab using lab credentials.

This task instructs the destination lab to import the scenario from the source lab using credential-based authentication.

A credentials of type lab are required in both labs to be able to send and receive scenarios. It needs to be the same api_key in both labs.

When auto_run is enabled, the create_option is forced to "Update if exists" so the scenario keeps the same ID. The auto_run flag is passed to the destination's downloader which will automatically run the scenario after import. The task does NOT unmark the scenario — downstream tasks (WaitExternalScenario) handle unmarking.

The following documentation explain how to configure the lab credentials: https://constellab.community/bricks/gws_academy/latest/doc/data-lab/scenario/f4453296-ccc5-4b54-8e46-2d1c2f830a0c#send-a-scenario-to-another-lab-(e.g.-a-datahub)

Input

Scenario to send

Scenario to send, it must not be running

Scenario resource

Output

Scenario

Scenario resource

Configuration

lab

The lab to send the scenario to (must have credentials configured)

Type : lab_model_param

resource_mode

Optional

Mode for downloading resource of the scenario

Type : string

Allowed values :

Auto
Inputs and outputs
Inputs only
Outputs only
Inputs of draft tasks
All
None

Default value : Auto

create_option

Optional

This applies for the scenario and the resources

Type : string

Allowed values :

Update if exists
Skip if exists
Force new scenario

Default value : Update if exists

auto_run

Optional

If true, the scenario will be automatically run in the destination lab

Type : bool

Input

Output

Configuration

Have you developed a brick?