Initializing help system before first use

xpressinsight.data.Param

Purpose
Creates an annotation for a parameter entity to be fetched from another scenario.
Synopsis
xpressinsight.data.Param(*, dtype: Type[BasicType] = <class 'string'>, entity_name: Optional[str] = None) -> Type[bool | float | int | str]
Arguments
dtype 
The data type; one of boolean, real, integer or string. If not given, 'string' is assumed.
entity_name 
The name of the parameter to read. If not given, the name of the class attribute will be used as the parameter name.
Example 
>>> @xi.ScenarioData
... class DataFromAnotherScenario:
...     # Example where the data type is not given.
...     NumFactory: xi.data.Param()
...     # Example where the data type is explicitly stated.
...     IsOn: xi.data.Param(dtype=xi.boolean)
...     # Example where the parameter name is different from the attribute name
...     OtherScenarioResult: xi.data.Param(entity_name='MyResult')
Further information
1. The function Param is part of the package xpressinsight.data.
2. This function returns an Annotated type containing the Param entity object; for example, if xpressinsight has been imported as xi, then xi.data.Param(dtype=xi.integer) is equivalent to Annotated[int, xi.Param(dtype=xi.integer)].
3. Parameters are stored in the Insight data-model as strings, and can always be fetched as strings regardless of their original definition.
Related topics
AppInterface.get_scenario_data,
BasicType,
Param,
ScenarioData

Parent Topic Scenario Data Entity Definitions

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