Kofax RPA 11.5.0 Installation guide

Kofax RPA

Installation Guide

Version: 11.5.0

Date: 2023-10-02

Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other

trademarks are the property of their respective owners. No part of this publication may be

reproduced, stored, or transmitted in any form without the prior written permission of Kofax.

Table of Contents

Preface..................................................................................................................................................... 5

Related Documentation........................................................................................................................5

Offline Documentation..............................................................................................................7

Training................................................................................................................................................. 10

Getting help with Kofax products.................................................................................................... 10

Chapter1:Dependencies and Prerequisites.................................................................................... 12

Chapter2:Install Kofax RPA.............................................................................................................. 18

Install on Windows............................................................................................................................. 19

Install Desktop Automation Service......................................................................................20

Install Document Transformation Components.................................................................. 22

Install Kapplets.........................................................................................................................34

Install on Linux....................................................................................................................................43

Silent Installation on Windows......................................................................................................... 44

Install and Configure CyberArk.........................................................................................................45

Important Folders in Kofax RPA....................................................................................................... 48

White-label Kofax RPA........................................................................................................................ 50

Chapter3:Provide License Information...........................................................................................52

License keys......................................................................................................................................... 52

Kofax TotalAgility license servers..................................................................................................... 52

Configuration inputs................................................................................................................53

High availability considerations.............................................................................................54

Configuring via properties file............................................................................................... 54

Configuring via a Docker file................................................................................................. 55

Management Console server functionality..................................................................................... 56

Concurrent Robot Execution (CRE) licensing...................................................................................56

Kofax RPA Compute Units (KCU) licensing...................................................................................... 57

Design Studio licensing......................................................................................................................58

Chapter4:Switch Display Language for Management Console and Design Studio....................60

Chapter5:Kofax RPA Initial Configuration......................................................................................62

Chapter6:Quick Start Guide............................................................................................................. 63

Install the software.............................................................................................................................63

Start Management Console and RoboServer................................................................................. 63

Access Management Console and enter license key..................................................................... 64

Configure Management Console settings.......................................................................................64

3

Kofax RPA Installation Guide

Management Console authentication..............................................................................................65

Configure Management Console before running robots..............................................................66

Build Robots.........................................................................................................................................69

Upload Robots..................................................................................................................................... 69

Run robots............................................................................................................................................69

4

Preface

This guide, which explains how to install Kofax RPA in a development environment, covers both

interactive and "silent" installation procedures for Windows, as well as standard and "headless"

procedures for Linux.

 If you plan to install Kofax RPA in a production environment, see the Administrator's Guide.

In a production environment, we strongly recommend deployment of the Management Console on

a stand-alone Tomcat server. This recommendation is based on, but not limited to the following.

• Derby is used as a system database in embedded mode, which is not recommended for

production environment.

• Management Console on Tomcat:

• Can use an enterprise class database for improved performance and data security.

• Can integrate with LDAP and SAML.

• Tomcat can be configured to customer requirements.

This guide describes:

• How to install Kofax RPA, either interactively or "silently" (without user interaction).

• How to enter license information so that you can start Kofax RPA.

• How to configure Kofax RPA.

• How to set up Kofax RPA server applications to start automatically when the computer restarts.

Related Documentation

The documentation set for Kofax RPA is available here:1

https://docshield.kofax.com/Portal/Products/RPA/11.5.0-nlfihq5gwr/RPA.htm

You can also access individual guides and online help directly from Kofax RPA. When you click the

help button in Design Studio, Management Console, Desktop Automation Service and Process

Discovery, online documentation appears in a new browser window.

 If the security policy for your organization restricts Internet access or the Internet connection

is not stable, you can access the documentation in offline mode while using the product.

In addition to this guide, the documentation set includes the following items:

1You must be connected to the Internet to access the full documentation set online.

5

Kofax RPA Installation Guide

Kofax RPA Release Notes

Contains late-breaking details and other information that is not available in your other Kofax RPA

