MoodleDocs - User contributions [en]

Messaging settings

2024-04-11T13:54:08Z

Jprovasnik: updating spacing in list of message types table

{{Messaging}}
==Messaging settings for all users==
*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.
==Enabling / disabling messaging site wide==
The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Messaging > Messaging settings.

From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.
==Notification settings ==
Messaging system default settings are set in 'Notification settings' in Site administration / Messaging

There are four default types of notification plugins: web, Jabber, email and mobile.

By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.
[[File:NotificationPlugins.png|center|thumb|500px]]
==== Jabber ====
Jabber is the original name of the Extensible Messaging and Presence Protocol ([https://en.wikipedia.org/wiki/XMPP XMPP]), an open standard instant messaging protocol.
The Jabber service on the Moodle server must be configured before use. To configure Jabber, an XMPP account should be created that is specific to the Moodle server, either on a locally hosted XMPP server or on one of many [https://xmpp.net/directory.php public servers]. The information for this account is entered in Site administration / Plugins / Message outputs / Jabber:
*Host - The server to connect to to send jabber message notifications - this is entered as the full hostname (e.g. jabber.org) with no protocol (i.e. no "https://")
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server as the Moodle site, without domain name
*Password - The password to use when connecting to the Jabber server as the Moodle site.
*Port - defaults to 5222
[[File:Jabber_configuration.png]]

After the Jabber service has been configured, it must also be enabled.

Each Moodle user wishing to receive instant message notifications through Jabber must create an account on a Jabber server and must configure their Moodle account to include those details:

[[File:jabber_user_account.png]]

The user must also choose which notifications to receive using Jabber:

[[File:Jabber_notification_preferences.png]]

Users may also choose to receive Moodle messages via Jabber.
====Mobile notifications====
[[File:mobilenotifications.png]]

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

[[Site registration|Registered sites]] can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.

Alternatively, you may install your own private Air notifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.
===Default notification preferences===
You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:
* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.

* ''Permitted'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

* ''Locked'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.
====Logged in/Offline====
You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.
====Ordering of messaging settings====
Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.
[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]
==== List of message types====
Except for 'Personal messages between users', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle.
{| class="wikitable"
|-
! Module !!Output Name!!Description!!Recipients
|-
|Assignment||Assignment notifications||Student has submitted an [[Assignment activity|assignment]] and Student has received a grade/feedback||Teacher
|-
|Feedback||Feedback notifications||Notices from setting Enable notification of submissions||Teacher, Feedback administrator
|-
|Feedback||Feedback reminder||[[Feedback activity|Feedback]] non-respondent reminder message|| Student feedback activity non-responders
|-
|Forum||Subscribed forum posts||Default for forum subscription handling||Anyone subscribed to a forum
|-
|Forum||Subscribed forum digests||Sets default for this for user profiles || Authenticated users
|-
|Lesson||Lesson essay graded notification||Notify students a teacher has graded a Lesson essay question||Student
|-
|Quiz||Notification of quiz submissions|| Message that student has submitted a quiz||Teacher
|-
|Quiz||Confirmation of your own quiz submissions||Notice your quiz was successfully submitted ||Student
|-
|Quiz||Warning when your quiz attempt becomes overdue||See [[Quiz settings]]||Student
|-
|System||Notices about minor problems||?
|Site administrators
|-
|System||Important errors with the site|| Important errors - See also [[Debugging]]||Site administrators
|-
|System||Course creation request notification ||Notice a course has been requested - See [[Course request]]||Defined in ''Site admin > Courses > Course request > Course request notification''
|-
|System||Course creation request approval notification ||Notice a requested course has been approved||User who requested the course
|-
|System||Course creation request rejection notification||Notice a requested course has been rejected||User who requested the course
|-
|System||Badge recipient notifications|| Notify recipient of a badge when it is awarded to them||Any badge recipient (typically Student role)
|-
|System||Badge creator notifications || Notify creator of a badge when it is awarded to someone||Any badge creator (typically Teacher or Manager role)
|-
|System||Insights generated by prediction models||?||?
|-
|System||Message contact requests notification||?||?
|-
|System||Grade notifications||?||?
|-
|System||Available update notifications||Notice of new releases of Moodle code||Site administrators
|-
|System||Backup notifications||Automated backup schedule run completed||Site administrators
|-
|System||Comment posted on a learning plan||?||?
|-
|System||Comment posted on a competency ||? ||?
|-
|Manual enrollment||Manual enrolment expiry notifications|| Notice if [[Manual enrolment]] about to expire||Manual enrolees
|-
|Self enrollment||Self enrolment expiry notifications||Notify users when their enrolment expires|| Enroller only, or Enroller & Enrolled user
|-
|Data privacy||Data request ||?||?
|-
|Data privacy||Data request processing results||?|| ?
|-
|Data privacy||Data request exceptions notifications||?||?
|-
|Inbound message configuration||Warning when an inbound message could not be processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Confirmation that a message was successfully processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Personal messages between users||Using the Messaging interface tool||Authenticated Users
|-
|Inbound message configuration||Message to confirm that an inbound message came from you||See [[Incoming mail configuration]]||Authenticated Users
|-
| Event monitoring||Notification of rule subscriptions||Notifications from [[Event monitoring]] rules||Event rule subscribers
|}

==Roles and Messaging capabilities ==
The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
*[[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
*[[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
*[[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
*[[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
*[[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
===Email===
All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in ''Site administration > Advanced features > Notification email override''.

Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.
[[fr:Paramètres de messagerie]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]

Capabilities/moodle/analytics:listinsights

2023-09-26T21:25:29Z

Jprovasnik: Added an example of what this permission does.

{{Capabilities}}
*This allows a user to list [[Analytics|analytics insights]]
*Notifications go to users, with this capability enabled, in the context of the prediction -- what this means for the Students at risk of dropping out model is that notifications go to teachers in each course.
*This capability is allowed for the default roles of manager, teacher and non-editing teacher
[[Category:Capabilities|Analytics]]
[[Category:Analytics]]

[[https://docs.moodle.org/es/Capabilities/moodle/analytics:listinsights]]
[[https://docs.moodle.org/de/Capabilities/moodle/analytics:listinsights]]
[[https://docs.moodle.org/fr/Capabilities/moodle/analytics:listinsights]]

Upload users

2022-04-29T17:23:30Z

Jprovasnik: /* Enrolment fields */ - added an example of date and time format for enroltimestart#

{{Accounts}}
==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|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 [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.
{{MediaPlayer | url = https://youtu.be/blUw-ZbhFqw| desc = How to bulk upload users and add to courses}}
==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 (eg, [https://notepad-plus-plus.org/ 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.
username,firstname,lastname,email

student1,Student,One,s1@example.com

student2,Student,Two,s2@example.com

student3,Student,Three,s3@example.com
*Additional fields can be added as below. The course and cohort must already have been manually created.
username,firstname,lastname,email,course1,group1,cohort1

student1,Student,One,s1@example.com,math102,groupA,cohortZ

student2,Student,Two,s2@example.com,math102,groupB,cohort Y

student3,Student,Three,s3@example.com,math102,groupA,cohortZ
== 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.
===Required fields===
These are the required user identification fields:
<code>username,firstname,lastname,email</code>
Validity checks are performed for:
* '''username''' can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
* '''email''' is in the form: ''name@example.com''
===Passwords===
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 [[Site_policies#Password_policy|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 &#44 - the script will decode these back to commas.
Tip: For Boolean fields with only two values, use '''0''' for false and '''1'''for true.

To provide values other than the default you can include one or more of these optional user fields:
<pre>institution,department,city,country,lang,auth,timezone,idnumber,icq,phone1,phone2,address,url,description,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,interests,theme</pre>
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, eg 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 [https://www.iso.org/obp/ui/#search 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 lettter) 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, nologin, 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, eg. 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.)
<pre>profile_field_xxxxx</pre>
'''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, eg. 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:
<pre>
username,firstname,lastname,email,profile_field_dohire
blumbergh,Bill,Lumbergh,blumbergh@example.com,1990-02-19
pgibbons,Peter,BGibbons,pgibbons@example.com,1996-06-05
tsmykowski,Tom,Smykowski,tsmykowski@example.com,1970-01-01
</pre>

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. Eg.
<pre>
username,firstname,lastname,email,profile_field_corporatedivision
blumbergh,Bill,Lumbergh,blumbergh@example.com,Management
pgibbons,Peter,BGibbons,pgibbons@example.com,Development
tsmykowski,Tom,Smykowski,tsmykowski@example.com,Training
</pre>
=== Special user change fields===
Three special fields are used for managing user accounts, '''oldusername''', '''deleted''' and '''suspended'''. [[#Allow_renames|See below for details]].
===Enrolment fields===
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:
<pre>course1,type1,role1,group1,enroltimestart1,enrolperiod1,enrolstatus1,course2,type2,role2,group2,enroltimestart2,enrolperiod2,enrolstatus2</pre> etc.
Header fields '''must''' have a numeric suffix such that type1,role1,group1,enrolperiod1 and enrolstatus1 all apply to course1 for course'''1''' to course'''n'''. 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 succesful 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, eg. 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 with 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 are not allowed. (Note that cohort id is what is usually known elsewhere as the "shortname".)

Here is a sample CSV file:
<pre>
username,cohort1,cohort2
student1,nursing,2016class
student2,nursing,2014class
student3,nursing,2014class
</pre>
=== MNet ===
Existing [[MNet]]users 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.

<code>sysrole1,sysrole2,sysrole3</code> etc

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.
[[File:GlobalRoles1.png|thumb|500px|center|Example of a file for uploading users with global/system roles]]
==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.
====Upload type====
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 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
;Update : 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#Password_policy|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#Password_policy|Password policy]].
;None : None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
;All : All of the users in the uploaded file will be forced to change the password during the user's next login attempt.
====Allow renames====
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.
;No : ignores the '''oldusername''' field and leaves the existing user account's username field unchanged.
;Yes : 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.
====Allow deletes====
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.
;No : ignores the '''deleted''' special field in the uploaded file and leaves the existing user account unchanged
;Yes : allows the existing user account to be deleted when the value of the 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.
;Yes : allows the existing user account to be suspended when the value of the of the '''suspended''' field is 1.
;No : 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#Allow_accounts_with_same_email|Managing authentication]] docs page
;Yes :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.
;No :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====
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.
;Yes : 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.
;No : 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:

<code>$username = preg_replace('/[^-\.@_a-z0-9]/', '', $username);</code>
====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 [[admin/user/user_bulk|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 [[admin/user/user_bulk|bulk user actions]].
;No : No users are selected for [[admin/user/user_bulk|bulk user actions]]
;New users : Only newly created users are selected for [[admin/user/user_bulk|bulk user actions]]
;Updated users : Only updated user accounts are selected for [[admin/user/user_bulk|bulk user actions]]
;All users : All users found (existing updated users and newly created user accounts) in the uploaded file are selected for [[admin/user/user_bulk|bulk user actions]]
===Default values===
You can provide default user values for some fields not included in the uploaded file. Some fields include:
*Email display
*Forum auto-subscribe
*City/town
*ID number
*Institution
*Department
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.

'''Other 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 the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The results screen; everything went well!]]
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==
===Templates===
''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
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (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 '''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.
==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.

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.)
<pre>firstname,lastname,username,email,password,auth,idnumber,institution,department,city,country,timezone,lang,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,skype,msn,aim,yahoo,icq,phone1,phone2,address,url,description,descriptionformat,interests,oldusername,deleted,suspended,alternatename,lastnamephonetic,firstnamephonetic,middlename</pre>
The enrolments into courses information are <pre>course1,type1,role1,group1,enrolperiod1,enrolstatus1</pre>
where each enrolment is grouped by number.
===Capabilities===
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:
* moodle/site:uploadusers
* moodle/role:assign
And
* 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).
== See also ==
* [[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]]
Forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish
[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[de:Nutzerliste hochladen]]
[[es:Subir usuarios]]

Upload users

2022-02-17T19:42:42Z

Jprovasnik: Typo: nlogin to nologin

{{Accounts}}
==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|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 [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.
{{MediaPlayer | url = https://youtu.be/blUw-ZbhFqw| desc = How to bulk upload users and add to courses}}
==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 (eg, [https://notepad-plus-plus.org/ 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.
username,firstname,lastname,email

student1,Student,One,s1@example.com

student2,Student,Two,s2@example.com

student3,Student,Three,s3@example.com
*Additional fields can be added as below. The course and cohort must already have been manually created.
username,firstname,lastname,email,course1,group1,cohort1

student1,Student,One,s1@example.com,math102,groupA,cohortZ

student2,Student,Two,s2@example.com,math102,groupB,cohort Y

student3,Student,Three,s3@example.com,math102,groupA,cohortZ
== 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.
===Required fields===
These are the required user identification fields:
<code>username,firstname,lastname,email</code>
Validity checks are performed for:
* '''username''' can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
* '''email''' is in the form: ''name@example.com''
===Passwords===
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 [[Site_policies#Password_policy|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 &#44 - the script will decode these back to commas.
Tip: For Boolean fields with only two values, use '''0''' for false and '''1'''for true.

To provide values other than the default you can include one or more of these optional user fields:
<pre>institution,department,city,country,lang,auth,timezone,idnumber,icq,phone1,phone2,address,url,description,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,interests,theme</pre>
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, eg 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 [https://www.iso.org/obp/ui/#search 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 lettter) 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, nologin, 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, eg. 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.)
<pre>profile_field_xxxxx</pre>
'''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, eg. 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:
<pre>
username,firstname,lastname,email,profile_field_dohire
blumbergh,Bill,Lumbergh,blumbergh@example.com,1990-02-19
pgibbons,Peter,BGibbons,pgibbons@example.com,1996-06-05
tsmykowski,Tom,Smykowski,tsmykowski@example.com,1970-01-01
</pre>

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. Eg.
<pre>
username,firstname,lastname,email,profile_field_corporatedivision
blumbergh,Bill,Lumbergh,blumbergh@example.com,Management
pgibbons,Peter,BGibbons,pgibbons@example.com,Development
tsmykowski,Tom,Smykowski,tsmykowski@example.com,Training
</pre>
=== Special user change fields===
Three special fields are used for managing user accounts, '''oldusername''', '''deleted''' and '''suspended'''. [[#Allow_renames|See below for details]].
===Enrolment fields===
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:
<pre>course1,type1,role1,group1,enroltimestart1,enrolperiod1,enrolstatus1,course2,type2,role2,group2,enroltimestart2,enrolperiod2,enrolstatus2</pre> etc.
Header fields '''must''' have a numeric suffix such that type1,role1,group1,enrolperiod1 and enrolstatus1 all apply to course1 for course'''1''' to course'''n'''. 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 succesful 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, eg. 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.

'''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 are not allowed. (Note that cohort id is what is usually known elsewhere as the "shortname".)

Here is a sample CSV file:
<pre>
username,cohort1,cohort2
student1,nursing,2016class
student2,nursing,2014class
student3,nursing,2014class
</pre>
=== MNet ===
Existing [[MNet]]users 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.

<code>sysrole1,sysrole2,sysrole3</code> etc

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.
[[File:GlobalRoles1.png|thumb|500px|center|Example of a file for uploading users with global/system roles]]
==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.
====Upload type====
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 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
;Update : 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#Password_policy|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#Password_policy|Password policy]].
;None : None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
;All : All of the users in the uploaded file will be forced to change the password during the user's next login attempt.
====Allow renames====
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.
;No : ignores the '''oldusername''' field and leaves the existing user account's username field unchanged.
;Yes : 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.
====Allow deletes====
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.
;No : ignores the '''deleted''' special field in the uploaded file and leaves the existing user account unchanged
;Yes : allows the existing user account to be deleted when the value of the 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.
;Yes : allows the existing user account to be suspended when the value of the of the '''suspended''' field is 1.
;No : 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#Allow_accounts_with_same_email|Managing authentication]] docs page
;Yes :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.
;No :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====
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.
;Yes : 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.
;No : 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:

<code>$username = preg_replace('/[^-\.@_a-z0-9]/', '', $username);</code>
====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 [[admin/user/user_bulk|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 [[admin/user/user_bulk|bulk user actions]].
;No : No users are selected for [[admin/user/user_bulk|bulk user actions]]
;New users : Only newly created users are selected for [[admin/user/user_bulk|bulk user actions]]
;Updated users : Only updated user accounts are selected for [[admin/user/user_bulk|bulk user actions]]
;All users : All users found (existing updated users and newly created user accounts) in the uploaded file are selected for [[admin/user/user_bulk|bulk user actions]]
===Default values===
You can provide default user values for some fields not included in the uploaded file. Some fields include:
*Email display
*Forum auto-subscribe
*City/town
*ID number
*Institution
*Department
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.

'''Other 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 the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The results screen; everything went well!]]
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==
===Templates===
''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
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (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 '''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.
==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.

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.)
<pre>firstname,lastname,username,email,password,auth,idnumber,institution,department,city,country,timezone,lang,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,skype,msn,aim,yahoo,icq,phone1,phone2,address,url,description,descriptionformat,interests,oldusername,deleted,suspended,alternatename,lastnamephonetic,firstnamephonetic,middlename</pre>
The enrolments into courses information are <pre>course1,type1,role1,group1,enrolperiod1,enrolstatus1</pre>
where each enrolment is grouped by number.
===Capabilities===
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:
* moodle/site:uploadusers
* moodle/role:assign
And
* 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).
== See also ==
* [[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]]
Forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish
[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[de:Nutzerliste hochladen]]
[[es:Subir usuarios]]

error/auth saml2/exception

2022-01-18T15:59:43Z

Jprovasnik: Added support link to the specific Moodle discussion page

See [https://moodle.org/mod/forum/discuss.php?d=413059 SAML2 Exception] discussion in the Moodle Forum

Messaging settings

2021-11-04T12:09:23Z

Jprovasnik: /* List of message types */

{{Messaging}}
==Messaging settings for all users==
*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.
==Enabling / disabling messaging site wide==
The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Messaging > Messaging settings.

From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.
==Notification settings ==
Messaging system default settings are set in 'Notification settings' in Site administration / Messaging

There are four default types of notification plugins: web, Jabber, email and mobile.

By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.
[[File:NotificationPlugins.png|center|thumb|500px]]
==== Jabber ====
Jabber is the original name of the Extensible Messaging and Presence Protocol ([https://en.wikipedia.org/wiki/XMPP XMPP]), an open standard instant messaging protocol.
The Jabber service on the Moodle server must be configured before use. To configure Jabber, an XMPP account should be created that is specific to the Moodle server, either on a locally hosted XMPP server or on one of many [https://xmpp.net/directory.php public servers]. The information for this account is entered in Site administration / Plugins / Message outputs / Jabber:
*Host - The server to connect to to send jabber message notifications - this is entered as the full hostname (e.g. jabber.org) with no protocol (i.e. no "https://")
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server as the Moodle site, without domain name
*Password - The password to use when connecting to the Jabber server as the Moodle site.
*Port - defaults to 5222
[[File:Jabber_configuration.png]]

After the Jabber service has been configured, it must also be enabled.

Each Moodle user wishing to receive instant message notifications through Jabber must create an account on a Jabber server and must configure their Moodle account to include those details:

[[File:jabber_user_account.png]]

The user must also choose which notifications to receive using Jabber:

[[File:Jabber_notification_preferences.png]]

Users may also choose to receive Moodle messages via Jabber.
====Mobile notifications====
[[File:mobilenotifications.png]]

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

[[Site registration|Registered sites]] can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.

Alternatively, you may install your own private Air notifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.
===Default notification preferences===
You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:
* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.

* ''Permitted'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

* ''Locked'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.
====Logged in/Offline====
You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.
====Ordering of messaging settings====
Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.
[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]
==== List of message types====
Except for 'Personal messages between users', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle.
{| class="wikitable"
|-
! Module !!Output Name!!Description!!Recipients
|-
|Assignment||Assignment notifications||Student has submitted an [[Assignment activity|assignment]] and Student has received a grade/feedback||Teacher
|-
|Feedback||Feedback notifications||Notices from setting Enable notification of submissions||Teacher, Feedback administrator
|-
|Feedback ||Feedback reminder||[[Feedback activity|Feedback]] non-respondent reminder message|| Student feedback activity non-responders
|-
|Forum||Subscribed forum posts||Default for forum subscription handling||Anyone subscribed to a forum
|-
| Forum||Subscribed forum digests||Sets default for this for user profiles || Authenticated users
|-
|Lesson||Lesson essay graded notification||Notify students a teacher has graded a Lesson essay question||Student
|-
|Quiz||Notification of quiz submissions|| Message that student has submitted a quiz||Teacher
|-
|Quiz||Confirmation of your own quiz submissions||Notice your quiz was successfully submitted ||Student
|-
|Quiz ||Warning when your quiz attempt becomes overdue||See [[Quiz settings]]||Student
|-
|System||Notices about minor problems||?
|Site administrators
|-
| System|| Important errors with the site|| Important errors - See also [[Debugging]]||Site administrators
|-
| System ||Course creation request notification ||Notice a course has been requested - See [[Course request]]||Defined in ''Site admin > Courses > Course request > Course request notification''
|-
|System||Course creation request approval notification ||Notice a requested course has been approved||User who requested the course
|-
| System||Course creation request rejection notification||Notice a requested course has been rejected||User who requested the course
|-
|System|| Badge recipient notifications|| Notify recipient of a badge when it is awarded to them||Any badge recipient (typically Student role)
|-
| System||Badge creator notifications || Notify creator of a badge when it is awarded to someone||Any badge creator (typically Teacher or Manager role)
|-
|System||Insights generated by prediction models||?||?
|-
|System||Message contact requests notification||?||?
|-
|System|| Grade notifications||?||?
|-
|System||Available update notifications||Notice of new releases of Moodle code||Site administrators
|-
| System||Backup notifications||Automated backup schedule run completed||Site administrators
|-
| System||Comment posted on a learning plan||?||?
|-
|System||Comment posted on a competency ||? ||?
|-
|Manual enrollment||Manual enrolment expiry notifications|| Notice if [[Manual enrolment]] about to expire||Manual enrolees
|-
|Self enrollment||Self enrolment expiry notifications||Notify users when their enrolment expires|| Enroller only, or Enroller & Enrolled user
|-
|Data privacy||Data request ||?||?
|-
|Data privacy||Data request processing results||?|| ?
|-
|Data privacy||Data request exceptions notifications||?||?
|-
|Inbound message configuration||Warning when an inbound message could not be processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Confirmation that a message was successfully processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Personal messages between users||Using the Messaging interface tool||Authenticated Users
|-
|Inbound message configuration||Message to confirm that an inbound message came from you||See [[Incoming mail configuration]]||Authenticated Users
|-
| Event monitoring||Notification of rule subscriptions||Notifications from [[Event monitoring]] rules||Event rule subscribers
|}

==Roles and Messaging capabilities ==
The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
*[[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
*[[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
*[[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
*[[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
*[[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
===Email===
All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in ''Site administration > Advanced features > Notification email override''.

Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.
[[fr:Paramètres de messagerie]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]

Messaging settings

2021-10-28T13:27:53Z

Jprovasnik: /* List of message types */ Updated based on the order in which they are displayed in Moodle -- added the missing System notifications. Added a "module" column.

{{Messaging}}
==Messaging settings for all users==
*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.
==Enabling / disabling messaging site wide==
The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Messaging > Messaging settings.

From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.
==Notification settings ==
Messaging system default settings are set in 'Notification settings' in Site administration / Messaging

There are four default types of notification plugins: web, Jabber, email and mobile.

By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.
[[File:NotificationPlugins.png|center|thumb|500px]]
==== Jabber ====
Jabber is the original name of the Extensible Messaging and Presence Protocol ([https://en.wikipedia.org/wiki/XMPP XMPP]), an open standard instant messaging protocol.
The Jabber service on the Moodle server must be configured before use. To configure Jabber, an XMPP account should be created that is specific to the Moodle server, either on a locally hosted XMPP server or on one of many [https://xmpp.net/directory.php public servers]. The information for this account is entered in Site administration / Plugins / Message outputs / Jabber:
*Host - The server to connect to to send jabber message notifications - this is entered as the full hostname (e.g. jabber.org) with no protocol (i.e. no "https://")
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server as the Moodle site, without domain name
*Password - The password to use when connecting to the Jabber server as the Moodle site.
*Port - defaults to 5222
[[File:Jabber_configuration.png]]

After the Jabber service has been configured, it must also be enabled.

Each Moodle user wishing to receive instant message notifications through Jabber must create an account on a Jabber server and must configure their Moodle account to include those details:

[[File:jabber_user_account.png]]

The user must also choose which notifications to receive using Jabber:

[[File:Jabber_notification_preferences.png]]

Users may also choose to receive Moodle messages via Jabber.
====Mobile notifications====
[[File:mobilenotifications.png]]

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

[[Site registration|Registered sites]] can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.

Alternatively, you may install your own private Air notifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.
===Default notification preferences===
You can specify the default notification preferences for each type of message in Site administration / Messaging / Notification settings.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:
* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.

* ''Permitted'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterwards in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

* ''Locked'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.
====Logged in/Offline====
You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.
====Ordering of messaging settings====
Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.
[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]
==== List of message types====
Except for 'Personal messages between users', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle.
{| class="wikitable"
|-
! Module !!Output Name!!Description!!Recipients
|-
|Assignment||Assignment notifications||Student has submitted an [[Assignment activity|assignment]]||Teacher
|-
|Feedback||Feedback notifications||Notices from setting Enable notification of submissions||Teacher, Feedback administrator
|-
|Feedback ||Feedback reminder||[[Feedback activity|Feedback]] non-respondent reminder message|| Student feedback activity non-responders
|-
|Forum||Subscribed forum posts||Default for forum subscription handling||Anyone subscribed to a forum
|-
| Forum||Subscribed forum digests||Sets default for this for user profiles || Authenticated users
|-
|Lesson||Lesson essay graded notification||Notify students a teacher has graded a Lesson essay question||Student
|-
|Quiz||Notification of quiz submissions|| Message that student has submitted a quiz||Teacher
|-
|Quiz||Confirmation of your own quiz submissions||Notice your quiz was successfully submitted ||Student
|-
|Quiz ||Warning when your quiz attempt becomes overdue||See [[Quiz settings]]||Student
|-
|System||Notices about minor problems||?
|Site administrators
|-
| System|| Important errors with the site|| Important errors - See also [[Debugging]]||Site administrators
|-
| System ||Course creation request notification ||Notice a course has been requested - See [[Course request]]||Defined in ''Site admin > Courses > Course request > Course request notification''
|-
|System||Course creation request approval notification ||Notice a requested course has been approved||User who requested the course
|-
| System||Course creation request rejection notification||Notice a requested course has been rejected||User who requested the course
|-
|System|| Badge recipient notifications|| Notify recipient of a badge when it is awarded to them||Any badge recipient (typically Student role)
|-
| System||Badge creator notifications || Notify creator of a badge when it is awarded to someone||Any badge creator (typically Teacher or Manager role)
|-
|System||Insights generated by prediction models||?||?
|-
|System||Message contact requests notification||?||?
|-
|System|| Grade notifications||?||?
|-
|System||Available update notifications||Notice of new releases of Moodle code||Site administrators
|-
| System||Backup notifications||Automated backup schedule run completed||Site administrators
|-
| System||Comment posted on a learning plan||?||?
|-
|System||Comment posted on a competency ||? ||?
|-
|Manual enrollment||Manual enrolment expiry notifications|| Notice if [[Manual enrolment]] about to expire||Manual enrolees
|-
|Self enrollment||Self enrolment expiry notifications||Notify users when their enrolment expires|| Enroller only, or Enroller & Enrolled user
|-
|Data privacy||Data request ||?||?
|-
|Data privacy||Data request processing results||?|| ?
|-
|Data privacy||Data request exceptions notifications||?||?
|-
|Inbound message configuration||Warning when an inbound message could not be processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Confirmation that a message was successfully processed||See [[Incoming mail configuration]]||Authenticated Users
|-
|Inbound message configuration||Personal messages between users||Using the Messaging interface tool||Authenticated Users
|-
|Inbound message configuration||Message to confirm that an inbound message came from you||See [[Incoming mail configuration]]||Authenticated Users
|-
| Event monitoring||Notification of rule subscriptions||Notifications from [[Event monitoring]] rules||Event rule subscribers
|}

==Roles and Messaging capabilities ==
The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.
*[[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
*[[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
*[[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
*[[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
*[[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]
===Email===
All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in ''Site administration > Advanced features > Notification email override''.

Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.
[[fr:Paramètres de messagerie]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]

Dashboard

2021-03-25T20:03:15Z

Jprovasnik: added an additional See Also link

{{Site appearance}}
==About the Dashboard==
The Dashboard is a customisable page for providing users with details of their progress and upcoming deadlines. In the centre is the [[Course overview block]] which allows students and teachers to easily track required activities and filter courses.

{{MediaPlayer | url = https://youtu.be/VApmuVO7sHY | desc = Overview of the Dashboard}}

If course images have been added in the course settings, they will display in the dashboard. Where no images have been added, coloured patterns appear. ('''New in 3.8:''' The administrator can define the colours from Site administration / Appearance /Course pattern colours.)

Quick access to Dashboard is also available from the user menu top right of the screen once logged in:

[[File:usermenufontawesome.png|thumb|center|User menu]]

The Navigation drawer or block includes a Dashboard link directly above or below the Site home link. Once a regular user is logged in, the My courses link will also take them to their Dashboard.

Users can normally customise their Dashboard, adding or removing blocks and changing block positions. They can revert their Dashboard back to the original blocks as follows:

# Click the 'Customise this page' button.
# Click the 'Reset page to default' button.

[[File:Resetdefault.png]]

(Note that an administrator can reset the Dashboard for all users from 'Default Dashboard page' in the Site administration).

==Default home page==

For new installations, Dashboard is the default home page for logged in users. An administrator can change the default home page in ''Administration > Site administration > Appearance > Navigation''.

If 'User preference' is selected as default home page, each user needs to navigate to Dashboard either via the Navigation block or the user menu and then from the Administration block click the "Make this my default home page" link. Note that this option only appears on the page that is not their current default home page. Once selected, Moodle will remember which page to present them each time they log on.

[[File:defaulthomepagelink.png]]

==Setting the default Dashboard==

An administrator or manager (or other user with the capability [[Capabilities/moodle/my:configsyspages|moodle/my:configsyspages]]) can set the default blocks for all users from ''Administration > Site administration > Appearance > Default Dashboard page''.

Clicking the button 'Reset Dashboard for all users' will then apply these settings to the Dashboard for everyone on the site.

Default blocks are:
* [[Navigation block|Navigation]]
* [[Administration block|Administration]]
* [[Course overview block|Course overview]]
* [[Private files block|Private files]]
* [[Latest badges block|Latest badges]]
* [[Calendar block|Calendar]]
* [[Upcoming events block|Upcoming events]]
* [[Online users block|Online users]]

==Preventing users from customizing their Dashboard==

By default, users can customize their Dashboard and add blocks. An admin can prevent this as follows:

# Go to ''Administration > Site administration > Users > Permissions > Define roles''
# Edit the authenticated user role and untick the [[Capabilities/moodle/my:manageblocks|Manage Dashboard blocks capability]]

==Dashboard capabilities==

* [[Capabilities/moodle/my:manageblocks|Manage Dashboard blocks]] (see above)
* [[Capabilities/moodle/my:configsyspages|Configure system templates for Dashboard]]

In addition, all blocks which may be added to a Dashboard have a ''myaddinstance'' capability (e.g. [[Capabilities/block/comments:myaddinstance|block/comments:myaddinstance]]) for controlling whether a user with a particular role can add the block.

==Preventing users from adding a block to their Dashboard==

By default, users can add many blocks to their Dashboard. An admin can prevent them from adding a particular block, such as the [[Online users block]], as follows:

# Go to ''Administration > Site administration > Users > Permissions > Define roles''
# Edit the authenticated user role and untick the [[Capabilities/block/online users:myaddinstance|Add a new online users block to the Dashboard capability]]

==Blocks not available on the Dashboard==

The following blocks may not be added to a user's Dashboard (because it wouldn't make sense):

*[[Course completion status block]]
*[[Course/site summary block]]
*[[Self completion block]]

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=340126 Show Categories of courses on Dashboard after sign in] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=418596#p1693029 Hide a block from student roles?] forum discussion

[[eu:Nire_Moodle]]
[[fr:Tableau de bord]]
[[de:Dashboard]]
[[es:Tablero]]

Grades FAQ

2021-01-31T21:42:27Z

Jprovasnik: added 8.4

{{Grades}}
== General ==

===How can I change how grades are displayed?===

Grades may be displayed as as actual grades, as percentages (in reference to the minimum and maximum grades) or as letters.

The default grade display type for the site is set by an administrator in ''Administration > Grades > [[Grade item settings]]''. However, this may be changed at course level.

To change how grades are displayed for particular [[Grade items|grade items]], or category and course summaries (called aggregations):

# Go to ''Course administration > Gradebook setup''.
# Click the Edit then edit settings link opposite the grade item or category total. (For the course total, click the Edit then 'Edit settings' link at the top of the actions column, opposite the name of the course.)
# On the edit category page, click the 'Show more...' link under 'Category total'.
# From the Grade display type menu, select real (for actual grades), percentage or letter.
# Click the "Save changes" button at the bottom of the page.

Alternatively, to change how grades are displayed for the whole course:

# Go to ''Course administration > Gradebook setup''.
# Select "Course grade settings" in the administration block.
# From the Grade display type menu, select real (for actual grades), percentage or letter, or a combination of these.
# Click the "Save changes" button.

===How can I hide entered grades until a specified date?===

To set a "Hidden until" date:

# Go to ''Course administration > Gradebook setup''.
#Click on the edit icon opposite the activity for which a "Hidden until" date is to be set.
#On the edit grade item page, ensure that advanced settings are displayed. (Click the "Show advanced" button if not.)
#Enable the "Hidden until" setting by unchecking the disable checkbox, then set a date.
#Click the "Save changes" button.

=== Is it possible to show the teachers/administrators' grades in the grader report? ===
Yes, at the site level you can define which roles will appear in the grader report. This can be found in [[General_grade_settings#Graded_Roles|Administration > Grades > General settings]]. Also read [http://moodle.org/mod/forum/discuss.php?d=92612 this discussion] for some more ideas.

===Why can't I change a grade within an assignment after changing it in the gradebook?===

When you edit a grade directly in the gradebook, an "overridden" flag is set, meaning that the grade can no longer be changed from within the assignment.

However, the flag can be removed by turning editing on in the [[Grader report|grader report]], then clicking the edit grade icon, unchecking the overridden box and saving the changes.

===How do I get groups to show up in the grader report?===

For groups to show up in the grader report, group mode should be set to visible or separate groups in the [[Course settings|course settings]]. This will result in a groups dropdown menu being displayed, enabling a teacher to view the grades of all participants, or only the grades for a selected group.

===The quiz grades keep disappearing from the student view, even after I un-hide them!===

Check your quiz settings. Under the '''Review options''' heading, in the '''Later, while the quiz is still open''' and/or the '''After the quiz is closed''' columns, you probably have Scores un-checked. Each time a student completes a quiz, these settings are consulted and the scores will be hidden from ''all'' students. If your students don't all take the quiz at the same time, it can look like quiz scores reset themselves to 'hidden' randomly, even after you un-hide them. (If there is no end date for the quiz, the quiz never actually closes and will never display grades unless Scores is checked in "Later, while the quiz is still open."

===How can I make the gradebook simpler for teachers?===

See [[Simplifying the gradebook by changing permissions]].

===How can I remove the grades link in the user menu?===

If you are using an alternative gradebook to the one provided in Moodle, you can remove the grades link in the user menu (or change it to something else) by editing the setting 'User menu items' (customusermenuitems) in the Site administration.

==Grades and user removals==

===What happens to gradebook data when a user is unenrolled from a course?===

On re-enrolling, you can recover their grades from before. See the section 'Unenrolment and grade history' in [[Unenrolment]] for more details.

==Advanced grading==

===Why can't I see the advanced grading option??===
To see the option for Advanced grading, you first have to create an assignment and choose Advanced grading/Rubric from the Grading method dropdown. Advanced grading will then appear in ''Settings>Assignment administration.''

===How can I allow teachers to save rubrics as templates for others?===
Create a new role and assign it in the system context. Give this role the capability ''moodle/grade:sharegradingforms'' (for sharing as a template) and if desired ''moodle/grade:managesharedforms'' (for editing or deleting templates created by others) Assign this role to those teachers you wish to have this ability.

===How do students see the Marking guide?===
Assuming the teacher has allowed this in the [[Marking guide]] settings, the student may click "submissions grading" under the assignment name in their navigation block:

[[File:submissionsgrading.png]]

===Why can't students see feedback when Blind Marking is used?===
If you use '''Blind Marking''' to conceal student identities when assessing in the Assignment module, it waits until ''all'' submissions are marked, and '''Reveal student identities''' is clicked, to enter final grades into the Gradebook. Only at this point does it release Rubric marks/comments and inline feedback for student view (if Advanced Grading: Rubrics and Inline Comment Feedback are used in the Assignment).

== Reports ==
=== How do I create my own custom gradebook reports? ===

See [[:dev:Gradebook reports|Gradebook reports]] in the dev docs.

===How can I sort or change the order of column headings?===
Go to Grades link, then select one of the "Category & items" actions from the pulldown on the top left. Use the move icon to change the position of the graded item. And/or you could create categories for the items and move them into a category so they will be grouped that way first.

===How can I remove user ID numbers and/or email addresses from the grader report===

Go to ''Settings > Site administration > Users > Permissions > [[Roles settings|User policies]]'' and untick the 'ID number' and/or 'email address' checkboxes for 'Show user identity'.

Note that this will result in ID numbers and/or email addresses not being shown when searching for users and displaying lists of users. See the section 'Show user identity' in [[Roles settings]] for a list of locations where user identity fields are shown.

=== How can I interpret the quiz report statistics?===

See [https://docs.moodle.org/dev/Quiz_report_statistics Quiz report statistics] in the developers documentation.

== Aggregation ==
=== I can't find where to change the aggregation type for my gradebook categories! ===

# Go to ''Course administration > Gradebook setup''.
# Click the edit settings link opposite the category.

=== How can I grade some of my activities without the results affecting my students' course total? ===

# Go to ''Course administration > Gradebook setup''.
#Add two [[Grade categories]], one for your "Graded activities" and one for your "Not graded activities". In the "Not graded activities" category choose "None" in grading type.
#Ensure that "Aggregate including subcategories" (an option visible only in "full view") is unchecked for your top level course grade category.
#If you want to completely hide the "Not graded activities" category from your students tick the "Hidden" icon too.
#Save your changes.
#Move all your normally graded activities into the "Graded activities" category.
#Move all your excluded from grading activities into "Not graded activities" category.

'''Note''': Following the above steps the not graded activities will be completely hidden from your students. So...

*'''IF''' you want the activity grades of the "Not graded activities" category, to remain visible to your student without their grades affecting their course total, simply click the eye to show the "Not graded activities" category.

*'''IF''' you want students to be able to see the activity grades and the category total of the "Not graded activities", then you have to let the category visible and also choose a grading type between value, scale or text, by editing the category.

In this case you can exclude the "Not graded activities" from course total using the "Weighted mean of grades" aggregation method in Course category and assigning 100 weight to the "Graded activities" and 0 weight to the "Not graded activities".

*'''IF''' you don't want to use grade categories, you can also exclude the grades of a specific activity by changing the "Multiplicator" (visible only in "full view") from 1.0 into 0.0.

*Last, '''IF''' you want to exclude the grade of an activity only to one or some specific students, then follow these steps:
#From the grader report "Turn editing on"
#Click the "Edit grade" icon of the activity of the student you want to exclude.
#In the Edit grade page, check the tick box next to the "Excluded" option and "Save changes".

=== My student completed only one activity out of 5, but his course total shows 100%. How do I show a more "progressive" course total? ===

==== Step-by-Step Explanation ====

# Go to ''Course administration > Gradebook setup''.
# At the top line there is a folder icon and an edit icon on the right, click the edit icon
# You'll then see the title "Grade category." Click "Show more..."
# In the expanded view, the 3rd item is "Exclude empty grades."
# Uncheck this.
# Save.

==== Another Explanation ====
By default, only non-empty grades are aggregated, the others are ignored. However, you can change this setting as well as others that affect the course total, by turning "Editing" on in the grader report, and clicking the "Edit" icon next to the course category (the very top row of the grader report).

You can untick the box "Exclude empty grades" if you want to show a more "progressive" score for each student. Their empty grades will count as a 0 and will be counted in the course mean/total.

If you prefer to show a sum of points, rather than a percentage, you can change the course category's aggregation method to "Natural".

=== How can I display the average grade for my course categories (not grade categories)? ===
In Moodle 3.0 there is no way to aggregate course totals within each category. The gradebook is course-centered, and there is currently no User Interface for showing grades within an entire course category at once. However, the Grades link from the User dropdown menu will show students their Total Grades from each course that they are enrolled in.

=== Why is the Category Total blank for one of my categories? ===
One possibility is that you accidentally entered some grades into the Category Total column and then erased them. When you do that, an override flag gets set and then the totals won't calculate. Here's how to check, and fix it:

# Go to the [[Grader report]] view of the gradebook.
# Click the "Turn editing on" button for the gradebook. (There's a separate one for the gradebook from the one on the main page.)
# Find the box for the problem category and the first student affected.
# Click on the icon of a gear *in that box*.
# See if the box marked "[[Grade_editing#Overridden|Overridden]]" (third line down) is checked. If it is, uncheck it.
# Repeat (4) and (5) for each student affected,

(Overridden grades are normally shaded a dark yellow in the grader report, which makes finding them much easier.)

== Categories ==
=== How many depths of categories/subcategories can I create? ===
There is no programmatic limit, but there are practical limits. Very deeply nested structures are difficult to manage. 3 levels of categories should be sufficient for most situations. Note that there is always at least one level of categories, since the Course category always encompasses all other categories and grade items, can cannot be deleted.

=== I can't find setting X in the grade category edit page! Where is it? ===
If a setting documented on the [[Grade categories]] page does not appear on your edit page, it may mean that it is set globally in your site. See [[Grade_category_settings#Forcing_settings|Forcing settings]] for more information.

== Outcomes ==
=== I want to set up an outcome item for my course. What are the steps required? ===
#The site administrator needs to have enabled outcomes via ''Administration>Site Administration > Advanced Features >Enable Outcomes''
#In your course, go to ''Administration>Course administration>Grades>Scales'' and create the scale you need.
#[[Scales#Creating_a_new_scale|Create a scale]]
#In Administration>Course administration>Outcomes, create a course outcome assigning it to the scale you just created.
#Read the [[Outcomes| outcomes documentation]] for instructions).
#You can now give your students a rating on the outcome dimension you just created. If you created a standard outcome, you will be able to use it in other courses and follow your students' performance across these courses.

===How can I remove an outcome from an activity?===

An outcome can be removed from an activity by deleting it via ''Course administration > Gradebook setup''. This results in the outcomes being deselected on the update activity page.

== Activities ==
=== The activity I wish to use doesn't support grading. How can I give my students a grade anyway? ===
You can create a [[Grade_items#Manual_grade_items|grade item]] manually in the gradebook. You will have to grade your students through the [[Grader report]] interface (in editing mode).

=== I just graded some of my students using the activity interface, but the results aren't showing up in the grader report. What's going on? ===
Here are some of the possible reasons:
#The site settings>Grades>General settings may not have the correct graded roles checked off to appear in grade book. If you see no students in the Gradebook but do see columns for the graded activities, then check the graded role settings.
#The corresponding [[Grade items|grade item]] is [[Grade_locking#In_grade_items|locked]], or its parent [[Grade categories|category]] is [[Grade_locking#In_grade_categories|locked]].
#The module code is not using the [[Development:Grades#API_for_communication_with_modules.2Fblocks|gradebook API]] correctly

=== I just created a new assignment with the "Grade" setting set to "No grade", but it still appears in the gradebook ===
The reason is that the gradebook is now the place where both numerical and textual types of feedback are recorded for all activity modules. The word "Grading" in assignment relates only to numerical grades, but the ability to give text feedback remains, and must be recorded in the gradebook. This is why a grade item is created for it. You can hide the grade item if you do not want it to appear in the user reports.

=== How can I quickly give all students additional points for an activity ===
To add points on top of an already existing grade, go to the Gradebook setup, click "Edit" next to the activity, and choose "Edit Settings" from the dropdown menu. Under the Grade item section, click Show More and add points into the Offset. This will give all users the additional points. Users with 0 points (or with no points yet earned) will start off with the amount you've set here.
The Single view is another place where you can override points earned for an activity; though, any modifications in the Singleview will override the grade -- changes made to grade at the activity level will not appear in the gradebook until this override is removed.

==Weights and extra credits==

===How do weighted grades influence the category or course total?===
Weighted grades behave differently in Weighted Mean of Grades and Natural Grading.

WEIGHTED MEAN OF GRADES
A weight (also called coefficient) only has meaning in reference to other weights. If you only have one grade item, changing its weight will not have any effect. However, if you have two grade items, each with a different weight, the "heavier" item will have more influence on the total grade than the "lighter" one.

You can set the weights to any positive numerical value you choose. Usually, at least one of the weights will be 1 and serve as the baseline for other weights. If another item has a weight of 2, its grades will be multiplied by 2 compared with the grades of the first grade item, before being averaged. The denominator used for averaging is the sum of all the weights.

An example follows:
item 1 weight: 1
item 2 weight: 3
item 3 weight: 0.5

item 1 grade: 40/100
item 2 grade: 60/100
item 3 grade: 20/100

Calculation:
total = ((40 * 1) + (60 * 3) + (20 * 0.5)) / (1 + 3 + 0.5)
= (40 + 180 + 10) / (4.5)
= 230 / 4.5
= 51.11

The total for this category will then be 51.11 out of 100

NATURAL GRADING

Natural grading automatically calculates the weight value in response to the maximum grade that is set for all of the grade items. The weighting column will always add up to 100%.

If you change the weight for one of the grade items, the weighting of the other grade items will all readjust in response to the change.

Example:

item 1 grade: 40/100
item 2 grade: 60/100
item 3 grade: 20/100

Natural Weight (because all items are of equal value (100 points):
item 1: 33.33%
item 2: 33.33%
item 3: 33.33%

If you then adjust the weight for item 1 to 50%, the other two grades will adjust to 25% each -
item 1: 50%
item 2: 25%
item 3: 25%

Calculation:
total = ((40 * 50) + (60 * 25) + (20 * 25)) / 100
= (2000 + 1500 + 500) / 100
= 4000 / 100
= 40

===Do I have to put a value in each "weight" input box?===
WEIGHTED MEAN OF GRADES
No. If you do not put a value, it will default to 1. If all items are set to 1 then they all have equal weight. If you set a weight to 0, the item's grades will not count at all in the category or course average.

NATURAL GRADING
The weights will adjust in response to the weights that you do change. If you only change 2 of 6 total grade items' weight, the other four weights will adjust so that all weights add up to 100.

===Do all the weights have to add up to 100 or some similar value?===
WEIGHTED MEAN OF GRADES
No, the numbers you put as weights are completely arbitrary. They must be positive numbers, and can add up to anything you want. Note however that the following four sets of weights are identical in value:

(1 1.75 3)
(4 7 12)
(8 14 24)
(400 700 1200)

NATURAL GRADING
Natural grading weights MUST equal 100%. If you manually adjust the values of EVERY grade item, and they do not equal 100%, upon saving they will be adjusted to equal 100%, retaining your weighting preferences. If you only adjust a few of your grade items, the remaining items weights will be adjusted so that the total comes to 100%.

Example:
If you set your weights as follows:
item1: 2
item2: 2
item3: 4

Natural grading will adjust them as follows:
item1: 25%
item2: 25%
item3: 50%

===What is the difference between Weight and Extra Credit?===
Weight is only available with "Weighted mean of grades" and "Natural" grading. For the "Simple weighted mean of grades", the weight is taken from the grade item's maximum grade. A weight is used to give a grade item more or less importance in the computation of the category total or average, compared with the other items of the same category.

Extra credit replaces grade item weight if the aggregation method is "Mean of grades (with extra credits)", "Natural", or "Simple weighted mean of grades". The effect of extra credit is different in each case, hence some confusion:

*Mean of grades (with extra credits): A value of 0 does nothing. Any other value is used to multiply the grade and add it to the total after the computation of the mean. This grade is not used in the computation of the mean, however, only added afterwards. Additionally, this cannot bring the category total over its maximum grade unless grades over 100% are enabled by the site administrator (since 1.9.5). This grade item is not counted either in the denominator used to compute the category mean.

*Natural: Extra credit is a checkbox, not a number. Normally, with Natural, the category's maximum grade is the sum of the maximum grades of all its grade items. If one of them is set as "Extra Credit", however, its maximum grade is not added to the category's maximum grade, but its grades will be. This way it is possible to achieve maximum grade (or grades over maximum if enabled by the site administrator) in the category without getting the maximum grade in all the grade items.

*Simple weighted mean of grades: Extra credit is a checkbox, not a number. The "Extra Credit" grades are counted in the numerator used to compute the category mean, but not the denominator. See [[Category_aggregation#Simple_weighted_mean|here]] for more information.

To change a graded item to an extra credit item for Natural or Simple weighted mean of grades:

# Go to ''Course administration > Gradebook setup''.
# Find the extra credit item. To the right of the item, click "Edit > Edit Settings."
# On the Grade Item page, scroll to the bottom and check "Extra credit."
# Click the "Save changes" button.

===How do I create an assignment for which students can receive a grade above the maximum/above 100%?===

#Ask your administrator to go to ''Administration > Site administration > Grades > General settings'' and tick the box 'Unlimited grades'.
#In Grade point maximum (just below the unlimited grades setting) enter the maximum grade point value you wish to be available for all activities.
#In Grade point default (if you wish) enter the default grade point value you wish to display, if you want it to be above 100%.
[[File:gradepointmaxdefault.png]]

===Why can't I enter a grade higher than the maximum?===
See the answer to the question above. Ask your administrator to check ''Administration > Site administration > Grades > General settings''
==Formulas==

===How do I give a fixed score for a successful quiz attempt===

Suppose you want to give 5 points for a passing grade (say, 40) in a certain quiz (which has a maximum score of 100). Possible scenario ([http://moodle.org/mod/forum/discuss.php?d=148576]): extra credit points to every student that gets a "passing grade" in a "practice test" at the end of each chapter covered in the course, to encourage them to practice after the homework quizzes and to get familiar with a "test type" situation before the actual test.

The following formula should do the trick:

<code>=if([[quiz]]>=40, 5, 0)</code>

The formula may be added to a designated grade item or category.

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=2122 Gradebook forum] on moodle.org.

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=349976 Converting to Natural from Weighted, M2.7 to 3.2, general advice!] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=382291 Grading the number of activities completed]

The following forum discussions are from before the implementation of the Natural Grading aggregation method but have been left here because they still contain some good information:

*[http://moodle.org/mod/forum/discuss.php?d=123143 Excluding practice quizzes from gradebook]
*[http://moodle.org/mod/forum/discuss.php?d=193705 Course total not sum of max grade column?]
*[https://moodle.org/mod/forum/discuss.php?d=167596 Why do only certain items have multiplicator & offset boxes?]
*[https://moodle.org/mod/forum/discuss.php?d=235640 Extra credit]
*[https://moodle.org/mod/forum/discuss.php?d=269534#unread Change grading method only for some students]

[[Category:FAQ]]

[[ca:PMF de les qualificacions]]
[[de:Bewertungen FAQ]]
[[es:Calificaciones FAQ]]
[[fr:FAQ des notes]]
[[ja:評定FAQ]]

Timeline block

2021-01-31T21:28:29Z

Jprovasnik: created 2 notes

{{Blocks}}
*The Timeline block (displayed by default on the [[Dashboard]] and replacing the timeline tab of earlier versions of the [[Course overview]]) provides an overview of deadlines.
*Deadlines may be sorted by Overdue or Upcoming due dates (1) or by due dates per course (2).

[[File:docsTimelineblock.png]]

==How to make activities and resources display in the Timeline block==

For activities
* Either set a deadline or
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]
* For teachers to see assignments which need grading, a 'Remind me to grade by' date must be entered in the assignment set up screen.
* Note 1: the dashboard will only display a maximum of 2 weeks in the past for 'Overdue' or 'Remind me to grade by' activities
* Note 2: students will not see activities on the dashboard unless they currently have access to view them in the course (ie. If an assignment is restricted to the view of a lesson, the assignment will not appear on the dashboard until the lesson has been viewed).

For resources
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]

[[es:Bloque Línea de tiempo]]
[[de:Zeitleiste]]

Timeline block

2020-12-10T20:11:17Z

Jprovasnik:

{{Blocks}}
*The Timeline block (displayed by default on the [[Dashboard]] and replacing the timeline tab of earlier versions of the [[Course overview]]) provides an overview of deadlines.
*Deadlines may be sorted by Overdue or Upcoming due dates (1) or by due dates per course (2).

[[File:docsTimelineblock.png]]

==How to make activities and resources display in the Timeline block==

For activities
* Either set a deadline or
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]
* For teachers to see assignments which need grading, a 'Remind me to grade by' date must be entered in the assignment set up screen.
* Note, the dashboard will only display a maximum of 2 weeks in the past for 'Overdue' or 'Remind me to grade by' activities

For resources
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]

[[es:Bloque Línea de tiempo]]
[[de:Zeitleiste]]

Question bank

2020-06-20T17:34:51Z

Jprovasnik: added additional link

{{Managing questions}}
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''

==Select a category==
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.

The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.

If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.

===Categories are shared in contexts===

There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.

==Add a new question==
# Click the ''Questions'' tab to access the Question Bank page, if not there already.
# From the '''Category''' drop-down menu, select a category you want to add a question to.
# The page will change to show the questions already in that category
# Select the question type you want to create from the '''Create new question''' drop-down menu.
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.
# Click ''Save Changes'' at the bottom of the form.

==Edit, duplicate, preview, delete, move and tag==
[[File:NewQuestionEditIcons1.png]]

Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."

A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.

[[File:FilterByTag.png]]

==Tips and tricks==
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.
*Do a copy and paste from a PDF file into the question content area. Reduces "other" hidden code which Word, Open Office and other programs can insert.

==Sharing and Managing Question banks==

Be default, teachers can manage only the questions in the context of the courses they are in. You can set up a role to allow teachers to share and manager questions on a larger scale.

You can also use this role to create a special system-wide "Question bank Manager" instead of giving admin level or site-wide Manager access to a person managing the Questions.

See:

*[[How to let teachers share questions between courses]]
*[[How to minimize the question bank when doing backup/restore]]
*Quiz Question Bank: Quiz level vs Course level - Forum Discussion: https://moodle.org/mod/forum/discuss.php?d=405646

[[de:Fragensammlung]]
[[es:Banco de Preguntas]]
[[eu:Galdera-bankua]]
[[fr:Questions]]
[[ja:問題バンク]]

Checklist module

2020-04-09T15:42:47Z

Jprovasnik: Added comments about sorting

{{Infobox plugin
|type = Activity module, block and grade export
|entry = http://moodle.org/plugins/view.php?plugin=mod_checklist, https://moodle.org/plugins/view.php?plugin=block_checklist and https://moodle.org/plugins/view.php?plugin=gradeexport_checklist
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10608
|discussion = http://moodle.org/mod/forum/discuss.php?d=144764
|maintainer = [[User:David Smith 2|Davo Smith]]
|float = right
}}

[[Image:checklist_module_overview.png|thumb|Checklist Module]]The '''Checklist Module''' is an add-on that allows a teacher to create a checklist for their students to work through. It is contributed by [http://moodle.org/user/view.php?id=201866&course=1 David Smith].
The students should tick off each item on the list, as they complete it and the resulting progress of the class can be monitored by the teacher. The student is also rewarded with a progress bar that shows how far through the checklist they have managed to get.

Other features include:
* Indenting items, to show a hierarchy of importance
* Optional items (which can be hidden in the class progress report and contribute to a secondary 'all items' progress bar)
* Student checklist items (so that students can add their own items to keep track of)
* Dates on checklist items
* Choice of colours

There is a short [http://www.youtube.com/watch?v=wIpGuW_-sVg overview video] available on YouTube.

==Installation==
# Unzip the contents of file you downloaded to a temporary folder.
# Upload the files to the your moodle server, placing the 'mod/checklist' files in the '[moodlefolder]/mod/checklist' folder, (optionally) the 'blocks/checklist' files in the '[moodlefolder]/blocks/checklist' folder and (optionally) the 'grade/export/checklist' files into the '[moodlefolder]/grade/export/checklist' folder.
# Log in as administrator and click on 'Notifications' in the admin area to update the Moodle database, ready to use this plugin.

==Adding a checklist block==
# Click 'Turn editing on', in a course view.
# Under 'blocks', choose 'Checklist'
# Click on the 'Edit' icon in the new block to set the checklist to display and (optionally) which group of users to display.

==Exporting checklist progress (Excel)==
# In a course, click 'Grades'
# From the dropdown menu, choose 'Export => Checklist Export'
# Choose the checklist you want to export and click 'Export Excel'
If you want to change the user information that is included in the export ('First name', 'Surname', etc.), then edit the file 'grade/export/checklist/columns.php' - instructions can be found inside the file itself.

==Usage==
Click on 'Add an activity' and choose 'Checklist'.
Enter all the usual information.
You can optionally allow students to add their own, private items to the list (this will not affect the overall progress, but may help students to keep note of anything extra they need to do).

You can then add items to the list.
Click on the 'tick' to toggle an item between required, optional and heading
Click on the 'edit' icon to change the text.
Click on the 'indent' icons to change the level of indent.
Click on the 'move' icons to move the item up/down one place.
Click on the 'delete' icon to delete the item.
Click on the '+' icon to insert a new item immediately below the current item.

Click on 'Preview', to get some idea of how this will look to students.
Click on 'Results', to see a chart of how the students are currently progressing through the checklist.

Students can now log in, click on the checklist, tick any items they have completed and then click 'Save' to update the database.
If you have allowed them to do so, they can click on 'Start Adding Items', then click on the green '+' icons to insert their own, private items to the list.

If you allow a checklist to be updated by teachers (either exclusively, or in addition to students), it can be updated by doing the following:
# Click 'Results'
# Click on the little 'Magnifying glass' icon, beside the student's name
# Choose Yes / No for each item
# Click 'Save'
# (Optional) Click 'Add comments', enter/update/delete a comment against each item, Click 'Save'
# Click 'View all Progress' to go back to the view with all the students shown.

===Checklist Overview Sort Order===

The sorting for the block in 'overview' mode is as follows:
* Started, but incomplete checklists (ordered from least complete, to most complete), then
* Unstarted checklists (0%), then
* Completed checklists (100%)

A maximum of 20 checklists are shown and the ordering of checklists that have the same completion % is undefined (for MySQL it is likely to be the order they were created, for other DB systems, it may not be). As the overview works across multiple courses, there is no simple way to order the checklists with identical completion % in the same order that they would appear within a course.

===Normal items, optional items and headings in a checklist===

The checklist module fully supports headings:
# On the edit page, click on the 'tick' mark on the left to convert an item into an 'optional' item,
# Click again to convert it into a heading.

* Optional items are ones that contribute to the 'all items' progress bar, but not the 'required items' progress bar;
* Optional items don't contribute to the gradebook score, nor do they help the student to 'complete' the checklist.

==Automatic updating==

On the settings screen you can allow the checklist to import modules from the current course (or just the section the checklist is in). This will list the names of the resources / activities in the course and automatically tick them off, when they are 'completed' (note there will be a delay of up to 60 seconds between an activity being completed and the checklist updating, unless you are willing to make a few Moodle core code modifications).

Activities are considered complete, based on either the course logs being updated (e.g. resource viewed, forum posted to, etc.), a certain grade being achieved (Moodle 1.9 & assignment / quiz / forum only) or the Completion criteria being met (Moodle 2.0+ only).

==Adding labels to the checklist==
Labels are not included in checklists by default, as they would be confusing for most people.

However, if you do want labels to appear, you should only need to change a couple of lines of code.

Open up mod/checklist/locallib.php, find line 262 ( https://github.com/davosmith/moodle-checklist/blob/master/locallib.php#l262 ), which should look like:
if ($mods->get_cm($cmid)->modname == 'label') {
continue; // Ignore any labels
}
Just delete these 3 lines (or add '//', without quotes, to the start of each line) and labels should appear in the checklist.

[[es:Módulo lista de cotejo]]

Parent role

2020-04-01T22:43:46Z

Jprovasnik: added a link to a forum discussion

{{Roles}}
The role of '''Parent''' may be used to provide parents/mentors/tutors with permission to view certain information, such as activity reports, grades, blog entries and forum posts, about their children/mentees/tutees.

The Parent role may also be allowed to agree to policies on behalf of their underage child. See the section on agreeing to policies on behalf of the child.

===Creating a new role===

#As an administrator, go to ''Site administration > Users > Permissions > Define roles'' and click the "Add a new role" button.
#For archetype role choose "No role."
#Give the role a short name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Give the role a custom full name (such as "Parent", but it can be anything appropriate, such as tutor/mentor)
#Under Context types where this role may be assigned check the '''user''' context.
#Under the heading of '''Course'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewdetails]] to ''allow'' - to access the student's profile
#Under the heading of '''Users'''
#Change [[Capabilities/moodle/user:viewdetails|moodle/user:viewalldetails]] to ''allow'' - to view all aspects of the student's profile
#Change any/all of the following capabilities to ''allow''
#*[[Capabilities/moodle/user:readuserblogs|moodle/user:readuserblogs]] - to read the student's blog entries
#*[[Capabilities/moodle/user:readuserposts|moodle/user:readuserposts]] - to read the student's forum posts
#*[[Capabilities/moodle/user:viewuseractivitiesreport|moodle/user:viewuseractivitiesreport]] - to view the student's activity reports and grades
#*[[Capabilities/moodle/user:editprofile|moodle/user:editprofile]] - to edit the student's profile
#*[[Capabilities/tool/policy:acceptbehalf|tool/policy:acceptbehalf]] for accepting policies on behalf of the student.
#Click the "Create this role" button.

{|
| [[File:CustomRole05.png|thumb|Setting up the parent role]]
| [[File:CustomRole06.png|thumb|Assigning capabilities to the parent role]]
| [[File:CustomRole07.png|thumb|Saving changes to the parent role]]
|}

Some permissions may already be set to "Allow", or the permissions granted here may not be the ones required for that Role. This set of Permissions mean that this Role allows anyone assigned to a Parent Role, then linked to the Student Role, to edit the profile or read the blogs of that Student - not everyone's profile or blogs.

==Assigning the parent to the student==

*Access the child's full profile page, via '''Site administration ► Users ► Accounts ► Browse list of users'''
*Click the child's name to view the profile.
*In the Administration section, click Preferences
*In the Roles section, click Assign roles relative to this user
*Choose the role to assign i.e. Parent by clicking on the word.
*Select the parent in the potential users list and use the Add button to add it to the existing users list.

{|
| [[File:Parentroleassignroles.png|thumb|500px|"Assign roles relative to this user"]]
| [[File:choosingparent.png|thumb|500px|Assigning the parent to the student]]
|}

At this point you can return to the "Assign roles in user:" page and you should see that the parent name is now in the "Users with Role" column.

:'''NOTE:'''The same parent may be assigned to several students, siblings or otherwise.

===Agreeing to policies on behalf of the child===
If the parent has been given the [[Capabilities/tool/policy:acceptbehalf]] then they can click on the child's profile, click the Policies and agreements link and agree to the policies there:

[[File:ParentConsent.png|center|thumb|500px]]

===Adding the Mentees Block===
This block needs to be added so parents can see links to their child's profile.

* On the Front Page, turn editing on.
*Go to the '''Add Blocks''' block and select the [[Mentees block]] and when it appears, click on the Configuration icon.
*Edit the configuration settings to suit the needs of the site. When complete, save the changes and return to the Front Page.

{|
| [[File:addmenteesblock.png|thumb|Accessing the Add Blocks]]
| [[File:configuringmenteesblock.png|thumb|Setting the configuration values]]
|}

===How a parent sees their child's activities===

*Once the mentees block has been added, a parent/mentor sees the link to any children/mentees they are responsible for.
*They click on a name and will be taken to the profile page of that user.
*They then select from "Course profiles" - the name of a course the user is enrolled in.
*Grades may then be viewed by clicking in the Reports section
*Forum posts or similar may also be viewed from the user's profile in the Miscellaneous section.
{|
| [[File:MOParentRole01a.png|thumb|Click the name of a course in the profile]]
| [[File:MOParentRole02.png|thumb|Only '''then''' choose an item, for example grades]]
| [[File:MOParentRole03.png|thumb|The course grades are now visible]]
|}

*To view activity in another course, the parent needs to click back to the user's main profile and then select another course link.

==See also==
*[http://www.youtube.com/watch?v=Gk_TRi_N00o The Parent role in Moodle 2.0 video]
*[[Create_custom_roles|Create a custom role]]
*[https://moodle.org/mod/forum/discuss.php?d=389146#p1568758 Forum discussion regarding limitations to the mentor role]

[[eu:Guraso_rola]]
[[fr:Rôle parent]]
[[ja:親ロール]]
[[de:Eltern-Rolle]]
[[es:Rol paterno]]

User policies

2020-03-27T21:43:09Z

Jprovasnik: /* Gravatar default image URL */

{{Roles}}
==User policies==
The following settings may be changed by an administrator in ''User policies'' in the Site administration.

===Role for visitors===
Users who are not logged in to the site will be treated as if they have the role specified here, granted to them at the site context. The role of Guest is the default and the recommended setting for standard Moodle sites. The user will still be required to login to participate in an activity.

===Role for guest===
This option specifies the role that will automatically be assigned to the guest user. This role is also temporarily assigned to non enrolled users when they enter a course that allows guests without password.

(If you wish to deny guest access to a site altogether, the guest login button should be set to hide in ''Manage authentication'' in the Site administration.)

===Default role for all users===

It is recommended that the default role for all users is set to [[Authenticated user]]. To set it to a custom role, the custom role must be assignable in the system context and have role archetype set to none.

Note: It is not recommended that the default role for all users is set to student.

===Creators' role in new courses===
Moodle will automatically enroll the user creating a new course in the course with the role specified in this setting. Moodle checks that the role used for creating the course eg "Course creator" has the right to assign the specified role in the new course. This means that the following capabilities needs to be set on the course creator role before the user is enrolled automatically :
* moodle/course:create | Allow
* moodle/course:manageactivities | Allow
* moodle/course:viewparticipants | Allow
* moodle/role:assign | Allow

If the course creator role is not setup correctly the user will be enrolled in the course without any roles.

===Auto-login guest===

If not set, then visitors must click the "Login as a guest" button before entering a course which allows [[Guest|guest access]].

Note: If auto-login guest is set, the guest login button also needs to be set to show in ''Manage authentication'' in the Site administration, even though visitors won't necessarily use it.

===Hide user fields===
The following user fields appear on users' profile pages. Certain user fields are also listed on the course participants page. You can increase student privacy by hiding selected user fields.

Description, city/town, country, web page, ICQ number, Skype ID, Yahoo ID, AIM ID, MSN ID, last access, My courses and first access and groups

*User fields on users' profile pages are hidden from all users with the capability [[Capabilities/moodle/user:viewhiddendetails|moodle/user:viewhiddendetails]] not set.
*User fields on the course participants page are hidden from all users with the capability [[Capabilities/moodle/course:viewhiddenuserfields|moodle/course:viewhiddenuserfields]] not set.

===Show user identity===

Any of the following fields may be shown to users with the capability [[Capabilities/moodle/site:viewuseridentity|moodle/site:viewuseridentity]] when searching for users and displaying lists of users.

*Username
*D number
*Email address
*Phone number
*Mobile phone
*Department
*Institution
*City/town
*Country

This setting is useful for sites with large number of users, where the likelihood of users with the same name is high.

Locations where user identity fields are shown are as follows:

*User selectors ([[Assign roles]] in some places, [[Groups|groups]], forum subscribers)
*[[Browse list of users]]
*[[Participants]]
*[[Gradebook|Grader report]]
*[[Quiz reports]]
*[[Using SCORM|SCORM reports]]
*[[Using Assignment|Assignment submissions]]
*[[Using Course completion|Course completion report]]
*[[Using Activity completion|Activity completion report]]

Tip: Select only one or two fields that are mandatory at your institution. Do not select more than two fields otherwise tables become very wide.

===Full name format===

See [[Additional name fields]] for details, also about the alternative full name format.

===Maximum users per page===

You can choose here the maximum number of users to be displayed when searching in courses, groups, cohorts etc. The default is 100 but if your Moodle site is very large you can increase the number here.

===Enable Gravatar===

[http://gravatar.com/ Gravatar] (an abbreviation for globally recognized avatar) is a third party service for providing globally personal avatars.

If Gravatar service is enabled by the administrator and a user has not uploaded any user picture, Moodle will check whether the user's email address has an associated gravatar account and if so, will use the gravatar as the user's picture.

===Gravatar default image URL===

In Moodle 2.3.3 onwards, if gravatars are enabled, an alternative default user picture may be specified. The options are:

* A gravatar default image - by entering a code such as ''mm'' or ''identicon'' - See https://en.gravatar.com/site/implement/images/ for codes of other gravatar default images.
* A specified image - by entering the image URL

If the field is left empty then the theme's default user picture is used.

==Unsupported role assignments==

Unsupported role assignments are role assignments in contexts that make no sense for that role, such as the course creator role in the course or activity context, or the teacher role in the user context.

Prior to Moodle 2.0, there was no 'Context types where this role may be assigned' setting in the edit role form, and so any role could be assigned in any context. Upon upgrading a site from 1.9, any role assignments in contexts that make no sense for that role are listed as unsupported role assignments.

In general, it is safe to delete all unsupported role assignments. In doing so, the worst that can happen is for a user to be unassigned a custom role; no other data loss will occur.

[[Category:Site administration]]

[[de:Einstellungen für Rollen]]
[[fr:Réglages des rôles]]
[[ja:ユーザポリシー]]
[[es:Políticas para el usuario]]

File resource settings

2020-03-18T20:43:51Z

Jprovasnik: Added a line about "Display Resource Description"

{{File}}
A teacher can add a file in a course when editing is turned on by dragging and dropping it or by clicking an 'Add an activity or resource' link (or, if not present, the "Add an activity" drop down menu) and selecting File.

===Dragging and dropping files===
*If you are using a modern browser, you can simply click, hold and drag and drop a file directly onto your course page. You will know if drag and drop is available to you because you will (briefly) see a message at the top of your screen:
[[File:dragdropmessage.png]]

To drag and drop a folder, you must first compress/zip it using whichever program your computer has. See the documentation [[Folder]] for more information.

===Uploading files===
*Instead of drag and drop, you can click the link 'Add an activity or resource' and select either [[File]] or [[Folder]] from the activity chooser (or choose from the 'Add a resource' drop down menu, if this is present instead.)
*Give your file a name and, if desired, a description (which you can display on the course page) and then upload your file by clicking the 'Add' button in the Select files box. Clicking on this button takes you to the [[File picker]] which is the name given to the file storage and access area within Moodle.
*There is also a block (with an arrow) into which you can drag and drop a file straight from your desktop into Moodle.
[[File:31File.png|thumb|center|400px|Settings for uploading a file]]

==Viewing and editing uploaded files==

* Once uploaded, files appear as thumbnails in the file manager for easy recognition.
* Files view can be easily toggled between icons view or a table view with sizes and dates, or a hierarchical list view. See the documentation on the [[File picker]] for more information.
*Clicking on the name of an uploaded file opens up a pop up dialogue box which allows file details quickly to be altered.

[[File:popupdialogue.png|thumb|400px|center|File info popup dialogue]]

==Creating an alias/shortcut==

*When an uploaded file - or a file from the Private files, Dropbox, File system or EQUELLA repositories - is re-used elsewhere on Moodle, the teacher has the option to make a copy (a new, unconnected version) or to create a shortcut or ''alias''.
*If an alias is created, then when the original file is updated, it will change in all instances of the alias. So a teacher might add course notes to their private files for example, and then add them into a number of courses. When the teacher makes an alteration in the file in their private files, this alteration will be reflected in all instances of the course notes.
*An alias can be recognised by its thumbnail. See the difference in the screenshot below between the original file (left) and the alias (right):
*To update a file, go to its original location (for example Private files) and upload your new version ''with the same name'' . You will be prompted to override or rename the file. Choose "override" and this file will replace your original file and the alisas/shortcuts will remain and all be updated to your latest version.
{|
| [[File:alias.png|thumb|Creating an alias]]
| [[File:shortcut1.png|frame]]
|}

'''''Note:''' Aliases cannot be made in the following areas:
''
* an assignment submission
* a forum post attachment
* a workshop submission
* a quiz essay
* a database activity file field

This is to prevent cases such as a student uploading an item for assessment and then subsequently changing the original in their private files. When a student uses a file from their private files in one of these instances, they do not see the options to "copy" or "create an alias".

==File resource course settings==
===Display===
* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''Embed'' - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well (good for images, flash animations, videos?, PDFs).
* ''Force download'' - user clicks on the file, then the web browser pops up with the 'where do you want to save this file' box.
* ''Open'' - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
* ''In pop-up'' - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus and address bar in it.

*The following additional options are only there if you enable them via ''Site administration > Plugins > Activity modules > File'':

* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizable area below (images, PDF, flash, etc. supported).
* ''New window'' - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.

All of the above is true of items that can be displayed inside the browser directly (e.g. images, text files, PDFs (with plugin)). If the file cannot be displayed within the browser (e.g. word documents, without a suitable plugin, or other files that need to be loaded by an external program), then the pop-ups or frames, etc. will be created, but then the browser will take over and ask if you want to save the file.

To summarise:

* Do you want Moodle to sort it all out for you? - Automatic
* Do you want to force the user to save the file (or open it in a program on their desktop)? - Force download
* Do you want to show the file as part of the Moodle page (images, PDFs, videos)? - Embed
* Do you want to show the file in the browser, but without the Moodle page decorations (images, PDFs, videos)? - Open
* Do you want that, but in a new window? - In Pop-up (or possibly 'New window')
* Do you want to use a horrible bit of non-strict HTML that should never be allowed in polite company? - In frame

===Show size or type===

To show the file size and/or type on the course page and also on the resource page, simply tick the appropriate checkboxes.

[[File:files showing size and type.png]]

===Show upload/modified date===

If enabled, this setting will display the date the resource was uploaded. If several resources are uploaded, then date the main file was uploaded will be displayed.
[[File:UploadedModified.png|thumb|500px|center]]

===Display Resource Description===

If enabled, this setting will display any content from the description box beneath the file (bottom of the page), provided that the Display is set to Embed.

===Use filters on file content===
(This setting is visible when "Show more" is clicked.)

If you wish included media such as images and mp3 to appear embedded in the files then select "all files" or "HTML files only", according to your file types. (Note that this setting may cause problems for some Flash and Java applets.)

Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Conditional activities| Restrict access]] and [[Activity completion]]

If your File doesn't display as you wish, check the site settings below:

==Extract or unzip a zipped archive file ==

If you uploaded a zip file into a File or Folder Resource, you can uncompress and expand it into its various files. To do this, go into Edit settings for the resource, right click on the file icon in the Select files area, and then click on the Unzip file button.

[[File:file_resource_unzip.png|Unzip button]]

==Displaying a website index page==

The file module may be used if you have a folder with linked files such as a website with an index.html file or a flash activity with xml/swf and index file.
{|
| [[File:Setmainfile.png|thumb|Setting the main file]]
| [[File:file resource.png|thumb|Website index page set as main file]]
|}

# Click the 'Turn editing on' button at the top right of the course page
# Drag and drop the zipped folder onto the course section where you'd like it to appear, answer 'Create file resource' to the popup dialogue, then click the upload button
# Clicking the editing icon (hand with a pen) then click on the zip file and unzip it
# Click on the index.html file or the file you want to start displaying your linked files from then in the popup dialogue click the button 'Set main file'. This ensures this file is the one that appears on the course page for students to click on. The main file is then indicated with a title in bold.
# Click the button 'Save and display' at the bottom of the page

==Site settings==

The file module has additional settings which may be changed by an administrator in ''Site administration > Plugins > Activity modules > File''.

*Frame height allows you to specify the height of the top frame (containing the navigation) if you choose the "in frame" display option. Note: If your theme has a large header then the ''resource_framesize'' variable should be increased to prevent horizontal and vertical scrollbars.
*Available display options: By default Moodle doesn't enable "New window" or "In frame", so you need to set them available here if required, and you can also disable other options if not applicable.

The following capabilities relate to the file resource:
* [[Capabilities/mod/resource:view|View file resource]]
* [[Capabilities/mod/resource:addinstance|Add a new file resource]]

[[de:Datei konfigurieren]]
[[es:Configuraciones del recurso archivo]]

Capabilities/moodle/course:reset

2020-02-06T21:16:56Z

Jprovasnik:

{{Capabilities}}
*This allows a user to [[Reset course|reset a course]]
*This allows a user to reset an individual activity within a course
*This capability is allowed for the default roles of manager and teacher

[[Category:Capabilities|Reset]]
[[Category:Backup]]
[[es:Capabilities/moodle/course:reset]]

Capabilities/enrol/manual:unenrolself

2020-02-06T21:09:46Z

Jprovasnik:

{{Capabilities}}
*This allows a user to manually unenrol themselves from a course in which they were previously manually enrolled via ''Administration > Course administration > Unenrol me from this course''
*This capability adds an "Unenroll me from course” link in the Administration block of the course
*This capability is not set for any of the default roles
*To allow students to unenrol themselves from courses which they were previously manually enrolled in, the capability must be set to "allow" for the student role via ''Administration > Site Administration > Users > Permissions > Define roles.''

==See also==

*[[Manual enrolment]]

[[Category:Capabilities|Enrol]]
[[Category:Enrolment]]
[[de:Capabilities/enrol/manual:unenrolself]]

Capabilities/enrol/manual:unenrol

2020-02-06T21:07:33Z

Jprovasnik:

{{Capabilities}}
*This allows a user to unenrol other users manually in ''Settings > Course administration > Users > Enrolled users''
*This capability is allowed for the default roles of [[Manager]] and [[Teacher]]
*This capability adds a trash can icon next to each participant of the [[Participants]] page

==See also==

*[[Manual enrolment]]

[[Category:Capabilities|Enrol]]
[[Category:Enrolment]]

Capabilities/enrol/manual:enrol

2020-02-06T21:04:31Z

Jprovasnik:

{{Capabilities}}
*This allows a user to enrol other users into a course manually via ''Settings > Course administration > Users > Enrolled users''
*The default roles of manager and teacher have this capability set to allow.
*This allows users to see the “Enroll Users” button on the course [[Participants]] page

==See also==

*[[Manual enrolment]]

[[Category:Capabilities|Enrol]]
[[Category:Course]]
[[Category:Enrolment]]
[[de:Capabilities/enrol/manual:enrol]]

Capabilities/mod/hvp:getcachedassets

2020-02-06T13:27:50Z

Jprovasnik: Created page with "{{Capabilities}} *This allows a user to cache Interactive_Content_-_H5P_activity H5P assets, required for viewing H5P activities *This capability is allowed for the defaul..."

{{Capabilities}}
*This allows a user to cache [[Interactive_Content_-_H5P_activity]] H5P assets, required for viewing H5P activities
*This capability is allowed for the default roles of teacher and student
*This capability must also be added for the authenticated user role

[[Category:Audio]]
[[Category:Video]]
[[Category:Language teaching]]
[[Category:Mathematics]]

[[es:Actividad Contenido Interactivo - H5P]]
[[fr:H5P]]

Capabilities/moodle/restore:restoresection

2020-02-06T13:05:22Z

Jprovasnik:

{{Capabilities}}
*This allows a user to [[Course restore|restore course sections]]
*This capability is allowed for the default roles of manager and teacher
*This capability is required in order to use the Sharing Cart plugin

[[Category:Capabilities|Backup]]
[[Category:Backup]]

[[es:Capabilities/moodle/restore:restoresection]]
[[fr:Capabilities/moodle/restore:restoresection]]

Capabilities/moodle/restore:restorecourse

2020-02-06T13:05:17Z

Jprovasnik:

{{Capabilities}}
*This allows a user to [[Course restore|restore a course]]
*This capability is allowed for the default roles of manager and teacher
*This capability is required in order to use the Sharing Cart plugin

[[Category:Capabilities|Backup]]
[[Category:Backup]]

[[es:Capabilities/moodle/restore:restorecourse]]
[[fr:Capabilities/moodle/restore:restorecourse]]

Capabilities/moodle/restore:restoreactivity

2020-02-06T13:05:13Z

Jprovasnik:

{{Capabilities}}
*This allows a user to [[Activity restore|restore an activity from a backup]]
*This capability is allowed for the default roles of manager and teacher
*This capability is required in order to use the Sharing Cart plugin

[[Category:Capabilities|Backup]]
[[Category:Backup]]

[[es:Capabilities/moodle/restore:restoreactivity]]
[[fr:Capabilities/moodle/restore:restoreactivity]]

IMS Common Cartridge import and export

2019-10-24T16:35:51Z

Jprovasnik:

{{Backup}}
==IMS Common Cartridge import==
IMS Common Cartridge packages can be imported into Moodle using the same process as for [[Course restore]]. Click the Restore link via the Actions menu (cog icon) if using Boost or via the Administration block if using Clean.

===Troubleshooting tips===

Occasionally you may have problems with packages from some other systems (Blackboard 9.1 is one example). In these cases try running the package through the [http://validator.imsglobal.org/index.jsp?validate=manifest IMS CC validator] to check it for errors. The validator can also fix some of the errors.

[http://validator.imsglobal.org/index.jsp?validate=manifest http://validator.imsglobal.org/index.jsp?validate=manifest] ( Link Not Working as of October 2019 )

==IMS Common Cartridge export==

A course can be exported as an IMS Common Cartridge as follows:

# Click the Backup link via the Actions menu (cog icon) if using Boost or via the Administration block if using Clean.
# Tick the 'IMS Common Cartridge 1.1' checkbox in the backup settings
# Go through the backup steps
# Complete - Click the Continue button

An IMS CC (with distinctive .imscc extension to avoid confusion with .zip files) is then saved in the private user backup area.

Note: Currently the ONLY activities that can be exported to IMS CC are as follows:

* Forum
* Label
* IMS LTI activity (external tool)
* Page resource
* Quiz (partial support)
* URL resource

[[Category:Common Cartridge]]

[[de:IMS_Common_Cartridge_Import_und_Export]]
[[es:IMS Common Cartridge importar y exportar]]
[[fr:Importation et exportation IMS Common Cartridge]]

URL resource settings

2019-08-12T20:05:21Z

Jprovasnik: see also

{{URL}}
==Adding a URL resource to your course==

# Turn editing on.
#From the the "Add an activity or resource" link (or, if not present, the "Add a resource" drop down menu),choose URL. All settings may expanded by clicking the "Expand all/Collapse all" link top right.

==General==
*Give your URL a name and type (or copy/paste) the URL into the External URL box. If you need to search for the correct URL, click the Choose a link button. When you find and select your link,it will be automatically pasted into the box.
*Give the URL a description if you wish, and tick the box to display that description on the course page if needed.
[[File:31URL.png|thumb|400px|center|Adding a URL]]

==Appearance==
For '''Display''' you have the following options. If you don't see an option, ask the administrator to enable it in ''Site administration >Plugins >Activity modules >URL.'' You can also have 'in frame' or 'New window' but these must be enabled by the administrator.

* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''Embed'' - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well
* ''Open'' - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
* ''In pop-up'' - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus in it. If you select this one, then you can specify the pop-up width and height.

==URL variables==

This section allows you to pass internal information as part of the URL.

This is useful if the URL is actually an interactive web page that takes parameters, and you want to pass something like the name of the current user, for example.

Another use is to create stable links that updates in each iteration of the course, for example:

if you want to link to the student's user report, then you add the base URL to the External URL field, and then in the URL variables section, add 'id' to the first field and select 'id' from under the site heading, and then save changes. The result is a URL that always points to the student's user report.

A further use includes displaying all forums in a site, by using the base URL then adding add 'id' to the first field and selecting 'id' from under the site heading. Another use makes use of mailto:email@address. URL variables could then include the subject parameter followed by the 'Site full name'. E.g. if you wanted to email a teacher who taught multiple courses, if a student clicked the URL then the email would automatically fill the subject field, which would help the teacher to identify which course the student was in.

==Common module settings==
See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)

These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Drag and Drop a URL==
Alternatively, if an administrator has enabled the experimental feature drag and drop upload of text/links in ''Settings > Site administration > Development > Experimental > [[Experimental settings]]'', a link can be dragged into a section of the course and given a name, as shown in the images below.

{|
| [[File:dragURL.png|thumb|Adding a URL using drag and drop]]
|}

==URL module capabilities==

* [[Capabilities/mod/url:view|View URL resource]]
* [[Capabilities/mod/url:addinstance|Add a new URL resource]]

==Site administration settings==

The URL module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > URL''.

===Frame height===

Here you can specify the height of the top frame (containing the navigation) if you choose the "in frame" display option. Note:If your theme has a large header then the height should be increased to prevent horizontal and vertical scrollbars.

===Password===

Here you can add a password that will connect your users to a secure site. [http://moodle.org/mod/forum/discuss.php?d=189842#p826416 See this forum post] for more details.

===Include role names in parameters===

===Available display options===

This setting allows you to add different ways the resource may be displayed on the course page. There are a number of defaults but you can add or change them here. Other display options are:
* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizeable area below
* ''New window'' - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.
[[File:Display.gif]]

===Default values for activity settings===

Here you can set the defaults for this resource.

===See also===
Form discussions:
* [https://moodle.org/mod/forum/discuss.php?d=389552#p1570270 URL Resource - adding a URL Variable]

[[de:Link/URL konfigurieren]]
[[fr:Paramètres de l'URL]]
[[es:Configuraciones del recurso URL]]

Grader report

2019-03-04T02:12:26Z

Jprovasnik: /* Hiding settings globally */

{{Grades}}
All the grades for each student in a course can be found in the course gradebook, or 'Grader report', accessed from the Grades link either in the nav drawer or navigation block depending on your theme.

{{MediaPlayer | url = https://youtu.be/ZR4AvpD3bVA | desc = Overview of the gradebook}}

The grader report collects [[Grade_items|items]] that have been graded from the various parts of Moodle that are assessed, and allows you to view and change them as well as sort them out into [[Grade_categories|categories]] and calculate totals in various ways. When you add an assessed item in a Moodle course, the gradebook automatically creates space for the grades it will produce and also adds the grades themselves as they are generated, either by the system or by you.

The grades displayed are initially displayed as the raw marks from the assessments themselves, so will depend on how you set those up e.g. an essay out of 36 will appear as however many raw marks that student got, not a percentage (although this can be changed later, see below).

Note that various default options for the gradebook are set at system level by the administrator in and can be marked as being overridable by you, or fixed. This means that the options will not always be set up the same way for every user when they see the grader report for the first time.

==Hiding settings globally==

New settings hide parts of the user interface:

*''Site administration>Grades>General settings'': 'Show minimum grade' . If this setting is disabled, the minimum grade will default to zero and cannot be edited (the minimum grade can never be edited).
*''Site administration>Grades>Grade category settings'': 'Allow category grades to be manually overridden'. If this setting is disabled, users cannot override category grades.

===Scrolling through the gradebook===

The gradebook allows for smooth and stable scrolling horizontally and vertically through grades. It uses the whole window, making it accessible on all platforms.( Note: horizontal scrolling is at the bottom of the browser window, and there is no horizontal scrollbar at the top.)

{|
| [[File:scrolling28a.png|thumb|500px|Scrolling in all directions]]
| [[File:wholewindow.png|thumb|500px|Using the whole window]]
|}

[[File:newgradereporta.png|thumb|600px|center]]

==Display==

Along the top of the grader report are several rows: first the course, then the category, then the columns for each graded activity (for example: Assignment, Quiz, Lesson). Any activities settings which were left "uncategorised" will appear in the general category which is named after the course by default (any category name can be changed).

[[Image:gradereportcategories.png|center|thumb|600px]]

You can add a row showing the range of possible scores by selecting 'Show ranges' in 'My report preferences.

There are three ways that the categories can be displayed:

* Grades only - without the category totals column
* Aggregates - Category total column only
* Full view - grades and the aggregates (the totals column for the category)

Each section has a small icon immediately to the right of its name. Clicking this will cycle through these display modes for that category;

[[Image:grades3iconsa.png|thumb|500px|center]]

===Sorting by columns===

You can sort by any column. Click the [[Image:iconsort.png]] symbol near the top of a column to sort by that column (1 below). This will change the symbol to a single down arrow. Clicking again will sort lowest-to-highest, changing the symbol to an up arrow. The arrows will toggle between these two states until you click on a different column.

You can also access the [[Single view]] by clicking the pencil icon next to the arrows (2 below).

[[File:iconsgrades.png]]

You can sort the students by clicking the arrow (1 below), access individual [[User report| user reports]] by clicking the icon (2 below) and similar to the grade items you can access [[Single view]] by clicking the pencil icon (3 below)

[[File:studentsort.png]]

===Searching and filtering the gradebook===
If you change the course settings Group mode to Visible groups or Separate groups a drop-down menu will appear in the gradebook to allow you to filter your students by groups.

It is also possible to search students by first name and last name:

[[File:gradebooksearch.png]]

==Editing==

Note: Editing anything in the gradebook refers to editing the grades '''only''' and none of the available operations bear any relationship to editing the main course page i.e. the appearance of your course page cannot be influenced by anything you do in the gradebook. The "Turn editing on" button functions separately from the main course one, so editing can be on in the gradebook, but simultaneously off when you switch back to course view. This is because editing grades and editing the course page are separate capabilities. Roles such as 'non-editing teacher' may only have one or the other.

===Altering the grades===
You can click "Turn editing on" at the top right to show an edit icon next to each grade. Clicking on the icon will bring up the editing screen for that grade which will allow you to set the grade, its written feedback and a number of other attributes.

Alternatively, you can choose "Quick grading" and "Quick feedback" in 'My preferences' to make the report appear with editable boxes containing each grade, so you can change many at once. This capability can be a real time saver, but make sure to save at reasonable intervals lest a pageful of changes be lost.

Note: If you make changes here, they are then shown highlighted to indicate grades which have been manually changed.

===Altering the grades using Single View===
There is a new way to enter grades into the grader report using the Single View tab (or listing in the dropdown) under Setup. (This interface can also be accessed by clicking on the pencil icon at the top of the column by the item name).
The single view interface allows you to enter grades in bulk for a specific grade item or a specific user. To change a specific grade or all grades, click on the Override checkbox by the specific grade row or use the Override All link to check every row. If you wish to override all grades with a set grade, check the Bulk Insert checkbox and enter the grade that you wish to insert. You can select whether to fill the grade for just empty grades or for all grades from the dropdown list.
Click on Save and you will now see in the Grader Report that all grades the specific item/user have been overridden with the grade/grades that you entered.

===Hiding columns or individual grades===
Turning on editing then clicking the "Show show/hide icons" link will give you the familiar show/hide eye icon next to each grade and at the top of each column. For more information, read about [[Grade_hiding|grade hiding]].

===Recalculating===
If you change any part of an assessment e.g. alter the maximum grade for one of the questions in a quiz, you may find that the columns do not yet reflect the change you have made. Click '''Turn editing on''' twice to force the gradebook to re-check.

==Gradebook capabilities==

There is just one gradebook capability, [[Capabilities/gradereport/grader:view|View the grader report]], which is allowed for the default roles of manager, teacher and non-editing teacher.

==Extending the gradebook==

The Gradebook can be extended in three main ways:

===1. [https://moodle.org/plugins/browse.php?list=category&id=9 Grade reports]===
Which are the main way to view and manipulate grades
* [[LAEGrader report|LAE Grader Report]] Alternative to Grader report that scrolls vertically and horizontally without losing student columns or grade item header rows. Lot of additional enhancements.
* [https://moodle.org/plugins/view.php?plugin=gradereport_updfgrades Upload PDF Grader Report] lets you view assignment grades, comments and lateness in a report

===2. Grade import plugins===
Which allow data to be imported from external sources

===3. [https://moodle.org/plugins/browse.php?list=category&id=10 Grade export plugins]:===
Which allow you to export grade data for other systems
* [https://moodle.org/plugins/view.php?plugin=gradeexport_pdf PDF document] This is moodle plugin for exporting grades in PDF format. It is developed by using "Moodle PDF library"
* [https://moodle.org/plugins/view.php?plugin=gradeexport_checklist Checklist] This is a grade export plugin which will create an Excel spreadsheet containing all the checkmarks from a single checklist.

==See also==

* Join the discussions about gradebook plugins in the [https://moodle.org/mod/forum/view.php?id=2122 Gradebook forum].

[[de:Bewertungen]]
[[es:Libro de calificaciones]]
[[fr:Carnet de notes]]
[[ja:評定表]]

Reengagement activity

2018-03-13T01:37:46Z

Jprovasnik: /* Email place holders */

{{Infobox plugin
|type = Activity module
|entry = https://moodle.org/plugins/mod_reengagement
|tracker = https://github.com/catalyst/moodle-mod_reengagement/issues
|maintainer = [https://www.catalyst.net.nz Catalyst IT]
|float = right
}}

==About the Reengagement activity==
The Reengagement activity is developed by the Moodle Partner Catalyst IT and provides a way for you to remind students to return to the course and complete activities. You can also use this plugin to selectively release timed content in a course.

==Adding a Reengagement activity==
A Reengagement activity can be added to a course in the same way as any other activity:

# Turn editing on
# Click 'Add an activity or resource'
# Select Re-engagement

===Set Reengagement details===
====Access Restrictions====
The Email delay can be based on the user enrolment date or a previous activity completion. If you want to use the enrolment date then don't set up any access restrictions on this Re-engagement; each user's timer will start after they enrol in the course. If you want the delay to be based on a previous activity completion you should set that activity as an access restriction to this Reengagment activity; each user's timer will start after they complete the dependencies.

==== Email User setting ====
Set "Email User" to "After Delay" and set the "Email delay" period. The e-mail delay is the when the e-mail reminder will be sent based on the previous event (enrolment or activity completion)

==== Target Activity ====
Set "Target Activity" - this is the activity that you want to remind the user they must complete - if this activity is flagged as complete within the course then no e-mail reminder will be sent.

===Timed release===
If you want to release a quiz within your course to individual users after a set period (eg 1 week after assignment completion) you use the "Activity completion" settings within the course.
# set the Reengagement duration to the time period you want eg 1 week
# set access restrictions to the reengagement to allow access after assignment is complete (or no access restrictions means start timer after enrolment)
# set access restrictions to the quiz so that it is available only after the re-engagement is complete.

===Email place holders===
When configuring the e-mails sent from the plugin there are limited place holders you can use. If need to use them properly wrap them with "percentage" (%) symbols. Available substitutions are given below

* %courseshortname%
* %coursefullname%
* %courseid%
* %userfirstname%
* %userlastname%
* %userid%
* %usercity%
* %userinstitution%
* %userdepartment%

Permissions
"receive notification" was removed from the codebase in github (3/2018)
"Start Reengagement" is given to students and controls which users in the course will be listed in the re engagement activity.

Discussion: https://moodle.org/mod/forum/discuss.php?d=337782