Configuring the Cleanup Processor - API Server - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/API-Server/Foundation-24.1/API-Server/Temp-File-Service-Installation/Installing-the-Temp-File-Service/Installation-and-Configuration/Configuring-Background-Processing/Configuring-the-Cleanup-Processor - 2024-11-04

API Server

Platform
OnBase
Product
API Server
Release
Foundation 24.1
License
Premier
Standard
Essential

The Cleanup Processor controls the background deletion of expired temp files.

To configure the Cleanup Processor:

  1. Open the 5_tempfs.json file in a plain text editor such as Notepad.
    The file is located in the config folder of the API Server's installation location.
  2. Locate the "CleanupProcessor" section of the 5_tempfs.json file.
  3. After "Enabled" :, enter true to enable the Cleanup Processor, or false to disable it.
    By default, this option is set to true.
  4. After "StartupDelaySeconds" :, enter the number of seconds you want the Cleanup Processor to wait before processing after the Temp File Service restarts.
    By default, this option is set to 0 seconds.
  5. After "RunDelaySeconds" :, enter the number of seconds you want the Cleanup Processor to wait between each time it runs.
    By default, this option is set to 300 seconds.
  6. After "ErrorBehavior" :, enter one of the following options for how the processor should behave when an error occurs:
    • Enter LogAndContinue to have the processor log the error and wait the amount of time configured in the RunDelaySeconds option before continuing.
    • Enter HaltProcessor to have the processor stop running entirely when it encounters an error.
    By default, this option is set to LogAndContinue.
  7. Save the configuration file.