documentation.

Kofax RPA Technical Speciﬁcations

Contains information on supported operating systems and other system requirements.

Kofax RPA Upgrade Guide

Contains instructions on upgrading Kofax RPA and its components to a newer version.

Kofax RPA Administrator's Guide

Describes administrative and management tasks in Kofax RPA.

Kofax RPA Help

Describes how to use Kofax RPA. The Help is also available in PDF format under the title of Kofax RPA

User's Guide.

Kofax RPA Best Practices Guide

Offers recommended methods and techniques to help you optimize performance and ensure

success while using Robot Lifecycle Management in your Kofax RPA environment.

Kofax RPA Getting Started with Robot Building Guide

Provides a tutorial that walks you through the process of using Kofax RPA to build a robot.

Kofax RPA Getting Started with Document Transformation Guide

Provides a tutorial that explains how to use Document Transformation functionality in a Kofax RPA

environment, including OCR, classification, extraction, field formatting, and validation.

Kofax RPA Desktop Automation Service Guide

Describes how to configure the Desktop Automation Service required to use Desktop Automation

on a remote computer.

Kofax RPA Developer's Guide

Contains information on the API that is used to execute robots on the RoboServer.

Kofax RPA Integration API documentation

Contains information about the Kofax RPA Java API and the Kofax RPA .NET API, which provide

programmatic access to the Kofax RPA product. The Java API documentation is available from both

the online and offline Kofax RPA documentation, while the .NET API documentation is available only

offline.

6

Kofax RPA Installation Guide

 The Kofax RPA APIs include extensive references to RoboSuite, the original product name. The

RoboSuite name is preserved in the APIs to ensure backward compatibility. In the context of the

API documentation, the term RoboSuite has the same meaning as Kofax RPA.

Offline Documentation

To make the documentation available for use in offline mode, obtain the documentation files from

the Kofax RPA product package that you downloaded from the Kofax Fulfillment Site. The product

package includes the following documentation files for offline use:

• KofaxRPADocumentation_11.5.0_EN.zip

Contains the entire Kofax RPA documentation set in English.

• KofaxRPADocumentation_11.5.0_JA.zip

Contains the entire Kofax RPA documentation set in Japanese.

• KofaxRPADocumentation_11.5.0_FR.zip

Contains the entire Kofax RPA documentation set in French.

• KofaxRPAManagementConsoleDocumentation-11.5.0.zip

Contains the documentation for Management Console and Kapplets in English, Japanese, and

French.

After you install the Kofax RPA product, follow these steps:

1. Extract the contents of the KofaxRPADocumentation ZIP file for the language you require to a

location on your computer.

Then, rename the extracted folder to either EN, JA, or FR, depending on the language code

specified in the .zip file name. For example, KofaxRPADocumentation_11.5.0_EN must be

renamed to EN.

The extracted folder for each language contains the following folders:

• api

• help

• print

• Resources

2. Extract the contents of the KofaxRPAManagementConsoleDocumentation ZIP file to a location

on your computer.

You do not need to rename the extracted folder.

The extracted folder contains the KofaxRPAManagementConsoleDocumentation.war file that

includes the documentation in all of the three languages.

When the offline documentation is installed for an RPA component according to the instructions

below, the component will use the offline version of the documentation by default, even if an active

Internet connection exists.

7

Kofax RPA Installation Guide

Offline API documentation

The api folder that you extracted from either of the KofaxRPADocumentation ZIP files contains the

API references in English. You can access the RoboSuite Java and RoboSuite .NET API documentation

from this folder.

Offline documentation for Design Studio

1. Navigate to the location where you renamed the extracted documentation folder.

2. Copy the EN, JA, or FR folder to the documentation folder inside the product files:

Example: C:\Program Files\Kofax RPA 11.5.0.0\documentation

3. Start Design Studio and navigate to Settings> Design Studio Settings.

