Skip to main content
Kofax

Instructions and examples for installing RoboServer Services

Article # 3035330 - Page views: 263

Issue

How to install RoboServers / Management Console as a windows Service? 

Solution

Commands below need to be run from the bin folder of your Kofax RPA installation where the ServiceInstaller.exe is located.

RSCommand.png

 

Step #1: Remove all existing Kofax RPA (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="RoboServer10.7.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 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.

product_documentation_-_user_guides_Important-Icon.png

Open RoboServer Settings application as the user running the RoboServer service. The configuration is by default saved under the user's Application Data folder.


 To install the services, use the same commands as in previous versions.

e.g.

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

Use this method when:

  • the services for Management Console and RoboServer(s) are on the same machine and will run as different users
    or
  • the services (for Management Console and RoboServer(s) are on the same machine, will run as the same user, and user authentication IS enabled on Management Console.
    or
  • you only have RoboServer services on the machine, they all run as the same user and can use the same configuration (same MC, credentials and cluster to register to/)

 2. Specify the information in the service parameters

 Please consider notes 1 and 2 below if using this option. Keep in mind the password is entered in plain text (using RoboServer Settings is a better option in this case).
 Install Roboservers as a service using these commands:

ServiceInstaller.exe -i RoboServer.conf wrapper.ntservice.account=.\USER_NAME_HERE
wrapper.ntservice.password.prompt=true wrapper.ntservice.name="RoboServer10.7.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.7.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"

Use this method when:

  • the services for Management Console and RoboServer(s) will run as the same user, and user authentication IS NOT enabled on Management Console.
    Note: from version 11.1 authentication is always enabled in Management Console
  • you have multiple RoboServer services on the same machine, they run as the same user but need different configuration. E.g. one RoboServer registers to the Production cluster and the other to the Development cluster. In this case, the MC configuration needs to be specified in the service because the configuration from RoboServer settings is saved under the user's Application Data folder and if the services run as the same user it's not possible to set different configuration for each service.

 

For versions 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"

 

Extra Notes

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

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

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

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

  5. 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"

    To troubleshoot this, please refer to this article

Level of Complexity 

Moderate

 

Applies to  

Product Version Build Environment Hardware
Kofax RPA  ALL      

References

 

 

Article # 3035330
  • Was this article helpful?