Chat now with support
Chat with Support

Identity Manager 9.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

Creating synchronization projects from a custom project template

Take note of the following advice before creating a synchronization projectClosed:

NOTE: It is possible that project templatesClosed created with an older version of One Identity Manager are not compatible with the currently installed version. Errors may occur if these project templates are used. Recreate the project templates with the currently installed version of One Identity Manager.

NOTE: The script language of the synchronization project you want to set up, supports the project template script language.

CustomClosed project templates can also be used if expert mode is not enabled.

To create a synchronization project from a custom project template

  1. Create a new synchronization project with the project wizard.

    1. Select the custom project template on the Select project template page.

    2. On the Synchronization base object page, select the base object that is required for the synchronization and provisioning processes.

      • Base objectClosed table: Table to select the base object from, for example ADSDomain.
      • Show more: Shows tables for other target system types in the base table menu.
      • Base object: Object from the base table that forms the base object for synchronization and provisioning processes.
      • Proceed without a base object: Synchronization does not require a specific base object.

        Set this option, if the base object is not in the One Identity Manager database yet.

    1. On the Synchronization server page, select the synchronization serverClosed to run the synchronization.

      If the synchronization server is not declared as a Job server in the One Identity Manager database yet, you can add a new Job server.

      1. Click to add a new Job server.

      2. Enter a name for the Job server and the full server name conforming to DNS syntax.

      3. Click OK.

        The synchronization server is declared as Job server for the target system in the One Identity Manager database.

      4. NOTE: After you save the synchronization project, ensure that this server is set up as a synchronization server.

    1. Enter the general setting for the synchronization project under General.

      • Display name: Display name for the synchronization project.
      • Description: Text field for additional explanation.
    2. Disable the Activate and save the new synchronization project automatically option on the last page of the project wizard.

      The synchronization project should not be activated jet because it is not completely configured.

  2. Changed the display names and description of the synchronization project if required.

  3. Save the synchronization project in the database.

To configure synchronization with this synchronization project

  1. Select the variables in the default variable set. Modify at least the value of variables with connection parameters.

  2. Define the synchronization scope.

  3. (Optional) If the base object does not yet exist in the One Identity Manager database, add the synchronization base object in the Manager. This might be the specific Active Directory domain to be synchronized, for example.

    • Specify the synchronization base object in the Synchronization EditorClosed.

      Select the base table for the base object you just added and the synchronization server.

  4. (Optional) In the DesignerClosed, check if the operations for provisioning and single objects synchronization have been added. This is the case if the base object was entered when the synchronization project was created from the custom project template. Otherwise, define the required single object operations in the Designer.
  5. Specify the extent of the synchronization log.

  6. Assign a scheduleClosed to the start up configuration.

  7. Run a consistency check.

  8. Activate the synchronization project.

  9. Save the changes.
Detailed information about this topic
Related topics

Managing project templates

The Synchronization EditorClosed provides an overview of all available project templatesClosed. Here you can edit display names and descriptions of customClosed project templates and delete project templates you no longer need.

To display a list of project templates

  1. Select the Database > Manage templates... menu item.

    This menu item is only displayed in export mode.

    This opens the dialog window Manage templates....

  2. To hide custom project templates, disable in the dialog box toolbar.

  3. To hide default project templates, disable in the dialog box toolbar.

Table 82: Project template properties

Property

Description

Project template

Name of the project template.

Target systemClosed

Type of target system, which applies to the project template.

Supported versions

Version of the target system that are supported by this project template. If no value is displayed, the project template supports every version that can be connected with the target system connector. For more information, see the administration manuals for connection to the respective target system.

Description

Description of the project template.

Last change

Date of the last change to the project template.

To edit a custom project template

  1. Enable in the dialog box toolbar.

  2. Select the project template.

  3. Edit the display name or description in the Properties pane.

  4. Click Save and close.

  5. Confirm the security prompt with Yes.

To delete a custom project template

  1. Enable in the dialog box toolbar.

  2. Select the project template.

  3. Click in the dialog box toolbar.

  4. Confirm the security prompt with Yes.
  5. Click Save and close.

  6. Confirm the security prompt with Yes.

