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.
Data | Explanation | ||
---|---|---|---|
Definition file | You provide the required Windows PowerShell cmdlets, schema types, schema properties and connection parameters in an XML file. | ||
Synchronization server |
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:
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 server |
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. The remote connection server and the workstation must be in the same Active Directory domain. Remote connection server configuration:
The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.
For more detailed information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide. | ||
Synchronization workflow |
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 object |
If no base object can be specified, you can assign a base table and the synchronization server.
| ||
Variable set |
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
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.
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 EditorOne Identity Manager tool for configuring target system synchronization. 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.
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. |
Schema |
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 type |
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. |
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 Editor
Additional settings can be made if the project wizard is run in expert mode or is started directly from the Synchronization |
To set up a synchronization project
|
NOTE: If synchronization is executed by an application server, connect the database through the application server. |
This starts the Synchronization Editor's project wizard.
In this case, set the option Connect using remote connection server and select, under Job serverServer with the One Identity Manager Service installed., the server you want to use for the connection.
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.
|
|
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. |
|
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. |
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.
If you use a project template, the template's script language is used. | ||
Description | Spare text box for additional explanation. |
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:
To update a system connection schema
Open the synchronization project in the Synchronization EditorOne Identity Manager tool for configuring target system synchronization..
- OR -
Select the categoryConfiguration | One Identity Manager connection.
This reloads the schema data.
To edit a mapping
Open the synchronization project in the SynchronizationThe process of comparing data between One Identity Manager and a target system. Objects and their properties are compared by fixed rules. Synchronization results in the identical data situation in the target system and One Identity Manager database. Editor.
Opens the MappingList of object matching rules and property mapping rules which map the schema properties of two connected systems to one another. Editor. For more detailed information about editing mappings, see One Identity Manager Target System
An instance of a target system in which the employees managed by One Identity Manager have access to network resources. Example: An Active Directory domain X for target system type "Active Directory", a directory Y for target system type "LDAP", a client Z for target system type "SAP R/3". Synchronization Reference Guide.
|
NOTE: The synchronization is deactivated if the schema of an activated synchronization project is updated. Reactivate the synchronization project to synchronize. |
© 2021 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy