Chat now with support
Chat with Support

Identity Manager 8.0 - Windows PowerShell Connector User Guide

Creating a Synchronization Project

Creating a Synchronization Project

A synchronization project collects all the information required for synchronizing the One Identity Manager database with a target system. Connection data for target systems, schema types and properties, mapping and synchronization workflows all belong to this.

Have the following information available for setting up a synchronization project.

Table 7: Information Required for Setting up a Synchronization Project
Data Explanation
Definition file You provide the required Windows PowerShell cmdlets, schema types, schema properties and connection parameters in an XML file.

Synchronization serverClosed

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Entries which are necessary for synchronization and administration with the One Identity Manager database are processed by the synchronization server.

Installed components:

  • One Identity Manager Service (started)

The synchronization server must be declared as a Job server in One Identity Manager. The Job server name is required.

For more information, see Setting Up the Synchronization Server.

Remote connection serverClosed

To configure synchronization with a target system, One Identity Manager must load the data from the target system. One Identity Manager communicates directly with target system to do this. If you do not have direct access on the workstation on which the SynchronizationClosed Editor is installed, because of the firewall configuration, for example, you can set up a remote connection.

The remote connection server and the workstation must be in the same Active Directory domain.

Remote connection server configuration:

  • One Identity Manager Service is started
  • RemoteConnectPlugin is installed

The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.

TIP: The remote connection server requires the same configuration (with respect to the installed software) as the synchronization server. Use the synchronization as remote connection server at the same time, by simply installing the RemoteConnectPlugin as well.

For more detailed information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide.

Synchronization workflowClosed Set the option Data import in the synchronization step if synchronization data is imported from a secondary system. You cannot select the processing method "MarkAsOutstanding" for these synchronization steps.

For more detailed information about synchronizing user data with different systems, see the One Identity Manager Target System Synchronization Reference Guide.

Base objectClosed If no base object can be specified, you can assign a base table and the synchronization server.
  • Select the Base table from the menu in which to import the objects. The base table can be used to defined downstream processes for synchronization. For more information about downstream processes, see the One Identity Manager Target System Synchronization Reference Guide.
  • All Job servers, which have the server function "Windows PowerShell connector" enabled are displayed in the Synchronization servers menu.
Variable setClosed If you implement specialized variable sets, ensure that the start up configuration and the base object use the same variable set.

To configure synchronization with the Windows PowerShell connector

  1. Create a definition file, which described the structure of the target system and the Windows PowerShell cmdlets to use.
  2. Create a new synchronization project.
  1. Add mappings. Define property mapping rules and object matching rules.
  2. Create synchronization workflows.
  3. Create a start up configuration.
  4. Define the synchronization scope.
  5. Specify the base object of the synchronization.
  6. Specify the extent of the synchronization log.
  7. Run a consistency check.
  8. Activate the synchronization project.
  9. Save the new synchronization project in the database.

For more detailed information about create the various components of the synchronization configuration (mappings, workflows, startup configuration,...), see the One Identity Manager Target System Synchronization Reference Guide.

Detailed information about this topic

Creating Definition Files

Creating Definition Files

When you set up synchronization, you enter the required Windows PowerShell cmdlets, schema types, schema properties and the information required for logging in to the target system in XML notation. Create one XML file for this, which contains the entire definition. The definition file is loaded when you configure synchronization in the project wizard. You can create Synchronization EditorClosed maps and synchronization workflows based on this definition.

You can find an example of a definition file on the One Identity Manager installation medium in directory ..\Modules\TSB\dvd\AddOn\SDK\ADSample.xml.

Table 8: Structure of the Definition File
Elements Description
PluginAssemblies Additionally required plugins. Plugin are required for converting return values from the connector or readable values from the Windows PowerShell.
ConnectionParameters Definition of the connection parameter required for connecting to the target system.
Initialization Describes the elements required for connecting Windows PowerShell and reading or writing data in the target system.
PredefinedCommands List of all required cmdlets, which are already defined in the Windows PowerShell modules and snap-ins in use.
CustomCommands Definition of custom cmdlets. Create cmdlets for all commands that are required in addition to PredefinedCommands . Specify a name, the required parameter and the command to run for each cmdlet.
Connect CommandSequence Command sequence to execute in order to create a Windows PowerShell connection to the target system. The command sequence consists of a succession of cmdlets in a specified order.
Disconnect CommandSequence Connection sequence to run in order to closed an existing Windows PowerShell connection. The command sequence consists of a succession of cmdlets in a specified order.
SchemaClosed Describes how return values from cmdlets are mapped to a schema, which is loaded from the Windows PowerShell connector and can be edited in the synchronization configuration. Defines schema types, schema properties and processing methods, which can be run for each schema type.
Class Schema typeClosed definition. A schema type is defined by elements listed below
Properties Definition of a schema type's schema properties.
CommandMappings Specifiesthe cmdlets used for editing the schema property's values.
ReturnBindings Specifies which cmdlets from the CommandMappings list, returns values for the schema property.
ModifiedBy Specifies which cmdlet from the CommandMappings list writes the schema property's value in the target system.
ReadConfiguration Definition of cmdlets used to read a list of objects (ListingCommand) or to read a single object with all properties (CommandSequence).
MethodConfiguration Definition of methods for reading, writing and deleting a schema type's objects. A method consists of a succession of cmdlets in a specified order. Equivalent methods for all processing methods used in synchronization workflows, must be defined here.

