Skip to main content

***Archive*** Kapow / Kofax RPA Upgrade Procedure_KCSFormat

Article # 3035409 - Page views: 276

Archived KB - doesn't account for being able to upgrade gradually i.e. keeping old version RoboServers

Use the Upgrade Guide instead.


What is the procedure to upgrade Kofax RPA?


Upgrading your Kapow / Kofax RPA environment includes upgrading ALL the components used:

  • Management Console,
  • RoboServer(s),
  • Design Studio(s),
  • Desktop Automation Service(s) (DAS)
  • Document Transformation Service(s) (DTS)
  • any Java or .net applications that are working with robots.

Kofax recommends to first install the new version in a test environment to make sure all the robots run correctly before installing the new version in production.


NOTE: It is possible to run two different versions of Kapow /Kofax RPA on the same machine, at the same time, as long as they are using different ports. Therefore, the new version can be tested on the same machine as the current version such that production is not affected. When testing is completed and you are ready to start using the new version you can shutdown the old version, change the ports for the new version and start it. This way, the users will be able to use the same old ports to access the new version of Kapow / Kofax RPA (please consult the Admin Guide for instructions on how to change RoboServer/Management Console ports). Additional Note for DAS: Keep in mind that the Desktop Automation Service is added to the Windows startup list. Therefore, if you have multiple versions of DAS and want to start one or the other, disable the older version in Windows startup (so that it won't start when the machine is rebooted).


IMPORTANT: When running two version of Kapow /KofaxRPA on the same machine at the same time, please take into consideration the resources available on the machine and the amount allocated to Kapow /Kofax RPA (Management Console and/or RoboServer(s)).


Upgrading Management Console (embedded mode) and RoboServers

Before proceeding with the upgrade, download the new software.

Starting with v10.3 the license keys can be used in the next major versions, when upgrading.

For versions before 10.3 the existing keys were sufficient when upgrading to the same major version (e.g. to

  1. From the current Management Console --> Backup tab, create a backup of the current management console.
    File will be in the Users download folder (unless your web browser is prompting you for a location to save the file).
  2. Move the backup to the desktop for easy access.
  3. Close the Management Console browser window.
  4. Stop and disable Roboserver(s) service(s) if created.
  5. Stop and disable Management Console service if created.
  6. Install the new software. Follow the instructions from the Installation Guide.
    For version 9.4 and later the instructions are in Knowledgebase Article #12530 - Kapow Product Documentation (Master).
  7. Install the new Management Console and RoboServer services (if used). Follow the instructions from the Instructions and examples for installing RoboServer Services article.
  8. Make any needed configuration changes
    • RoboServer Settings configuration (or any changes in the files from the Application Data Folder /Configuration)
    • RoboServer.conf (e.g. to set memory) or common.conf (e.g. to change Application Data folder location)
    • cef.cfg (any customization to the CEF browser)
  9. Start the RoboServer(s) (service).
  10. Start the Management Console (service).
  11. Bring up the Management Console Web interface in a browser. It should be empty. Enter the license information.
  12. Restore the Management Console backup from the file created in step 1-2.

IMPORTANT Note: If you are Upgrading from a pre-9.2 version to a post-9.2 version, please read Knowledgebase article #13334 - Troubleshooting "Restore failed. The backup is too old" when restoring a Management Console backup. IMPORTANT: The full Management Console backup will backup ALL settings from the Management Console; besides the robots, types and settings it will backup: Cluster setup, RoboServer(s) name(s), Database mappings, Schedules and everything in the Admin-->Settings. Therefore, all this data will be restored in the new Management Console. After the restore, the following settings should be checked and changed if needed (please note that in version 10, the "Clusters" tab under "Admin" has been renamed to "RoboServers"): Admin --> Clusters: make sure the cluster name, KCU/CRE allocation are correct and the RoboServers are pointing to the correct servers (and ports). Admin --> Clusters --> Cluster settings: make sure the database mappings are correct (e.g. if this is a test Management Console, it might need to point to test databases, not the production databases). Repository --> Databases: if upgrading to a post-9.6 version, make sure you create the databases connections (for your database mappings already present in Admin -> Clusters -> Cluster Settings. Admin --> Settings --> RoboServer Log Database: make sure this is the correct database that this Management Console should be pointing to. Note1: If you are upgrading from a pre-9.5 version to version 9.5 or later and plan to use the same database for logs, please make sure you edit the Robot Run table structure. Please see Knowledge base article #12890 - Troubleshooting the "Could not load robot runs. Invalid column name 'BYTES'" message. Note1: If you are upgrading from a pre-10.3 version to version 10.3 or later and plan to use the same database for logs, please make sure you use a new database for logs. Please see Knowledge base article #307750: Schedule could not start - invalid object name 'SEQ GEN SEQUENCE Admin --> Settings --> Analytics Database: if Analytics was set up with the previous Management Console, make sure this is still the correct database to point to. Schedules: confirm which schedules should be Active (e.g. if this is a test Management Console, you might want to run all schedules manually until all robots are tested). for upgrades to v11: the Kapplets have been moved out from the Management Console and have to be set p separately (see Install Guide for more details). If Kapplets are installed, the backup will have to be restored on Kapplets as well.

13. Test the environment by running a robot from the repository and a schedule. If problems are encountered open a case via the portal with Technical Support.


NOTE: Starting in v10.4 it's possible to use "hybrid" clusters that can contain multiple versions of RoboServers (old and new version). This can be used for testing, during the migration. See the Upgrade Guides for more information. If your migration includes having multiple Roboserver versions in the same cluster, this is the time where you can start a RoboServer of the old version and register it to the new version Management Console.

Upgrading Management Console (deployed into Tomcat)

When Management Console is deployed into Tomcat, it has to be upgraded following the same steps as above except on step 7 the new Management Console has to be deployed in Tomcat.


IMPORTANT: For the new Management Console (ro new Kapplets v11.0 or later) , do NOT use the platform database from the previous version (the table structure in the new version might be different). Always create new databases for the new versions of Management Console or Kapplets.

Setting up the new Management Console in Tomcat can be done in a few different ways:

  • Tomcat service on a different machine than the old Management Console. In this case, the deployment process in exactly the same as for a brand new Management Console (see Admin Guide)
  • Tomcat service on the same machine as the old Management service, but a new service (e.g. upgrade Tomcat as well). In this case the deployment is again exactly the same as for a brand new Management Console (see Admin Guide). But the services can't run at the same time because of port conflict. If the services have to run at the same time, Tomcat ports have to be changed for the second service.
  • Use the same Tomcat service as for the previous Management Console. There are two options here:
    1. Keep both applications running, e.g. have both old and new MC accessible. In this case, the war file for the new MC has to be renamed, which means the new MC application name will be different.
      e.g. if the old MC was named "ManagementConsole" and was accessed using http://TomcatServer:port/MangementConsole, the new MC has to have a different name. For example "ManagementConsoleNew". Then it can be accessed at http://TomcatServer:port/ManagementConsoleNew
    2. Backup the old MC and deploy the new one. This can be done by backing up the old MC files which include:
      • the war file from Tomcat under /webapps
      • the application folder from Tomcat under /webapps (e.g. the "ManagementConsole" folder)
      • the application context XML file from Tomcat under /conf/Catalina/localhost (e.g. the ManagementConsole.xml file)

These files should be moved to a backup folder first. Then the new Management Console can be deployed instead following the deployment for a brand new MC (follow the Admin Guide)


  1. Customization in Management Console (e.g. HighAvailability, LDAP, SAML) has to be redone in the new Management Console. If the old Management Console war file already had these settings you can use the Configurator.jar to replicate these settings in the new Management Console war file (see the Admin Guide > "Configure Management Console WAR file")
  2. The same process can be applied for the Kapplets application deployed into Tomcat (for versions of RPA 11.0 and later).

Once the new Management Console is available, enter the license keys and then restore the backup from the old Management Console so all the content is brought over. The notes from the "Upgrading Management Console (embedded mode)" section apply here too.

Upgrading Design Studio(s), DAS or DTS

Since most of the settings are no longer stored in Design Studio / DAS / DTS, upgrading it is actually a new installation of the new version.

Once the new version is installed, start Design Studio / DAS / DTS and point it to the new Management Console to register (and, for Design Studio, to acquire a license).

Note: Starting in v10.7 DAS has an "easy upgrade" feature where the DAS will download the packages from the Management Console depending on the version of the RoboServer running the DA robot.

Upgrading the applications that work with robots

All Kofax RPA versions contain the libraries that are needed to develop applications that work with robots: .jar files for Java and .dll for .NET.
When Upgrading your Kofax RPA environment, if you have any applications that work with robots, you should also upgrade your applications such that they use the new libraries from the new version.


Level of Complexity 



Applies to  

Product Version Build Environment Hardware


Add any references to other internal or external articles


Article # 3035409
  • Was this article helpful?