Skip to main content
Kofax

Instructions and examples for installing RoboServer Services

Summary

12442


Step #1: Remove all existing Kapow Windows Services (if any)

ServiceInstaller.exe -r RoboServer.conf wrapper.ntservice.name=<SERVICE_NAME>

Step #2: Create a Windows Service for Management Console that has the default memory configuration as specified under RoboServer.conf

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE wrapper.ntservice.password.prompt=true
wrapper.ntservice.name="RoboServer9.3.0_MC"
wrapper.ntservice.starttype=AUTO_START wrapper.syslog.loglevel=INFO wrapper.app.parameter.1="-MC"

Note: This script will create a Windows Service that ONLY starts Management Console. This is the desired configuration as the Management Console should run under its own JVM if possible. The name of the Windows Service can be changed as needed.

Step #3: Create a Windows Services for one or more RoboServer instances using the default memory configuration as specified under RoboServer.conf

In version 9.2 to 9.7:

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE
wrapper.ntservice.password.prompt=true wrapper.ntservice.name="RoboServer9.3.0_50000"
wrapper.ntservice.starttype=AUTO_START wrapper.syslog.loglevel=INFO
wrapper.app.parameter.1="-service"
wrapper.app.parameter.2="socket:50000"

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE
wrapper.ntservice.password.prompt=true
wrapper.ntservice.name="RoboServer9.3.0_50001"
wrapper.ntservice.starttype=AUTO_START
wrapper.syslog.loglevel=INFO wrapper.app.parameter.1="-service"
wrapper.app.parameter.2="socket:50001"

In version 10 and Later:

In these versions, a standalone RoboServer (started in a JVM without a Management Console) or the Management Console with user authentication configured need to be given the URL of Management Console, credentials and the cluster to which to register. Therefore, there are two ways to configure services:

 1. Specify the information in RoboServer Settings

 On the RoboServer Settings app > General tab select "Register to a Management Console" then fill the form with the correct information.
 To install the services, use the same commands as in previous versions.

 2. Specify the information in the service parameters

 Please consider notes 2 and 3 below if using this option. Kepp in mind the password is entered in plain text (using RoboServer Settings is a better option in this case).
 Install services using these commands:

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE
wrapper.ntservice.password.prompt=true wrapper.ntservice.name="RoboServer10.1.0_50000"
wrapper.ntservice.starttype=AUTO_START wrapper.syslog.loglevel=INFO wrapper.app.parameter.1="-service"
wrapper.app.parameter.2="socket:50000" wrapper.app.parameter.3="-mcUrl"
wrapper.app.parameter.4="http://localhost:50080" wrapper.app.parameter.5="-cl"
wrapper.app.parameter.6="Production"

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE
wrapper.ntservice.password.prompt=true wrapper.ntservice.name="RoboServer10.1.0_50001"
wrapper.ntservice.starttype=AUTO_START wrapper.syslog.loglevel=INFO wrapper.app.parameter.1="-service"
wrapper.app.parameter.2="socket:50001" wrapper.app.parameter.3="-mcUrl"
wrapper.app.parameter.4="http://localhost:50080" wrapper.app.parameter.5="-cl"
wrapper.app.parameter.6="Production"

Notes:

  1. In versions 10 and Later, the RoboServer will be registered automatically in the Management Console specified by the "-mcUrl" parameter and under the cluster specified by the "-cl" parameter.

  2. If User Management is enabled, the user and password must be specified in the URL to the management console
    (wrapper.app.parameter.4) like this: http://user:password@localhost:50080

  3. When registering against a standalone Management Console (Kapow Enterprise), enter the path to the Management Console (wrapper.app.parameter.4), e.g.: http://user:password@localhost:8080/ManagementConsole

  4. Each RoboServer instance must have a unique TCP Listening Port. In the examples above, TCP Ports 50000 and 50001 are being used.

  5. The names of the Windows Services can be changed as needed.

  6. In versions 10 and Later, the RoboServer will be registered automatically in the Management Console specified by the "-mcUrl" parameter and under the cluster specified by the "-cl" parameter. An alternative to set the default user, password, cluster name and MC URL in the RoboServer Settings > General Tab > Register to a Management Console section.

  7. The service's login user should NOT be Local System (because of security issues). If LocalSystem is used for the RoboServer service, when webkit (default) robots are run, this error will occur: "Could not establish connection to WebKitBrowser. Failed to connect to bus"

  8. To troubleshoot this, please refer to Knowledgebase article #12900.

Keywords: install services

  • Was this article helpful?