Welcome to Kofax RPA > Management Console > Management Console Configuration and User Interface > Admin > Back Up Management Console

Back Up Management Console

Use the Backup tab to copy all or part of the Management Console configuration into a file for backup or export purposes. If necessary, you can use the file to perform a restore or import operation.

Note You can restore backups created in Kofax RPA version 9.2 or later. For earlier versions, contact Kofax RPA technical support for assistance in migrating your data.

It is important to understand the difference between creating/restoring a backup and exporting/importing a project.

A backup contains all of the Management Console configuration including all schedules and all projects in the repository, and can be restored only in its entirety. It may be used to restore the system after data loss, or when upgrading to a later version of Kofax RPA. In the latter case, you will create a backup of the old instance of the Management Console and restore it into the new instance. See Restore a Backup for more information on restoring from an instance of the Management Console prior to release 8.1.

Note Prior to release 8.1, "Create Backup" was named "Export"; the term "export" is now used only for "Export Project."

Use Export Project to create a file with information pertaining to a single project. This comprises the schedules, robots, types, and resources within the project. Such a file may be used to copy schedules, robots, and so on, from one Kofax RPA system to another, for example when moving from a test environment into production. It is possible to import into an existing project on the target system; in this case, items from the file are merged into the project, overriding present items when names match. It is also possible to do a selective import that includes only some items.

Create a Backup

  1. To create a backup, in Admin > Backup, click Create Backup.

    The Create Backup window appears.

  2. Click Create Backup.
  3. When the backup is complete, select Click to download.

    You can open the backup files, or click Save.

Export a Project

When exporting a project, you must select the desired project in this window. Then click Create to create the desired backup/export file; this may take a while. When the file is ready, a download link appears. The link is active only while the window is open; you cannot copy the link and use it after closing the window.

  1. To export a project, in Admin > Backup, click Export Project.

    The Create Export window appears.

  2. Select the project to export.
  3. Click Create Export.
  4. When the export project is complete, select Click to download.

    You can open the export files, or click Save.

Export a Project by Name

You can export a project by name using the following URL. For example, it can be useful if you need to back up a project using API. 

http://user:password@localhost:8080/ManagementConsole/secure/BackupProjectByName?projectName=MyProject

In this URL, replace the following parts with you actual data:

  • user:password: User credentials to access the Management Console.

  • localhost:8080/ManagementConsole: URL to the Management Console.

  • MyProject: Name of the project to export.

Restore a Backup

When restoring an export from a Management Console prior to release 8.1: As described above, it is possible to restore from a backup made with an earlier release of the Management Console. Three caveats should be kept in mind: First, the terminology was changed in release 8.1. Previously, the term "export" was used for what is now named "backup". That is, if you want to migrate contents from a Management Console prior to release 8.1, you must use its "Export" function to create an export file. Secondly, this file must be converted to the new backup file format with the aid of the "Upgrade Pre-8.1 Management Console Export" feature in the Tools menu of Design Studio. Thirdly, the new project based permissions introduced in 8.2 mean that permissions from a previous version can not be upgraded automatically. After you restore an older backup, you have to assign project permissions manually.

Note Starting from Kofax Kapow 9.5.0, the threshold for cleanup has been changed from a number of records to a number of days; thus the number of days is set to 10 in case of old backup with a number of records 50000 or more (the old default). If the number of records is less, the number of days is scaled back accordingly.
  1. To restore a backup, in Admin > Backup, click Restore Backup.

    The Restore Backup window appears.

  2. Browse to the backup file to restore.
  3. Choose either Merge or Reset from the drop-down list.

    • Choose Merge to merge the settings of the backup into the current version of the Management Console.

      Those settings that are missing in the backup, that is settings that did not exist in an earlier version when the backup was created, keep their custom value.

    • Choose Reset to reset all the settings before restoring a backup.

      Those settings that are missing in the backup, that is settings that did not exist in an earlier version when the backup was created, are reset to their default value.

  4. Click Restore.
  5. When the restore is complete, click OK and then click Close.

Importa Project

  1. To import a backup, in Admin > Backup, Click Import Project.

    The Import Project window appears.

  2. Select the items to import.

    Available options include:

    • Import Schedules

    • Import Robots, Types and Snippets

    • Import Resources

    • Import OAuth

    • Import Master Kapplets (Classic Kapplets)

    • Import Permissions

  3. Browse to the backup file to import.
  4. Click Import.
  5. When the import is complete, click OK and then click Close.