Initializing help system before first use

The Lifecycle of Scenario Data

A scenario persisted in FICO® Xpress Insight can have input data, result data, and file attachments. A scenario is created in an unloaded state with no input data, no result data and no file attachments.
The usual way of transitioning the state of the scenario data is to execute the scenario. There are two types of execution mode:
  • One which sets the input data. This load type of mode has the clear_input flag set to True. On execution of a scenario with this type of execution mode, any existing input data values are erased. When the model exits, Xpress Insight captures and persists the current values of the input data entities.
    Note: The built-in LOAD execution mode has clear_input=True.
  • One which sets the result data. This run type of mode has the clear_input flag set to False. On execution of a scenario with this type of execution mode, the input data entities in the model are automatically initialized to their values as stored by Xpress Insight. When the model exits, Xpress Insight captures and persists the current values of the result entities.

    Input entities can be recaptured during a run type execution by setting their update after execution flag to True.

    Note: The built-in RUN execution mode has clear_input=False.

By default, all existing result data values are erased on any execution mode. You can use the optional capture() function to capture only specified result entities while not affecting others. For more information, see Loading and Capturing Partial Data Sets.

For more information about execution modes, see Execution Modes.

The result data for a scenario should be consistent with the input data. The system provides three options for how the results data is treated as the input data evolves:
  • On-change—the result data is deleted as soon as an input entity value is modified.
  • On-queue—the result data is flagged as dirty as soon as an input entity value is modified, and deletion of the result data is deferred until the scenario is queued for execution.
  • On-execute—the result data is flagged as dirty as soon as an input entity value is modified, and deletion of the result data is deferred until the scenario begins executing.

You can use the insight.update.keepresultdata annotation to allow modification to an input entity without deleting result data or marking it as dirty. For more information, see Keeping Result Data When Modifying Input Data.

Covered Topics
  • Keeping Result Data When Modifying Input Data
    It is possible to modify some input data without erasing result data when using REST API, JavaScript API, or VDL actions. This can be useful for adding comments to a scenario after execution, or for updating entities or controls for reporting purposes.
  • Loading and Capturing Partial Data Sets
    By default, the model automatically populates all input entities with data from Xpress Insight, and all result entities are captured and persisted by Xpress Insight when the model exits. For an execution mode that uses only a subset of the Insight data, you can specify that only certain entities should be populated or captured.
Parent Topic The Model and Scenario Data Management

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