/
Scenario Authoring: Create, Edit, Clone and Delete Scenarios

Scenario Authoring: Create, Edit, Clone and Delete Scenarios

Overview

The Scenario Authoring feature empowers users of the Intent-Based Diagnostics to create, manage, and customize test scenarios for use in trace file evaluations within AGILITY.

Withi this page, you will learn how to:

These scenarios are the foundation for targeted and meaningful diagnostics during trace analysis, enabling more accurate and context-aware evaluations.

🚪 Accessing the Scenario Authoring Feature

Users can access the Scenario Authoring page from multiple areas within AGILITY:

From the Main Navigation Menu

  1. Access from the Main Navigation Sidebar under the Intent-Based Diagnostics Section.

  2. Click on Scenarios Catalog.

image-20250421-152710.png
Main Navigation Menu: Scenarios Catalog


From a Specific Evaluation

When you're already on the Evaluations page, reviewing an existing evaluation:

  1. From the evaluations' sidebar, click on the Evaluation you want to work with.

  2. At the top of the evaluation page, locate the section displaying Scenario Details, such as name, category, number of steps, and result.

  3. Navigate via Hyperlinks

    • Click on the Scenario Name to open the Scenario Authoring interface focused on that scenario's attributes, or

    • Click on the Category Name to view all scenarios associated with that category.

  4. A page redirect will take you to the appropriate view in the Scenario Authoring interface.

image-20250421-152242.png
Assessing from a selected Evaluation

🆕 Creating a New Scenario

To create a new scenario:

  1. Navigate to the Scenarios Catalog page.

  2. Then, click the New Scenario button to get started:

image-20250421-190610.png
"New Scenario” button

  1. Enter a Scenario Name and an optional Description.

  2. Then, select a Scenario Category and, if needed, choose all relevant Services from the provided lists. You can select only one category, but multiple services at once.

The services are required to understand which services to extract from the trace and provide as input to the evaluation scenario.

Enter the new scenario’s details

Each scenario step is organized into two structured sections based on the type of action:

  • Given Keywords: Define the initial setup or preconditions before the scenario begins.
    Example:
    Given a SIP Registration Flow

  • When/Then Keywords: Describe the action taken (When) and the expected outcome (Then). These steps represent the behavior being tested.
    Example:
    When UEa initiates a call with UEb → Then the media session is configured for bidirectional communication

Each section displays its title along with the number of steps added.
Example:
Given Keywords (2) = There are two different Given steps for this selected scenario

  1. Click the New Step button to add a new step to your scenario.

image-20250421-194353.png
Adding a new scenario step

  1. After clicking the New Step button, the step form will appear, allowing you to enter the step details and parameters. To cancel, simply click the Close () icon.

    image-20250421-200633.png
    Fill out the new step details or cancel the action.

 

  1. Enter the new step details, fill in the following parameters:

    • Step Definition: Select a structure from the pre-defined list.

      Selecting the step definitions

  • Confirm your selected step definition by clicking the Checkmark () icon.

image-20250421-200831.png
Step definition confirmation

  • Step Parameters: After selecting a step definition, enter the required parameters, if applicable.

    image-20250421-202147.png

Some step definitions may not require parameter input. When parameters are needed, you'll see placeholders enclosed in brackets, these indicate customizable values.

Example:
Given a {flow_type} with {protocol} messages
In this scenario, you must specify values for the flow type and protocol parameters within the chosen step. It's important to note that each step possesses unique attributes, which are not interchangeable between steps.

 

  • Step Output: Review the output generated from the selected structure and entered parameters

    image-20250421-203823.png
    Step output after filling out the parameters

  • Remove steps after creation by clicking the Close () icon.

    image-20250421-205700.png
    Remove a step after creation

 

  • Once you’ve added multiple steps, you can rearrange them by dragging and dropping the table rows. The step numbers will automatically update to reflect the new order.

    image-20250421-210137.png
    Drag & Drop: Step Reorder

The Step # is automatically generated when a step is added or reordered.

 

  1. Click Save to create the scenario, or Cancel to discard it.

    image-20250421-212728.png

A scenario won’t be saved unless it includes at least one step.

 

  1. Your new scenario will appear under the Available Scenarios page with all the information provided.

    Available Scenarios Page updated

👥 Identifying Scenario Ownership in the Catalog

The Scenario Catalog categorizes scenarios by ownership and origin, helping you easily identify whether a scenario was created by you, by another user, or provided as a default system resource. These classifications determine which actions, such as editing, cloning, or deleting, are permitted based on scenario ownership.

