Restoring an FME Server Configuration

When restoring an FME Server configuration, keep in mind the following:

  • If you are restoring from a backed-up configuration that was using custom System Encryption, you must restore to a system that is using the same custom encryption key as the backup.
  • If Version Control was enabled on the backed-up configuration, and configured with a remote Git repository, the restored FME Server does not automatically synchronize with the repository. That is, the restored FME Server does not automatically perform a Fetch From Remote operation. To avoid errors, be sure to fetch updates from the repository before pushing updates to the repository.
  • Any messaging to or from Automations triggers or external actions, or Notification Service topics, is disabled during the restore operation. This prevents the restore operation from triggering unintended notifications from any actively-configured triggers or publications.
  • For general information, see Backup & Restore.

To Restore an FME Server Configuration

  1. Select Backup & Restore > Restore. The Migration page opens on the Restore tab.

  2. Overwrite Existing Items. In general, when this box is checked, items on the current instance are overwritten by items in the backed up configuration of the same name. If not checked, only items from the backed up configuration that do not exist on the current instance are imported; nothing is overwritten.

    When using Overwrite Existing Items, keep in mind the following, depending on the component that is being restored:

    • Services: The restore operation is the same, whether checked or unchecked: Services missing on the target FME Server are added; existing services are not updated. This is to prevent breaking service definitions on the target FME Server.
    • Notifications: If checked, topics, subscribers, and publishers missing on the target FME Server are added; existing ones are updated. A union is performed between topic registrations already present on the target server and topic registrations received from the source.
    • Security: If unchecked, users, roles and tokens missing on the target FME Server are added; existing ones are not updated. A union is performed between the permissions already present on the target server and the permissions received from the source. If checked, users, roles and tokens missing on the target server are added; existing ones are not updated. Permissions for roles that are present on both the source and target servers are overwritten, and permissions for roles present only on the target server are left unchanged.
    • Resources: If unchecked, files or folders that are missing are added; existing ones are not updated. If checked, files or folders that are missing are added; existing ones are updated. In either case, if a root resource of the same name is not defined on the target server, the resource package is not imported.
    • System Events: If unchecked, the configurations of all system events return to their default states. That is, all system events are enabled, and email notifications are not configured.
    • Favorites: Any designations by users of a repository item as a 'favorite' are migrated if the repository item and user exist, and if the repository item is not already a favorite of the user, regardless of this setting.
  3. Restore From: Select a location from which to restore, depending on where the backup (.fsconfig) file was saved (see Backing Up an FME Server Configuration):
    • Resource Location: Restores from a backup file saved to a location on the Resources page.
      1. Choose Resource File: Select the backup (.fsconfig) file. (To open a folder, double-click on it.)
      2. Post to Topic on Success/Failure: (Optional) FME Server is pre-configured to publish content about the success or failure of a backup or restore operation. By default, this content is delivered to the MIGRATION_ASYNC_JOB_SUCCESS notification service topic. You can configure an Automations external action to notify you over a supported protocol when a backup or restore succeeds or fails. For more information, see Monitoring FME Server Events from Topics.
      3. Click Restore. The restore proceeds, accompanied by a message.

        4. Note: During the restore, you may need to re-log in to the Web User Interface. The restore operation proceeds unaffected. This happens when both of the following are true:

        - Overwrite Existing Items is checked.

        - The backup file contains the same user who is performing the restore, but the user session tokens are different. This is likely the case, unless the backup file was created in the current login session.

    • Upload: Restores from a backup file saved to another location.
      1. Click Upload File and select the backup (.fsconfig) file to restore from. Or, drag and drop the file onto the page.
      2. Click Import to begin the restore. When complete, a message displays indicating success or failure.

        3. Note: During the restore, you may need to re-log in to the Web User Interface. The restore operation proceeds unaffected. This happens when both of the following are true:

        - Overwrite Existing Items is checked.

        - The backup file contains the same user who is performing the restore, but the user session tokens are different. This is likely the case, unless the backup file was created in the current login session.