Exporting and Importing Projects

You can export the contents ofFME FlowProjects, and import the projects to the same instance, or another instance, ofFME Flow2017 or later.

When exporting and importing projects, keep in mind the following:

  • If a project contains users:
    • You must belong to the fmesuperuser group to export and import, with the exception that a user can export a project if the project contains that user's account, and only that account.
    • The same permissions the user has on the current system apply on the system to which the project is imported, butonlyon items in the project. Any other permissions the user has on the current system do not carry over.
  • If a project contains API tokens, one of the following must be true to import:
    • You belong to the fmesuperuser group.
    • The owner of the project conducting the import has the same user account on the target system.
  • If a project contains flow apps without their associated API tokens, those apps are disabled on the target system until explicitly enabled.
  • The user who performs the import becomes theownerof any items in the project if the project does not include the user accounts of the original owners, or those user accounts do not exist on the target server. If the project contains any items of the same name on the system to which the project is imported, and the user performing the import does not own those items, the import fails.
  • If a project changes after it is exported, but before it is imported, you may want to revert it to its original state, so that it matches the export. For more information, seeRemoving Projects.
  • You may want toupdatethe project version before you export it. The specified version is appended to the .fsproject file that is exported.
  • 小鬼orting a project triggersonlythe Project Importsystem event, if enabled. For example, if a new repository is created on theFME Flowas a result of importing a project, the Repository Create event is not triggered.

To Export a Project

Note  "> NoteAnyResourcesthat belong to a project are not included in an export 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 thefmeServerConfig.txtconfiguration file. Locate your resources under FME SERVER SETTINGS START > Shared Resource Management. Resources with aSHAREDRESOURCE_ISMIGRATABLE_*value oftrueare migrated.
  1. On theProjectspage, select a project and clickExport. The Export Project page opens.
  2. File name: If desired, edit the .fsproject project configuration filename.
  3. Export location:
    • Download: Downloads the project configuration as a .fsproject file to your local system.
    • Resources: Saves the project configuration as a .fsproject file to the specifiedResourceslocation.
      • Resource Location: TheResourceslocation in which to save the project.
      • Post to Topic on Success: the Notification Service topics to notify upon success of the export (a default topic is already specified). For more information, seeMonitoring FME Flow Events from Topics.
      • Post to Topic on Failure: the Notification Service topics to notify upon failure of the export (a default topic is already specified). For more information, seeMonitoring FME Flow Events from Topics.
  4. Standard Security Mode: IfSystem EncryptionisStandard, this setting isEnabled, and a custom encryption key will be required to import the project ifInclude all sensitive information(below) is checked.

    5. Ensure this key is available before proceeding. If available, checkYes, I have the required encryption keyand proceed.

  5. Include all sensitive information: If checked, the following are included in the export:
  6. To complete the export, clickExport.

To Import a Project

Tip  "> TipIf you navigate away from configuring an import before actually initiating the import, you can return to the import configuration from thePending Importstab.

On theProjectspage, click小鬼ort. The Import Project page opens.

File location:

  • Upload: Imports a project configuration (.fsproject file) that was downloaded to the system.
  • Resources: Imports a project configuration (.fsproject file) that was saved to the specifiedResourcesLocation.
    • Post to Topic on Success/Failure(optional): Specify the notification service topics to notify upon success or failure of the import (default topics are already specified). For more information, seeFME流动监测和通知.

    • To proceed, select one of the following:

    • Quick Import: Imports the project without allowing you to review the items in the project, including those items that will overwrite items of the same name on the currentFME Flow.
      1. Allow items to be overwritten if they already exist: 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.

        2. When usingAllow items to be overwritten if they already exist, keep in mind the following, depending on thecomponentthat is being imported:

        • Automations and Notifications: If checked, Automations workflows, 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 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.
      2. Pause all notifications during import: This option appears only to users who belong to the fmesuperuser securityrole. When checked (default), allAutomationsworkflows andNotification Servicepublishers and subscribers are disabled during the import. When the import is complete, the service automatically re-enables. This option is useful to prevent automations workflows from triggering unexpectedly during an import. For example, you may have aDropbox Directorytrigger configured on a directory that is affected by the import, but do not wish to trigger notifications related to the import.

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

      3. Disable all listed item types after import: If checked, the following types of items in the project that are new or overwritten on theFME Flowafter import are disabled:

        4. To use these items, you must explicitly enable them.

      4. To complete the import, click小鬼ort Project.
    • Preview Import: Allows you to review the items in the project prior to importing, including those items that will overwrite items of the same name on the currentFME Flow. Also allows the option of removing certain types of items, including database connections, web connections, users, security tokens, and deployment parameters.
      1. Preview Content: This page lists the items in the project that are being imported. Above the list, you can filter by name, type of item, or whether the item is new (New Item) or if an item of the same name already exists, which will be overwritten ifAllow items to be overwritten if they already existis checked (Overwrite).
        • Allow items to be overwritten if they already exist: 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.

          • When usingAllow items to be overwritten if they already exist, keep in mind the following, depending on thecomponentthat is being imported:

        • Automations and Notifications: If checked, Automations workflows, 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 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.

        2. To proceed, clickContinue.

      2. Choose Items: If the project contains anyDatabase Connections,Web Connections,Users,Security Tokens, orDeployment Parameter Store, you can exclude them from the import. To exclude an item, remove the check from the item's checkbox.

        3. To proceed, clickContinue.

      3. Additional Options:
        • Pause all notifications during import: This option appears only to users who belong to the fmesuperuser securityrole. When checked (default), allAutomationsworkflows andNotification Servicepublishers and subscribers are disabled during the import. When the import is complete, the service automatically re-enables. This option is useful to prevent automations workflows from triggering unexpectedly during an import. For example, you may have aDropbox Directorytrigger configured on a directory that is affected by the import, but do not wish to trigger notifications related to the import.

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

        • Disable all listed item types after import: If checked, the following types of items in the project that are new or overwritten on theFME Flowafter import are disabled:
          • Note  "> Note Flow Apps如果它们相关的安全令牌不运行disabled.

          To use these items, you must explicitly enable them.

          To complete the import, click小鬼ort Project.

    To View History of Project Import and Export Activity

    On the Projects page, select theHistorytab. For a log of a particular import or export, click an entry in the table.