Flat file: Difference between revisions
(Edits and links) |
m (added link to spanish translation of document) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
Location: ''Administration > Courses > | Location: Flat file edit settings link in ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 | ||
A flat file allows enrolment management (enrol or unenrol) of existing users in existing course. The file is read one time by Moodle then erased. The file is located in the moodle file structure as a text file and [[Cron]] provides the timing when it is read. | |||
A flat file allows bulk enrolment management (enrol or unenrol) of existing users in existing course. The file is read one time by Moodle then erased. The file is located in the moodle file structure as a text file and [[Cron]] provides the timing when it is read. | |||
==Options== | ==Options== | ||
| Line 7: | Line 8: | ||
[[Image:Enrolment Flat file options.png|thumb|center|Options for flat file enrolment]] | [[Image:Enrolment Flat file options.png|thumb|center|Options for flat file enrolment]] | ||
The default name and location of the file is ''.../moodledata/1/enrolments.txt''. If you do specify a file path, it should be absolute (eg /var/moodledata/enrolments.txt) and can be read and modified by the webserver process. | Version 2.0 | ||
[[Image:EnrolSettngsFlatFile 2.0.png]] | |||
The default name and location of the file is ''.../moodledata/1/enrolments.txt''. | |||
:If you do specify a file path, it should be absolute (eg /var/moodledata/enrolments.txt) and can be read and modified by the webserver process. | |||
You can choose to have | You can choose to have an email sent to notify the Administrator, Teachers and/or students when the file has been processed. | ||
==Flat file structure== | ==Flat file structure== | ||
The file should be structured with the action, role, user id, and course ID number. Optionally a start time and end time can be added as additional fields. | The file should be structured with the action, role, user id, and course ID number. Optionally a start time and end time can be added as additional fields. | ||
The edit field link will give details on how to format the flat file on the Administration > Courses > Enrolments'' | The edit field link will give details on how to format the flat file on the Administration > Courses > Enrolments'' page. | ||
[[Image:Enrolment Flat file data.png|thumb|center|Flat file instructions for fields and records]] | [[Image:Enrolment Flat file data.png|thumb|center|Flat file instructions for fields and records]] | ||
| Line 20: | Line 26: | ||
==See also== | ==See also== | ||
*[[Upload users]] | *[[Upload users]] | ||
*[[Bulk user actions]] how to download site user information (including userIDs | *[[Bulk user actions]] how to download site user information (including userIDs) | ||
Using Moodle forum discussions: | Using Moodle forum discussions: | ||
*[http://moodle.org/mod/forum/discuss.php?d=13289 How does flat file work?] | *[http://moodle.org/mod/forum/discuss.php?d=13289 How does flat file work?] | ||
*[http://moodle.org/mod/forum/discuss.php?d=45514 un-enroll a user from a course] | *[http://moodle.org/mod/forum/discuss.php?d=45514 un-enroll a user from a course] | ||
*[http://moodle.org/mod/forum/discuss.php?d=144997 Flat file enrolments - how is this typically used by organisations?] | |||
[[Category:Enrolment]] | [[Category:Enrolment]] | ||
[[fr:Inscription par fichier plat]] | [[fr:Inscription par fichier plat]] | ||
[[es:Archivo plano]] | |||
Latest revision as of 19:03, 8 March 2014
Location: Flat file edit settings link in Site administration > Plugins > Enrolments > Manage enrol plugins in 2.0 onwards or Administration > Courses > Enrolments pre-2.0
A flat file allows bulk enrolment management (enrol or unenrol) of existing users in existing course. The file is read one time by Moodle then erased. The file is located in the moodle file structure as a text file and Cron provides the timing when it is read.
Options
The site administrator should edit the settings for a flat file if it is enabled.
Version 2.0
The default name and location of the file is .../moodledata/1/enrolments.txt.
- If you do specify a file path, it should be absolute (eg /var/moodledata/enrolments.txt) and can be read and modified by the webserver process.
You can choose to have an email sent to notify the Administrator, Teachers and/or students when the file has been processed.
Flat file structure
The file should be structured with the action, role, user id, and course ID number. Optionally a start time and end time can be added as additional fields.
The edit field link will give details on how to format the flat file on the Administration > Courses > Enrolments page.
See also
- Upload users
- Bulk user actions how to download site user information (including userIDs)
Using Moodle forum discussions:
