Import a Project

To reuse an exported project or transfer it to another system, an import operation is performed within Synergy IDE. This process is completed by correctly matching the components in the system and includes several matching steps.

Project Import Process

The project import process is used to integrate an exported project into the same or a different Synergy environment. During the process, the components of the project are matched with their counterparts in the system.

The import process is carried out through the following steps:

1. Opening the Import Modal

   • The modal is opened by clicking "Import Project" → "Import Project from File" via the Tools Menu, Startup Panel, or the top-left menu.

2. Selecting the Source

   • In the first step, the .tar.gz project file is selected. The user can choose either Select from Computer or Select from Document Management.

     

3. Defining the Target

   • A new project name is defined or an existing project is selected for overwriting.

     

4. Analysis

   • The selected project is analyzed. The components in the project files are reviewed and listed on the screen in groups.

     

5. DM Objects (Document Management)

   • Documents and templates in the transferred project are selected. At this step, items in the document management system must be matched with the project. If components already exist in the target environment, they are matched automatically. Unmatched items must be matched manually.

     

6. Connections

   • Data sources in the project are checked to ensure they can be correctly matched in the target environment. Automatic matching is performed if the data sources exist; otherwise, manual matching is required.

     

7. HR Objects

   • HR-related elements such as users, positions, titles, and departments are matched. If matching records exist, they are matched automatically. Otherwise, manual selection is required.

     

8. Forms

   • Form templates defined in the project are matched with their counterparts in the system. If no match is found, the appropriate one must be selected manually.

     

9. Flows

   • Flows in the project are matched with those in the system. Automatic or manual selection may be used as needed.

     

10. PAT (Personnel Access Token)

    • Access tokens used in the project are matched with existing PATs in the system.
    • If no match is found, a new PAT can be created.
    • The import process cannot be completed without PAT matching.

    

11. Import and Publish

    • The process is started by clicking the "Import" button.

    • Optionally, the project can be published after the import is completed (as Major or Minor version).

    • A Deploy Agent can be selected to handle the publishing process.

      

Authorization and Requirements

• The following permissions are required to perform the import process:
  • Synergy IDE Access: The user must have permission to access the IDE interface.
  • Project Management: The user must belong to a group that has permission to manage projects.

Notes

• The project to be imported must have a .tar.gz extension.
• If the project is encrypted, the password must be provided during the import process.
• Projects can only be imported into Synergy CSP environments. Compatibility between the source and target versions should be considered, as incompatibility may lead to import issues.
• Any errors or mismatches found during the analysis step must be resolved before the import can proceed.
• Once the import is complete, the project will open automatically.
• The project can be published automatically after import, based on user preference.

See Also

• [Development Environment (IDE) Permissions](../../../User Guides/AdministrativeTools/Security/IDE/IDE.md)
• Export a Project
• [IDE (Integrated Development Environment)](../../../User Guides/AdministrativeTools/IDE/IDE.md)
• Developer Environment Startup Guide

FAQs

• Can I overwrite an existing project during import?
• Is PAT matching mandatory during import?
• What happens if a component cannot be matched automatically?
• Which file formats are supported for importing a project?
• Can I import projects between different Synergy versions?

How To's

• Automatically Publishing a Project After Import
• Defining a New Project Name During Import
• Creating a New PAT During Import
• Importing a Project from File
• Manually Matching Document Management Objects