4. On the General tab, in Documentation location, select Offline on the list.

5. Save the changes.

To switch to online mode, select Online in Design Studio Settings and save the changes.

 If you try to access the online documentation from Kofax RPA without Internet access, the

Retrieving help and documentation warning is displayed. If you select Do not show this

notification again and later you want to reset this option, select Show documentation retrieval

notifications on the General tab in Design Studio Settings.

Offline documentation for Management Console

1. Navigate to the location that contains the extracted

KofaxRPAManagementConsoleDocumentation.war file.

The .war file includes the documentation in all of the three languages, and the documentation

to use will depend on the language that the Management Console is set to.

2. Copy the file to:

C:\<Tomcat installation folder>\Tomcat <version>\webapps

3. Start the Management Console.

4. Open Settings> General> Base URL.

5. Select Use local documentation. In Local documentation base URL, specify the URL to the

Tomcat website containing the documentation.

Example: http://localhost:8080/KofaxRPAManagementConsoleDocumentation

6. Save the changes.

You may need to refresh the Management Console for the changes to take effect.

To switch to online mode, clear Use local documentation in the Base URL settings and save the

changes.

8

Kofax RPA Installation Guide

Offline documentation for Desktop Automation Service

1. Navigate to the location where you renamed the extracted documentation folder.

2. Copy the EN, JA, or FR folder to the documentation folder inside the product files:

Example: C:\Program Files\RPA DesktopAutomation 11.5.0.0\documentation

To switch to online mode, delete or move the documentation folder from the RPA

DesktopAutomation 11.5.0.0 folder.

Offline documentation for Process Discovery

1. In each of the installation folders, create a new folder called documentation. The actual path

to the folders may be different.

•Example: C:\Program Files (x86)\Kofax RPA Process Discovery Agent

11.5.0.0

•Example: C:\Program Files (x86)\Kofax RPA Process Discovery Analyzer

11.5.0.0

2. Navigate to the location where you renamed the extracted documentation folder.

Copy the EN, JA, or FR folder to the newly created documentation folders.

To switch to online mode, rename, delete or move the documentation folder from the Kofax

RPA Process Discovery Agent 11.5.0.0 and Kofax RPA Process Discovery Analyzer

11.5.0.0 folders.

Offline documentation for Kapplets

The offline documentation for Kofax RPA Kapplets is contained in the

KofaxRPAManagementConsoleDocumentation.war file that you have already copied to the Tomcat

installation folder. To use the Kapplets documentation in offline mode, follow these steps.

1. Depending on whether Kapplets are installed in embedded mode, on Tomcat, or on Docker,

configure the required properties in the respective configuration file. For information on each

installation scenario, see "Install Kapplets" in the Kofax RPA Installation Guide.

• Embedded mode. Create an application-help.properties file using the following

template and place it next to the application.properties file in the folder where

Kapplets are run.

kapplets.services.mc.connection.url=http:// <host-url>:<port>/ManagementConsole

kapplets.services.mc.connection.username=<username>

kapplets.services.mc.connection.password=<password>

kapplets.services.help.languages-map[en]=EN

kapplets.services.help.languages-map[ja]=JA

kapplets.services.help.languages-map[fr]=FR

kapplets.services.help.base-url=http://:/KofaxRPAManagementConsoleDocumentation/

@@language@@/help/rpa_help/help_main/kapplets

kapplets.services.help.landing-url=http://:/

KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/

kapplets/c_rpakappletsmain.html

9

Kofax RPA Installation Guide

 In this scenario, the offline documentation can be used only if the Management Console

is deployed on Tomcat.

• On Tomcat. To the kapplets.xml file, add the following properties at the end of the file.

<Environment name="kapplets.services.help.languages-map[en]" value="EN"

type="java.lang.String" override="false"/>

<Environment name="kapplets.services.help.languages-map[ja]" value="JA"

type="java.lang.String" override="false"/>

<Environment name="kapplets.services.help.languages-map[fr]" value="FR"

