Initializing help system before first use

Retrieving Updates from the View

A running model can check whether there are any messages waiting to be processed by calling self.insight. get_messages() which returns a generator. 
def get_messages(self) -> Generator[str, None, None]:

This generator can be used to iterate over available messages until none are available. The message format must be agreed between model and view developer. The model developer should ensure the model checks for messages and handles them properly.

Multiple users may perform actions in Insight views that trigger a message being sent from the client to the model. These messages are queued on the worker and read into the model in the order they were sent (measured to one millisecond). Therefore it is best to periodically loop over the messages returned by the generator. 
for msg in self.insight.get_messages():

To ensure smooth behavior for your Insight 5 users, performance implications need to be taken into account. It is highly recommended to carry out only efficient tasks while processing a message. A user may want to cancel or interrupt model execution, or to reset a control parameter.

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.