Settings in the application.properties File

Each worker must be configured to communicate progress events.

Configure the Worker Settings

Configure the worker to handle progress callbacks, limit the size of the callback, and to send progress request to the server.

Note: There are similar settings in the Server application.properties file. The server and worker properties should be set to the same value.

1. When the model calls insight.send_progress_update, the worker sends requests to the server containing names of the updated entities.

   Note: If too much data is sent to the worker callback, the worker closes the stream, resulting in an error message in the runlog but the model continues to execute.

   Set the limit in the worker application.properties file. The default value is shown in the example. Minimum value is 1k, maximum is 1m.

   insight.worker.execution.progress.max-bytes=64kb

   Note: The amount of data transferred between the model and view should not exceed 10kB.

2. Configure the size of progress messages that can be sent from the worker to the server in the worker application.properties file. The default value is shown in the example. Minimum value is 1k, maximum is 512k.

   insight.worker.execution.messages.max-characters=32kb

3. Define the maximum number of messages that can be queued. The default value is shown in the example. Minimum value is 1, maximum is 100.

   insight.worker.execution.messages.queue-length=100

4. Configure the rate at which progress messages are sent from the worker to the server in the worker application.properties file.

   insight.worker.progress.interval = 5 

   When a callback is received from the model for the first time, the worker sends a REST request to the server to indicate progress data is available. When a callback is received from the model:

   • if more than <Threshold> seconds has passed, the worker sends a REST request to the server to indicate progress data is available.
   • if less than <Threshold> seconds has passed, the worker records the progress data and sends a REST request to the server to indicate progress data is available after the threshold has passed.
   • if a job raises at least one progress message, job metrics contain entry for number/size of progress messages raised by model and an entry for number/size of progress requests received by worker from server—The run log contains a line for each of these metrics within the worker phase.

Configure the Server Settings

Edit the same settings as those listed for the Worker in the Server application.properties file—The server and worker properties should be set to the same value.

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