Chat now with support
Chat with Support

Identity Manager 8.0 - CSV 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

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 CSV import data is supplied by 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

You cannot normally specify a base object for synchronizing with the CSV connectorClosed. In this case, assignment of one base table and the synchronization server is sufficient.

  • Select the Base table from the 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.
  • All Job servers, which have the server function "CSV 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 CSV connector

  1. 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.
Detailed information about this topic

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 the entry CSV connectorClosed. 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 to create a connection to the CSV file.
  1. Select Create new CSV system on the system connection wizard start page.
  2. Select the CSV file whose data is to be synchronized in the file browser. Click Open.
  1. Check the values for coding the files and language on the Load CSV file page.
    Table 8: CSV File Properties
    Property Description
    CSV file path Full directory path to CSV file.

    File encoding

    CSV file character encoding. 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.

    File language

    File language for the file. The language is required in order to read local character formats correctly, for example, dates.

    Read only access Specifies whether the CSV connector only has read access to the CSV file.

    If this option is not set, the CSV connector can also write to the CSV file when the synchronization project is configured correspondingly.

  2. Describe the CSV file structure on the File structure page.
    Table 9: File Structure
    Property Description
    Number of lines in header Number of lines in the CSV file header. The header is not imported.
    Column names in line Lines, which contain column names.
    Columns identified by ID for column limits.
    • Select the option Delimiter if the data is separated by a semi-colon, comma, space, tab, pipe or other character. Specify the line structure.
    • Select the option Fixed width if all the data in the columns has the same length. Specify the line structure.
  3. Describe the row structure in the CSV file on the Line structure page.
    1. If columns are separated by a delimiter, enter the delimiter.
      Table 10: Line structure
      Property Description

      Delimiter

      Delimiter used to separate the data in the file. You can choose between "semi-colon", "comma", "space", "tab" and "pipe".

      If the data is separated by another character select "other" and enter the delimiter in the field next to the list.

      Text delimiter

      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: "Smith,Bill"
      Value after import: Smith,Bill
         
      Delimiter: Comma (,)
      Text qualifier: Not given or other character:
      Value in file: "Smith,Bill"
      1st value after import: "Smith
      2nd value after import: Bill"

      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: Smith,,Bill
      Value after import Smith,Bill
         
      Delimiter: Comma (,)
      Mask delimiter by doubling: Not set
      Value in file: Smith,,Bill
      1st value after import: Smith
      2nd value after import:  
      3rd value after import: Bill
    2. If the columns are delimited by a fixed width, specify the separation points.
      • Click on the ruler to set the separation points. A separation mark is inserted.
      • When you click again on a fixed separation point, the separation mark is deleted.
  4. Describe the data structure on the page Display information.
    1. Specify the Display pattern for displaying the objects in the Synchronization Editor. The display pattern is, for example, used in error messages or test result from object matching rules.
    2. Specify the following properties for each column.
      Table 11: Column Structure
      Property Description
      Column CSV file column name.

      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.

      Hierarchical sort order

      Specify whether the column maps the path in an object hierarchy. Synchronization objects are sorted by this order. This make it possible to resolve object dependencies.

      This option can only be set for one column of the CSV file.

      An example from the One Identity Manager schema:

      A department's full name (Department.FullPath) specifies the path in 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.

      Display name Name with which to display the column in the mapping editor. Specify a new display name or copy the column name from the CSV file.
      Description Spare text box for additional explanation.
      Data type Column's data type.

      MVP column

      Specifies whether the import contains a multi-value column (MVP). Enter the value delimiter.

  1. On the page Define CSV system file specify the name and repository of the CSV system file. The system connection configuration to the CSV file is saved in this file.
  2. 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 option Save connection data on local computer 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.

      Note: The connection data is saved in a variable set and can be modified under Configuration | Variables in the Synchronization Editor.
  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 CSV 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 12: 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.

Customizing the CSV System File

Customizing the CSV System File

The synchronization configuration must be changed if the CSV file schema changes. Changes are entered in the CSV system file. The CSV system file is edited in the system connection wizard. You can update the directory to the CSV files or CSV system file here.

How to Edit a CSV File Schema

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

  1. Select the category Configuration | Target systems.
  2. Click Edit connection....

    This starts the system connection wizard.

  3. Specify the CSV files with which to set up the system connection on the page Load CSV system file, in view CSV system information.
    • To add a new CSV file to the system connection, click . Then edit the schema for this file.
    • To edit a CSV file schema, mark the file and click .
  1. Check the values for coding the files and language on the Load CSV file page.
    Table 13: CSV File Properties
    Property Description
    CSV file path Full directory path to CSV file.

    File encoding

    CSV file character encoding. 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.

    File language

    File language for the file. The language is required in order to read local character formats correctly, for example, dates.

    Read only access Specifies whether the CSV connectorClosed only has read access to the CSV file.

    If this option is not set, the CSV connector can also write to the CSV file when the synchronization project is configured correspondingly.

  2. Describe the CSV file structure on the File structure page.
    Table 14: File Structure
    Property Description
    Number of lines in header Number of lines in the CSV file header. The header is not imported.
    Column names in line Lines, which contain column names.
    Columns identified by ID for column limits.
    • Select the option Delimiter if the data is separated by a semi-colon, comma, space, tab, pipe or other character. Specify the line structure.
    • Select the option Fixed width if all the data in the columns has the same length. Specify the line structure.
  3. Describe the row structure in the CSV file on the Line structure page.
    1. If columns are separated by a delimiter, enter the delimiter.
      Table 15: Line structure
      Property Description

      Delimiter

      Delimiter used to separate the data in the file. You can choose between "semi-colon", "comma", "space", "tab" and "pipe".

      If the data is separated by another character select "other" and enter the delimiter in the field next to the list.

      Text delimiter

      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: "Smith,Bill"
      Value after import: Smith,Bill
         
      Delimiter: Comma (,)
      Text qualifier: Not given or other character:
      Value in file: "Smith,Bill"
      1st value after import: "Smith
      2nd value after import: Bill"

      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: Smith,,Bill
      Value after import Smith,Bill
         
      Delimiter: Comma (,)
      Mask delimiter by doubling: Not set
      Value in file: Smith,,Bill
      1st value after import: Smith
      2nd value after import:  
      3rd value after import: Bill
    2. If the columns are delimited by a fixed width, specify the separation points.
      • Click on the ruler to set the separation points. A separation mark is inserted.
      • When you click again on a fixed separation point, the separation mark is deleted.
  4. Describe the data structure on the page Display information.
    1. Specify the Display pattern for displaying the objects in the Synchronization EditorClosed. The display pattern is, for example, used in error messages or test result from object matching rules.
    2. Specify the following properties for each column.
      Table 16: Column Structure
      Property Description
      Column CSV file column name.

      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.

      Hierarchical sort order

      Specify whether the column maps the path in an object hierarchy. SynchronizationClosed objects are sorted by this order. This make it possible to resolve object dependencies.

      This option can only be set for one column of the CSV file.

      An example from the One Identity Manager schema:

      A department's full name (Department.FullPath) specifies the path in 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.

      Display name Name with which to display the column in the mapping editor. Specify a new display name or copy the column name from the CSV file.
      Description Spare text box for additional explanation.
      Data type Column's data type.

      MVP column

      Specifies whether the import contains a multi-value column (MVP). Enter the value delimiter.

  1. 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.
  2. Select the view General and click Update schema.
  3. Confirm the security prompt with Yes.
  4. This reloads the schema data.

  5. Save the changes.
Related Topics
Related Documents