Uploading users via text file
There are many options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific roles to updating user information in the User profile to deleting users from the site.
Tip: It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as connecting to existing external databases or letting the users create their own accounts (Self enrolment). See Authentication for more information.
File formats for upload users file
The upload users file has fields separated by a comma (or other delimiter) ONLY - no space. The first line contains the valid field names. The rest of the lines (records) contain information about each user.
Tip: Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
Tip: You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors (e.g., Notepad++) for verification.
Valid upload file for testing
- From Site administration / Users / Upload users, an example text (.csv) file is available. It includes can be downloaded and adapted to your needs.
- Additional fields can be added as below. The course and cohort must already have been manually created.
User Fields that can be included
Tip: We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time.
These are the required user identification fields:
Validity checks are performed for:
- username can only contain alphabetical lowercase letters, numbers, hypen '-', underscore '_', period '.', or at-sign '@'
- email is in the form: email@example.com
The "password" field is optional if the 'New user password' setting on the upload screen is set to "Create password if needed and send via email" but is required if the setting is "Field required in file".
If included, values should meet the requirements for the site's Password policy.
To force password change for a particular user, set the password field to changeme. If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out. The text for the welcome e-mail is in the language settings in Site administration > Language > Language customisation with a String identifier of 'newusernewpasswordtext'.
Optional user fields
Note: Commas within a field must be encoded as , - the script will decode these back to commas. Tip: For Boolean fields with only two values, use 0 for false and 1for true.
To provide values other than the default you can include one or more of these optional user fields:
Most of the these are user profile fields or user preference fields that belong to the user profile and are the filled in the user or at manual creation. Some however require specific formats:
See Additional name fields for more details. Key things to note are:
country - use the country TWO LETTER CODE, in upper case, e.g. AU,ES,GB,US. These are all UPPER CASE. Using "au" or "es" or "USA" as a country code will result in a database error. If you are having trouble working out the two-letter code for a country, you can consult the list of country names and code elements available on the ISO Website. A common error is to use UK for United Kingdom; it should be GB.
lang - use the two letter (or extended four letter) code as defined in the Moodle language packs, e.g. en, es, en_us, de, in Site administration > Language > Language packs.
auth - The auth field must be used if the site uses an alternative authentication method, such as LDAP, as otherwise the authentication method will default to manual and users using a different auth method won't be able to log in. Use the shortname codes defined in Plugins > Authentication for the various types, e.g. manual, nlogin, ldap, cas, mnet, db, none. If you do not include an auth column, then newly created users will be created with the manual account type.
You can set "auth" to "nologin" in your csv file which will mean that then created users cannot login.
timezone - Should be in the format as found in the Location settings in terms of Zone/Region, e.g. Australia/Sydney, Asia/Kathmandu, Europe/Madrid, etc. The entry is case sensitive so Europe/London will work but europe/london will not.
NOTE: Needed: settings for mailformat,maildisplay,htmleditor,autosubscribe
maildigest To prevent users from receiving a large number of emails from courses or forced subscription forums use the maildigest. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.
maildisplay allows you to set the email display option for a user. The options for this field are 0 = Hide my email address from non-privileged users, 1 = Allow everyone to see my email address and 2 = Allow only other course members to see my email address.
theme User themes may be added by using 'classic', 'boost' or the name of any other installed theme. The value should be the short name of the theme, e.g. 'boost' not 'Boost', 'fordson' not 'Fordson'.
Custom profile field names
These are optional and depend on whether you have created any custom profile fields in your site. The name of the header in file is of the form 'profile_field_xxxxx' where xxxx is the unique shortname of custom user profile field name as you created it.
The field name should match the case of the profile field shortname. So, for instance if the shortname of your custom profile field is all upper case, for example, DOB, then use a header of profile_field_DOB to match the case, not profile_field_dob, which will produce a "is not a valid field name" error. Likewise, a mixed case shortname such as Dob should have a header of profile_field_Dob. (The exception to this is if the shortname is all lower case, then any case will work in the field header, which is a historical quirk: but best practice is to match the case and you will avoid errors.)
Example: To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.
For custom profile fields that are dates, use the ISO standard format YYYY-MM-DD, e.g. 2014-06-19 which will then be properly localized in the interfaced. For example, a field called dohire for date of hire, the fields could be:
username,firstname,lastname,email,profile_field_dohire blumbergh,Bill,Lumbergh,firstname.lastname@example.org,1990-02-19 pgibbons,Peter,BGibbons,email@example.com,1996-06-05 tsmykowski,Tom,Smykowski,firstname.lastname@example.org,1970-01-01
For custom profile fields that are a menu, use the corresponding value in the menu list from field as you defined it. For example: a custom field 'corporatedivision' with one of three values 'Management', 'Development' or 'Training'. Just insert one of those three words (e.g. 'Training') as the value for that field. E.g.
username,firstname,lastname,email,profile_field_corporatedivision blumbergh,Bill,Lumbergh,email@example.com,Management pgibbons,Peter,BGibbons,firstname.lastname@example.org,Development tsmykowski,Tom,Smykowski,email@example.com,Training
Special user change fields
Three special fields are used for managing user accounts, oldusername, deleted and suspended. See below for details.
You may optionally enrol users in already existing courses using manual enrolment. Only manual enrolment is done this way; if the manual enrolment method is disabled in a course, then no enrol is done.
You use fields in the upload file of this type:
Header fields must have a numeric suffix such that type1,role1,group1,enrolperiod1 and enrolstatus1 all apply to course1 for course1 to coursen. Even if you are just doing one course enrolment, you must still use the number 1 on the heading name, i.e. course1,role1, etc. Do not use the bare headings without numbers, e.g. course,role, etc. as those will generate an error.
course# is the shortname of the course, if present the user will be enrolled in that course. Do not use the fullname of the course or it will generate an error. This field is the ONLY required field for a successful enrolment. All the others are optional.
type# sets the role to be used for the enrolment. A value of 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
role# may be used to specify roles directly, using either role short name or the role id (numeric names of roles are not supported). Usually you will use the role name that is the shortname of the role as defined in Users > Permissions > Define roles, e.g. student, editingteacher. If the role column is left out, the users will be enroled in the course with the default role, which is normally student.
group# may be used to assign users to groups in course, using name or id (numeric group names are not supported). NOTE: if the group does not already exist, it will be created.
enroltimestart# may be used to set the enrolment start time, for each course. If not explicitly set here, the enrolment start time is set to be today. To set a date: "2021-02-15" and to set a date and time "2021-02-15 15:30"
enrolperiod# may be used to set the enrolment duration, in days, for each course. If not explicitly set here, all the users will get the duration as set in the Manual enrolment method of the course (which defaults to 0 meaning unlimited.)
enrolstatus# is optional as by default all newly enrolled users are set to active. If used a value of 1, it will suspend users in the course and if a user is previously set as inactive / suspended then a value of 0 will unsuspend them and make them active again.
Cohort membership assignment
You can assign users to any already existing Cohort by using only the "username" and the "Cohort ID" with just two fields in the file. Note that this is an exception to the usual case where the firstname, lastname and email address of the user are required.
cohort# is the form to use and like enrolment in courses, you have to add a number to each header, so cohort1,cohort2, etc.
Internal cohort ID numbers or non-numeric Cohort IDs of existing cohorts must be used; do not use the full name as this is not allowed. (Note that cohort ID is what is usually known elsewhere as the "shortname".)
Here is a sample CSV file:
username,cohort1,cohort2 student1,nursing,2016class student2,nursing,2014class student3,nursing,2014class
Existing MNetusers can be added to courses, groups or cohorts as below by using the field header mnethostid
- enrolling to courses: username+mnethostid+course required
- adding to group: username+mnethostid+course+group required
- adding to cohort: username+mnethostid+cohort required
- suspending/reviving accounts: username+mnethostid+suspended required
All other operations are ignored. You can not add users, delete them or update them (such as change names or email, profile fields, etc.)
Set system roles
Users may also be assigned to already defined system roles, using the shortname of the system role as defined in Site administration > Users > Permissions > Define roles for roles with a system context defined.
Users may be uploaded to a system role (usually Manager or Course creator) by entering the shortname of that role. Other roles can only be uploaded if they have already been assigned in the 'system' context. See Creating custom roles. Multiple roles can be assigned using sysrole2, sysrole3, etc. fields. Note that the number suffix in no way relates to the number suffixes on the enrolment fields. The numbers must go up in sequence starting at 1.
Unassigning system roles Users can also be removed from a given system role by entering the shortname of that role prefixed with a minus symbol: '-'. If the user is currently assigned to that role, they are removed from it. If the user is not currently assigned to that system role, the field value is ignored. However, the field value must refer to a system role that does exist on the system, otherwise an error will occur.
Upload user process
- Create file for uploading
- Go to Site administration > Users > Accounts > Upload users
- Add file to upload
- Upload users preview - check settings and default user profile settings
- Upload users preview - click "Upload users"
- Upload users results - shows list of users, exceptions made in upload and summary of number of users
- Upload users results - click "Continue"
- Returns to Upload users screen
Updating users preview
There are various settings to better control the desired upload behaviour. These settings are found on the "Upload users preview" page.
Warning: errors updating existing accounts can affect your users badly. Be careful when using the options to update.
The Upload type specifies how to handle existing accounts.
- Add new only, skip existing users
- is the default Moodle upload type. It creates a new user account for each new record in the uploaded file. If an existing username is found in the uploaded file matches an existing username, that record is skipped. By skipping the existing user account, the data in the existing record is not touched (in contrast to the "Add new and update existing users" option) and a second new user account is not created (in contrast to the "Add all, append number to usernames if needed" option).
- Add all, append number to usernames if needed
- creates a new user account for each record in the uploaded file. If an existing user account is found, a new account will be created with a number appended to the username. For example, if a user account for username 'jsmith' already exists and a new record in the uploaded file contains a record forusername 'jsmith' an additional user account is created with a 1 appended to the username to produce user 'jsmith1'.
- Add new and update existing users
- creates a new user account for each new user in the upload file. If an existing user account with the same username is found, the account information is updated by the data in the uploaded file.
- Update existing users only
- ignores any new users found in the upload file and updates the user account if a matching username record is found in the uploaded file.
New user password
When creating a new user account Moodle can create a new password (if one is not provided) or require a password in the uploaded file.
- Create password if needed and send via email
- creates a random default password for each new user account if one is not provided in the uploaded file, and emails the user their user information and new password.
- Field required in file
- requires that a password be provided in the uploaded file in order. If a password is not provided, an error is generated and the user account is not created. No notification of this user information or password is sent to the user.
Existing user details
The Existing user details options are only available when the Upload type allows existing user accounts to be updated. It specifies how Moodle should process user detail information for existing users.
- No changes
- ignores user detail data in the uploaded file and leaves the existing user account data unchanged.
- Override with file
- overwrites data in the existing user account with the data provided in the uploaded file.
- Override with file and defaults
- overwrites data in the existing user account with data provided in the uploaded file and fills in the default values for existing user details when no data is provided in the uploaded file.
- Fill in missing from file and defaults
- adds data in the existing user account with data provided in the uploaded file if the field is empty (does not already contain data) and fills in the default values for existing user details when no data is provided in the uploaded file.
Existing user password
The Existing user password option appears when you you have set the "Existing user details" setting to "Overwrite with file". It specifies how to handle password data for existing user accounts, to change them or leave them as it. This is a bit of insurance to make sure that you really want to mass change user passwords.
- No changes
- ignores password field in the uploaded user file and leaves the existing user account password untouched
- overwrites the existing user account password with the password provided in the uploaded file
Force password change
The Force password change option specifies when to tag a user account so that the next login attempt will require the user to change the user's password.
- Users having a weak password
- If the user account has a weak password as defined by the site's Password policy then the user will be forced to change the password during the next login attempt. This option is not shown if there the site does not have a Password policy.
- None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
- All of the users in the uploaded file will be forced to change the password during the user's next login attempt.
If the uploaded file contains the special oldusername field, it is possible to rename a user from the oldusername to a new username. The default setting is to not allow renames. Keep in mind that renaming a user will require the user to use the new username when logging in.
- ignores the oldusername field and leaves the existing user account's username field unchanged.
- allows the existing user account's username to be changed by the data provided in the uploaded file's username field. The oldusername will be searched for and then updated with the data provided in the username column.
If the uploaded file contains the deleted special field, it is possible to use the upload file to delete existing user accounts. The default setting is to not allow deletes. Keep in mind that deleting a user account will prevent that user from logging in. As a protection, site administrator user accounts cannot be deleted with this method.
- ignores the deleted special field in the uploaded file and leaves the existing user account unchanged
- allows the existing user account to be deleted when the value of the deleted field is 1.
Allow suspending and activating of accounts
If the uploaded file contains the suspended special field, it is possible to use the upload file to either suspend or make active (unsuspend) existing user accounts. The default setting is to allow suspending/activating of existing user accounts. Keep in mind that suspending an existing user account will prevent that user from logging in.
- allows the existing user account to be suspended when the value of the suspended field is 1.
- ignores the suspended special field in the uploaded file and leaves the existing user account status unchanged.
Prevent email address duplicates
It is possible, but not recommended to upload users with duplicate email addresses. By default, uploading users with duplicate email addresses is prevented. To allow duplicate email addresses, go to Site administration ► Plugins ► Authentication ► Manage authentication. You can tick "Allow accounts with same email". Then on the upload users screen you will be allowed to change the "Prevent email address duplicates" setting.
However, doing this is not recommended for file uploads. Test thoroughly any user uploads before implementing.
For more info, see the Managing authentication docs page
- prevents user accounts from being created from the uploaded if an existing user account already has the same email address as found in the uploaded file's email column.
- allows user accounts to be created if an existing user account already has the same email address found in the uploaded file's email column.
Standardise usernames is used by default to convert the username to all lower case and to strip out illegal characters. It is possible to not standardise the usernames; however, doing so is not recommended.
- standardises usernames found in the uploaded file before updating existing or creating new user accounts so that the username contains only lowercase letters and numbers.
- skips standardising usernames found in the uploaded file so that the newly created or updated usernames will be exactly as they are in the uploaded file (not recommended).
For those seeking a more technical explanation, the process for standardising the usernames consists of ensuring the characters are all UTF-8 (fix_utf8) encoded, converting the username to lower case, and then stripping out non-letters/non-number characters (unless Site administration > Security > Site policies > Allow extended characters in usernames is set on) with something similar to:
$username = preg_replace('/[^-\.@_a-z0-9]/', , $username);
Select for bulk user actions
After the uploaded file has finished being processed (all new accounts have been created and existing accounts updated as specified by the previous settings), there is an option to select some of those user accounts to perform additional bulk user actions such as
- Confirm user accounts created through Email-based self-registration which are not yet confirmed by the user
- Send a message (requires Messaging to be enabled)
- Delete user accounts
- Display a list of users on a page
- Download user data in text, ODS or Excel file format
- Force users to change their passwords
- Add users to a cohort
By default, no users are selected for bulk user actions.
- No users are selected for bulk user actions
- New users
- Only newly created users are selected for bulk user actions
- Updated users
- Only updated user accounts are selected for bulk user actions
- All users
- All users found (existing updated users and newly created user accounts) in the uploaded file are selected for bulk user actions
You can provide default user values for some fields not included in the uploaded file. Some fields include:
- Email display
- Forum auto-subscribe
- ID number
By clicking the Show more.... link, other default user profile fields will show up. You can set 17 different fields here, including the Authentication method, Country. Language, Timezone, as well as most other standard User profile fields.
If you have created any custom profile fields for your users, they will show up here.
Upload user results
After accepting the preview settings by clicking on "Upload users", you should see the Upload users results screen.
This screen will show you any exceptions or changes that were made to each user in the upload process. For example, if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.
The screen will summarize how many users were uploaded or updated, indicate the number of weak passwords and the number of errors.
Advanced potentials of Upload user
Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.
The default values are processed as templates in which the following codes are allowed:
- %l - will be replaced by the lastname
- %f - will be replaced by the firstname
- %u - will be replaced by the username
- %% - will be replaced by the %
Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:
- (-) minus sign - the information specified by the code letter will be converted to lowercase
- (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
- (~) tilde sign - the information specified by the code letter will be converted to Title Case
- a decimal number - the information specified by the code letter will be truncated to that many characters
For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:
- %l%f = DoeJohn
- %l%1f = DoeJ
- %-l%+f = doeJOHN
- %-f_%-l = john_doe
- http://www.example.com/~%u/ results in http://www.example.com/~jdoe/ (if the username is jdoe or %-1f%-l)
Template processing is done only on default values, and not on the values retrieved from the CSV file.
In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example, if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.
When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.
If the deleted field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for username. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".
Tip: A similar field is available for suspended. This enables a user account to be temporarily disabled rather than completely removed.
Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:
username,firstname,lastname,deleted jonest,Tom,Jones,0 reznort, ,1
Encoding file format
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.
If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.
Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.
If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.
The upload will also fail if you have trailing spaces at the end of your data fields. Often, this can not be removed with a simple Find " " and Replace with "". If information has been copied from web sources than it is possible to include non-breaking spaces which will prevent your upload from being completed correctly. To find these invisible spaces, use the Find and Replace function in Excel. In the find field, hold alt and type 0160. Leave the replace field blank.
Field size limits
Some fields have maximum character lengths, as defined in the database fields. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. The error will be "User not added - error".
The sizes of some common fields, in number of characters, are currently (3.2):
- username - 100
- password - 255
- idnumber - 255
- firstname - 100
- lastname - 100
- lastnamephonetic - 255
- firstnamephonetic - 255
- middlename - 255
- alternatename - 255
- institution - 255
- department - 255
- address - 255
- city - 120
- icq -15
- skype - 50
- yahoo - 50
- aim - 50
- msn - 50
- phone1 - 20
- phone2 - 20
All user fields listed here
- All the user fields that are valid in an upload file are listed below, except for any custom fields you may have created (for which see below.)
The enrolments into courses information are
where each enrolment is grouped by number.
You may wish to create a limited role to allow some users access to this function. Create a role at the system/site level with the following capabilities allowed:
- In 'Allow role assignments' tab of this new role, permit it to assign the required roles that it may be uploading, especially Student, but also Teacher, Non-editing Teacher, and any other custom roles you may have created, which will be used in the uploads to assign users to.
In particular, don't forget the moodle/role:assign capability (even if these users have it in the courses they will be enrolling users in - it won't work).
Upload users via CLI
In Moodle 3.10 onwards, an administrator can upload users via a CLI script.
To obtain instructions on how to use the script, in the command line from the moodle directory run
php admin/tool/uploaduser/cli/uploaduser.php --help
- Flat file enrolment
- User profile fields for details of how to include data about custom user profile fields in the upload users file
- Upload courses