Export and import link configuration and data

Note: This topic is relevant for ALM Synchronizer for Agile Manager only. For details about the NextGen Synchronizer see NextGen Synchronizer, or search using the NextGen Synchronizer filter.

If you are still using ALM Synchronizer, we recommend migrating to the more robust NextGen Synchronizer embedded in Agile Manager's configuration area.

Export link configurations and or mapping data to files that you can import and reuse to create new links.

You can export and import data using the following methods:

Exported file Description
XML configuration file

Export a configuration file to reuse the configuration of a synchronization link.

Tip: To export and import only field mappings for a specific link, see Map endpoint fields instead.

Configurations are exported to an XML file saved in a location you define, and include:

  • The link name

  • Email notification information

  • Data from the following tabs:

    • Connectivity

    • Scheduling

    • Filters

    • Rules

    • Field Mapping

For a list of modifications to make when importing this file as a new link, see Create a link from an exported XML file.
.ZIP backup file

Export a .ZIP file to reuse all data for a synchronization link, such as moving the link to another synchronization server.

The .ZIP file includes all configurations exported to the XML configuration file, as well as entity mappings, and link synchronization history.

The exported information is saved in a <link name>.zip file, in the <ALM Synchronizer installation directory>\backup directory on the Synchronizer server. This location is defined per server. For details about changing this location, see Configure server options.

Caution:  

  • The name of the exported .zip file is not editable and is based on the name of the link. If you have already backed up data for the link or a link with the same name, exporting link data will overwrite the existing backup file.

  • If you plan to import this link to NextGen Synchronizer, make sure not to export a link that synchronizes requirements in sub-folders.

    To migrate such a link to NextGen Synchronizer, do the following:

    - Restructure your requirement tree to avoid using sub-folders.

    - Re-run the synchronization in ALM Synchronizer.

    - Export the link from ALM Synchronizer.

  • For considerations about importing the .ZIP file as a new link and steps required, see Create a link from an exported .ZIP file.

What do you want to do?

  1. In the links grid or navigation tree, select the link whose configuration and/or mapping data you want to export.

  2. Determine the data and file type you want to export using the table above.

  3. Select Link > Export, and then select one of the following:

    • Link Configuration Into XML File
    • Link Data Into Backup File

Note: If you are setting up a synchronization link for the first time for a specific Agile Manager site, first open a support ticket requesting that the site be enabled for synchronization.

  1. If you are creating the link on the same Synchronizer server as the one you exported from, you must modify the link name in the XML file to prevent errors caused by having two links with the same name.

    Open the XML file for editing, and modify the link name.

    For example:

    <LinkConfig version="0.58">
    <name>Defects_Link</name>

  2. Select Link > Create From > Link Configuration XML File.

  3. Browse to, and select the file to import. A new link is displayed in the links grid and navigation tree based on the settings you imported.

  4. Modify data in the new link as needed, especially on the following tabs:

    • Connectivity. You cannot run two links with the same connectivity data.
    • Filters.
    • Field Mapping. Refresh the schema after updating the connectivity data, and then re-map any user defined or custom fields.

  1. Select Link > Create From > Link Data Backup File.

  2. Browse to, and select the file to import. A new link is displayed in the links grid and navigation tree based on the settings you imported.

    Caution: Modifying connectivity data after importing may cause data corruption during synchronization.