How to Set up a Synchronization Project

How to Set up a Synchronization Project

There is an wizard to assist you with setting up a synchronization project. This wizard takes you all the steps you need to set up initial synchronization with a target system. Click Next once you have entered all the data for a step.

NOTE: The following sequence describes how you configure a synchronization project if the Synchronization EditorClosed is both:
  • In default mode
  • Started from the launchpad

Additional settings can be made if the project wizard is run in expert mode or is started directly from the SynchronizationClosed Editor. Follow the project wizard instructions through these steps.

To set up a synchronization project

  1. Start the Launchpad and log on to the One Identity Manager database.

    NOTE: If synchronization is executed by an application server, connect the database through the application server.
  1. Select Windows PowerShell connector. Click Run.

    This starts the Synchronization Editor's project wizard.

  1. Specify how the One Identity Manager can access the target system on the System access page.
    • If you have access from the workstation from which you started the Synchronization Editor, do not set anything.
    • If you do not have access from the workstation from which you started the Synchronization Editor, you can set up a remote connection.

      In this case, set the option Connect using remote connection server and select, under Job serverClosed, the server you want to use for the connection.

  • Click Next to start the system connection wizard for connecting with the Windows PowerShell .
  1. Click Next on the start page of system connection wizard.
  2. On the Connector Definition page, you enter the required Windows PowerShell cmdlets, schema types, schema properties and the information required for logging in to the target system in XML notation.
    Table 9: Connector Definition
    Property Description
    System ID/Name Unique name for the system connection.
    Concurrent connections

    Maximum number of connections to the target system that can exist in parallel.

    Definition Definition that the target system schema converts into cmdlet calls. Enter the definition in XML notation.
    1. To load the definition from a definition file, click .
    2. To check the definition, click .
  3. Enter the data for the required connection parameter on the Connection data page. All the parameters from the ConnectionParameters element of the XML definition are queried.
  4. You can save the connection data on the last page of the system connection wizard.
    • Set the option Save connection locally to save the connection data. This can be reused when you set up other synchronization projects.
    • Click Finish, to end the system connection wizard and return to the project wizard.
  1. Verify the One Identity Manager database connection data on the One Identity Manager connection page. The data is loaded from the connected database. Reenter the password.

    NOTE: Reenter all the connection data if you are not working with an encrypted One Identity Manager database and no synchronization project has been saved yet in the database. This page is not shown if a synchronization project already exists.
  2. The wizard loads the target system schema. This may take a few minutes depending on the type of target system access and the size of the target system.
  1. Select a project template on the Select project template page to use for setting up the synchronization configuration.

    NOTE: The Windows PowerShell connection does not provide a default project template for setting up synchronization. If you have created your own project template, you can select it to configure the synchronization project. Otherwise, select Create blank project.
  1. Enter the general setting for the synchronization project on the General page.
    Table 10: General Synchronization Project Properties
    Property Description
    Display name Display name for the synchronization project.
    Script language Language in which the scripts for this synchronization project are written.

    Scripts are implemented at various points in the synchronization configuration. Specify the script language when you set up an empty project.

    Important: The script language cannot be changed after the synchronization project has been saved.

    If you use a project template, the template's script language is used.

    Description Spare text box for additional explanation.
  1. Click Finish to complete the project wizard.
  2. Save the synchronization project in the database.

Updating Schemas

Updating Schemas

All the schema data (schema types and schema properties) of the target system schema and the One Identity Manager schema are available when you are editing a synchronization project. Only a part of this data is really needed for configuring synchronization. If a synchronization project is finished, the schema is compressed to remove unnecessary data from the synchronization project. This can speed up loading the synchronization project. Deleted schema data can be added to the synchronization configuration again at a later point.

If the target system schema or the One Identity Manager schema has changed, these changes must also be added to the synchronization configuration. Then the changes can be added to the schema property mapping.

To include schema data that have been deleted through compressing and schema modifications in the synchronization project, update each schema in the synchronization project. This may be necessary if:

  • A schema was changed by:
    • Changes to a target system schema
    • Customizations to the One Identity Manager schema
    • A One Identity Manager update migration
  • A schema in the synchronization project was shrunk by:
    • Activating the synchronization project
    • Synchronization projectClosed initial save
    • Compressing a schema

To update a system connection schema

  1. Open the synchronization project in the Synchronization EditorClosed.

  2. Select the category Configuration | Target system.

    - OR -

    Select the category

    Configuration | One Identity Manager connection.

  3. Select the view General and click Update schema.
  4. Confirm the security prompt with Yes.

    This reloads the schema data.

To edit a mapping

  1. Open the synchronization project in the SynchronizationClosed Editor.

  2. Select the category Mappings.
  3. Select a mapping in the navigation view.

    Opens the MappingClosed Editor. For more detailed information about editing mappings, see One Identity Manager Target SystemClosed Synchronization Reference Guide.

NOTE: The synchronization is deactivated if the schema of an activated synchronization project is updated. Reactivate the synchronization project to synchronize.
Related Documents