Home / Flat file

Flat file

Enrollment plugins

The flat file enrollment plugin allows bulk enrollment management (enroll or unenroll) of existing users in the existing course via a CSV file.

The file is processed by the Flat file enrollment sync scheduled task and then deleted.

The file should include action, role, user ID number, and course ID number; start time and end time are optional fields. Details of the file format are shown on the flat file settings page Site administration > Plugins > Enrollments > Flat file (CSV).

Enabling flat file enrollment

An administrator can enable flat file enrollment as follows:

  1. Go to Site administration > Plugins > Enrollments > Manage enroll plugins and click the eye icon opposite Flat file (CSV). When enabled, it will no longer be greyed out.
  2. Click the settings link, configure as required (see details of settings below), then click the ‘Save changes’ button.

File location

You should specify an absolute path for the upload file (eg /var/lmsdata/enrollments.txt) where it can be read and modified by the web server process. The file is automatically deleted after processing.

File encoding

Make sure, you save the file (for example in a text editor) with the same encoding.

Notification

You can choose to have an email sent to notify the Administrator, Instructors and/or users when the file has been processed.

Unenrollment action

  • “Unenroll user from course” When the user disappears from the external source, the enrollment is completely removed and all the roles removed. This means some user data and settings are purged from course during course unenrollment (that usually include grades, activity attempts, etc.)
  • “Keep user enrolled” When the user disappears from the external source, the enrollment is kept as is, and the user is still able to enter the course and perform activities, access resources, etc. It’s a “do nothing” option.
  • “Disable course enrollment and remove roles” When the user disappears from the external source, the enrollment is suspended and roles assigned by enroll instance are removed. Please note that user may “disappear” from gradebook and other areas.

See also

 

➤