Initializing help system before first use

# Application Configuration

An Xpress Insight Python app is implemented as a Python class which contains: meta-data about the app, definition of the data model, as well as definition of the execution modes.

    import xpressinsight as xi

    @xi.AppConfig(name="My First Insight Python App", version=xi.AppVersion(0, 1, 2),
                  raise_attach_exceptions=True)
    class MyApp(xi.AppBase):

        # Declare data model here.

        # Define execution modes here.

In the above example, the MyApp class represents the main Insight Python app. Any name may be chosen for the class, but it must extend xpressinsight.AppBase and must be decorated by xpressinsight.AppConfig. Additionally, there must be exactly one such class per app.

The xpressinsight.AppConfig decorator allows the user to specify meta-data about the app such as the name and version. The name and version will appear on the Xpress Insight home page for the app. The version follows the "Semantic Versioning" guidelines of specifying the major, minor, and patch versions as non-negative integers between 0 and 999. In the above example, the version of the app is 0.1.2.

Extending xpressinsight.AppBase provides the primary functionality to interact with the Insight server, for example reading and writing attachment files.

## App Configuration Classes

### xpressinsight.AppBase

xpressinsight.AppBase | The AppBase class.
xpressinsight.AppBase.app_cfg | Property for the application configuration object of the Insight app.
xpressinsight.AppBase.initialize_entities | Initialize entities to their default values (empty string, 0, empty series or dataframe column, etc.).
xpressinsight.AppBase.insight | Property for the application interface of the Insight app.

### xpressinsight.AppConfig

