MoodleDocs - User contributions [en]

Upload users

2011-07-21T15:50:37Z

Tbachert: /* Upload users file format */

{{Accounts}}
'''Please refer to [[TOC_with_notes#Accounts|these notes]] before editing this page.'''
Location: ''Administration > Users > Accounts > Upload users''

[[Image:Upload users preview.png|thumb|Upload users preview in Moodle 1.9]]
Firstly, note that it is usually not necessary to import users in bulk - to keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the [[Internal enrolment|users create their own accounts]]. See [[Manage authentication]] for more information.

If you are sure you want to import multiple user accounts from a text file, then you need to format your text file as follows:

==Upload users file format==

* Each line contains fields '''separated''' by commas (or other delimiters) without quotes (") and no trailing delimiter
* The first line is special, and contains fieldnames defining the format for the rest of the file.

*'''Required fields''': In any order
:<code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).

*'''Optional fields''': To provide values other than the default include one or more of these
:<code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, emailstop, htmleditor, autosubscribe</code>

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<code>profile_field_xxxxx</code>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".
:'''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.

*'''Special fields''': Used for changing of usernames or deleting of users
:<code>oldusername</code>, <code>deleted</code>

*'''Enrolment fields''': (Optional):
:<code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.
**<code>course</code> is the "shortname" if present the user will be enrolled in those courses.
** <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
** You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
** Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
*** A group is identified by name or id (numeric group names are not supported).
** From Moodle 2.0, you can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

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.

Here is an example of a valid upload file:

<code>username, password, firstname, lastname, email, emailstop, course1, group1 
jonest, verysecret, Tom, Jones, jonest@someplace.edu, 1, math102, Section 1 
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, 1, math102, Section 3</code>

==Updating existing accounts==
By default Moodle creates new user accounts, and skips lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing accounts''', and existing user account will be updated.

