Data Migration Tutorial

In this tutorial we will perform a test migration of existing Kapow Katalyst data from version 9.2 to version 9.3 of the Kapow Katalyst solution. We strongly recommend you to create a test setup to perform a migration, before you work with your production environment to ensure that Robots, restored in a new version of Kapow Katalyst, do not interfere with your production process and database.


If you are using a Kapow Katalyst version prior to 9.2, there are other considerations that are outside of this tutorial. Please contact Kapow technical support for assistance in migrating from version prior to 9.2.

Kapow Katalyst version 9.2 and later use the new Kapow compute units licensing model as well as our centralized application settings, which are handled through the Management Console UI.

Most of the migration can be performed using the Admin>Backup tabs in the Management Console. In this tutorial we use MySQL as a data source for the project.

Backup tab

Figure . Backup tab

Note that any settings made in the RoboServer Settings application must be reset using the same application in the new version of the Kapow Katalyst product.

RoboServer Settings Application

Figure . RoboServer Settings Application


For all the steps in this tutorial, including making changes in the RoboServer Settings application, we strongly recommend to use one and the same account that will be used later to run the new version of the Kapow application as a service on Windows or as a process on Linux.

Perform the steps of the following procedure to migrate your Kapow application data.

  1. Start the Management Console version 9.2, open it in the browser, and perform a backup of your entire inventory. Later you will restore schedules, robots, types, etc. in the new version of Kapow Katalyst.

    1. In the Management Console, go to Admin>Backup tab.

    2. Click Create Backup under Full Backup/Restore and confirm your action.

    This action will create a .zip backup file with all the configuration settings stored by the Management Console.


    Kapow stores its data in the application data folder located under a Windows user folder of the user who is currently logged in the system. Because Kapow stores some of its important information in the data folder and because this information is relevant to the user account, we recommend you to include Kapow application data folder to your normal file backup procedure. For more information about Kapow folders, see the Important Folders in Kapow Katalyst topic.

  2. Start your new version of the Management Console from the command line window. You should start the Management Console without starting the RoboServer by using the following command in the bin subfolder of the Kapow installation folder:

    RoboServer -MC

    The command window will show you the Management Console connector TCP port. The default port number is 50080. If you changed the TCP port using the RoboServer Settings application, the number you specified should appear in the command line window when the Management Console is being started.

    Starting the RoboServer

    Figure . Starting the RoboServer


    Use the same account to start the command line interface and run the Management Console to ensure Kapow service has access to all the necessary files and folders.

  3. Start the Management Console in the browser. If you use the same browser to switch between different versions of the Management Console, you might get the Unable to start application error with the “The response could not be deserialized” message. To avoid this shared browser cache issue, either use different browsers (for example, Internet Explorer and Chrome) for different versions of Kapow Management Console or you can try to just click OK and reload the page.


    Once the Management Console loads, look for the version of the Console you are working with in the left top corner to make sure you working with the version 9.3 of the product.

  4. Go to Admin>Backup tab and click Restore Backup. Specify the path to the zip backup file you created in your previous version of Kapow Katalyst and click Restore. Once the restore process is complete click Close to close the Restore Backup dialog box.

  5. Perform the following in the Management Console:

    1. On the Admin>Clusters tab, check that any listed RoboServers are not started. This action ensures that the new version of the Management Console does not connect to any of the previous version robots that you used when creating a backup in your previous version of the Management Console.

    2. On the Admin>Clusters tab, right click the cluster name and select Cluster Settings…. Specify a database different from the one that was set in the previous version. If you made a backup from your production environment, this step ensures that your new robots would not interfere with your production database. You can choose to use the same database, but change the schema. It is strongly recommended to keep the name of the database without changing, because the imported robots will be looking for this label when running. Click OK and select to stop all robots and apply settings.

    3. On the Admin>Settings tab, click RoboServer Log Database and change the schema to a new clean version. Test the connection and save the settings.


      If the specified logging database is empty, the application creates necessary tables when it connects to the database.

    4. Check the Schedules tab and disable any scheduled runs that you do not want to be running.

  6. On the Admin>Clusters tab, click Add Server to add a new server and assign this server to the production cluster. In this tutorial we will add a server that runs on the same machine where we run the new version of the Kapow Management Console. You can also specify a port number different from those you used for RoboServers in your previous version, for example, 50001.

    Adding New RoboServer

    Figure . Adding New RoboServer

    The server you added appears offline in the Cluster/Server list until we start it with the specified port.

  7. Open the command line window where you started the Management Console and stop the process (Ctrl C).

  8. Start the Management Console and the RoboServer with the port you specified using the following command:

    RoboServer –MC –p 50001

    Starting the RoboServer

    Figure . Starting the RoboServer

    Once the RoboServer is started, you can see the version of the server listed in the Cluster/Server list on the Clusters tab.

    RoboServer Version

    Figure . RoboServer Version

  9. Create necessary tables in your new database. You can use database tools to populate tables from your production database, or you can use the Design Studio to create necessary tables. You must specify the same database for the cluster in the Management Console and for the project in Design Studio. To create the tables using the Design Studio, download and save necessary Types and Robots from the Management Console to your new project folder, open the project in Design Studio, specify all the database settings, and allow the Studio to create necessary tables in the database. To check that the tables are created, go to the Data tab in the Management Console and look for the tables in the selected database.

  10. If you imported any Kapplets from your previous version, go to Kapplets>Repository in the Management Console and enable the Kapplets you want to use. Once the Kapplets are enabled, you can open the KappZone and check whether the Kapplets can be opened and run.

After you complete the migration, perform a thorough examination of your existing processes in the new version of Kapow Katalyst to confirm that everything is functioning as expected. For any questions during migration and verification testing, contact Kapow technical support by sending an email to