Initializing help system before first use

# xpressinsight.ScenarioData

Purpose

Insight scenario data class decorator. A class used to receive data from another scenario or app must use this decorator.

The ScenarioData decorator will automatically add EntitiesContainer as a superclass of the supplied class definition, if it is not already present.

Synopsis
`class xpressinsight.ScenarioData(EntitiesConfig)`
Example
Example of a decorating a class with ScenarioData:

    >>> @xi.ScenarioData
    ... class EntitiesToRead:
    ...     my_integer: xi.data.Scalar()
    ...     my_string: xi.data.Scalar()
    ...     my_set: xi.data.Index()
    ...     my_array: xi.data.Series()
    ...     my_table: xi.data.DataFrame(
    ...         columns=[
    ...             xi.data.Column('my_first_array'),
    ...             xi.data.Column('my_second_array')])
    ...
    ... SCENARIO_PATH = '/MyApp/MyFolder/MyScenario'
    ... my_data = self.insight.get_scenario_data(SCENARIO_PATH, EntitiesToRead)
    ... print(f"the integer scalar I read is {my_data.my_integer}")

Related topics
AppInterface.get_scenario_data,
EntitiesConfig,
EntitiesContainer,
ScenarioData.__init__,
ScenarioData.entities,
ScenarioData.get_entity
Parent Topic App Interface Classes

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