Skip to main content
Skip table of contents

Users add-on CSV- Manage option to add a uniqueness check

This article describes how to manage the option to add or remove a uniqueness check in the use case Synchronize users from CSV file to Identity Manager in the Users add-on CSV package. Read more here: Smart ID Workforce use cases.

A script in Identity Manager Admin is used to manage the options.

See a list of all available options in the Smart ID use cases for the Users add-on CSV package here: Users add-on CSV - Options.



Step-by-step instruction for the administrator

Log in to Identity Manager Admin
  1. Log in to Identity Manager Admin as Administrator.
Manage the option to add a uniqueness check for "Synchronize users from CSV file to Identity Manager"

This section shows how to enable the uniqueness check for the Synchronize users from CSV file to Identity Manager use case. See the previous section for the Create user add-on CSV use case.

  1. In Identity Manager Admin, go to Home > Script.
  2. Select the script UsersScriptOptions.
  3. In the section Uniqueness check in the script, go to the UsersAddonCSVCheckUniqueness variable, see the example. By default it is set to true, that is, there is a uniqueness check done when you synchronize users. 

    Defines if a uniqueness check will be done during user creation.
    Possible options:
     * true(default) - User uniqueness check will be done.
     * false - User uniqueness check will not be done. 
    UsersAddonCSVCheckUniqueness = true
  4. If you do not want to have a uniqueness check when you synchronize, set UsersAddonCSVCheckUniqueness to false.
  5. Click Save in the upper left corner to save the updated script (or exit without saving if there are no updates).
Change the unique identifier

You can change the unique identifier if you want to use something else than email.

To see the unique identifier:

  1. In Identity Manager Admin, go to Home > Process Import.
  2. Select the process Create user.
  3. Click the row Check uniqueness.
  4. Click Edit task on the Check uniqueness row (the pen to the right on the row).
  5. In the list of Parameters, you see the parameter name UsersDp_Email and the value EQUALS:${UsersDp_Email} which means that the email is used for the uniqueness check.

The service task that controls this is called Process: Execute Search Task, read more about it here: Process - Standard service tasks in Identity Manager. Normally, the email is what you use for the uniqueness check. But if you, for example, use the Users add-on LDAP, see Create user add-on LDAP, to create users, the uniqueness check is done on a parameter called UsersAddonLDAPDp_ObjectGUID and the value is EQUALS:{UsersAddonLDAPDp_ObjectGUID}.

Technical details

Default value and outcome
True (default)
  • There will be a uniqueness check when creating or synchronizing users from a CSV file.
  • The unique identifier is email.
  • If the uniqueness check fails, information is shown that there is already a user with this email. Possibility is given to go back and change the email.
FalseThere will not be a uniqueness check when creating or synchronizing users via a CSV file.
Users add-on CSV - manage options script

Click here to see the whole manage options script.

Additional information

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.