Identity Manager 9.2 - CSV Connector User Guide

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 5: Information required for setting up a synchronization project
Data	Explanation
Synchronization server	All One Identity Manager Service actions are run against the target system environment on the synchronization server. Data entries required 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 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 the target system to do this. Sometimes direct access from the workstation, on which the Synchronization Editor is installed, is not possible. For example, because of the firewall configuration or the workstation does not fulfill the necessary hardware and software requirements. If direct access is not possible from the workstation, 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 as the synchronization server (with regard to the installed software and entitlements). Use the synchronization as remote connection server at the same time by 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 workflow	Set the Data import option in the synchronization step, if CSV import data is supplied by a secondary system. You cannot select the MarkAsOutstanding processing method 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	You cannot normally specify a base object for synchronizing with the CSV connector. In this case, assignment of one base table and the synchronization server is sufficient. Select the table from the Base table menu in which to import the objects. The base table can be used to defined downstream processes for synchronizing a CSV system. For more information about downstream processes, see the One Identity Manager Target System Synchronization Reference Guide. The Synchronization servers menu displays all Job servers with an enabled CSV connector server function.
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 CSV connector

Create a new synchronization project.

Add mappings. Define property mapping rules and object matching rules.
Create synchronization workflows.
Create a start up configuration.
Define the synchronization scope.
Specify the base object of the synchronization.
Specify the extent of the synchronization log.
Run a consistency check.
Activate the synchronization project.
Save the new synchronization project in the database.

Detailed information about this topic

Creating a synchronization project

Creating a synchronization project

There is a wizard to assist you with setting up a synchronization project. This wizard takes you through 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 to configure a synchronization project if the Synchronization Editor is both:

Run in default mode
Started from the Launchpad

If you run the project wizard in expert mode or directly from the Synchronization Editor, additional configuration settings can be made. Follow the project wizard instructions through these steps.

To set up a synchronization project

Start the Launchpad and log in on the One Identity Manager database.

NOTE: If synchronization is run by an application server, connect the database through the application server.

Select the CSV connector entry. Click Run.

This starts the Synchronization Editor's project wizard.

On the wizard's start page, click Next.
On the System access page, specify how One Identity Manager can access the target system.
- If access is possible from the workstation on which you started the Synchronization Editor, do not change any settings.
- If access is not possible from the workstation on which you started the Synchronization Editor, you can set up a remote connection.
  
  Enable the Connect using remote connection server option and select the server to be used for the connection under Job server.

Click Next to start the system connection wizard to create a connection to the CSV file.

On the system connection wizard start page, select Create new CSV system.
Select the CSV file whose data is to be synchronized in the file browser. Click Open.

Check the values for coding the files and language on the Load CSV file page.

Table 6: CSV file properties
Property	Description
CSV file name and path	Full path of the CSV file.
File encoding:	Encoding of the .csv file. Encoding of the character set is determined from the character set on your workstation when the import file is loaded. Change the setting if the file was created with another character set.
Language	Language used to create the file. The language is required in order to read local character formats correctly, for example, dates.
On uniqueness violation	The CSV connector’s behavior if there are CSV entries that cannot be uniquely identified. Report error: Synchronization is canceled with an error message. Use first data set: The first data set is synchronized. All other data sets are ignored. User last data set: The last data set is synchronized. All other data sets are ignored. Do not use multiple data sets: None of the data sets are synchronized.
Read-only access	Specifies whether the CSV connector has read-only access for the CSV file. If this option is disabled, the CSV connector can also write data to the CSV file if the synchronization project is configured accordingly.

Describe the CSV file structure on the File structure page.

Table 7: File structure
Property	Description
Header lines	Number of header lines in the CSV file. The header is not imported.
Column names in line	Line that contains the column names.
Detect columns by	Indicator of column limits. Select the Delimiter option if the data is separated by a semi-colon, comma, space, tab, pipe, or other character. Specify the line structure. Select the Fixed width option if all the data in the columns has the same length. Specify the line structure.

Describe the line structure in the CSV file on the Line structure page.

If columns are separated by a delimiter, enter the delimiter.

Table 8: Line structure

Property

Description

Delimiter

Delimiter used to separate the data in the file. You have the following options: Semicolon, Comma, Space, Tab, and Pipe.

If the data is separated by a different character, select Other: and enter the delimiter in the input field next to the menu.

Text wrap character

Character enclosing the column text. This text is treated as one value on import, even is the text contains the delimiter given as above.

NOTE: The delimiters are masked by doubling them up.

Example:

