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

Specifying custom processing methods

Apart from a connector’s default and additional processing methods, the Synchronization EditorClosed can also use custom processing methods. This is done using custom scripts.

To set up and use a custom processing method

  1. In the Designer, create a script to make the necessary modifications to the loaded objects.

    Script structure:

    Public Sub CCC_ScriptName(unit As IUnitOfWork, entity As IEntity())
       'Steps to execute
    End Sub
    • <Tag("Projector")>: Labels the script to use as a processing method. This enables the Synchronization Editor to identify the scripts to use as processing methods.

    • <BaseObjectType("Table")>: Defines the type of objects the script will be applied to. Enter the table that contains the objects to be handled.

      If the script can be applied to several object types, define a separate object type for each table.

    • CCC_ScriptName: Script name. In the Synchronization Editor, you can select the script as the processing method under this name. Enter a name that uniquely describes the processing method.

    For detailed information about creating scripts with the Script Editor, see the One Identity Manager Configuration Guide.

  2. Compile the script.

  3. Open the synchronization projectClosed in the Synchronization Editor.

  4. Select the Configuration | One Identity Manager connection category and update the One Identity Manager schema.

  5. In the Workflows category, select the synchronization workflow in which you want to use the new processing method.

  6. Find the synchronization stepClosed and click Edit.

    The synchronization step must handle the object type defined in the script.

  7. On the Processing tab, you can select processing methods under the script name.

Example script

The following example script removes the manager from all departments and location that the script will be applied to as a processing method.

Public Sub CCC_Department_RemoveManager(unit As IUnitOfWork, entities As IEntity())
   For Each currEntity As IEntity In entities
      If Not String.IsNullOrEmpty(currEntity.GetValue("UID_PersonHead").ToString()) Then
      End If 
End Sub
Related topics

Specifying quotas

Errors in the synchronizationClosed configuration can cause system objects to be processed incorrectly. Errors in the data through incorrect configuration can be reduced. Often, it is known how many system objects have been modified, added, or deleted in a connected system. If this number is exceeded when a processing method is executed, a warning appears and synchronization is aborted. The synchronization stepClosed and mappingClosed configurations can be checked and corrected before repeating synchronization.

A quotaClosed can be defined for each processing method in each synchronization step to specify the part of the system objects to process. A quota provides the number of object to process relative to the total number of all objects in the schema class to be synchronized. When a synchronization step is executed, One Identity Manager calculates the number of objects to process for each processing method with a quota. If this number exceeds the quota, the synchronization step is aborted.

Quotas can only be defined for processing methods which modify data (for example, Insert, Update, Delete).

NOTE: One Identity Manager takes total number objects to be synchronized into account when it calculates the number of objects to process. Conditions defined for processing methods are not taken into account!

Enter an higher quota for processing methods which limit the number of objects to synchronize with a condition.

Table 53: Quotas for a synchronization step
Property Meaning
No quota If this is set, quotas are not included.
Use these settings

Specify which processing methods include a quota. Enter the quota in percent.

One Identity Manager specifies quotas for synchronization in the target system in workflows created with the workflow wizard, by default. These quotas can be changed later.

Processing method Quota
Update 75 %
Delete 10%

Rule filters

You can specify which Property mappingClosed rules must be applied to each synchronization stepClosed. For example, dependencies between schema class objects can be resolved this way.

Included rules: Select the property mapping rule to be applied during synchronizationClosed.
Excluded rules: Select the property mapping rules which should not be applied during synchronization.
NOTE: Unmarked rules are included automatically.
Detailed information about this topic

Extended synchronization step properties

You can optimize memory usage for processing synchronization stepClosed data on the Extended tab.

Table 54: Extended synchronization step properties
Property Description
Performance/memory factorClosed This controls the behavior of memory and performance in the synchronizationClosed step. If more memory is available, you can change the performance/memory factor in favor of performance. Reduce the performance/memory factor if there are memory problems.

The performance/memory factor specifies the percentage with which the reload threshold, partition size, and bulk level are applied to an object type.

Use the slider to set the performance/memory factor.

  • Move the slider to the right to increase performance. This requires more memory.
  • Move the slider to the left to reduce the memory requirement. This also reduces the performance.

Reload threshold

Specifies the maximum number of properties that can be loaded by synchronization to prevent partitioned reloading. You can increase this value to accelerate synchronization of target systems with small mappingsClosed. However, more memory is required.

The default value for all data to be processed is fixed in the start up configuration. It can be specified separately for every synchronization step.

To specify the threshold for a synchronization step

  1. Disable Use start up configuration settings.
  2. Change the preset reload threshold.


Specifies whether changes in the in-memory object are committed after the synchronization step has been executed. This affects changes that are made through the property mapping rule’s Force mapping against direction of synchronizationClosed option.

This setting is required only for object-based synchronization, for example, provisioning, when the object must be handled by more than one synchronization step.

  • None: No changes are committed.

  • Automatic: It is decided automatically, which changes are committed.

  • UserDefined: Changes to the selected schema properties are committed.

    Under Commit changes for, enable the schema properties whose changes are committed in the in-memory object.

TIP: You can adjust the memory requirements for all the data to be processed in the start-up configuration. You can set the reload threshold, partition size, and bulk level here. These setting are only possible in expert mode. For more information, see Extended properties for start up configuration.

Detailed information about this topic
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating