Skip to main content
A scenario is a flow written in plain words, such as “sign in, add two products to the cart and check that the cart badge counts both”. IronBee runs it against one of your project’s environments, one action at a time, and shows what happened at each action. A scenario is saved, unlike an instant verification: you write the flow once and run it again whenever you need. Every run is kept with its result and its evidence. Scenarios belong to a project. Each one is Web or API, like the project’s verification type.
These are the scenarios you write and run in the console. The CLI has its own saved scenarios, which your AI coding agent writes into your repository. The two are separate.

How a scenario is built

A scenario has three sections: Each section holds rows:
  • actions: Act, Assert, Extract and Wait
  • Step, which groups rows under a name
  • Import, which runs another scenario’s Main in this one
A scenario can take inputs, read the project’s variables, secrets and environment properties, and give outputs back to the scenarios that import it. See Write a scenario and Inputs, references and imports.

The Scenarios page

Click Scenarios in the sidebar. The page lists every project in your account: Scenarios page with a table of projects, their scenario and reusable part counts, their runs in the last 7 days by result, and when and by whom a scenario was last updated Scenarios page with a table of projects, their scenario and reusable part counts, their runs in the last 7 days by result, and when and by whom a scenario was last updated The projects with the most recent scenario changes come first. Search to filter the list by project name or provider.

A project’s scenarios

Open a project and click its Scenarios tab. A project's Scenarios tab with the search, type and tag filters, and a table of scenarios with their type, Used By count, last 5 runs, and created and updated columns A project's Scenarios tab with the search, type and tag filters, and a table of scenarios with their type, Used By count, last 5 runs, and created and updated columns To narrow the list:
  • Search by name, description or tag.
  • Pick a type: All types, Web or API.
  • Pick tags from Any tag. The list shows the scenarios with any of the selected tags.
  • Click Clear filters to start over.
Sort by Scenario or Updated. The … menu on a row offers Run scenario, Edit, Duplicate and Delete.

The scenario page

Click a scenario to open it. The header shows its type, how many actions it runs (including the ones its imports bring) and how many scenarios it imports. Use Edit to open the editor, Run scenario to run it, and the … menu to Duplicate or Delete it.

Definition

The Definition tab shows the scenario section by section. Each row shows its kind, its instruction and its name. Some rows show their settings on a second line:
  • Soft, does not block the verdict on a soft assert
  • the number of retries on an Act
  • Up to 60 s, every 10 s on a Wait
An Import row names the scenario it runs, the name it has in this scenario, the values it passes to the imported scenario’s inputs, and what it gives back. Click Expand all to see what each import runs. The panel on the right sums the scenario up: its Inputs, Outputs, Imports (with the section each one runs in), Used by and Tags, then when it was Created and Updated. Definition tab of a scenario: Setup imports Sign in as customer, Main has asserts, two imports of Add product to cart and a wait, Teardown imports Reset app state and logs out; the right panel lists its inputs, outputs, imports, Used by and tags Definition tab of a scenario: Setup imports Sign in as customer, Main has asserts, two imports of Add product to cart and a wait, Teardown imports Reset app state and logs out; the right panel lists its inputs, outputs, imports, Used by and tags

Runs

The Runs tab lists every run of the scenario with its result, with the same columns as the Verifications list and one more, Version:
  • Current: the run used the scenario as it is now.
  • Older, with a count of changes: the scenario changed after the run.
Click a run to open it. See Run a scenario.

Create a scenario

  1. On the project’s Scenarios tab, click New scenario.
  2. Type a Name. Names are unique in a project.
  3. Pick the Type, Web or API. Only the types the project runs are offered, and you can’t change the type later. A web scenario can also call the app’s API.
  4. Under Start from, pick Blank, which starts with one empty Act in Main, or From a template:
    • Sign in, add to cart and check the total signs in during Setup, adds a product and checks the cart total in Main, and empties the cart in Teardown.
    • A page that loads opens the home page, waits for its main content and checks that no error is shown.
    Templates are for web scenarios only.
  5. Click Continue. The editor opens on the new scenario. Nothing is saved until you click Save changes.
New scenario dialog with a name, the Web type, From a template selected, and the Sign in, add to cart and check the total template New scenario dialog with a name, the Web type, From a template selected, and the Sign in, add to cart and check the total template A project can have up to 100 scenarios. The dialog shows how many the project has.

Duplicate or delete a scenario

Duplicate opens the editor on a copy, named after the original with (copy) at the end. The copy is saved when you click Save changes. Delete asks you to confirm with Delete scenario. Deleting can’t be undone:
  • The scenario’s past runs keep their copy of it and stay in Verifications.
  • If another scenario imports it, the dialog lists them and you can’t delete it. Remove the import from those scenarios first.

Who can change scenarios

On an archived project, scenarios are read-only and can’t be run. See Roles.

What’s next?

Write a scenario

Sections, actions, settings and saving in the editor.

Run a scenario

Pick an environment, pass inputs and read the run.