Initializing help system before first use

Workflow for Custom Progress Reporting

The model and view must be configured to ensure messages are correctly exchanged and interpreted. The model defines which progress entities are to be displayed and sets their values. The view receives corresponding events based on which it automatically updates. The view is further able to send messages to the model.
Conceptually, the workflow is as follows.
  1. Execution modes are annotated via the decorator to send progress. These notify views that custom progress information will be emitted by the execution mode. 
    send_progress True
  2. Model entities (both input and result) are marked as progress entities by setting the update_progress flag on the type annotation. 
    update_progress=True
  3. The progress entities values can be sent from the running model to the Insight view by calling the routine self.insight.send_progress_update.
  4. Views that will interact with the progress elements can be configured to disable the execution overlay and explicitly subscribe to receive progress events from the running model. An attribute on the vdl tag needs to be configured. 
    <vdl version="4.8" progress="true" default-execution-overlay = "disabled_for_progress">
  5. VDL components that bind to progress entities will automatically update when the model sends progress. If additional views which show information about this running scenario are opened, only the most recently submitted values are available.
  6. VDL actions can be used to send plain text messages from a view to the model. The text message can be plain text or use JSON, XML, or any other format.
  7. The model calls self.insight.get_messages to check for new messages upon demand. The model interprets any message and takes corresponding action.
  8. A model will emit the progress information to all views that have subscribed to progress events. If a value is changed in a view, the model should send progress information to all views observing the execution. This ensures that the views for every user observing the same scenario are kept in sync.
Parent Topic Introduction to Custom Progress Reporting

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