Skip to main content

How to Migrate Kofax RPA Management Console and RoboServers

Article # 3035411 - Page views: 260


How to Migrate Kofax RPA Management Console and RoboServers


This article lists the process to follow to migrate Management Console and RoboServer(s) from one environment to another.


  1. the version of Kofax RPA does not change during the migration. For the Upgrade procedure see this Knowledgebase article.
  2. this procedure should be followed outside of business hours because the service will be unavailable at different times.

More Information: 

Migrating Management Console
  1. On the old Management Console create a full backup (from the Admin > Backup tab)
  2. Install the new Management Console. Follow the Installation Guide to install embedded Management Console or deploy Management Console in a standalone Tomcat. Configure services if needed.
    • If Embedded Management Console:
      When starting Management Console for the first time, it will create a new set of settings.
      To ensure the user settings for new MC are the same as for old MC, you can:
      • stop the Management Console
      • copy the mc.settings file from the Configuration folder of the Application Data folder of the old machine to the new machine.
        The default location of the Application Data folder is C:\Users\UserRunningMC\AppData\Local\Kofax RPA\<version>
      • Restart Management Console
    • If Management Console deployed into Tomcat:
      Please make sure that all Tomcat settings are correct. E.g. SSL, port (from server.xml) ManagementConsole configuration (Configuration.xml or login.xml)

      It's possible to connect the new Management Console to the database used by the old Management Console: the ManagementConsole.xml context file of the new Management Console should be configured to point to the old database. In this case, step 4 (restore backup) can be skipped.
  3. Stop old Management Console.
  4. On the new Management Console restore the backup created at step 1:
    • From Admin > Backup tab select "Restore Backup"
    • Select the backup file
    • Restore mode should be "Reset"

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 tab. 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: Admin > RoboServers: make sure the cluster name, KCU/CRE allocation are correct and the RoboServers are pointing to the correct servers (and ports). If RoboServers will be migrated as well then remove the RoboServers from the list. Admin > RoboServers > Cluster settings: make sure the database mappings are correct (e.g. if databases are being migrated too, the hostnames for the DB servers might need to be updated as well) Admin > Settings > RoboServer Log Database: make sure this is the correct database that this Management Console should be pointing to. 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)

Migrating RoboServer(s)
  1. Install new RoboServer(s) on the new machine. Configure services if needed (for commands and examples to install services see Knowledgebase article 12422)
  2. Configure the RoboServers:
    • start the RoboServers (to create the default user files, even if the RoboServer fails to start)
    • to ensure that the user settings on the new RoboServer(s) are the same as on the old ones, you can copy the roboserver.settings file from the Configuration folder of the Application Data folder of the old machine to the new machine.
      The default location of the Application Data folder is C:\Users\UserRunningRS\AppData\Local\Kofax RPA\<version>
    • Open RoboServer Settings with the user running the RoboServer service and verify that the url to which the RoboServer should register is correct.
    • restart the RoboServer service

      WARNING: If only Management Console is migrated, these last two steps have to be performed on the existing RoboServers anyway. This is to make sure the RoboServer(s) register to the correct Management Console. 2. Keep in mind that depending on how the RoboServer is started, the Management Console url and cluster could be specified in the command/service parameters. This should be checked as well.

  3. Stop old RoboServer service(s)
Design Studio Changes

If Management Console is migrated, all users using Design Studio will need to configure their connections to go to the host where the new Management Console is.

Desktop Automation Service Changes

All Desktop Automation Services that are in "Management Console" mode will need to be configured to connect to the new Management Console.


Level of Complexity 



Applies to  

Product Version Build Environment Hardware
Kofax RPA all      


Add any references to other internal or external articles


Article # 3035411
  • Was this article helpful?