Create and Enrol Users with a CSV File

Creating, updating, enrolling, and deleting users, in bulk, is best done through the use of a CSV (comma-separated value) file.


Step 1: Add Headers to Columns

To start, we suggest you have access to a spreadsheet software, like Excel or Google Sheets, but you can also do this in a simple notepad application and use actual commas.

The basic *.csv for creating/uploading users and/or updating user information must contain the following required fields:

  • "username"
  • "firstname"
  • "lastname"
  • "email

These will be the headers of each column in your sheet and are case sensitive, so keep them lowercase. 

Use this for a *.csv file for you to use as a template  User Upload Example.

Back to TOPICS

Step 2: Input User Information

Start with the username - as this is typically the way users will login to your site. If you have a naming convention that your users are already familiar with from another context, use that. If not, we recommend a simple "firstname.lastname" format. No capitals or special characters are allowed in this column.

For firstname, lastname, and email you can use special characters, but cannot leave a trailing space (no spaces) at the end. 

If you want to include extra fields, like institution, department, or city, you can include headers for those columns and add that information as well - this example, however, will keep things simple.

Back to TOPICS

Step 3: Add a Course to be Enrolled

If you have courses that users will be enrolled in, you can create a column in this sheet to enrol your users. 

The header should contain "course" followed by a number, starting at 1. The reason for this is to indicate to the system any other details you want to include about the enrolment, like role, group, or enrolment duration.

An example would be "course1" with the value of the course's shortname and then another column "role1" with and the value of the role to be assigned - like teacher.

In this example, Test Twoser will be enrolled into the WHIMS2019 course as an editing teacher, whereas Test User will be enrolled as a student.  If you don't indicate a role, the default of student will be given.

Back to TOPICS

Step 4: Upload Users to Your LMS 

Next, you will need to save this file as a .CSV file. Once you have done so, return to your site and go to Site Admin > Users > Accounts > Upload Users.

Here, you can drop your CSV file to the drop area, then click the "Upload users" button. This will take you to a preview screen to show you how the system has read your CSV files, providing you with any errors you have made, or how you want to handle the file.

Either add new and skip existing, add all and append numbers to duplicates, or add new and update existing.

Once you have configured the settings to meet your needs, and there are no errors, proceed and click Continue.


If you have custom Profile Fields, you will need to include "profile_field_xxxx" with the x's indicating the short name of that custom profile field. 

Back to TOPICS