type="java.lang.String" override="false"/>

<Environment name="kapplets.services.help.base-url" value="http://

<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/

rpa_help/help_main/kapplets" type="java.lang.String" override="false"/>

<Environment name="kapplets.services.help.landing-url" value="http://

<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/

rpa_help/help_main/kapplets/c_rpakappletsmain.html" type="java.lang.String"

override="false"/>

• On Docker. In the docker-compose.yml file, add the following properties at the end of the

file.

- KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[en]=EN

- KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[ja]=JA

- KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[fr]=FR

- KAPPLETS_SERVICES_HELP_BASE-URL=http://<host-url>:<port>/

KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets

- KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/

KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets/

c_rpakappletsmain.html

2. Save the file. If Kapplets are installed on Tomcat and you adjusted the kapplets.xml file, you

may need to restart the Tomcat server for the changes to take effect.

To switch to online mode, delete the added properties from the configuration file, save the changes,

and restart the server.

Training

Kofax offers both classroom and computer-based training to help you make the most of your Kofax

RPA solution. Visit the Kofax Education Portal at https://learn.kofax.com/ for details about the

available training options and schedules.

Also, you can visit the Kofax Intelligent Automation SmartHub at https://smarthub.kofax.com/ to

explore additional solutions, robots, connectors, and more.

Getting help with Kofax products

The Kofax Knowledge Portal repository contains articles that are updated on a regular basis to

keep you informed about Kofax products. We encourage you to use the Knowledge Portal to obtain

answers to your product questions.

10

Kofax RPA Installation Guide

To access the Kofax Knowledge Portal, go to https://knowledge.kofax.com.

 The Kofax Knowledge Portal is optimized for use with Google Chrome, Mozilla Firefox, or

Microsoft Edge.

The Kofax Knowledge Portal provides:

• Powerful search capabilities to help you quickly locate the information you need.

Type your search terms or phrase into the Search box, and then click the search icon.

• Product information, configuration details and documentation, including release news.

To locate articles, go to the Knowledge Portal home page and select the applicable Solution

Family for your product, or click the View All Products button.

From the Knowledge Portal home page, you can:

• Access the Kofax Community (for all customers).

On the Resources menu, click the Community link.

• Access the Kofax Customer Portal (for eligible customers).

Go to the Support Portal Information page and click Log in to the Customer Portal.

• Access the Kofax Partner Portal (for eligible partners).

Go to the Support Portal Information page and click Log in to the Partner Portal.

• Access Kofax support commitments, lifecycle policies, electronic fulfillment details, and self-

service tools.

Go to the Support Details page and select the appropriate article.

11

Chapter 1

Dependencies and Prerequisites

This chapter lists components and required configuration settings to use different Kofax RPA

features. For information on supported platforms and versions, see the Kofax RPA Technical

Speciﬁcations document on the Kofax RPA Product Documentation site: https://docshield.kofax.com/

Portal/Products/RPA/11.5.0-nlfihq5gwr/RPA.htm.

Real-time data: If you have a solution where users are waiting for results in real-time, CPU speed is

normally the bottleneck, and you should buy the fastest CPU available for your hardware platform.

Dedicated hardware: For best performance, we recommend that you always run RoboServer,

Management Console, or Document Transformation Service each on dedicated hardware. That

means that you should not run database servers and other services on the same hardware with

your RoboServer, Management Console, or Document Transformation Service.

Any email field in Kofax RPA can contain up to 255 characters. Do not exceed the number of

characters in the email field.

Windows installation prerequisites

If you get the error: "Module <modulename> not found," install the following update.

https://support.microsoft.com/en-us/kb/2999226

Note that <modulename> can be "automationnative", "cef" or any other Kofax RPA module

name.

If the Windows update is not available on your system, use the following workaround.

1. Create a c:\temp\976571 folder.

2. Use the following command to extract the contents of the MSU file:

