Chat now with support
Chat with Support

Identity Manager 8.0 - Target System Synchronization Reference Guide

Target Synchronization with the Synchronization Editor Basics of Target System Synchronization Setting up Synchronization
Starting the Synchronization Editor Creating a Synchronization Project How to Configure 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 Synchronization Configuration Checking Synchronization Configuration Consistency Activating the Synchronization Project
Running Synchronization Synchronization Analysis Setting up Synchronization with Default Connectors Updating Existing Synchronization Projects Additional Information for Experts Error Handling Appendix: Example of a Configuration File

Parameter Definitions

Parameter Definitions

First, define all the parameters for variable settings. You can use these parameters in the global and editor definitions.

Table 76: Parameter Definition
Attribute Description
Parameter name Name of the parameter.
Display Display name of the parameter.
IsQueryParameter Specifies whether the parameter's value is given by the user.
  • False: the parameter value is pass on the command line.
  • True: the parameter value is queried after the command is executed. The user must enter a value. This setting can be used to input a password, for example.
IsSecret Specifies whether the parameter value is displayed or not.
  • False: The parameter value is displayed when the user enters it.
  • True: the parameter is masked when the user enters it.
Example value Default value used if no value is entered on the command line or by user input. If no default value is defined, a value must be passed on the command line or entered by the user.

Global Definitions

Global Definitions

Global definitions contain the following information required for adding new synchronization projects.

Table 77: Global Definitions
Elements Description
WorkDatabase.ConnectionString Database server connection parameter.
WorkDatabase.AuthenticationString Login data for the One Identity Manager database which the synchronization project is created in.

Modify these settings or define parameters for adding new synchronization projects to a different database.

Editor Definitions

Editor Definitions

This definition section contains all the settings made in the project wizard. It contains the information:

Table 78: Project wizardClosed definitions
Elements Description
TemplateUid Unique project template ID to be used.

This element does not exist if the reference project was created without a project template.

ConnectedSystemIdentity SchemaClosed information, such as type, version and schema ID of the connected system.
ScriptLanguage Script language used in the synchronization project.
ShellDisplay Synchronization projectClosed display name.
ShellDescription Description of the synchronization project.
AutoCompletion Specifies whether the synchronization project is activated immediately.
MainConnection The connection data of the One Identity Manager database to be synchronized in this synchronization project.
ConnectedSystemConnection Connection data for the target system to be synchronized with this synchronization project.
TemplateConfiguration Additional settings that were made in the project wizard. For example:
  • ProvisioningClosed data
  • Enabled revision filter
  • Setting for the synchronization log
  • Selected synchronization server

This element does not exist if the reference project was created without a project template.

Synchronization Editor Command Line Interface

Synchronization Editor Command Line Interface

Once you have created a configuration file and have customized it accordingly, you can generate new synchronization projects with the Synchronization EditorClosed Command Line Interface.

To create a synchronization project with the SynchronizationClosed Editor Command Line Interface

  1. Start a command line editor.
  2. Switch to the One Identity Manager installation directory.
  3. Execute the Synchronization Editor Command Line Interface with the option -V and set the parameter values.

    SynchronizationEditor.CLI.exe --CreateShell {<options>} <configuration file> {<parameter>}

    Example: SynchronizationEditor.CLI.exe --CreateShell -V /Workspace=D:\ActiveDirectoryProject.sews /SetParam SyncProject="Synchronization Project for Active Directory Domain XYZ"

    NOTE: If a parameter value contains a space or special character, it must be enclosed in quotes.

  4. Enter the values for parameters requiring user input.
    • To enter an empty value, press ENTER.
    • To copy default values defined in the configuration file, press ESC.
  5. If no error occur, execute steps 3 and 4 with the option -S.

    If the synchronization project was created with a project template, the schemas are shrunk when saved.

TIP: Run the SynchronizationEditor.CLI.exe without additional input to view help for the Synchronization Editor Command Line Interface.

Table 79: Synchronization Editor Command Line Interface Options
Option Description
-?|H Displays help.
-Q No alert before running irreversible actions.
-V The Synchronization Editor Command Line Interface is run in verbose mode. Use this option for debugging.
-S Saves the new synchronization project in the database. If this option is not given, creating the synchronization project is simulated.
Table 80: Parameter Declaration
Parameter Description
/Workspace Full or relative path of the configuration file.
/SetParam Sets the value of the parameter defined in the configuration file. Overwrites default values.

Format: parameter name=value

Note case sensitivity of parameter names.

If a value contains a space or special character, it must be enclosed in quotes. Multiple parameters are separated with spaces.

Related Documents