› Management Console › User interface › Admin › Backups

Backups

This section is available for users with the following roles: Administrator and Project Administrator.

Use the Backups section to copy all or part of the Management Console configuration into a file to back up or export data. If necessary, you can use the file to perform a restore or import operation.

You can restore backups created in Kofax RPA version 9.7.10 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.

Creating and Restoring a Backup

A backup contains all of the Management Console configuration, including all schedules and all projects in the repository, and it 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.

After you restore a Management Console backup that has user management off, use the default superuser credentials to log in to the Management Console (user: admin, password: admin). If you restore a backup from the Management Console with enabled user management, the default admin user is replaced with a superuser from the backup. Use credentials specified in the restored Management Console.

Exporting and Importing a Project

Use the Export Project feature to create a file with information pertaining to a single project. This comprises the schedules, robots, types, resources, OAuth, and Robot File Systems 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 > Backups, click Create backup.
  2. Click Create.
  3. When the backup is ready, it is downloaded to your computer.

Export a Project

  1. To export a project, in Admin > Backups, click Export project.
  2. Select the project to export.
  3. Click Export.
  4. When the export project is ready, it is downloaded to your computer.

Export a Project by Name

You can also 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

Starting from version 9.5.0, the threshold for cleanup is changed from a number of records to a number of days; thus the number of days is set to 10 in case of an old backup with 50000 or more records (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 > Backups, click Restore backup.
  2. Click the paper clip sign to select a backup file to restore, select the file on your computer, and then click Open.
  3. Select Merge or Reset.

    • 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.

      When restoring a backup using Merge or Reset modes, all previously made clusters get deleted. To retain the clusters, tick the box "Retain existing clusters" in the "Restore backup" window. It is important that the names of the existing clusters are different from the cluster names in the backup.

  4. Click Restore.

    If a backup contains item names that do not conform to the naming policy rules, these items are renamed automatically when you restore the backup.

  5. When the restore is complete, click Close.

Import a Project

  1. To import a project, in Admin > Backups, click Import project.
  2. Select the items to import.

    Available options include:

    • Import schedules

    • Import robots, types and snippets

    • Import resources

    • Import OAuth

    • Import permissions

    • Import Robot File Systems

    • Import trigger mappings

    • Import email triggers

  3. Click the paper clip sign to select a project file to import, select the file on your computer, and then click Open.

    • If a project with the same name already exists and you want to replace it with the newly imported project, select Delete project if exists. If you do not select this option, the changes are merged into the existing project.

  4. Click Import.

    If a project contains item names that do not conform to the naming policy rules, these items are renamed automatically when you import the project.

  5. When the import is complete, click Close.