Delimiter:	Comma (,)
Text qualifier:	Quotation mark (")
Value in file:	"User,BS"
Value after import:	User,BS

Delimiter:	Comma (,)
Text qualifier:	Not given or other character:
Value in file:	"User,BS"
1st value after import:	"User
2nd value after import:	BS"

Mask delimiter by doubling

Specifies whether the data is separated by several of the same delimiters. Data that contains a new line must be marked with a text qualifier.

Example:

Delimiter:	Comma (,)
Mask delimiter by doubling:	Enabled
Value in file:	User,,BS
Value after import	User,BS

Delimiter:	Comma (,)
Mask delimiter by doubling:	Not set
Value in file:	User,,BS
1st value after import:	User
2nd value after import:
3rd value after import:	BS

Define the separation points if the columns are separated by a fixed width.
- Click on the ruler to set a separation point. A separation mark is inserted.
- When you click again on a fixed separation point, the separation mark is deleted.

Describe the data structure on the Display information page.

Specify the Display pattern for displaying the objects in the Synchronization Editor. For example, the display pattern is used in error messages or test result from object matching rules.

Specify the following properties for each column.

To display all the properties, click Expert view.

Table 9: Column data structure
Property	Description
Column	Column name in the CSV file.
Name	The column’s technical name. Specify a new display name or copy the column name from the CSV file.
Display name	Name for the column when it is displayed in the Synchronization Editor. Specify a new display name or copy the column name from the CSV file.
Key column	Specifies whether the column is used as a key column. More than one key columns can be defined. Data records should be uniquely identified with these key columns.
Data type	Column data type
Description	Text field for additional explanation.
Multi-value column	Specifies whether the import contains multiple value property columns. Specifies the delimiter for the individual values.
Hierarchical sort order	Specify whether the column maps the path in an object hierarchy. Synchronization objects are sorted by this order. This makes it possible to resolve object dependencies. This option can only be set for one column of the CSV file. Example from the One Identity Manager schema: The full name of a department (Department.FullPath) specifies the path to the department hierarchy (department with all parent departments). Objects are sorted by their full name during synchronization. All parent departments are loaded first during synchronization and then the child departments.
Reference	Specifies whether the column references other objects.
Revision column	Specifies whether the column contains the revision counter. The data in this column form the comparison value for revision filtering.

On the Define CSV system file page, specify the name and repository of the CSV system file. Configuration of the connection to the CSV file is saved in this file. Optionally, you can specify a system category.
- System category: Category for further differentiation of system types. A maximum of 16 characters, consisting of numbers and letters, are permitted for the identifier.
  
  Connections with the CSV connector are normally saved with the CSV system type. The system category allows one more classification into subtypes. This allows different connections with differing content to be distinguished from one another.
  
  Example:
  
  Connection 1: type =CSV, system category=Internal
  
  Connection 1: type =CSV, system category=External
On the past page of the system connection wizard you can add another CSV file to the system connection.
- To add another CSV file to the system connection, click Add another CSV file.
- Set the Save connection data on local computer option to save the connection data. This can be reused when you set up other synchronization projects.
- Click Next, to end the system connection wizard and return to the project wizard.
  
  NOTE: In the Synchronization Editor, the connection data is saved in a variable set and can be modified in the Configuration > Variables category if necessary.

On the One Identity Manager Connection tab, test the data for connecting to the One Identity Manager database. The data is loaded from the connected database. Reenter the password.
NOTE:
- If you use an unencrypted One Identity Manager database and have not yet saved any synchronization projects to the database, you need to enter all connection data again.
- This page is not shown if a synchronization project already exists.
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.

On the Select project template page, select a project template to use for setting up the synchronization configuration.

NOTE: The CSV connector 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.

Enter the general setting for the synchronization project under General.

Table 10: General properties of the synchronization project
Property	Description
Display name	Display name for the synchronization project.
Description	Text field for additional explanation.

To close the project wizard, click Finish.
Save the synchronization project in the database.

Customizing the CSV system file

Editing a CSV file schema

To add a new CSV file to a system connection and edit the CSV file schema

Select the Configuration > Target system category.
Click Edit connection.

This starts the system connection wizard.
On the Load CSV system file page, in the CSV system information view, specify the CSV files with which to set up the system connection.
To add a new CSV file to the system connection, click . Then edit the schema for this file.
To edit the schema for a CSV file, select the file and click .

Check the values for coding the files and language on the Load CSV file page.

Table 11: CSV file properties
Property	Description
CSV file name and path	Full path of the CSV file.
File encoding:	Encoding of the .csv file. Encoding of the character set is determined from the character set on your workstation when the import file is loaded. Change the setting if the file was created with another character set.
Language	Language used to create the file. The language is required in order to read local character formats correctly, for example, dates.
On uniqueness violation	The CSV connector’s behavior if there are CSV entries that cannot be uniquely identified. Report error: Synchronization is canceled with an error message. Use first data set: The first data set is synchronized. All other data sets are ignored. User last data set: The last data set is synchronized. All other data sets are ignored. Do not use multiple data sets: None of the data sets are synchronized.
Read-only access	Specifies whether the CSV connector has read-only access for the CSV file. If this option is disabled, the CSV connector can also write data to the CSV file if the synchronization project is configured accordingly.

Describe the CSV file structure on the File structure page.

Table 12: File structure
Property	Description
Header lines	Number of header lines in the CSV file. The header is not imported.
Column names in line	Line that contains the column names.
Detect columns by	Indicator of column limits. Select the Delimiter option if the data is separated by a semi-colon, comma, space, tab, pipe, or other character. Specify the line structure. Select the Fixed width option if all the data in the columns has the same length. Specify the line structure.

Describe the line structure in the CSV file on the Line structure page.

If columns are separated by a delimiter, enter the delimiter.

Table 13: Line structure

Property

Description

Delimiter

Delimiter used to separate the data in the file. You have the following options: Semicolon, Comma, Space, Tab, and Pipe.

If the data is separated by a different character, select Other: and enter the delimiter in the input field next to the menu.

Text wrap character

Character enclosing the column text. This text is treated as one value on import, even is the text contains the delimiter given as above.

NOTE: The delimiters are masked by doubling them up.

Example:

Delimiter:	Comma (,)
Text qualifier:	Quotation mark (")
Value in file:	"User,BS"
Value after import:	User,BS

Delimiter:	Comma (,)
Text qualifier:	Not given or other character:
Value in file:	"User,BS"
1st value after import:	"User
2nd value after import:	BS"

Mask delimiter by doubling

Specifies whether the data is separated by several of the same delimiters. Data that contains a new line must be marked with a text qualifier.

Example:

Delimiter:	Comma (,)
Mask delimiter by doubling:	Enabled
Value in file:	User,,BS
Value after import	User,BS

Delimiter:	Comma (,)
Mask delimiter by doubling:	Not set
Value in file:	User,,BS
1st value after import:	User
2nd value after import:
3rd value after import:	BS

Define the separation points if the columns are separated by a fixed width.
- Click on the ruler to set a separation point. A separation mark is inserted.
- When you click again on a fixed separation point, the separation mark is deleted.

Describe the data structure on the Display information page.

Specify the Display pattern for displaying the objects in the Synchronization Editor. For example, the display pattern is used in error messages or test result from object matching rules.

Specify the following properties for each column.

To display all the properties, click Expert view.

Table 14: Column data structure
Property	Description
Column	Column name in the CSV file.
Name	The column’s technical name. Specify a new display name or copy the column name from the CSV file.
Display name	Name for the column when it is displayed in the Synchronization Editor. Specify a new display name or copy the column name from the CSV file.
Key column	Specifies whether the column is used as a key column. More than one key columns can be defined. Data records should be uniquely identified with these key columns.
Data type	Column data type
Description	Text field for additional explanation.
Multi-value column	Specifies whether the import contains multiple value property columns. Specifies the delimiter for the individual values.
Hierarchical sort order	Specify whether the column maps the path in an object hierarchy. Synchronization objects are sorted by this order. This makes it possible to resolve object dependencies. This option can only be set for one column of the CSV file. Example from the One Identity Manager schema: The full name of a department (Department.FullPath) specifies the path to the department hierarchy (department with all parent departments). Objects are sorted by their full name during synchronization. All parent departments are loaded first during synchronization and then the child departments.
Reference	Specifies whether the column references other objects.
Revision column	Specifies whether the column contains the revision counter. The data in this column form the comparison value for revision filtering.

On the past page of the system connection wizard you can add another CSV file to the system connection.
- To add another CSV file to the system connection, click Add another CSV file.
- Click Finish to end the system connection wizard.
Select the General view and click Update schema.
Confirm the security prompt with Yes.
This reloads the schema data.
Save the changes.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Identity Manager 9.2 - CSV Connector User Guide

Creating a synchronization project

Detailed information about this topic

Creating a synchronization project

Customizing the CSV system file

Detailed information about this topic

Editing a CSV file schema

Related topics