Include fieldname <code>oldusername</code> to updating existing accounts and change usernames. In the preview options, Set "Allow renames" to '''Yes''.
'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

==After preview==
After the preprocessing, depending on the contents of the upload, the following may be available before final user creation
*Settings
** New user password
** Existing user details
** Existing user password
** Allow renames
** Allow deletes
** Prevent email addess duplicates
** Select for bulk operations

* Default values
** Authentication method: Manual account |no login | EMail-based self-registration
** Email display: Allow only other course members to see my email address | hide .. from everyone | allow anyone ...
** Email format Pretty HTML | plain text
** Email digest type: none|complete subjects
** Forum auto-subscribe: no |yes when I post
** When editing text: use HTML| standard web forms
** AJAX and Javascript: yes|no
** city/town
** country
** timezone
** Preferred language
** Description
** Web page
** ID number
** Institution
** Department
** Phone
** Mobile Phone
** Address

==After results ==
Users which were not added, will NOT be auto-enrolled in courses

----

Open another moodle browser and
* Site administration
** Courses
*** Add/edit courses; select the category, and the course
* Course administration
** Users
*** Enrolled Users
**** Enrol users and select the users flagged from other window

==Templates==

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/ = 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.

==Deleting accounts==

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

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==

In Moodle 1.8 the file must be UTF-8. In Moodle 1.9 onwards, the encoding may be selected from a large list, including ISO-8859-1.

==Hints==

===Spreadsheet===

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.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]

== See also ==
Moodle Docs:
*[[Flat file]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=58215 Making Email Optional]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[Category:Authentication]]
[[Category:Enrolment]]
[[Category:Groups]]

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[zh:上传用户]]
[[ru:Загрузка пользователей]]

Upload users

2011-07-21T15:24:44Z

Tbachert: /* Upload users file format */

{{Accounts}}
'''Please refer to [[TOC_with_notes#Accounts|these notes]] before editing this page.'''
Location: ''Administration > Users > Accounts > Upload users''

[[Image:Upload users preview.png|thumb|Upload users preview in Moodle 1.9]]
Firstly, note that it is usually not necessary to import users in bulk - to keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the [[Internal enrolment|users create their own accounts]]. See [[Manage authentication]] for more information.

If you are sure you want to import multiple user accounts from a text file, then you need to format your text file as follows:

==Upload users file format==

* Each line contains fields '''separated''' by commas (or other delimiters) without quotes (") and no trailing delimiter
* The first line is special, and contains fieldnames defining the format for the rest of the file.

*'''Required fields''': In any order
:<code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).

*'''Optional fields''': To provide values other than the default include one or more of these
:<code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, mailstop, htmleditor, autosubscribe</code>

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<code>profile_field_xxxxx</code>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".
:'''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.

*'''Special fields''': Used for changing of usernames or deleting of users
:<code>oldusername</code>, <code>deleted</code>

*'''Enrolment fields''': (Optional):
:<code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.
**<code>course</code> is the "shortname" if present the user will be enrolled in those courses.
** <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
** You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
** Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
*** A group is identified by name or id (numeric group names are not supported).
** From Moodle 2.0, you can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

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.

Here is an example of a valid upload file:

<code>username, password, firstname, lastname, email, mailstop, course1, group1 
jonest, verysecret, Tom, Jones, jonest@someplace.edu, 1, math102, Section 1 
reznort, somesecret, Trent, Reznor, reznort@someplace.edu, 1, math102, Section 3</code>

==Updating existing accounts==
By default Moodle creates new user accounts, and skips lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing accounts''', and existing user account will be updated.

Include fieldname <code>oldusername</code> to updating existing accounts and change usernames. In the preview options, Set "Allow renames" to '''Yes''.
'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

==After preview==
After the preprocessing, depending on the contents of the upload, the following may be available before final user creation
*Settings
** New user password
** Existing user details
** Existing user password
** Allow renames
** Allow deletes
** Prevent email addess duplicates
** Select for bulk operations

* Default values
** Authentication method: Manual account |no login | EMail-based self-registration
** Email display: Allow only other course members to see my email address | hide .. from everyone | allow anyone ...
** Email format Pretty HTML | plain text
** Email digest type: none|complete subjects
** Forum auto-subscribe: no |yes when I post
** When editing text: use HTML| standard web forms
** AJAX and Javascript: yes|no
** city/town
** country
** timezone
** Preferred language
** Description
** Web page
** ID number
** Institution
** Department
** Phone
** Mobile Phone
** Address

==After results ==
Users which were not added, will NOT be auto-enrolled in courses

----

Open another moodle browser and
* Site administration
** Courses
*** Add/edit courses; select the category, and the course
* Course administration
** Users
*** Enrolled Users
**** Enrol users and select the users flagged from other window

==Templates==

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/ = 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.

==Deleting accounts==

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

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==

In Moodle 1.8 the file must be UTF-8. In Moodle 1.9 onwards, the encoding may be selected from a large list, including ISO-8859-1.

==Hints==

===Spreadsheet===

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.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]

== See also ==
Moodle Docs:
*[[Flat file]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=58215 Making Email Optional]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[Category:Authentication]]
[[Category:Enrolment]]
[[Category:Groups]]

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[zh:上传用户]]
[[ru:Загрузка пользователей]]

Upload users

2011-07-21T15:21:01Z

Tbachert: /* Upload users file format */

{{Accounts}}
'''Please refer to [[TOC_with_notes#Accounts|these notes]] before editing this page.'''
Location: ''Administration > Users > Accounts > Upload users''

[[Image:Upload users preview.png|thumb|Upload users preview in Moodle 1.9]]
Firstly, note that it is usually not necessary to import users in bulk - to keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the [[Internal enrolment|users create their own accounts]]. See [[Manage authentication]] for more information.

If you are sure you want to import multiple user accounts from a text file, then you need to format your text file as follows:

==Upload users file format==

* Each line contains fields '''separated''' by commas (or other delimiters) without quotes (") and no trailing delimiter
* The first line is special, and contains fieldnames defining the format for the rest of the file.

*'''Required fields''': In any order
:<code>username, firstname, lastname, email</code>
:Validity checks are performed for:
#<code>username</code> can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
#<code>email</code> is in the form: ''name@example.com'' .

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out (not working in v2.0.2?).

*'''Optional fields''': To provide values other than the default include one or more of these
:<code>institution, department, city, country, lang, auth, ajax, timezone, idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, mailstop, htmleditor, autosubscribe</code>

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<code>profile_field_xxxxx</code>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB: as at v2.0.2, the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".
:'''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.

*'''Special fields''': Used for changing of usernames or deleting of users
:<code>oldusername</code>, <code>deleted</code>

*'''Enrolment fields''': (Optional):
:<code>course1, type1, role1, group1, enrolperiod1, course2, type2, role2, group2, enrolperiod2</code> etc.
**<code>course</code> is the "shortname" if present the user will be enrolled in those courses.
** <code>type</code> refers to the role to be used for associated course enrolment. Value 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.
** You can use role field instead to specify roles directly - use either role short name or id (numeric names of roles are not supported).
** Users may be also assigned to groups in course (group1 in course1, group2 in course2, etc.).
*** A group is identified by name or id (numeric group names are not supported).
** From Moodle 2.0, you can set the enrolment duration, in days, for each course (<code>enrolperiod1</code> for <code>course1</code>, <code>enrolperiod2</code> for <code>course2</code>, etc.).

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

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.

Here is an example of a valid upload file:

<code>username, password, firstname, lastname, email, course1, group1 
jonest, verysecret, Tom, Jones, jonest@someplace.edu, math102, Section 1 
reznort, somesecret, Trent, Reznor, reznort@someplace.edu,math102, Section 3</code>

==Updating existing accounts==
By default Moodle creates new user accounts, and skips lines where the <code>username</code> matches an existing account. Set "Upload Type" to '''Add new and update existing accounts''', and existing user account will be updated.

Include fieldname <code>oldusername</code> to updating existing accounts and change usernames. In the preview options, Set "Allow renames" to '''Yes''.
'''Warning''': errors updating existing accounts can affect your users badly. Be careful when using the options to update.

==After preview==
After the preprocessing, depending on the contents of the upload, the following may be available before final user creation
*Settings
** New user password
** Existing user details
** Existing user password
** Allow renames
** Allow deletes
** Prevent email addess duplicates
** Select for bulk operations

* Default values
** Authentication method: Manual account |no login | EMail-based self-registration
** Email display: Allow only other course members to see my email address | hide .. from everyone | allow anyone ...
** Email format Pretty HTML | plain text
** Email digest type: none|complete subjects
** Forum auto-subscribe: no |yes when I post
** When editing text: use HTML| standard web forms
** AJAX and Javascript: yes|no
** city/town
** country
** timezone
** Preferred language
** Description
** Web page
** ID number
** Institution
** Department
** Phone
** Mobile Phone
** Address

==After results ==
Users which were not added, will NOT be auto-enrolled in courses

----

Open another moodle browser and
* Site administration
** Courses
*** Add/edit courses; select the category, and the course
* Course administration
** Users
*** Enrolled Users
**** Enrol users and select the users flagged from other window

==Templates==

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/ = 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.

==Deleting accounts==

If the <code>deleted</code> field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for <code>username</code>. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

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==

In Moodle 1.8 the file must be UTF-8. In Moodle 1.9 onwards, the encoding may be selected from a large list, including ISO-8859-1.

==Hints==

===Spreadsheet===

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.

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult this Moodle source code file /moodle/lang/en_utf8/countries.php [http://cvs.moodle.org/moodle/lang/en_utf8/countries.php?view=markup&pathrev=MOODLE_19_STABLE or click here for a 1.9 STABLE list].
ISO Website: [http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm]

== See also ==
Moodle Docs:
*[[Flat file]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=58215 Making Email Optional]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[Category:Authentication]]
[[Category:Enrolment]]
[[Category:Groups]]

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[zh:上传用户]]
[[ru:Загрузка пользователей]]

Quickmail block

2009-02-13T19:57:08Z

Tbachert: /* History */

The '''quickmail''' block adds a link to a tool that has a checkbox list of all students in the course, and a mail composition text area. You can check the students you like, and email those and only those. This enhances the existing communications systems of messaging (one user) and subcribed forums (all subscribers) by allowing teachers to select a specific subset of students. It was developed by Michael Penney's team at Humboldt.

==Installation==
Download Quickmail with the provided link in the [[Quickmail_block#Links | Links section]]. After unzipping the file, you will find the quickmail directory in block_quickmail_1.5/blocks/. Copy this quickmail directory to your Moodle's blocks directory. Then visit Moodle's admin screen, clik in Notifications so that Quickmail can install itself. After that, you can add Quickmail to any course.

==Block Display==
[[Image:Quickmail-en-blockdisplay-screenshot.jpg|right]]
The image to the right shows how Quickmail will appear when added to a course. The three links are described as follows:
*'''Compose:''' takes you to Quickmail's email composition page.
*'''History:''' takes you to a history of all your emails sent by Quickmail in the current course.
*'''Settings:''' takes you to Quickmail's configuration screen; the same configuration screen as the block's edit button when course editing is turned on. This link only appears for course teachers and administrators.

==Block Settings==
Quickmail has two settings:
*'''Allow Students to use Quickmail:''' if ''Yes'' then Students will be able to see Quickmail in the course and use it to send emails. If ''No'' then Quickmail will be hidden to the Students.
NOTE: Quickmail displays '''all email addresses''' for '''all moodle users''' in '''any course'''. Quickmail overrides the user profile setting of "Hide my Email address from everyone".
*'''Group mode:''' set the [[Groups#Group_modes | group mode]] of Quickmail. This setting is disabled if [[Force_group_mode | Force group mode]] is turned ''On'' in the course.

In Moodle 1.7 or later, the ''Allow Students to use Quickmail'' setting has been removed. To allow students (or any other role) to use Quickmail, just override the Quickmail block capability called [[Capabilities/block/quickmail:cansend | block/quickmail:cansend]]. For more information about role management, please review the [[Manage_roles | Manage roles]] page.

==Compose==
When composing an email, the following fields must be set:
*'''To:''' this area contains a series of check boxes, one for each course user. Each user who has their check box ''checked'', will be emailed. Also, there is a handy button that can ''Check All'' or ''Uncheck All'' users. If a Group mode has been set in Quickmail's settings or if Force group mode is turned on, then the display of the users and their check boxes changes. Here is how the different modes affect the display:
**'''Visible groups:''' users and their check boxes are grouped together by their groups and each group has a ''Check All'' and an ''Uncheck All'' button.
**'''Separate groups:''' only users belonging to your group are displayed. Teachers always see the ''Visisible groups'' display because s/he never belongs to a group.
**'''Similarities between both modes:''' each group's name and picture are printed. Also, all users not belonging to a group are added at the bottom.
*'''Subject:''' whatever is written here will appear as the email's subject.
*'''Message:''' this area is used to compose the email message or body. You can use the [[HTML_editor | HTML editor]] for this section if you have it turned on in your user profile. Otherwise, you can select from one of Moodle's [[Formatting_options | formats]].
*'''Attachment:''' this is the only optional field and it behaves differently for Students and for Teachers.
**Students can select a file from their hard drive to attach to the email. This file is only temporarily stored on the server and it deleted after the email has been sent.
**Teachers use the standard course files interface. These files are stored in the course files and are never removed by Quickmail.

==History==
This page displays a table with information regarding sent emails. The columns are as follows:
*'''Date:''' the day and time of when the email was sent.
*'''Subject:''' the subject of the email.
*'''Attachment:''' name of the attachment sent along with the email.
*'''Action:''' contains action buttons. The button that looks like a magnifying glass takes you back to the ''Compose email'' page, but pre-fills the form with the original values from the old email. This is handy for resending an email to a particular user or for sending similar emails. The other image is in a shape of an ''X'' and it deletes a single sent email.
All columns are collapsible and sortable. If you have more than ten emails in the history, then a paging mechanism is displayed for paging through all the sent emails.

Also, there is a '''Clear History''' button on the right in the header of the page. Clicking on this button brings you to a confirmation page prompting you to delete all entries in your history. Choosing ''yes'' will clear your history and choosing ''no'' will leave the history unchanged. If you have no emails in your history, then the button is disabled.

'''By the way''' there is an modified version of Quickmail which has a more straight-forward Graphical User Interface (GUI) and is easier to use for large classes. This block is known as '''"quickmail for large classes"''' or '''"quickmail v2."''' This mod was implemented by the team at San Francisco State University and is currently maintained by Wen Hao Chuang. This enhanced version of Quickmail could be downloaded from http://moodle.org/mod/forum/discuss.php?d=68296

==Credits==
*Original developer: Mark Nielsen (currently co-maintained by Wen Hao Chuang)
*Project Manager: Michael Penney
*Postgres7 contribution: Rubens Ribeiro
*Language Translations:
**Japanese: Mitsuhiro Yoshida
**Spanish: Rubens Ribeiro
**French: Yves Dufour
**German: Andy Tagliani
**Slovak: Miroslav Fikar
**Hungarian: Császár-Cs. Péter
**Hebrew: Miki Alliel
**Italian: Lorenzo Nicora

==Links==
* [http://moodle.org/mod/data/view.php?d=13&rid=92 Quickmail in modules and plugins]

[[Category:Contributed code]]

[[ja:クイックメールブロック]]