Here’s how to recognize the different types of ownership:

  1. My Scenario: Scenarios that you have personally created. You have full editing rights for these entries.

  2. User Defined: Scenarios created by other users in your organization or workspace. While you can view and clone these scenarios, you cannot directly edit them unless you're the original creator.

  3. System: Built-in scenarios provided by the AGILITY platform. They come pre-configured and are intended to help you get started quickly.

Summary Table

Ownership Type

Label/Chip

Editable

Cloneable

Description

Ownership Type

Label/Chip

Editable

Cloneable

Description

My Scenario

My Scenario

✅ Yes

✅ Yes

Scenarios you created

User Defined

User Defined

❌ No

✅ Yes

Created by other users

System

(No Label)

❌ No

✅ Yes

Default scenarios included in AGILITY

✏️ Editing an Existing Scenario

You can only edit scenarios labeled as My Scenario (those you’ve created).

To update an existing scenario:

  1. On the Scenarios Catalog page, find the scenario you wish to update.
    Pro tip: Use the search and filter options to quickly locate the scenario of interest.

  2. Click the Edit (✏️) button located at the bottom of the Scenario Card:

    image-20250423-144914.png
    Edit Scenario button

  3. Update the scenario details as needed.

  4. Click Save to apply your changes, Reset to revert all recent changes, or Cancel to cancel the edit action.

    image-20250423-145059.png
    Action buttons

🧬 Cloning a Scenario

To create a new scenario by cloning an existing one:

Both system scenarios and user-created scenarios can be cloned.

  1. On the Scenarios Catalog page, find the scenario you wish to clone.
    Pro tip: Use the search and filter options to quickly locate the scenario of interest.

  2. Click the Clone button located at the bottom of the Scenario Card:

    image-20250423-144844.png
    Clone Scenario button

  3. A new scenario will be created with the name prefixed by “[CLONE]”.

  4. Edit the name and any parameters as needed.

  5. Click Save to apply your changes, Reset to revert all recent changes, or Cancel to cancel the edit action.

    image-20250423-145135.png
    Action buttons

🗑️ Deleting a Scenario

To remove a scenario no longer needed, follow the steps below.

You can only edit scenarios labeled as My Scenario (those you’ve created). Scenarios created by other users cannot be modified.

  1. Navigate to the Scenarios Catalog page.

  2. Locate the scenario you wish to delete.

  3. Click on the Delete icon (🗑️) located at the bottom of the Scenario Card:

    image-20250423-144808.png
    Delete Scenario button

  4. A confirmation message will appear to ensure that you want to permanently delete the scenario.

    Delete Scenario confirmation

  5. Click Delete to delete, or Cancel to keep the scenario.

Deleting a scenario will remove it from the library and cannot be undone. Be sure to confirm that you no longer need the scenario before deleting it.

🔍 Using Filters on the Scenarios Catalog Page

The Scenarios Catalog page provides several filters to help users quickly find and manage scenarios based on specific criteria. These filters make it easier to locate the right scenario, especially when the library contains a large number of entries.

Available Filters

Below is a list of the most commonly available filters and how to use them:

Scenario Type

image-20250424-185456.png
Scenario Type Filter

  • Options: User Defined and System Default Scenarios

  • Description: Filter scenarios based on whether they were created by a user or generated by the system.

  • Use Case: Helpful for isolating editable/custom scenarios or reviewing system defaults.


My Activity

image-20250424-185552.png
My Activity Filters

  • Options: Created by Me and Modified by Me

  • Description: Filters scenarios by the creator.

  • Use Case: Useful when tracking your contributions in the scenario list.

Modified Date Sort

image-20250424-185920.png
Modified Date Sort Filter

  • Options: Ascending or Descending

  • Description: Sorts scenarios by modified date, from oldest to newest or newest to oldest.

  • Use Case: Helpful for quickly reviewing recent additions or revisiting older scenarios.

Scenario Name Search per Category

Scenario Name Search per Category

  • Field: Free text input

  • Description: Allows users to search for a scenario by name, organized by categories.

  • Use Case: Fastest way to locate a known scenario.

🏁 Starting an Evaluation from the Available Scenarios Page

Starting an evaluation directly from the Available Scenarios:

  1. Open the Scenario Catalog page where your scenarios are listed.

  2. Find the scenario you want to evaluate.

  3. Click the Start Evaluation icon () located at the bottom of the Scenario Card:

    image-20250423-144715.png
    Start an Evaluation from the Available Scenarios List

  4. The Start New page will appear, allowing you to:

    • Select the trace file to include in the evaluation

    • Choose a service, if applicable

  5. Once your configuration is complete, click Run Analysis to start the evaluation.

 

Related content