Chat now with support
Chat with Support

Identity Manager 8.1.4 - 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 Resolving errors when connecting target systems Configuration parameters for target system synchronization Configuration file examples Glossary

Applying patches

CAUTION: Patches do not change customizations 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.

One Identity Manager has three patch types. All patches that are applied are displayed in the synchronization project's migration details. Once a milestone has been applied, the associated patches are not listed separately in the migration details anymore.

Table 73: Patch types
Patch type Description
Optional features Patch for optional functionality
Fix Patch for solved problems.
Mile stone Milestones are provided with every new One Identity Manager version. A milestone is provided for each context, which includes all the solved issues of the previous version. It does not contain the optional features of the previous version.

Patches can be dependent on each other. These dependencies determine the order in which the patches are applied. When a patch is applied, the patches that are dependent on it are also applied. If a new version of One Identity Manager is installed, all patches for the version are consolidated into one milestone. If patches are available for different version of the program, the older patches must always be applied first. Therefore, One Identity Manager automatically applies all previous milestone once a patch for a later version is selected.

Patches and their dependencies are displayed in the patch view. The left side shows the patches that are available. The newest patches are at the top. Dependent patches are displayed below. In this area, select the patches that you want to apply to the current synchronization project. Then the patches are displayed on the right-hand side, with all their predecessor in the order in which they will be applied.

Each patch contains a script which checks if the patch can be applied to the synchronization project. Whether or not a patch can be applied depends on the concrete synchronization configuration.

Table 74: Meaning of icons in the rule tool bar
Icon Meaning
Fixes Shows patches with fixes.
Optional features Shows all patches for optional features.
Shows all patches that are cannot be applied to the synchronization project.
Shows all patches that are already applied to the synchronization project.

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

To apply patches

  1. Open the synchronization project in the Synchronization EditorClosed.

  2. Select Edit | Update synchronization project... from the menu.

  3. Optional: Select the patches to be applied under Available patches. Multi-select is possible.

    In the patch detail view, 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. If necessary, use the patch log to check whether customization need to be reworked.

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

  8. Run a consistency check.

  9. Simulate the synchronization.

  10. Activate the synchronization project.

  11. 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 queue 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 server 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 server server function. In order to execute the migration process, the One Identity Manager Service 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 native database connector. 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 you use in different synchronization projects you can label as script templates. 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 templates.

Table 75: 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 76: 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 77: 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