Menu
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
1
Share

Load scenario from archive

TASK
Typing name :  TASK.gws_core.ScenarioLoaderFromArchive Brick :  gws_core

Load a scenario and its resources from a single tar archive

Load a scenario from a self-contained tar archive file.

The archive must have been created by the ScenarioArchiveZipperTask (or ScenarioArchiveZipper). It contains the full scenario metadata, protocol definition, and selected resources bundled as individual tar files.

This task reconstructs the scenario locally without making any API calls to an external lab.

Inputs

  • archive: A tar archive file containing the scenario and its resources.

Outputs

  • scenario: The loaded scenario.

Parameters

  • create_option: How to handle an existing scenario with the same ID.
  • auto_run: Automatically run the scenario after loading.
  • skip_scenario_tags: Skip importing scenario tags.
  • skip_resource_tags: Skip importing resource tags.

Input

Scenario archive

Output

Scenario
Scenario resource

Configuration

create_option

Optional

This applies for the scenario and the resources

Type : select_paramDefault value : Update if exists

auto_run

Optional

If true, the scenario will be automatically run after loading

Type : bool

skip_scenario_tags

Optional

If true, the scenario tags will not be set

Type : bool

skip_resource_tags

Optional

If true, the resource tags will not be set

Type : bool
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.