Include custom tables in the synchronization

CustomClosed schema extensions can be included in the synchronizationClosed configuration. Custom columns are automatically assigned to additional schema properties which can be included in the mapping. The following settings must be made in order to include custom tables that were created using the default project templatesClosed in synchronization projectsClosed.

To prepare a custom table for synchronization

  1. In the Manager, assign a target system type to the custom table.

    • Specify whether outstanding objects can be published in post-processing.

  2. In the Synchronization EditorClosed, select a synchronization project and create a schema class for the custom table in the One Identity Manager schema.

  3. In the Synchronization Editor, define the mapping and synchronization stepsClosed for the schema class.

For more information about target system types and post-processing outstanding object, see the target system connection guides.

Integrate a custom table into provisioning processes

  • In the DesignerClosed, define the provisioning operations.

    Use the settings from other operations for the same target system and modify the following properties:

    • Synchronization workflowClosed: Select the provisioning workflowClosed.

    • Table: Select the custom table.

To publish outstanding objects in a custom table

  1. Create a process that performs provisioning of objects for:

    • Simple tables
    • Assignment tablesClosed that contain additional information, such as a valid-from date

    Use the AdHocProjection process taskClosed of the ProjectorComponent process componentClosed.

    For more information about defining processes, see the One Identity Manager Configuration Guide.

  2. Create the HandleOutstanding event for this process.

For memberships mapped to simple assignment tables, the Dependencies modified on (XDateSubItem column) is changed on the base table of the mapping when publishing. This triggers the default update process that is set up for this base table. For more information, see Changing a membership label.

Configuring single object synchronization for a custom table

  1. In the Designer, define the operations for single object synchronization.

    Use the settings from other operations for the same target system and modify the following properties:

    • Name: Read

    • Synchronization workflow: Select the synchronization workflow.

    • Table: Select the custom table.

  2. In the Designer, assign the custom table to customizer DPR.CustomizerClosed.ProjectorReadEntityLogic.

  3. Create a process in the Designer for the custom table.

    Use the settings from another read process for the same target system and modify the following properties.

    • Replace all references to the original table with a reference to the custom table.

    Process properties:

    • Table: Select the custom table.

    • Event: Read

    • Pre-script for generating: Pass the defined single object operation as a parameter to script DPR_GetAdHocData.

    Process step properties:

    • Process task: ProjectorComponent - UpdateProjection

    • Process information term: Replace the display name of the object with the display name of the custom table.

    For more information about setting up processes, see the One Identity Manager Configuration Guide.

  4. Record the path to the base object of synchronization for the custom table in the Manager.

    For more information about this, please consult the manuals for connecting target systems.

Detailed information about this topic
Related topics

Validating scripts

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. You can enter scripts in C# or Visual Basic .NET depending on script's language, which was specified for the synchronization project.

You can use the available compiling and debugging functions to troubleshoot script.

Table 83: Edit box buttons
Button Description
Opens advanced edit mode.
Compile Checks the script's syntax.

Script was compiled without errors.

Script contains syntax errors.

Debug Export the current script to a Visual Studio project.

This button is available only in the Edit SchemaClosed Properties dialog and in the system connection wizard for the generic database connector.

Compile

To verify the script's syntax

  1. Open the script in the Synchronization EditorClosed.
  2. Click Compile.

Compiler errors are shown immediately and written to in the Synchronization Editor's error log.

Debug

The script is exported to a Visual Studio project for debugging. Once the project is run, the Synchronization Editor starts in debug mode and the script is tested.

Prerequisites
  • Visual Studio is installed on the workstation on which the Synchronization Editor is running.
  • All changes to the synchronization project are saved.
  • The debugger can be used in scripts that are used in:
    • Schema properties
    • Script variablesClosed
    • Data operations for system connections using the generic database connector

To debug a script

  1. Open the script in the Synchronization Editor.
  2. Click Debug.
  3. Confirm the prompt with OK.
  4. Start debugging in the Visual Studio project.
  5. If necessary, correct the script in the Synchronization Editor's default mode.
  6. Save the changes.
Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating