Creating and Editing Connections

You perform these tasks using the Create Connection Wizard.

Note: The data sources you want to use for a connection must exist before you can complete a connection. See Defining a Data Source for more information.
  1. From the Connections tab, click the Add Connection button. The Create Connection Wizard appears.
  2. On the Data Source tab, enter a name in the Connection Name field.
  3. n the Master Name field, select a data source to use as the master data source. Define this data source as the master which should win in case of conflict situations. In case of parallel file changes done in both data sources Enterprise Sync will assure that the file in the master data source is not replaced with the version coming from the other data source.
  4. In the Target Name field, select a data source to use as the data source which is used for synchronizing data from and to the master data source.
  5. Optionally, use the fields in the Error Notification group to override error notification email settings specified in Settings
    • Enter email addresses (separated by a semicolon (;)) in the Send Email To field.
    • Change the value in the Frequency field.
    Tip: Email addresses and frequency values established on the Settings page are not displayed here.
  6. Click the Next button which displays the Types and Fields tab. The current version of Enterprise Sync doesn't support any specific mappings on this page. A Type Mapping called ChangeSet is already pre-configured. Do not change this and do not add a new Type Mapping.

    You may want to select the Default Sync Direction. This is a default value only and can be changed on a project level later on. The three values have the following meaning:

    • A bi-directional synchronization supports data transfers in both directions, from and to the master data source.
    • As an alternative you may want to synchronize only in one direction, either from the master to the target data source or vice versa.
  7. Click the Next button again which displays the Projects tab. A Project defines a specific synchronization rule for the previously selected data sources. You can defines several projects within one connection and each single project can be activated for synchronization separately.
  8. Click the Add button. A new row is added to the list.
  9. Select the project you want to map from the Target list.
    Tip: The data source product name is displayed on the list column title. The values displayed on the list depend on the product associated with the data source.
    Note: Depending on the selected data source multi selection may be allowed or disallowed.
  10. Select the corresponding Master project from the Master Project list. Depending on the selected data source multi selection may be allowed or disallowed.
  11. The direction is pre-defined corresponding to the default value selected on the Types and Fields tab (inherit). You can select and associate another valid direction for this project, either From Master, To Master or Bi-directional.
  12. Project synchronizations are enabled by default. If you wish to disable it, clear the check box.
  13. Some data sources for SCM tools allow you to specify a deeper directory level synchronization. If it's available and you want to specify a directory deeper than the root directory for synchronization, click the project path button and enter path in the fields provided.
  14. Once you have added all projects you want to synchronize, click the Save button to save your changes.

Once a connection defined and saved, you can use the Connections tab on the dashboard for editing the connection's configuration data. Select one connection and click on the edit button to open the connection wizard again. We strongly recommend that you disable a connection first before editing it.

If you are changing configuration data which have an impact on the synchronization process, but some synchronization have already been executed, then it might be required to verify all executed synchronizations and, if required, execute the synchronization again based on the changed configuration data. It depends on the data sources which configuration changes are allowed and supported.

It might be required to run the synchronization once again on all files. This can be enforced by clearing the connection's synchronization watermarks . If you click on this button you have to confirm that you really want to delete the water marks.

Important: Clearing the water marks might have a significant impact on the next synchronization runtime, because the synchronization is checked and, if required, executed once again for all files.
Parent topic: Working with Connections