Exporting/Importing Users

Users can be exported or imported between systems using Excel files (.XLS, .XLSX or .CSV).

Exporting Users #

To export users, select one or more users from the User List, then click on the Export Users action link. An export box will appear that enables you to specify the name of the Excel file to which the list of selected users will be exported. A default name will be provided, but you can edit the default, at your discretion.

Once you have done so, click the OK Button to complete the export and create the Excel file.

The available columns in the exported Excel file are described below.

COLUMN	DESCRIPTION	DEFAULT VALUE
UserID	This is required on an import.
UserName	The optional User Display Name.
EmailAddress	The users email address.
Culture	This is the optional culture for the user as defined by Windows (e.g. en).
Domain	The optional Windows AD domain for the user.
TimeZone	This is the optional time zone identifier for the user as defined by Windows (e.g. Pacific Standard Time).
Disabled	This indicates if the user is disabled. If this is set to “true” or “1” on an import it WILL disable the user.	False
AuthType	The authentication type for the user. The authentication type can't be changed on an import. The available types are: Unknown, Built-In, Windows, LDAP, External, SAML, and Header.	Unknown
LastLogin	This is only available on the user export, it isn't used on the import.
Groups	A comma separated list of groups this user belongs to.
Phone	The optional phone number of the user.
Password	This is only an option on the user import, the password is never exported.
Description	An optional description for the user.
Title	The optional title for the user.
Office	The optional office for the user.
Company	The optional company name for the user.
BusinessUnit	The optional business unit for the user.
LegalEntity	The optional legal entity for the user.
Department	The optional department for the user.
Country	An optional country for the user.
Location	This is an optional location string.
CustomString	This can be any string that should be associated with this user.
CustomString2	This can be any string that should be associated with this user.
CustomNumber	This can be any numeric value.
CustomDate	This can be any date value.
Manager	This is the USERID or UID of the manager record.
PasswordChange	This indicates if the user should be required to change their password on the next login.	False
DayPass	This indicates if the user is a “Day Pass” user.	False
DeleteUser	This is an optional column that will, when set to "DELETE" on a user's row, delete the user from the system. BP Logix strongly recommends that you disable, rather than delete users, to retain the user's activity history, but this is an available spreadsheet option, if needed.

Importing Users #

Once the Excel file has been exported, you can import the users to another system by transferring the Excel file between the systems.You may wish to edit certain attributes of the Excel file before importing it. When exporting/importing Built-in users between systems, the PasswordChange column, will, when set to 1", force the user to change the password on their next login.

Similarly, you can use your own Excel or CSV file to import new users. If you are importing users via your own Excel or CSV file, you must, as a minimum, have a UserID column for each record, but BP Logix recommends that you have the following columns in your file, with the appropriate data for the users in each row:

• UserID
• UserName
• EmailAddress

When using an Excel file for the import, the user data must be on a worksheet named "Users".

To import the file into the target system, navigate to the Users page again. Once there, click the Import Users action link. You'll be prompted for the Excel or CSV file to import.

When importing an Excel file with users there are a couple options available.

• Create groups as needed during import
• Remove users from groups not listed in import file

The first option will automatically create and groups in the “Groups” column if they don't exist. The default is to add users to groups that exist, but not to create the groups. The second option will remove a user from an group that isn't listed in their “Groups” column.

Once you have selected the import file and set the desired properties for the import, click the OK button to begin the import. All of the users in the import file will be imported to the target system.