Using the Scenario List Widget

The Scenario List widget is the default widget on the Home view, which is the only view available when launching the web client for the first time. For more details, please refer to Section Understanding the Home View.

Scenario List Widget

The Scenario List displays all the scenarios imported into the application for a specific workspace. Scenarios imported in a workspace can be copied, moved or shared to other workspaces. For more details, please refer to Chapter Managing the Application Data.

A tooltip displays the number of schema errors in the scenario. When using a composite data model, a dedicated icon indicates the initials of the scenario type, TransactionalData in the figure, and any scenario References. For more details, please refer to Section Defining a Composite Data Model (CDM).

The icon in front of each scenario reflects its state, whether it is in the process of importing or already imported in the application database. If it is shared, i.e. ACCESS is granted to EVERYONE — as it can happen when the scenario is associated to a scenario link or when it is referenced by another scenario — an indicator is displayed. An option in the Actions menu described below allows to Stop Sharing the scenario.

Shared Scenario

Additional information on the last validity check, scenario type full name and scenarios referencing the current scenario can be displayed using the option Scenario details from the Actions menu described below.

Scenario Details Tooltip

The widget toolbar indicates the workspace name and displays icons for the following options:

  • Move to Trash all scenarios preselected in the Workspace list;

  • New Scenario creation within the workspace. For more details, please refer to Section Managing the Application Data; and

  • New Folder creation within the workspace to store scenarios.

  • Additional features:

    • Empty Trash to permanently delete any scenario listed under Trash at the bottom of the Scenario List, and

    • Reset Widget to refresh the widget state.

By default, the columns indicate, for each scenario, the Name, Creation Date, Modification Date, Author, Data Status, Latest Job, and the available Actions via a dedicated button .

The layout of the widget columns can be edited. For more details, please refer to Section Understanding Table Widgets.

From the Scenario List, users can "preselect" a scenario by double-clicking on it. Selecting a scenario refreshes, with the new value, the Scenario Selector as well as any widget in the same context.

Clicking on the Actions menu of a scenario displays a dropdown menu allowing to perform specific actions on it, such as:

  • Select a scenario, which is the same as double-clicking on it in the list or picking it from the scenario picker,

  • Rename the scenario without changing its content,

  • Move to Trash the scenario, which can be permanently deleted using the Empty Trash option described above.

  • Duplicate the scenario,

  • Create Link to share the scenario with other workspaces,

  • Stop Sharing to remove the ruleset granting ACCESS to EVERYONE added by any scenario link or reference from scenarios in other workspaces associated with the scenario,

  • Copy to Workspace to create a duplicate of the scenario in other workspaces,

  • Move to Workspace to remove the scenario from the workspace and place it in another,

  • Scenario Details to display additional information about the scenario,

  • Lock to prevent any edition on the scenario by other users until unlocked,

  • Session Lock to prevent any edition on the scenario until the user logs out or the session expires,

  • Unlock to remove any lock on the scenario,

  • Force unlock to remove any lock left after a failed task — only available to users with the role PERMISSIONS_ADMIN,

  • Excel Export for all or part of the scenario,

  • DBRF Export for all or part of the scenario,

  • Run Schema Checkers on the scenario data, and

  • Run Job on the scenario.

Clicking on the Actions menu (…) of a scenario in the Trash folder displays a dropdown menu allowing to perform specific actions on it, such as:

  • Restore, which moves the scenario back to where it was before being put in the trash

  • Delete, to permanently delete a scenario

For more details on locks, please refer to Chapter Managing the Application Data and Section Understanding Scenario Locks.

The widget settings can be edited using a dedicated configurator.

The upper tabs allow configuring the:

  • Header, i.e. the widget top bar, by setting if it must be shown by ticking Show Header and if so, by inserting its Title and Icon.

  • Colors, by ticking Use Custom Colors, and setting the Header Color and Text Color.

  • Toolbar, beneath the widget header, by adding configurable action buttons. For more details, please refer to Section Using the Action API.

  • Custom Controller in charge of customizing the widget behavior, set to None by default.

The main tabs allow configuring the:

  • General properties of the widget, such as the:

    • Columns to show, and

    • Multi-Model columns to show if the application uses a composite data model.

  • Actions to display or hide in the Actions menu .

  • Custom Actions that users can add to the Actions menu . There, custom actions can be added, removed, reordered or duplicated. A custom action consists of an Action Label, an Icon and an Action declared using the Action API. The Platform provides some action samples by default. For more details, please refer to Section Using the Action API.

    Scenario List Custom Actions Configuration