Chat now with support
Chat with Support

Identity Manager 8.2.1 - Target System Synchronization Reference Guide

Target system synchronization with the Synchronization Editor Working with the Synchronization Editor Basics of target system synchronization Setting up synchronization
Starting the Synchronization Editor Creating a synchronization project Configuring synchronization
Setting up mappings Setting up synchronization workflows Connecting systems Editing the scope Using variables and variable sets Setting up start up configurations Setting up base objects
Overview of schema classes Customizing the synchronization configuration Checking the consistency of the synchronization configuration Activating the synchronization project Defining start up sequences
Running synchronization Synchronization analysis Setting up synchronization with default connectors Updating existing synchronization projects Script library for synchronization projects Additional information for experts Troubleshooting errors when connecting target systems Configuration parameters for target system synchronization Configuration file examples

Applying patches

CAUTION: Patches do not change customizationsClosed in synchronization projectsClosed. This mean that conflicts may occur if patches are applied to synchronization projects, which have been customized. This may cause loss of data.

Before you apply a patch

  1. Read the patch description to decide whether it provides necessary improvements for the synchronization project.
  2. Check whether conflict with customizations could occur.
  3. Create a backup of the database so that you can restore the original state if necessary.
  4. Deactivate the synchronization project.

NOTE: If synchronization projects are updated, connection parameters from the default variable set are always used. Ensure that the variables in the default variable set contain the correct values.

Some patches required user input during installation, for example, to confirm that you really want a particular change to be run.

To apply patches

  1. Open the synchronization project in the Synchronization EditorClosed.

  2. In the menu bar, select the Edit > Update synchronization project... menu item.

  3. Select the milestone to apply under Available patches.

    In the patch details view, all dependent patches are listed in the order in which they will be applied.

  4. Click Apply selected patches.

  5. Enter any user input as prompted.

  6. Optional: Select the patches to apply for new functions under Available patches. Multi-select is possible.

    In the patch detail view, patches are listed in the order in which they will be applied.

  7. Click Apply selected patches.

  8. Enter any user input as prompted.

  9. If necessary, use the patch log to check whether customization need to be reworked.

  10. If required, rework customizations in the synchronization configuration.

  11. Run a consistency check.

  12. Simulate the synchronization.

  13. Activate the synchronization project.

  14. Save the changes.

NOTE: A patch does not take effect until the changes associated with it are saved in the database. If consistency check or simulation errors occur that cannot be corrected, you can dismiss the patch changes by reloading the synchronization project without saving the changes.

Related topics

Automatic patches

Patches can be labeled as automatic patches. All existing synchronization projectsClosed are migrated after One Identity Manager is updated, for example, with a service pack. This updates the One Identity Manager schema and applies automatic patches. A process is queued in the Job queueClosed to do this. After the One Identity Manager update, you should check whether the process DPR_Migrate_Shell was run successfully. If a patch could not be applied, for example because the target system was not available, you can apply the patch manually later.

A Job serverClosed is found to migrate existing synchronization projects. To do this, the synchronization serverClosed is determined from base object that is assigned to the synchronization project’s default variable set. If a synchronization server cannot be found, the Job server carries out the migration using the Update serverClosed server function. In order to run the migration process, the One Identity Manager ServiceClosed must be started on all Job servers found in this way.

Related topics

Script library for synchronization projects

You can apply scripts at various points in the synchronization projectClosed; for example, when defining the schema properties, in the object filter, or when you define data operations for system connections through the generic database connectorClosed. For each synchronization project, you can build a separate script library. The scripts in these script libraries can be used everywhere where scripts are implemented in the synchronization configuration. You can create and maintain scripts centrally that are required for defining different synchronization configuration components.

You can import scripts into other synchronization projects. Scripts that are used in different synchronization projects are labeled as script templatesClosed. The script templates are only maintained in one synchronization project. You can transfer any modification to other synchronization projects as required.

NOTE: Scripts from the One Identity Manager script library are not available in the Synchronization EditorClosed‘s script library. For detailed information about the One Identity Manager script library, see One Identity Manager Configuration Guide.

To display a synchronization project’s script library

  1. In the Synchronization Editor, open the synchronization project.
  2. Select the Configuration > Script library category.
Detailed information about this topic

Views in the script library

The Synchronization EditorClosed‘s script library has two views. The Scripts view provides an overview of all general properties of the scripts. The scripts are edited in the Editor view.

Script views

This lists all the scripts in the script library with all their general properties. You can update scripts that were created from script templatesClosed.

Table 76: Icons in the script view




Create a new script.


Edit the selected script’s general properties.


Deletes the selected script.


Imports scripts from other synchronization projectsClosed.

Updates scripts with changes from script templates.

Table 77: General properties of scripts




Name of script.


Text field for additional explanation.

Schema typeClosed

SchemaClosed type that the script is used on.

Is template

Script can be used as a template for other synchronization projects.

Uses template

Script was imported from another script template.

Updates available

Script template used as basis for the script has changed.

Updates differences

Shows the changes to the script template.

Updates apply

Updates the script with the changes from the script template.

Editor view

Show the code of the selected script. It can be edited and compiled. For more information, see Support for scripting.

Table 78: Icons in the editor view



Saves changes to the script.


Compiles all the scripts in the script library.

Script was compiled without errors.

Script contains syntax errors.

Detailed information about this topic
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating