| Table of Contents |
|---|
...
| Field/Column Name | Description |
|---|---|
| userId | The unique user id used for login. Required |
| tenant | The tenant identifier is optional. If not supplied, it defaults to the current tenant. Attempts to upload users for another tenant shows a validation error. |
| firstName | User's first name. |
| lastName | User's last name. |
| User's email address. Required | |
| enabled | Set to 'true' to enable the user |
| reportsTo | The userId of the user that the user reports to, if any. |
| roles | A list of the user's roles, separated by the '|' character. Roles are inserted as necessary. Spaces are not allowed in role names. Role names cannot contain more than 100 characters. |
| taskNotification | The user's task notification preference. The options are "OFF" or "Email"; if left blank or if this column is not used, this will default to "Email". |
| transaction | Either blank or 'DELETE'. If DELETE then the user will be removed. Otherwise, the user is updated if it exists or inserted as necessary. |
| notifyIfNewUser | A value of 'true' will send an email to users prompting them to create a new password. A value of 'false' will not notify users. |
| Info |
|---|
| To include a ',' (comma) in a field, escape it with a leading '\' character. To include a '|' (bar) in a role name, escape it with a leading '\' notifyIfNewUser determines when a password reset notification is sent to a user.
|
| Info |
|---|
|
...
Make sure you are logged in as the tenant admin. Click the Manage Users link.
- Click the
upload users csv icon. - Browse to your users csv file and then click Validate and Load. User data is validated prior to successful import. You will see "ValidatingLoading..." until the validation and loading process is completed. It is useful to report the status especially if you are loading a large csv file. Once validation has succeeded without error, the Load button is enabled to allow the upload. When you click on the Load button, you will see "Loading...".
The image shows the result of a validation that resulted in errors. User data cannot be uploaded until the errors are corrected. The table showing the validation data is scrollable vertically when loading a large csv file.
| Info |
|---|
notifyIfNewUser determines when a password reset notification is sent to a user.
|
- Click the Load button, the system uploads the same data again from the file. Another validation is performed and if still no error, the users are loaded individually or deleted if specified in the transaction column of the file. Roles are also inserted as necessary.
You will see this message with the number of roles and users that were created: "Users Loaded successfully. 3 Uploading an empty users file displays the message "Users file is empty".
Upon successful upload, you will see this message with the number of roles and users that were created: "Users Loaded successfully. 1 Added, 3 Updated, 0 Deleted, 1 Roles Added."
Updating Users and Roles using a CSV file
Once your csv file has been uploaded, it is very easy to update User and Role information. It is not necessary to reload your entire csv file every time you need to make changes. Simply create a csv file, with the proper format, that contains only the information that you want to change.
Existing users will be updated with the new information if you upload modified versions of your csv file.
For example, let's say you have 19 users in your tenant. You want to change the last name of an existing user, and add a new user (mary) who will have the new role of (Coordinator).
- Create a csv file with the changes - change the last name of a user and add a new line for a new user (mary) with the role of Coordinator.
- When you upload the modified file, you will see this message: "Users Loaded successfully. 1 Added, 1 Updated, 0 Deleted,
...
- 1 Roles Added
...
Updating Users and Roles using a CSV file
Once your csv file has been uploaded, it is very easy to update User and Role information. It is not necessary to reload your entire csv file every time you need to make changes. Simply create a csv file, with the proper format, that contains only the information that you want to change.
Existing users will be updated with the new information if you upload modified versions of your csv file.
For example, let's say you have 19 users in your tenant. You want to change the last name of an existing user, and add a new user (mary) who will have the new role of (Coordinator).
- Create a csv file with the changes - change the last name of a user and add a new line for a new user (mary) with the role of Coordinator.
- When you upload the modified file, you will see this message: "Users Loaded successfully. 1 Added, 1 Updated, 0 Deleted, 1 Roles Added". The existing user ". The existing user will be updated with the new last name, the role of Coordinator will be created and new user Pat will be added with that role.
- notifyNewUser for mary is set to TRUE, so Mary will receive an email to create her password.
| Tip |
|---|
|
CSV Upload Considerations
...
- The CSV upload can handle up to 1,000 rows in a given upload action. If you need to upload a large number of users, we recommend breaking them up into multiple CSVs of 1,000 users or fewer.
- Return to the Manage Users page and click Upload Users again after each successful upload operation.
- Return to the Manage Users page and click
- The "Reports To" column can only contain existing users. You should upload all of your users first, then re-upload the CSV(s) with the Reports To column filled.
- If you have a large number of users, the Manage Users page may display a user count of -1. This is a known issue we plan to resolve in a future release.
Troubleshooting
Current Tenant Validation Error
If the csv file contains a name that is different from the current tenant, a validation error message displays. Upload the file again with the tenant field empty.
Spaces in Role Names
If there are spaces in the role names in your csv file, the message "role [the name of the role that contains the space for example: V P] - format not permitted (must start with a letter or _, max 16 chars from the set: a-zA-Z0-9_- ). Remove the spaces then upload the file again.
Validate Hangs After Re-Upload CSV
When using Chrome, if you re-upload your CSV (for example, after you noticed errors on your first upload validation), you may notice that the validation does not complete.
...
Current Tenant Validation Error
If the csv file contains a name that is different from the current tenant, a validation error message displays. Upload the file again with the tenant field empty.
Spaces in Role Names
If there are spaces in the role names in your csv file, the message "role [the name of the role that contains the space for example: V P] - format not permitted (must start with a letter or _, max 16 chars from the set: a-zA-Z0-9_- ). Remove the spaces then upload the file again.
View User List
Click on a capital letter (A to Z) to display a list of users whose name begins with that letter. Click All to display all current users.
...