User Imports

The User Imports page displays a list of import tasks that have been started and gives the status of each import task.

Who has access?

User Administrators

Detailed Description

The following is displayed for each import task in the User Imports list:

  • File
  • The name of the file that was used to import data. Clicking on the filename in the list will display a summary of the user import settings used for that import task.

  • Started
  • The date and time at which the import task was started.

  • Ended
  • If the task has completed or had an error, this will show the date and time at which the task ended.

  • Status
  • The status of the import task. Possible status values are:

    • Created – the task has been created but has not started execution
    • In Progress – the task is executing
    • Complete – the task has completed without errors
    • Error – an error was encountered during execution of the task

To set up an import task to be run, click on the Start User Import Wizard button in the Operations sidebar of the page.

User Import Wizard

The User Import Wizard allows for the creation of multiple user accounts through uploading and processing a file containing required user account information. The file that is uploaded will typically come from the export of data from a datastore such as a database or AD/LDAP.

The user import process consists of these steps:

Upload CSV

CSV File

This is the name of the file on the local computer from which the user account data will be extracted.

Click on the button inside of the Upload CSV box and navigate to the directory on your computer where the file that contains user account data exists and select the file. The file will typically come from exporting data from a datastore such as a database or Active Directory/LDAP and is a text file where each line in the file contains all of the data needed to define a single user.

Once the file has been selected, the name of the file will be displayed in the Upload CSV box. Click on the Next button at the bottom-right of the browser window to advance to the next step.

Import Options

Sample Row

Upon entering this step, the first two rows will be read from the import file using the default import options and the results will be displayed in the Sample Row section. By default, the first row is assumed to be a row of descriptive column headings and not user data.

If no header row exists in the file, header names will be automatically generated using the data from the first row appended to the string ‘Column’. For example, if the first row is:

Smith,Bob,bsmith,bobsmith@example.com

then the columns will be named:

'Column Smith', 'Column Bob', 'Column bsmith', 'Column bobsmith example com'

Note that the non-alphanumeric characters are converted to blanks.

Import Options

Field Delimiter Character

The character that delimits between data columns in a row (use \t for Tab). The default delimiter is a comma (,).

Field Enclosure Character

The character that encloses ambiguous data for a column within a row. This allows the use of the delimiter as part of the data. For example, if a multi-value attribute name Aliases has been defined and the delimiter character is a comma and the enclosure character is a double-quote character, the data column for that attribute could be in the file like this:

"Bob Smythe, Robbie Smitts, Robert Samuels"

Since the comma delimiter is between two enclosure characters, they would not be interpreted as delimiters. The characters between the two enclosure characters would be the data for a single column value.

Escape Character

The character used as an indicator to use an alternate interpretation of the character that follows it. For example, if the Escape character is a backslash, then character combinations like:

/t or /n

would be interpreted as Tab and Newline characters, respectively.

The default Escape character is a backslash (\).

Header

If the first line of the import file is a header row rather than user account data, select the option ‘CSV has header row‘. If there is no header row and the first line in the import file is user account information then select the option ‘CSV has no header row’.

When any changes are made in the Import Options, click on the Refresh button to apply these options. The Sample Row will be updated accordingly.

Once the Import Options have been set to correctly interpret the data from the import file, click on the Next button at the bottom-right of the browser window to advance to the next step.

Column Mappings

At the Column Mappings step, all user attributes are displayed by the attribute group in which those attributes are defined. All attributes that are required to be mapped have a red asterisk (*) displayed by the attribute name. If all required attributes are not mapped to a column in the import file, the wizard will not move to the next step but will display an error indicating which fields still need to be mapped. To map an attribute to a import file column, select the appropriate column from the drop-down list by each attribute name. The same column can be mapped to more than one attribute.

Once all required attributes have been mapped to import file columns, click on the Next button at the bottom-right of the browser window to advance to the next step.

Merge and Notification Options

During the import process, certain cases will arise which need a determination of what to do. These options are used to specify what actions to take in those cases.

For New Users…

If data for a new user account is found in the import file, these are the options that determine the actions that are to be taken.

New User Action

  • Create new users
  • Use the data to create a new user account.

  • Do nothing
  • Do not create any new users.

If this option is set to not create any new users, the other New User options are ignored.

New User Notification

  • Send email
  • If a new user is created, send them a notification email.

  • Do not send email
  • Do not send a notification email when a new user is created.

New User Password Action

The options displayed in this drop-down list will depend on whether an import file column was mapped to the password attribute or not in the previous wizard step (Column Mappings).

If an import file column is mapped to the password attribute:

  • Create using provided password column
  • If a new user is created, use the mapped import file column value for the password.

  • Create using provided password column and mark temporary
  • If a new user is created, use the mapped import file column value for the password and mark the password as temporary thus requiring the user to change their password when they log in.

If an import file column is not mapped to the password attribute:

  • Generate password
  • If a new user is created, generate a random password for the user.

  • Generate password and mark temporary
  • If a new user is created, generate a random password for the user and mark the password as temporary thus requiring the user to change their password when they log in.

New User Password Notification

  • Send password email
  • If a new user is created, send them an email containing their user account password.

  • Do not send email
  • Do not send a password notification email when a new user is created.

For Existing Users…

If data for a user account is found in the import file but that user account already exists, these are the options that determine the actions that are to be taken.

Existing User Action

  • Update users
  • Use the data from the import file to update the existing user account information.

  • Clear and replace users
  • Clear all data in the existing user account and replace it with the data from the import file.

  • Do nothing
  • Do not make any changes to the existing user.

If this option is set to not make any changes to the existing user, the other Existing User options are ignored.

Existing User Notification

  • Send email
  • Send an email to the existing user to notify them that their account has been updated.

  • Do not send email
  • Do not send a notification email to the user.

Existing User Password Action

The options displayed in this drop-down list will depend on whether an import file column was mapped to the password attribute or not in the previous wizard step (Column Mappings).

If an import file column is mapped to the password attribute:

  • Generate password
  • Replace the existing user’s password with a randomly generated password.

  • Generate password and mark temporary
  • Replace the existing user’s password with a randomly generated password and mark the password as temporary thus requiring the user to change their password when they log in.

  • Keep existing
  • Do not change the existing user’s password.

If an import file column is not mapped to the password attribute:

  • Update password
  • Replace the existing user’s password with the mapped value from the import file.

  • Update password and mark temporary
  • Replace the existing user’s password with the mapped value from the import file and mark the password as temporary thus requiring the user to change their password when they log in.

  • Keep existing
  • Do not change the existing user’s password.

Existing User Password Notification

  • Send password email
  • If an existing user’s password is updated or generated, send them an email containing their user account password.

  • Do not send email
  • Do not send a password notification email if an existing user’s password is updated or generated during the import process.

Review

At the Review step of the user account import wizard, a summary of the import settings that will be used to do the import will be displayed. If any of the settings need to be changed, the Back button at the bottom-right of the browser screen may be used to step backwards through the wizard and make the necessary changes.

Finish

Click on the Finish button to start the import process. The User Imports page will then be shown and the current import being done will have been added to the list of User Imports.