Initializing help system before first use

# Custom Scenario Types

In addition to the default `SCENARIO` type that cannot be disabled or removed, you can create and define additional custom scenario types in an app. The appearance of the scenario and the actions that can be performed on it can be individually configured for each scenario type, by editing the app companion file (cfile).

You can also use this functionality to customize the appearance and behavior of the default `SCENARIO` type.

This feature requires Insight 4.54.1 or above, and apps must be configured to use version 3.1 or above of the companion file.

The definition in the cfile of each scenario type controls the following:

- The actions a user can perform on the scenario in the web client.
- The way Xpress Insight displays the pill shown on the shelf when the scenario is active in your app.
- The icons Xpress Insight uses to represent the scenario internally, such as in the explorer and in dialog windows.

Note: The companion file settings only customize the actions that are allowed in the UI, these actions are only prevented through the standard web-client UI. It is still possible to use VDL, the JS API, or the REST API to invoke these behaviors.
Covered Topics

- Declaring Custom Scenario Types in the Python Model
  Scenario types are declared in the model using the AppConfig decorator.
- Using Custom Scenario Types
  You can use a custom scenario to control what a user is able to do when the scenario is displayed in the Scenario Manager, and when it is loaded onto the shelf in Xpress Insight.
- Configuring Custom Scenario Types
  You can control the way the pill is displayed on the shelf, and which actions are available to scenario users.
- Web Client Behaviors
- App Upgrade Behaviors
- API Behaviors

Parent Topic Advanced Topics

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.