Expand -F:* c:\kb976571\Windows6.1-KB976571-v2-x64.msu c:\temp\976571

This command extracts multiple files, from Windows6.1-KB976571-v2-x64.cab.

3. Run the following command:

DISM.exe /Online /Add-Package /PackagePath:c:\temp\976571\Windows6.1-

KB976571-v2-x64.cab

For more information, see How to use DISM to install a hotﬁx from within Windows on the Microsoft

Technet website https://blogs.technet.microsoft.com.

If text shows as boxes in Kofax RPA applications, you are missing the fonts required to render this

text. Windows installs only a limited set of fonts based on the language of the installation media.

Additional fonts must be enabled as Supplemental Font features through the Manage Optional

Features tool.

12

Kofax RPA Installation Guide

 To display Thai script correctly, enable both the Thai Supplemental Font feature and the Lao

Supplemental Font feature.

Linux installation dependencies

Currently, Ubuntu version 20.04 LTS is supported.

Design Studio and RoboServer require the following packages to be installed:

• libc6

• libglib2.0-0

• libnss3

• libnspr4

• libatk1.0-0

• libatk-bridge2.0-0

• libcups2

• libdrm2

• libx11-6

• libxcomposite1

• libxdamage1

• libxext6

• libxfixes3

• libxrandr2

• libgbm1

• libexpat1

• libxcb1

• libxkbcommon0

• libdbus-1-3

• libpango-1.0-0

• libcairo2

• libasound2

• libatspi2.0-0

• libgcc-s1

• libffi7

• libpcre3

• zlib1g

• libmount1

• libselinux1

• libxrender1

• libxau6

• libxdmcp6

• libsystemd0

13

Kofax RPA Installation Guide

• libblkid1

• libpcre2-8-0

• libbsd0

• liblzma5

• liblz4-1

• libgcrypt20

• libgpg-error0

• xvfb

• libsqlite3-0

• libglx0

• libglvnd0

• libgl1

• libgssapi-krb5-2

Also, make sure that you install all the necessary fonts on a headless Linux server for the WebKit-

based browser robots to work.

Databases

 Create and maintain the Kofax RPA product databases according to the recommendations in

the product documentation. If you are considering database modifications or customizations, do

not proceed without consulting Kofax; otherwise, the results are unpredictable and the software

may become inoperable.

You can use Microsoft SQL Server with integrated Windows Authentication as a logging (logdb)

database only in the following cases:

 Microsoft SQL Server with integrated Windows Authentication cannot be used as a logging

(logdb) database when you run Management Console and RoboServer in embedded mode.

Also, make sure that SQL Server Authentication of the Microsoft SQL Server is disabled.

• Both Management Console and RoboServer must run only on a Windows platform.

• Management Console must be installed on a Tomcat server.

• The JDBC driver, including DLLs, must be manually installed into both Management Console and

all RoboServer installations without using the JDBC distribution mechanism in the Management

Console.

Oracle Connection URL must use ${ServerName}:${Schema}. Using ${ServerName}:

${ServiceName} is not supported.

Be aware that loss of data may occur when storing data in Oracle, Sybase or MySQL. On Oracle, an

empty string is converted to null. On Sybase, an empty string is converted to " " (a single space).

On MySQL, millisecond precision is lost when storing dates. For details, see the ObjectKey Caveats

section in the Storing Data in Databases topic in the Kofax RPA Help.

14

Kofax RPA Installation Guide

 While MySQL provides two types of SHA-256 hashing for user account passwords,

sha256_password and caching_sha2_password, caching_sha2_password is not supported with

Kofax RPA.

 For correct display of data in the Kofax Insight Dashboard, make sure Java correctly sets the

time according to your time zone on RoboServers and computers running Management Consoles.

See the Timezone Data Versions in the JRE Software on the Oracle web site for the latest updates in

time zones. If necessary, use the Timezone Updater Tool to update the time zone information.

Document Transformation prerequisites and limitations

