Create a file for the Bulk User Management tool

The Bulk User Management tool lets you create CSV and TXT files that are compatible with the Brightspace Learning Environment. You must include the fields listed in this section of the help in a specific order for each action.

File Format

Import files must be CSV files with file extension .csv or .txt. You must separate all fields with commas, and all records must occur on a separate line. If you are creating your BUM input as a TXT file, you can denote blank fields with two commas with nothing separating them (,,), or two commas with a space separating them(, ,). The Bulk User Management tool accepts either format.

Required Fields

An asterisk (*) denotes a required field.

Optional Fields

Optional fields do not begin with an asterisk symbol.

An empty or blank field causes no change to user information.

To indicate that a field should be cleared or deleted, use #CLEAR.

Is Active

When specifying whether a user is active or not, use 1 to indicate the user should be active or 0 to indicate the user should be inactive.

Roles

You can assign and remove users from roles that you have permissions to change. To add or remove roles from this list access the permissions for your role under the Users tool.

Available Actions

The Create action creates a new user. If the user already exists, no action will be performed. When you update fields indicated with a dagger (†) in the BulkUserCreate form element, it results in updates to Contact Information in both User Profile and User Management. The format of this action is as follows:

CREATE, Username, Org Defined ID, *First Name, *Last Name, Password, *Role Name, Is Active, *Email

The Update action updates information for an existing user. When you update fields indicated with a dagger (†) in the BulkUserUpdate form element, it results in updates to Contact Information in both the User Profile and User Management. The format of this action is as follows:

UPDATE, *Username, Org Defined ID, First Name, Last Name, Password, Is Active, Email

The Delete action deletes an existing user. The format of this action is as follows:

DELETE, *Username, Org Defined ID

The Enroll action enrolls an existing user in a specified org unit. The format of this action is as follows:

ENROLL, *Username, Org Defined ID, *Role Name, *Org Unit Code

The Unenroll action unenrolls an existing user from a specified org unit. The format of this action is as follows:

UNENROLL, *Username, Org Defined ID, *Org Unit Code

The Import action creates a new user and enrolls the user in a specified Org Unit. When you update fields indicated with a dagger (†) in the BulkUserImport form element, it results in updates to Contact Information in both the User Profile and User Management. The format of this action is as follows:

IMPORT, Username, Org Defined ID, *First Name, *Last Name, Password, *Role Name, Is Active, *Email, *Org Unit Code

 

To display the columns you want to appear in the CREATE, IMPORT, and UPDATE CSV files:

  1. In Form Elements, expand the BulkUserCreate, BulkUserImport, or BulkUserUpdate form element.
  2. Click on the form item name and then click Edit.
  3. Select the Is Displayed checkbox.
  4. To make this column a required column, select the Is Required checkbox.
  5. Click Save.