Backup & Restore

Note: Backup & Restore is available only to users who belong to the fmesuperuser security role.

Use the Backup & Restore tools to perform the following:

  • Back up the configuration of a current instance of FME Server 2014 or later.
  • Restore a backed-up FME Server configuration to an instance of FME Server that is of the same or later version.
  • View your history of backup and restore activity.

For more information about backup and restore of FME Server configurations, see Upgrading FME Server.

FME Cloud Users: The tools on the Backup & Restore page of the Web User Interface do not allow you to perform a full restore of an FME Server instance, including FME Server data and the PostGIS database. To perform a backup and restore operation of an FME Cloud instance, launch a new instance from a backup snapshot using the tools on the FME Cloud Dashboard and the FME Cloud Snapshots page. For more information, see Working with Backups in the FME Cloud documentation.

Performing a Backup and Restore

WARNING: If System Encryption is enabled on the FME Server that is backed up, it must also be enabled on the FME Server that is restored, and use the same custom encryption key.

What FME Server Components Are Migrated?

When you perform a backup and restore operation of an FME Server configuration, the following components of your FME Server are migrated:

  • Automations workflows

    • Note: The Retry settings of actions and external actions are restored to FME Server default settings.

  • Notifications components, including Topics, Subscriptions, and Publications
  • Streams
  • Server Apps, including workspace apps and gallery apps
  • Schedules
  • Repositories and the items stored in them, including workspaces, custom transformers, custom formats, templates, and resources. Any designations by users of a repository item as a 'favorite' are also migrated.

    • WARNING: If Version Control is enabled, previous versions of repository files are not migrated. To access previous versions of repository files, version control must be configured with a remote Git repository prior to a backup and restore operation. Alternatively, you can view all versions from the Repositories page (History) prior to migration, and download them as desired.

  • Projects
  • Resources, which include the following:
    • Resources whose definitions and files are both stored with FME Server, and are configured for migration. By default, the DATA, ENGINE, and DASHBOARD Resources are configured for migration. To determine if your resource folders are migratable, open the fmeServerConfig.txt configuration file. Locate your resources under FME SERVER SETTINGS START > Shared Resource Management. Resources with a SHAREDRESOURCE_ISMIGRATABLE_* value of true are migrated.

      • Note: Resource folders containing large amounts of data require considerable time to back up, and result in large configuration files. We recommend defining large folders as non-migratable. Following backup and restore, manually migrate these folders to the new FME Server. Alternatively, host big data on a UNC path, then point the new FME Server to that path. For more information about configuring resource directories, see Resources.

    • Resource connections whose definitions only are stored with FME Server, but whose files are stored outside FME Server. These definitions include any Amazon Web Service (AWS) S3 bucket or network (UNC path) connections that are defined. Only connection definitions are migrated (such as bucket names and authentication parameters), as the files themselves are not stored on FME Server.
  • Database Connections and Web Connections
  • User Management configuration, including Users, Roles, tokens, and Authentication Services settings.

    • Note: To enable single sign-on (if configured) following migration, you must Update the Tomcat Properties File, if applicable. Additionally, if you restore to a new machine, you must: a) Assign a service principal name (SPN); and b) Register the SPN to a service account. For more information, see Updating the Windows Domain Configuration.

  • System Configuration settings, as follows:
  • Queue Control mechanisms, including job routing rules, engine assignment rules, and queues.
  • Your user preferences

See Also