Backup, restore, and migrate

Kapplets rely on the robots being present in the Management Console. In most cases, a Kapplets backup or restore is dependent on a corresponding Management Console backup or restore. Use the following sequence to ensure that data is available:

  • First back up or restore the Management Console.
  • Wait 5 to 10 minutes (or as configured in the Kapplets server) for Kapplets to refresh the Management Console data.
  • Back up or restore the Kapplets.

The following Kofax RPA methods are available for backing up, restoring, and migrating Kapplets. When migrating data from earlier versions, follow the sequence and instructions for the specified version.

Restore from versions 11.3.0 and newer

Backups created with 11.3.0 and newer versions can be restored via Kapplets > Backup tab. See Backup.

Restore from versions 11.0.0, 11.1.0, and 11.2.0

In these versions, there are no backup functions for Kapplets, and the standard backup file from the Management Console does not contain the Kapplets data.

Kapplets created with versions 11.0.0, 11.1.0, and 11.2.0 must first be migrated to version 11.3.0. To get a Kapplets backup file that can be used in future Kapplets versions, upgrade the Kapplets to version 11.3.0 without dropping the existing Kapplets database.

You can migrate directly from an earlier version (11.0.0 through 11.2.0) to 11.3.0, without restoring incrementally from one version to another. You cannot migrate directly from a version earlier than 11.3.0 to 11.4.0 and newer versions.

Do not upgrade or migrate a SQL server and Kofax RPA simultaneously. Constraint errors may occur. Instead, use the following sequence:

  • Upgrade Kapplets to version 11.3.0.

  • Create a backup via Kapplets > Backup tab.

  • Upgrade or migrate the SQL server.

  • Install Kapplets version 11.4.0 or newer.

  • Restore with the backup you created.

To upgrade Kapplets created with versions 11.0.0 through 11.2.0, perform the following steps.

  1. Back up the existing database to create a restore version in case it is needed. (Follow the guidelines of the database vendor.)

  2. Switch to Kofax RPA version 11.3.0 Kapplets, then configure it to use the existing database.

    The database URL must be configured in the kapplets.xml file. For an example kapplets.xml file, see "Install Kapplets, Tomcat Server Installation" in the Kofax RPA Installation Guide.

    Some input parameters and their values are not restored from backups containing scheduled legacy Kapplets.

    Kapplets do not support restoring the following fields: Session, Country, Currency, and Language.

  3. In version 11.3.0, create a backup file by selecting Admin > Backups > Create backup.

  4. Use the backup file to restore the Kapplets to version 11.4.0 or newer by selecting Admin > Backups and selecting the target 11.3.0 backup file. For details, see Backup.

Restore from versions 10.6.0 and 10.7.0

In versions 10.6.0 and 10.7.0, separate backup functions for Kapplets and the Management Console are not available. Instead, all of the Kapplets templates, settings, projects, and so on are included in the standard backup file from the Management Console.

Legacy backups created with versions 10.6.0 and 10.7.0 can be restored in the following way.

  1. Restore the backup file to the RPA Management Console by using the Admin > Backups > Restore backup button.

    A legacy backup will be restored correctly in Kapplets only if the backup is first restored in the Management Console.

  2. Restore the Management Console backup file via the Kapplets > Backup tab.

  3. Configure projects, templates, and users.

    • Users will be moved to Kapplets within their user groups. These user groups and users get no privileges, until these privileges are assigned by the global administrator.

    • Objects from the Management Console backup will be moved to Kapplets objects as follows.

      Management Console backup objects

      Kapplets objects

      Project

      Workspace

      Master Kapplet

      Template

      Installed Kapplet

      Kapplet marked as "favorite"

Equivalents of the Management Console roles in Kapplets

This transfer occurs only when a Management Console backup is imported to the Kapplets.

Management Console group role

Kapplets group privilege

Kapplet User

User

Developer

Developer

Kapplet Administrator

Developer

Project Administrator

Administrator

RPA Administrator

Administrator

Kapplets Service User

None