› Management Console › Admin › Backups

Backups

Use the Backups page to copy all or part of the Management Console configuration into a file to back up or export data. Use the file to perform a restore or import operation.

This option is available for superusers only.

See Understand the options for descriptions of what you can backup, restore, export, and import on the Management Console.

You can restore backups created in versions 11.2 and newer.

Use the Management Console > Admin > Backups page to:

Understand the options

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

Creating and restoring a backup

A backup contains most of the Management Console configuration, including all schedules and all projects in the repository, and it can be restored only in its entirety. The backup does not include the list of devices.

Use the backup to either restore the system after data loss or upgrade to a newer version of Tungsten RPA. For an upgrade scenario, create a backup of the old instance of the Management Console and restore it into the new instance.

Behavior for restoring a backup varies based on the following scenarios:

  • User management on: 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).

  • User management off: If you restore a backup from the Management Console with user management on, the default admin user is replaced with a superuser from the backup. Use credentials specified in the restored Management Console.

Automatic logoff after backup restore is normal and occurs depending on the conditions and versions from which you are restoring a backup.

Exporting and importing a project

Use the Export project options to create a file with information pertaining to a single project.

Configuration, operational, reporting, runtime, project, and other data is available to export, including data from the following:

  • Email triggers

  • Permissions

  • Repository

  • Resources

  • Robots and Basic Engine Robots

  • Robot File Systems

  • Schedules

  • Snippets

  • Trigger mappings

  • Types

  • Vault entries

Such a file may be used to copy schedules, robots, and so on, from one Tungsten RPA system to another. For example, when moving data from a test environment to 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. Also, it is possible to do a selective import that includes only some items.

Create a backup

  1. In Admin > Backups, click Create backup.
  2. Click Create.
  3. When the backup is ready, it is downloaded to your computer.

Restore a backup

  1. In Admin > Backups, click Restore backup.
  2. Click the paper clip sign to select a backup file to restore, select the file, then click Open.
  3. Select Merge or Reset mode.

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

      Any settings that are missing in the backup, because those settings did not exist in the 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, because those 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 are deleted.

    • To retain the clusters, select the box "Retain existing clusters".

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

Export a project

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

Export a project by name

An export by project name can be useful if you need to back up a project that uses APIs.

Export a project by customizing the following URL. 

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

Replace the following parts with your 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.

Import a project

  1. In Admin > Backups, click Import project.
  2. Review the items to import and select or deselect items.

    A check mark next to an item indicates it will be included in the import. To exclude an item, click the item's box to remove the check mark.

  3. Click the paper clip sign to select a project file to import, select the file, then click Open.
  4. If a project with the same name exists, choose an option for managing project data:

    • To delete a project and replace it with the imported project, ensure that the Delete project if exists is selected (default).

      The entire project is deleted from Management Console and replaced with the content from the imported project file. Any objects in the deleted project (such as robots, types, and project information) that are not in the import file are lost.

    • To merge changes into the existing project, clear the Delete project if exists to ensure that the checkbox is not selected.

      • If an object exists in Management Console and doesn't exist in the imported project file, it's preserved.

      • If an object doesn't exist in Management Console but exists in the imported project file, it's automatically inserted into the project.

      • If objects with the same names exist both in Management Console and in the imported project file, the content from the imported project file overwrites Management Console objects. For objects with the same names, there is no option to skip the overwrite and keep the Management Console object.

  5. Click Import.

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

  6. When the import is complete, click Close.