Install all the latest Windows updates before installing and using Kofax RPA Document

Transformation.

Prerequisites

The maximum document size for transformation is 100 MB. Kofax RPA imposes a file size limit

for a transformed document to enable protection against the denial-of-service attacks. You

can lower the file size value to protect against such an attack. To change the document size

limit, edit the following parameter in the Web.config file in the Kofax DTS\Transformation

Services directory in the Kofax RPA installation folder.

The following are other requirements you need to observe.

• Do not install Kofax RPA Document Transformation on the computer running Kofax

Transformation or Kofax TotalAgility.

• You can re-use existing KTM, KTT, and RTTI projects version 6.2 or earlier.

• You cannot re-use KTA projects, because KTA does not provide a way to export a KTA

Extraction/Classification group to a complete .fpr file.

Limitations

The following features are not supported.

• Rich client user modules (Doc Review, Validation, Verification, Correction)

• ThinClient user modules other than validation (Verification and Correction)

• Multiple steps of Validation

• Configuration Sets for migration between systems

• A2iA engines

• Reporting settings

Desktop Automation requirements and prerequisites

The following sections list components that must be installed and configured on the automation

devices (remote computers you want to automate) before you can use the Desktop Automation

feature in Kofax RPA.

Remote computer requirement

The Desktop Automation Service must be installed on a different computer than the RoboServer

that it connects to. If the RoboServer and Desktop Automation Service are installed on the same

computer, only one robot can run at a time.

15

Kofax RPA Installation Guide

Java Access Bridge

To automate Java programs or Java applets on remote devices with Kofax RPA, install Java

version required by the application being automated on your device and enable the Java Access

Bridge in the Java Runtime Environment used by the application. We recommend using the

latest available Java version.

For JRE 7 or newer

To enable Java Access Bridge for Java version 7 or newer, navigate to the bin directory in the

Java installation directory and run the following command.

jabswitch -enable

For JRE6

Follow this procedure to install Java Access Bridge 2.0.2. For older applications that require

Java version 1.6, copy the following files to the specified destination directories, where

%WINDOWSHOME% is the directory where Microsoft Windows is installed (for example,

C:\WINDOWS), and %JAVAHOME% is the directory where your JDK or JRE is installed. The

following are examples of directory names for Java SE 6 Update 24.

•JDK: C:\Program Files\Java\jdk1.6.0_24\jre

•JRE: C:\Program Files\Java\jre6

The following table lists Java Access Bridge Windows libraries and related files.

Java Access Bridge File Destination Directory

WindowsAccessBridge-32.dll %WINDOWSHOME%\SysWOW64

WindowsAccessBridge-64.dll %WINDOWSHOME%\SYSTEM32

JavaAccessBridge.dll %JAVAHOME%\bin

JAWTAccessBridge.dll %JAVAHOME%\bin

accessibility.properties %JAVAHOME%\lib

access-bridge.jar %JAVAHOME%\lib\ext

jaccess.jar %JAVAHOME%\lib\ext

For more information, search the Downloads page on the Oracle website ( http://

www.oracle.com/technetwork/java/javase/downloads/) to locate and download jab-2-0-2.

Perform the following to test that you have installed Java Access Bridge properly.

1. Run the SwingSet2 application and then run the JavaMonkey.exe application.

2. Select File> Refresh Tree in the Java Monkey application and the SwingSet2 application

should appear.

Alternatively, you can use the JavaFerret.exe application.

WebDAV Redirector

When using the Robot File System on a computer where the Desktop Automation Service

is installed, to be able to connect to the service, you require the WebDAV Redirector. Some

operating systems do not include WebDAV by default, so you need to manually install it.

For a Windows Server 2022, check the WebDAV Redirector option.

16

Kofax RPA Installation Guide

Requirements for Linux-based platforms

Make sure your computer has all the necessary packages and libraries installed. To do so, see

