Running the Client as a Windows Service - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Essential
Standard
Premier

Running OnBase as a Windows service turns the OnBase Client into a background process that automatically starts and runs when the computer boots, without user intervention.

You can configure the OnBase Client as a Windows Service through either the Client or Configuration modules. The following items should be considered when running the OnBase Client as a Windows service:

  • To configure the OnBase Client as a Windows Service, the user that is logged in must have the System Configuration right.

  • Files within mapped drives are not visible in the OnBase Client as a Windows Service.

    Note:

    If you need to access files within a mapped drive and cannot provide a direct link to the drive, you can work around the mapped drive limitation either by migrating the processing directory to a shared folder with a visible Universal Naming Convention (UNC) string or by referencing the hidden share via UNC string.

  • The Windows Service menu option is not displayed in the OnBase Client if the user does not have the System Configuration right. This also applies to the MANAGER and ADMINISTRATOR user groups.

  • When creating or running the OnBase Scheduler Service, you need to use the Service Delay utility to allow the server workstation to properly restart. See, Delaying the Startup of a Service.

  • You must restart the Client after performing either of the following actions:

    • Adding a new process to the OnBase Scheduler

    • Modifying an existing process in the OnBase Scheduler.

  • When running the OnBase Client as a Windows Service, disable any dialog boxes configured to launch on startup for the OnBase user running the service.

CAUTION:

You should not attempt to run more than two OnBase Clients as a Windows service under the built-in Windows accounts, such as the Local System account. Since the built-in accounts use the same session for every service, the workstation can run out of memory if too many services are run simultaneously under them, which can cause one or more of the OnBase Clients to fail. Multiple OnBase Clients can be safely run as Windows services under a single distinguished (named) account (e.g., domain\username) because a separate session is created for each service, so they do not share the same memory pool. However, the total number of services that can be run is still limited by the total amount of memory available on the workstation.

See the following sections for more information on using the OnBase Client as a Windows Service: