Service Configuration - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential

Service Configuration - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

On-Premises System Administration

Platform

OnBase

Product

System Administration - On-Premises

Release

Foundation 22.1

License

Standard

Essential

Premier

To configure the OnBase Client as a service:

Launch the OnBase Client or Configuration module.
Note:
With User Account Control (UAC) enabled, the OnBase Client or Configuration modules must be launched with elevated administrator privileges in order to configure Windows Services. To launch the module with elevated administrator privileges, right click the executable or shortcut to it and select Run as administrator.
- In the Configuration module, select Utils | Windows Services.
- In the Client module, select Admin | Utilities | Windows Services.
The Services dialog box is displayed.
Enter a display name for the service in the field at the bottom of the dialog box. This is a user-friendly name for the service. The name cannot be more than 256 characters long.
Click Create. The Service Configuration dialog box is displayed. Select the Service Settings tab if it is not already displayed.
The Service Name field is automatically populated with the value you entered as the display name. You can change the value in this field.

Note:
The actual service name used by Windows Services is a unique 10-character name created by the system and based on the value entered in the Service Name field.
Enter the description of the service in the Service Description field. This value is optional.
In the Executable Path field, specify the full path, including the filename, of your OnBase Client executable file, or click Browse to navigate to the location of the file and select it.

Note:
When clicking Browse, the Choose the client executable file dialog box is displayed, automatically opened to the directory in which the OnBase Configuration executable file resides. Be sure to navigate to the location of the OnBase Client executable file to select it.
Select the Start Type from the drop-down list. If you select Automatic, the service will start when the operating system boots. If you select On-Demand, the service must be manually started in the Windows Control Panel. If you select Disabled, the service cannot be started.

Note:
It is recommended that the Automatic option is selected after the service has been tested and verified.
Specify the OnBase User name and Password to log onto the system. These fields are optional. If Active Directory or LDAP auto-logon is used, these fields should be left blank.
Select Encrypt Password to encrypt the password.
Enter any appropriate command line switches in the Additional Arguments field. The ODBC source must be specified. Example: -ODBC="datasource"

Tip:
It is recommended that an ODBC switch always be explicitly supplied.

Note:
The -AL switch does not have to be specified. It is always implied for services.
Select the Service Logon Settings tab.

Select the identity under which the service will run. You must supply the identity of a distinguished security principal in order to provide the service with access to the OnBase Disk Groups and other resources.

The system accounts (Local System Account, Local Service Account, and Network Service Account) all have the required Windows security right to start an application as a service under Windows. However, these system accounts usually do not have the necessary domain rights required by OnBase to access the Disk Groups and database. It is recommended to configure the OnBase service to run under a domain account by selecting Use Other Account.

Note:
You must select Use Other Account if the account being used is part of an integrated auto-logon scheme, or when running OnBase as a print server (-PS switch) or sending e-mail notifications with a MAPI complaint e-mail system. The account specified must be logged on to the workstation when the service is running so that the current user section of the registry contains the printer settings or MAPI e-mail profile of that account.

If you select Use Other Account you must supply a valid Windows User name and Password in the corresponding fields. If the account is a member of a domain, the user name should be qualified with the domain, for example, domain\user or user@domain.net.

Note:
The account specified must be configured in Windows to log on as a service, which requires the Logon as a Service right under Windows (see Configuring a User Account to Log on as a Service).
Select the Service Dependencies tab.
Select from the Available Services list the services that you would like the OnBase service to be dependent on and click Add>>.
OnBase services must be run with the following minimum dependencies:
- DCOM Server Process Launcher
- Event Log
- Remote Procedure Call (RPC)
- Security Accounts Manager
- Windows Management Instrumentation
CAUTION:
If these minimum dependencies are not assigned to all OnBase services running on the workstation, when the machine running the services and starting them automatically is started, the boot process will stop at the Applying Computer Settings dialog.

Note:
If multiple OnBase services are configured to automatically start on the same machine, those services may need to be assigned as dependencies of the other OnBase services on that machine in order to avoid conflicts during the boot process of the workstation.
Click Save.