You can backup the contents of FME Server Projects, and restore the projects to the same instance, or another instance, of FME Server 2017 or later.
When backing up and restoring projects, keep in mind the following:
- If a project contains users:
- You must belong to the fmesuperuser group to perform a backup and restore.
- The same permissions the user has on the current system apply on the system to which the project is restored, but only on items in the project. Any other permissions the user has on the current system do not carry over.
- The user who performs the restore operation becomes the owner of all items in the project. If the project contains any items of the same name on the system to which the project is restored, and the user does not own these items, the restore fails.
To backup projects
Note: Any Resources that belong to a project are not included in a backup unless the resource is migratable. By default, the DATA, ENGINE, and DASHBOARD Resources are configured for migration. To determine if your resource folders are migratable, open the FME Server configuration file at <FMEServerDir>Server\fmeServerConfig.txt. Locate your resources under FME SERVER SETTINGS START > Shared Resource Management. Resources with a SHAREDRESOURCE_ISMIGRATABLE_* value of true are migrated.
- On the Projects page, select one or more projects and click Export. The Configure Export page opens.
- Export To:
- Resource Location: Saves the project configuration as a .fsproject file to the specified Resources location.
- Download: Downloads the project configuration as a .fsproject file to your local system.
- Filename: If desired, edit the .fsproject project configuration filename.
- Notifications: (Optional) If Resource Location is specified, expand this field and specify the Notification Service topics to notify upon success or failure of the backup (default topics are already specified). For more information, see Monitoring FME Server Activity with Notifications.
- To complete the backup, click Save (if Resource Location is specified) or Download (if Local File is specified).
To restore a project
- On the Projects page, click Import. The Configure Import page opens.
- Overwrite Existing Items: If a project configuration of the same .fsproject filename already exists on the current instance, this setting controls the overwrite behavior of the import. If checked, items in the existing project are overwritten by items of the same name in the imported project. If unchecked, only items from the imported configuration that do not exist in the existing project are imported; nothing is overwritten.
- Notifications: If Yes, topics, subscribers, and publishers missing on the target project are added; existing ones are updated. A union is performed between topic registrations already present on the target project and topic registrations received from the source.
- Resources: If No, files or folders that are missing are added; existing ones are not updated. If Yes, files or folders that are missing are added; existing ones are updated. In either case, if a root shared resource of the same name is not defined on the target server, the shared resource package is not imported.
- Pause Notifications System: This option appears only to users who belong to the fmesuperuser security role. When checked (default), all Notification Service publishers and subscribers are disabled during the import. When the import is complete, the notification service automatically re-enables. This option is useful to prevent notifications from triggering unexpectedly during an import. For example, you may have a Directory Watch Publisher configured on a directory that is affected by the import, but do not wish to trigger notifications related to the import.
- Import From:
- Upload: Imports a project configuration (.fsproject file) that was downloaded to the system.
- Resource Location: Imports a project configuration (.fsproject file) that was saved to a Resources location.
- Notifications: (Optional) If Resource Location is specified, expand this field and specify the notification service topics to notify upon success or failure of the import (default topics are already specified). For more information, see Monitoring FME Server Activity with Notifications.
- To complete the Restore, click Upload File (if Upload is specified), or Import (if Resource Location is specified).
When using Overwrite Existing Items, keep in mind the following, depending on the component that is being restored:
This option is not available to users who do not belong to the fmesuperuser role. If an import is conducted by a non-fmesuperuser user, the notification service remains active during the import.