Initializing help system before first use

Annotation of Progress Entities

Any entity which is annotated as either an input or result entity can be marked to emit progress information during model execution using the following annotation:

!@insight.update.progress

The behavior of non-progress entities does not change and will not be affected. 

!@insight.update.progress
!@insight.alias Progress Metric 
progressIdx: set of string
If the following requirements are not fulfilled, an error is returned :
  • All index sets of a progress entity must also be progress entities and vice-versa.
  • Input progress entities must be annotated !@insight.update.afterexecution true.

Treatment of Entity Values

All scenario entities are locked in the Insight data repository while a model is running. During execution, progress entities are held as temporary values updated directly on the client; the client displays these updated values, not those held in the repository. The server stores the last submitted values for progress entities until the model execution is complete, at which point the progress values are discarded. Prior to the start of model execution:
  • All result entities values (both unmarked and marked for progress) are always cleared when a scenario or job is queued for execution and upon start of an execution mode.
  • Input entities marked to update with progress are cleared if the clearinput setting is configured as true (default setting for LOAD mode). To retain the input values, configure clearinput as false.

During execution, progress entity values are transferred from the model to the view when the model calls to insightsendprogress. However, if the execution mode sets clearinput=true , progress result entities are not updated during execution and remain empty.

Scenario Status Result Entity Values Input Entity ValuesMarked for ProgressUpdates
Queued for Execution Cleared Cleared if clearinput=true / Retained if clearinput=false
Start of an Execution Mode Cleared Updated in progress events
During Execution Updated in progress events except if clearinput=true Updated in progress events
After Execution Updated in Insight data repository except if clearinput=true Updated in Insight data repository

Conceptually, the clearinput=true setting corresponds to a LOAD mode which should not update result entities at all. The annotation lifting it to a progress result entity doesn't change this concept.

When the execution is complete, the final results are displayed:
  • If the model completes without errors the data is replaced with the new data.
  • If execution is cancelled or fails to execute, the original data is retained.
Parent Topic Preparing the Model

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