Initializing help system before first use

xpressinsight.Index.__init__

Purpose
Create a new Index entity.
Synopsis
xpressinsight.Index.__init__(self, dtype: Type[BasicType] = None, alias: str = '', format: str = '', hidden: Hidden = Hidden.FALSE, manage: Manage = Manage.INPUT, read_only: bool = False, transform_labels_entity: str = '', update_after_execution: bool = False, *, update_keep_result_data: bool = False, update_progress: bool = False, entity_name: str = None)
Arguments
dtype 
The data type.
alias 
Used to provide an alternative name for an entity in the UI. The value is used in place of the entity name where appropriate in the UI.
format 
The formatting string used for displaying numeric values.
hidden 
Indicates whether the UI should hide the entity where appropriate.
manage 
How and whether Insight handles an entity. Defines how the system manages the entity data.
read_only 
Whether an entity is readonly. Specifies that the value(s) of the entity cannot be modified. See also hidden.
transform_labels_entity 
The name of an entity in the schema from which to read labels for values of this entity. The type of the index set of the labels entity must match the data type of this entity. The data type of the labels entity can be any primitive type.
update_after_execution 
Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution. If True the value of the entity is updated to correspond with the model entity after execution.
update_keep_result_data 
Whether to retain result data when this input entity is updated outside a scenario execution (e.g. in a view or a REST API call). If False, the result data may be deleted when a view or REST API request updates this entity, depending on the configuration of AppConfig.result_data. If True, the result data will not be deleted when this entity is updated.
update_progress 
Whether the value of the entity in the scenario is sent on progress updates. If True the value of the entity will be written back to the Insight repository when insight.send_progress_update is called from an execution mode where the send_progress attribute is True.
entity_name 
The entity name. If not given, the name of the class attribute will be used instead. Only valid for entities in a ScenarioData-decorated class.
Further information
1. The method __init__ is part of the class xpressinsight.Index.
2. Parameters before update_progress can be specified positionally for reasons of backwards compatibility, but it's recommended that you always use named arguments if you're specifying parameters other than dtype and alias.
Related topics
BasicType,
Hidden,
Manage

Parent Topic Entity Definition Container Classes

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