Single User

Clear (default)

Select for direct connection to the Automation Desktop from Design Studio or when using the RDP connection.

"singleUser"

false (default)

true

Set to false to automatically register the Desktop Automation Service with the specified Management Console.

For direct connection to the Automation Desktop , set to true and specify a token.*

Host name

"hostName"

Name or IP address of the computer running the Desktop Automation Service.

If a computer has multiple names or IP addresses, specify the one that RoboServers and Design Studio contact this Desktop Automation Agent with. That is, the host name or IP address must be reachable from RoboServers and Design Studio.

Command port

"commandPort"

49998 (default)

Reassign this port for the Automation Desktop if necessary.

Stream port

"streamPort"

49999 (default)

This port is used to send data between Design Studio and Desktop Automation Service. If streamPort is set to "0", the Desktop Automation Service selects a random port number.

You might need to reassign the streamPort if there is a firewall between Design Studio and the Automation Desktop .

CA file

"caFile"

empty (default)

You can communicate with the Management Console using SSL. If the default certificate in node.js is not used, you can specify a path to another certificate file using this parameter. Note that you need to have a root certificate for this to work. To save a root certificate in a file from a Google Chrome browser, do the following.

1. Right-click the lock icon in the address bar, and click Certificate (valid).

2. On the Certificate Path tab, select the top most (root) certificate, and click View Certificate.

3. On the Details tab, click Copy to File, then complete the wizard to export the root certificate as a base-64 encode X.509 certificate.

Now you can specify the path to the file with exported certificate.

Timeout

"commandTimeout"

This option specifies the timeout for command execution in seconds. A command is an instruction sent to Automation Desktop , such as click mouse button, open application, add a location found guard, and so forth. If a command cannot be completed in a specified time, the service sends a notification and execution of the robot stops.

Note that in case of a Location Found guard, this setting applies to invoking the guard in the workflow, but waiting for the guard to be satisfied is not bound to this timeout and can wait forever. Similar situation occurs when using the Move Mouse and Extract steps. The commands must be invoked on the device withing the timeout specified in this field, but the robot waits for up to 240 seconds for the commands to complete.

The command timeout for automating terminals or browsing websites in Desktop Automation Workflow is set either on the Desktop Automation tab of the Design Studio Settings window for executing the workflow in Design Studio, or in the Desktop Automation section on the Security tab of the RoboServer Settings window for roboserver execution.

Token on Single User tab

"token"

empty (default)

If the "singleUser" option is set to false, leave this option empty. If you use the direct connection to the Automation Desktop ("singleUser": true), specify a token. It can be any token you define.

Certificates tab

"tlsServerConfig"

Kofax RPA provides TLS communication between Automation Desktop and RoboServer or Design Studio. The communication uses certificates for encrypting the communication. The following is a server.conf file code extract. For more information see Use TLS Communication.

  "tlsServerConfig": {
    "key": "kapow.remote.das.pem",
    "cert": "kapow.remote.das.cert.pem",
    "ca": "./serverCa"
  },

Windows tab

"automationnative"

• "useLegacy"

  In some situations, the Java Access Bridge does not work and it can help to switch to legacy mode. Default is false.

• Installed packages

  Lists Desktop Automation Service packages installed on this computer. Starting from version 10.7, new version packages are installed automatically if the Lock package option below is not selected. The packages in ZIP files are installed to C:\ProgramData\Kofax RPA on the automated computer. The appropriate package is selected automatically depending on the RoboServer version. If you want to specify only one version package to be used, select Lock package and select one of the installed packages.

• Lock package

  When selected you can choose a version package as the only one to work with. A RoboServer with a different version cannot connect to this service. Default: the option is clear or false in the server.conf file.

  Select this option or change the setting to true in the server.conf file to run robots with triggers.

• Map RFS share to drive letter

  The Windows drive that the Robot File System file share is available in. When the file share is mapped to a Windows drive, other Windows applications can also access this file share.

OCR tab

"ocrConfig"

"defaultLanguage": "eng"

Specifies a language to perform an OCR operation. By default, Kofax RPA installs the English language. See Change Default OCR Language for language installation instructions.

System tab

This tab helps you open the log file to examine for any errors and shows the version and location of the service file. Using this tab, you can check whether Java Access Bridge is properly installed on the computer where the service is running.

MC Path

Connection protocol, name or IP address, port number, and path of the Management Console the device must register with. The format is as follows:

http://10.10.0.136:50080.

"hostName"

Name or IP address of the Management Console the device must register with.

"port"

Connection port of the specified Management Console.

"schema"

Connection protocol of the specified Management Console.

"path"

empty (default)

The part of the path to the standalone Management Console after the port number. For example, if your Management Console is deployed on Tomcat at http://computer.domain.com:8080/ManagementConsole/, specify "/ManagementConsole/" in this parameter. Leave this parameter empty for the embedded Management Console installation.

User name

"user"

empty (default)

User name to authenticate on the specified Management Console.

Password

"password"

empty (default)

Password to authenticate on the specified Management Console.

Cluster

"cluster"

Production (default)

Cluster name on the specified Management Console.

Labels

"labels"

"label1,label2" (default)

Labels to distinguish the automation devices.

Ping interval (ms)

"pingInterval"

5000 (default)

Time interval for the Desktop Automation Service to ping the Management Console.

Use proxy to connect to Management Console

"useProxy"

Select this option for the Desktop Automation Service to use proxy when connecting to Management Console. All necessary parameters are specified in the following fields.

Under Linux, you can set up proxy parameters in the managementConsole section of the server.conf file.

    "useProxy": true,
    "proxyHostName": "proxyhost.com",
    "proxyPort": 9000,
    "proxyUserName": "username",
    "proxyPassword": "pwd"