"Kofax RPA Design Studio and RoboServer for Linux" in the Kofax RPA Technical Speciﬁcations.

Prerequisites for Microsoft Edge in Internet Explorer mode

If you use Microsoft Edge in Internet Explorer mode, check the following requirements to

automate Internet Explorer 11.

• Check that a FEATURE_BFCACHE subkey with a DWORD value named iexplore.exe is

present in the registry on the target computer. This subkey enables the driver to maintain a

connection to the instance of Internet Explorer it creates. For 64-bit Windows, examine the

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Internet Explorer\Main

\FeatureControl\FEATURE_BFCACHE key. If the FEATURE_BFCACHE subkey is not present,

create it and create a DWORD value named iexplore.exe with the value "0" in the key.

• Set the browser zoom level to 100% to align the native mouse events with the correct

coordinates.

SAP prerequisites

To automate an SAP application, enable scripting on both the server and the client sides.

• On the client, go to SAP GUI Options and enable scripting. Also, turn off notifications,

because they interrupt the automation process.

• To enable scripting on the SAP server, perform the following steps. Note that you must have

administrative privileges to change the sapgui/user_scripting parameter.

1. Log in to your SAP server.

2. Run transaction RZ11. Specify the parameter name sapgui/user_scripting and click

Display. If Parameter name is unknown appears in the status bar, it indicates that

you are missing the current support package. Check your installed packages.

3. Change the value to TRUE.

4. Click Save.

Note that some elements, such as scroll bars, are only available if you run the SAP client on a

machine with a Windows Classic desktop theme.

Enable integration with SAP

To work with the SAP application in Robots, from the product installation files, download and

save the RegSAPSurrogate.reg file on the computer running the Desktop Automation Service.

Run it accepting any warnings and then restart the Desktop Automation Service agent. The file

resides in the {path}\DesktopAutomationService\bin folder.

17

Chapter 2

Install Kofax RPA

This chapter describes how to install Kofax RPA on a single computer in a developer environment.

See the Administrators Guide for installation and deployment in a production environment.

The complete installer is delivered as a .zip file. For the Windows platform, Kofax RPA has five

installers that install different components of the software:

• Kofax RPA Design Studio installer: Installs Design Studio, but does not install RoboServer,

Management Console or API. Use this installer if you have a central Management Console/

License Server and need a separate copy of Design Studio.

• Kofax RPA RoboServer installer: Installs RoboServer only and does not install Management

Console or Design Studio. This installer is useful, if you need to set up dedicated RoboServer

machines.

• Configurable full Kofax RPA installer: Installs all of the core components, including Git

Synchronizer, or selected components that you specify.

• Kofax RPA Desktop Automation installer: Installs the Desktop Automation Agent to automate

remote devices.

• Kofax RPA DTS (Document Transformation Service) installer: Installs the Kofax RPA Document

Transformation components.

This installer contains the following components required to run:

• Document Transformation Project Builder

• Kofax Licensing Server

• Document Transformation Services

• Document Transformation Thin Client Server

• Document Transformation Standard Projects

• Document Transformation Service Scheduler

Prerequisite: Prior to unzipping the software archive file, right-click the .zip file and unblock it to

prevent issues during installation. Disregard this step if the Unblock option is not displayed.

18

Kofax RPA Installation Guide

Silent Installation

As another option, you can perform a silent installation. If you run a silent installation of the full

installer, you get the "Typical" install. See Silent Installation on Windows for details.

For Linux, Kofax RPA provides a full installer as well as the DEB package for installing RoboServer as

a service. See Install on Linux for details.

Upgrade from Earlier Versions

In the interest of stability, different versions of Kofax RPA may be installed side by side on the same

computer without interfering with each other (except that they must be configured to use different

port numbers for the Management Console if run simultaneously). This means that you can install a

newer version and get acquainted with it while still doing your daily work with the older version.

You can copy important data such as uploaded robots, execution schedules and so on from

one version of Management Console to another by making a backup of the old installation and

