Initializing help system before first use

# Traffic Between Worker and Server

The processing of progress updates places a load on the Insight system. The frequency with which updates are collected and broadcast to the user interface is automatically throttled to protect the Insight server. This frequency is configurable by an application property and defaults to 5 seconds. Developers are advised not to decrease this value unless strictly necessary as this may impact overall system performance.
Note: Throttling and this configuration parameter are not yet active in Insight 5.3, but will be added with the next release. This behavior needs to be taken into account when developing views for custom progress.

Although updates to the server are throttled, the worker itself must respond to every progress update send by the model. Developers are strongly recommended to throttle their calls to `insight.send_progress_update()` to avoid overwhelming the worker. For example, calling `insight.send_progress_update()` from the simplex log callback of the solver could lead to a very large number of progress updates being sent to the worker. Model code should use a local time check to limit the rate by which it sends updates.

Finally, the volume of progress data being broadcast by a model is also a scalability consideration. The developer should restrict the total size of the progress entities to only what is strictly necessary. All entities marked as progress get sent to the server in an internal JSON format (such as [entity name] : "value"), where value might be empty if not initialized. The length of names and type of entities determine the overall size of such an update.

The amount of data transferred between the model and view should not exceed 10kB. A technical limit of 64kB is enforced. Messages exceeding this limit will not be sent and an entry is added to the server log.

The limits are configured in the `application.properties` file.

Parent Topic Performance Considerations

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