xpressinsight.AppConfig | Insight application configuration decorator.
xpressinsight.AppConfig.__init__ | Insight AppConfig constructor.
xpressinsight.AppConfig.allow_duplicate_indices | Whether to skip the check for duplicate index tuples in Series / DataFrame / PolarsDataFrame entities, and duplicate values in Index / PolarsIndex entities.
xpressinsight.AppConfig.entities | Get the list of all Insight entities of an app or scenario data container.
xpressinsight.AppConfig.exec_modes | Get the list of all execution modes of the app.
xpressinsight.AppConfig.exec_resource_groups | Get the list of all execution resource groups of the app.
xpressinsight.AppConfig.get_entity | Get an Insight entity by name.
xpressinsight.AppConfig.get_exec_mode | Get an execution mode object by name.
xpressinsight.AppConfig.get_exec_resource_group | Get an execution resource group of the app.
xpressinsight.AppConfig.name | Get the default name of the app.
xpressinsight.AppConfig.partial_populate | Whether this app is using the 'partial populate' pattern.
xpressinsight.AppConfig.raise_attach_exceptions | Property indicating whether to raise an exception on an attachment-related error (such as attempting to get an attachment that doesn't exist, or put an attachment too large to be accepted by Insight).
xpressinsight.AppConfig.result_data | Get the result data configuration of the app.
xpressinsight.AppConfig.scen_types | Get the scenario types of the app.
xpressinsight.AppConfig.slow_task_threshold | When internal tasks taking longer than this threshold, warnings will be written to the run log.
xpressinsight.AppConfig.version | Get the version number of the app.

### xpressinsight.AppVersion

xpressinsight.AppVersion | Class to represent the version number of an Insight Python app, according to semver (Semantic Versioning) conventions.
xpressinsight.AppVersion.__init__ | Initializes AppVersion with major, minor, and patch version information.
xpressinsight.AppVersion.major | Major version number
xpressinsight.AppVersion.minor | Minor version number
xpressinsight.AppVersion.patch | Patch version number

### xpressinsight.ResultData

xpressinsight.ResultData | Class which specifies how to handle result data within the Insight server.
xpressinsight.ResultData.__init__ | Initializes ResultData with delete strategy.

### xpressinsight.ResultDataDelete

xpressinsight.ResultDataDelete | When to delete scenario results data.

### xpressinsight.EntitiesConfig

xpressinsight.EntitiesConfig | Abstract base class for entity container configuration.
xpressinsight.EntitiesConfig.entities | Get the list of all Insight entities of an app or scenario data container.
xpressinsight.EntitiesConfig.get_entity | Get an Insight entity by name.

### xpressinsight.EntitiesContainer

xpressinsight.EntitiesContainer | Abstract base class used for classes that contain scenario entities (such as AppBase and ScenarioData), providing a standard way to query entity definitions.
xpressinsight.EntitiesContainer.entities_cfg | Property for the entities configuration for entities stored in this class.
xpressinsight.EntitiesContainer.get_entities_cfg | Return the configuration for entities stored in this class.

### xpressinsight.ExecMode

xpressinsight.ExecMode | Insight execution mode decorator.
xpressinsight.ExecMode.__init__ | Constructor for the execution mode decorator for user-defined execution modes.
xpressinsight.ExecMode.call | Invoke the execution mode.
xpressinsight.ExecMode.clear_input | Whether this execution mode clears inputs.
xpressinsight.ExecMode.descr | Execution mode description.
xpressinsight.ExecMode.exec_resource_group | Execution resource group.
xpressinsight.ExecMode.exec_resource_group_name | Execution resource group name.
xpressinsight.ExecMode.name | Execution mode name.
xpressinsight.ExecMode.preferred_service | Preferred execution service for this execution mode.
xpressinsight.ExecMode.send_progress | Whether this execution mode sends progress updates.
xpressinsight.ExecMode.threads | Desired thread allocation for this execution mode.

### xpressinsight.ExecModeLoad

xpressinsight.ExecModeLoad | Decorator class for the built-in LOAD execution mode.
xpressinsight.ExecModeLoad.__init__ | Constructor for the LOAD execution mode decorator.
xpressinsight.ExecModeLoad.call | Invoke the execution mode.
xpressinsight.ExecModeLoad.clear_input | Whether this execution mode clears inputs.
xpressinsight.ExecModeLoad.descr | Execution mode description.
xpressinsight.ExecModeLoad.exec_resource_group | Execution resource group.
xpressinsight.ExecModeLoad.exec_resource_group_name | Execution resource group name.
xpressinsight.ExecModeLoad.name | Execution mode name.
xpressinsight.ExecModeLoad.preferred_service | Preferred execution service for this execution mode.
xpressinsight.ExecModeLoad.send_progress | Whether this execution mode sends progress updates.
xpressinsight.ExecModeLoad.threads | Desired thread allocation for this execution mode.

### xpressinsight.ExecModeRun

xpressinsight.ExecModeRun | Decorator class for the built-in RUN execution mode.
xpressinsight.ExecModeRun.__init__ | Constructor for the RUN execution mode decorator.
xpressinsight.ExecModeRun.call | Invoke the execution mode.
xpressinsight.ExecModeRun.clear_input | Whether this execution mode clears inputs.
xpressinsight.ExecModeRun.descr | Execution mode description.
xpressinsight.ExecModeRun.exec_resource_group | Execution resource group.
xpressinsight.ExecModeRun.exec_resource_group_name | Execution resource group name.
xpressinsight.ExecModeRun.name | Execution mode name.
xpressinsight.ExecModeRun.preferred_service | Preferred execution service for this execution mode.
xpressinsight.ExecModeRun.send_progress | Whether this execution mode sends progress updates.
xpressinsight.ExecModeRun.threads | Desired thread allocation for this execution mode.

### xpressinsight.ExecResourceGroup

xpressinsight.ExecResourceGroup | Insight execution resource group.
xpressinsight.ExecResourceGroup.__init__ | Constructor for the execution resource group.
xpressinsight.ExecResourceGroup.default_memory | Default memory allocation for this execution resource group.
xpressinsight.ExecResourceGroup.default_threads | Default thread allocation for this execution resource group.
xpressinsight.ExecResourceGroup.descr | Execution resource group description.
xpressinsight.ExecResourceGroup.min_memory | Minimum memory allocation for this execution resource group.
xpressinsight.ExecResourceGroup.min_threads | Minimum thread allocation for this execution resource group.
xpressinsight.ExecResourceGroup.name | Execution resource group name.

Covered Topics

- xpressinsight.AppBase
- xpressinsight.AppBase.app_cfg
- xpressinsight.AppBase.initialize_entities
- xpressinsight.AppBase.insight
- xpressinsight.AppConfig
- xpressinsight.AppConfig.__init__
- xpressinsight.AppConfig.allow_duplicate_indices
- xpressinsight.AppConfig.entities
- xpressinsight.AppConfig.exec_modes
- xpressinsight.AppConfig.exec_resource_groups
- xpressinsight.AppConfig.get_entity
- xpressinsight.AppConfig.get_exec_mode
- xpressinsight.AppConfig.get_exec_resource_group
- xpressinsight.AppConfig.name
- xpressinsight.AppConfig.partial_populate
- xpressinsight.AppConfig.raise_attach_exceptions
- xpressinsight.AppConfig.result_data
- xpressinsight.AppConfig.scen_types
- xpressinsight.AppConfig.slow_task_threshold
- xpressinsight.AppConfig.version
- xpressinsight.AppVersion
- xpressinsight.AppVersion.__init__
- xpressinsight.AppVersion.major
- xpressinsight.AppVersion.minor
- xpressinsight.AppVersion.patch
- xpressinsight.EntitiesConfig
- xpressinsight.EntitiesConfig.entities
- xpressinsight.EntitiesConfig.get_entity
- xpressinsight.EntitiesContainer
- xpressinsight.EntitiesContainer.entities_cfg
- xpressinsight.EntitiesContainer.get_entities_cfg
- xpressinsight.ExecMode
- xpressinsight.ExecMode.__init__
- xpressinsight.ExecMode.call
- xpressinsight.ExecMode.clear_input
- xpressinsight.ExecMode.descr
- xpressinsight.ExecMode.exec_resource_group
- xpressinsight.ExecMode.exec_resource_group_name
- xpressinsight.ExecMode.name
- xpressinsight.ExecMode.preferred_service
- xpressinsight.ExecMode.send_progress
- xpressinsight.ExecMode.threads
- xpressinsight.ExecModeLoad
- xpressinsight.ExecModeLoad.__init__
- xpressinsight.ExecModeLoad.call
- xpressinsight.ExecModeLoad.clear_input
- xpressinsight.ExecModeLoad.descr
- xpressinsight.ExecModeLoad.exec_resource_group
- xpressinsight.ExecModeLoad.exec_resource_group_name
- xpressinsight.ExecModeLoad.name
- xpressinsight.ExecModeLoad.preferred_service
- xpressinsight.ExecModeLoad.send_progress
- xpressinsight.ExecModeLoad.threads
- xpressinsight.ExecModeRun
- xpressinsight.ExecModeRun.__init__
- xpressinsight.ExecModeRun.call
- xpressinsight.ExecModeRun.clear_input
- xpressinsight.ExecModeRun.descr
- xpressinsight.ExecModeRun.exec_resource_group
- xpressinsight.ExecModeRun.exec_resource_group_name
- xpressinsight.ExecModeRun.name
- xpressinsight.ExecModeRun.preferred_service
- xpressinsight.ExecModeRun.send_progress
- xpressinsight.ExecModeRun.threads
- xpressinsight.ExecResourceGroup
- xpressinsight.ExecResourceGroup.__init__
- xpressinsight.ExecResourceGroup.default_memory
- xpressinsight.ExecResourceGroup.default_threads
- xpressinsight.ExecResourceGroup.descr
- xpressinsight.ExecResourceGroup.min_memory
- xpressinsight.ExecResourceGroup.min_threads
- xpressinsight.ExecResourceGroup.name
- xpressinsight.ResultData
- xpressinsight.ResultData.__init__
- xpressinsight.ResultDataDelete

Parent Topic Insight 5 Python Reference

© 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.