"restoring" it into the new one. Making a backup varies in different versions of Kofax RPA, so check

help or User's Guide to learn how to create a backup.

For more information about upgrade procedures, see the Kofax RPA Upgrade Guide.

 Effective since Kofax RPA version 10.3, any admin user can restore a backup created by any

other admin user.

Install on Windows

The complete Kofax RPA installer provides the following installation options. Optional items are

listed with an asterisk.

• Design Studio: Installs Design Studio and its required components

• RoboServer: Installs RoboServer

• Embedded Management Console: Installs components needed to run an embedded

Management Console on the RoboServer

• Management Console: Creates the WAR file for manual installation of the Management Console

• SQL scripts for database tables

• API*: Installs necessary API components

The following files install separate Kofax RPA components.

• If you are installing Design Studio only, download and save the

KofaxRPADesignStudio-11.5.0.0.msi file to your hard disk. After the download is completed,

run the file to start the installation and follow the installer prompts.

• To install a RoboServer, download and save the KofaxRPARoboServer-11.5.0.0.msi file to

your hard disk. After the download is completed, run the file to start the installation and follow

the installer prompts.

• To install the Desktop Automation Service, download and save the

KofaxRPADesktopAutomationService-11.5.0.0.msi file. After the download is completed,

19

Kofax RPA Installation Guide

run the file on the computer you want to automate and follow the installer prompts. For more

information, see Install Desktop Automation Service.

As another option, you can use the silent installation to automate the installation process.

 You need administrator rights to install Kofax RPA on Windows.

Install Desktop Automation Service

To install the Desktop Automation Service, download and save the

KofaxRPADesktopAutomationService-11.5.0.0.msi file to your hard disk. After the download

is completed, run the file on the computer you want to automate to start the installation. The

Desktop Automation Service is installed in autostart mode. Note that you do not need to install the

Desktop Automation Service to automate terminals.

 To avoid a conflict of resources, do not install the Desktop Automation Service on the same

local computer as Design Studio, unless you intend to use the Local Desktop Automation feature,

which is primarily for demonstration purposes. For more information, see "Configure local

Desktop Automation Service" in the Kofax RPA Help.

 Do not install the Desktop Automation Service on the same computer as the RoboServer

that it connects to. If the RoboServer and Desktop Automation Service are installed on the same

computer, only one robot can run at a time.

Install the virtual input driver

During the Desktop Automation Service installation, you can install the virtual input driver, which is

a Windows device driver that simulates hardware keyboard and mouse. To install it, select Install

the virtual input driver on the Virtual input driver step of the installer. The driver is supported by

64-bit versions of Windows 8.1 and Server 2012 or later.

The driver is not installed by default. To install the virtual input driver from command-line, such

as during the silent installation, specify the INSTALLINPUTDRIVER=1 parameter. Note that when

the driver is installed for the first time, Windows prompts to confirm a device installation even

when running as Administrator. To avoid this prompt during an unattended installation, add the

certificate to the Windows Trusted Publishers store beforehand. You can install the certificate from

the InputDriver.cat file, located in the DesktopAutomationService\bin\inputdriver

directory under the Kofax RPA Desktop Automation Service installation directory.

To enable the virtual input driver for keyboard and mouse operations on the automated computer,

set the environment variable KOFAX_RPA_VIRTUAL_INPUT to Y. To cancel the virtual input driver

usage, set the environment variable to N.

For compatibility, the variable KAPOW_KEYBOARD_INPUT_METHOD, which was used to enable the

keyboard, is preserved, but KOFAX_RPA_VIRTUAL_INPUT should be used instead.

To uninstall the driver and its devices, uninstall the Desktop Automation Service. Do not modify,

disable or remove the devices through Windows Device Manager, as it may cause issues during

robot runs.

20

Page is loading ...

Kofax RPA 11.5.0 Installation guide

Kofax RPA 11.5.0 Installation guide

Related papers

Other documents