MoodleDocs - User contributions [en]

Workplace plugins

2024-11-27T18:36:28Z

Marycooch: removed Workplace ready badge ref

==Compatibility==
Like Moodle LMS, Moodle Workplace can be extended via plugins. While there is a high degree of compatibility between the two systems, special consideration has to be given to contributed plugins from [https://moodle.org/plugins Moodle LMS].
==Plugins and multi-tenancy==
One of the key advancements of Moodle Workplace is the ability to support [[multi-tenancy]]. All Moodle Workplace tools are multi-tenant-aware, and thus, plugins also have to support multi-tenancy to work correctly in Moodle Workplace.

As a rule of thumb, Moodle LMS plugins work in Moodle Workplace if they don't collide with multi-tenancy. For example, activity modules don't support multi-tenancy and should work as-is, whereas authentication plugins have to be adapted since tenants are multi-tenant-aware.
==Extended workplace support (TITLE?)==
Plugins supporting Workplace specific features also require some attention. [[Multi-tenancy authentication#SAML|SAML2]] is a good example since it has been extended to work in a Moodle Workplace fully.

Any theme-related extensions fall into the same category since Moodle Workplace uses a different core theme than Moodle Workplace.

[[Category:Workplace]]

Grade aggregation

2024-08-26T10:33:19Z

Marycooch: include scales in aggregation enabled by default

{{Grades}}
The aggregation dropdown menu lets you choose the aggregation strategy used to calculate the overall grade of a [[Grade categories|grade category]]. The different options are explained below.

Note: if you have only one aggregation type on your menu, 'Natural,' you will need to add others. See the [[Grade aggregation#Available aggregation types menu|Available aggregation types menu]] section below.

== Aggregation strategy ==

All grades are first converted to percentage values (interval from 0 to 1), then aggregated using one of the strategies below and finally converted to the associated category item's range (between Minimum grade and Maximum grade). In the following, we assume that all Minimum grades are equal to 0.

'''Important''': An "empty grade" is a missing gradebook entry and could mean different things. For example, it could be a participant who hasn't yet submitted an assignment, an assignment submission not yet graded by the teacher, or a grade that the gradebook administrator has manually deleted. Caution in interpreting these "empty grades" is thus advised.

== Mean of grades ==
In yields the sum of all grades divided by the total number of grades.
For instance: assume a category A (with a Maximum grade equal to 100) includes three items, A1, A2 and A3 (with maximum grades equal to 100, 80 and 10, respectively); if a student scores A1=70, A2=20 and A3=10, then we have the following grade calculation for A:
A1 -->70/100=0.7, A2 --> 20/80=0.25, A3 -->10/10=1
A: (0.7 + 0.25 + 1.0)/3 = 0.65 --> 65/100 --> 65 (the maximum grade for category A is 100).

== Weighted mean ==
Each grade item can be given a weight to change its importance in the overall mean. In simple terms, the category "total" will be equal to the sum of the scores in each grade item, each multiplied by its grade weight, and that sum is finally divided by the sum of all weights. This is shown in the following example (with the same assumptions as the previous case).
A1: 70 out of 100 weight 10, A2: 20 out of 80 weight 5, A3: 10 out of 10 weight 3, category A: maximum grade 100
A1 -->70/100=0.7, A2 --> 20/80=0.25, A3 -->10/10=1
A: (0.7*10 + 0.25*5 + 1.0*3)/(10 + 5 + 3) = 0.625 --> 62.5/100 --> 62.5 (out of 100)

== Simple weighted mean ==
The difference from the Weighted mean is that the weight of each item is its Maximum grade.
For instance, using the same assumptions of the first case:
A1 --> 70/100, A2 --> 20/80 = 0.25 A3 --> 10/10, category max 100:
A: (0.7*100 + 0.25*80 + 1.0*10)/(100 + 80 + 10) = 0.526 --> 52.6/100 --> 52.6 (out of 100)

When the "Simple weighted mean" aggregation strategy is used, a grade item can act as Extra credit for the category. This means that the grade item's maximum grade will not be added to the category total's maximum grade, but the item's grade will. For example, if A3 is marked as extra credit in the above calculation:
A1 --> 70/100, A2 --> 20/80 = 0.25, A3 (extra credit) 10/10, category max 100:
A: (0.7*100 + 0.25*80 + 1.0*10)/(100 + 80) = 0.556 --> 55.6/100 --> 55.6 (out of 100)

== Mean of grades (with extra credits) ==
Arithmetic mean with a twist. An old, now unsupported, aggregation strategy is provided here only for backward compatibility with old activities.

A value greater than 0 treats a grade item's grades as extra credit during aggregation. The number is a factor by which the grade value will be multiplied before it is added to the sum of all grades, but the item itself will not be counted in the division. For example:

* Item 1 is graded 0–100, and its "Extra credit" value is set to 2
* Item 2 is graded 0–100, and its "Extra credit" value is left at 0
* Item 3 is graded 0–100, and its "Extra credit" value is left at 0
* All three items belong to Category 1, which has "Mean of grades (with extra credits)" as its aggregation strategy
* A student gets graded 20 on Item 1, 40 on Item 2 and 70 on Item 3
* The student's total for Category 1 will be 95/100 since 20*2 + (40 + 70)/2 = 95

== Median of grades ==
The middle value (or the mean of the two middle values) when percentages (the ratios between grades and their maximum values) are arranged in order of value. The advantage over the mean is that it is not affected by outliers (grades which are uncommonly far from the mean).
A1 70/100, A2 20/80, A3 10/10, category max 100:
A: median(0.7, 0.25, 1.0) --> 0.70 --> 70/100

== Lowest grade ==
The result is the smallest grade after [https://en.wikipedia.org/wiki/Normalization_(statistics) normalisation]. It is usually used in combination with Aggregate only non-empty grades.
A1 70/100, A2 20/80, A3 10/10, category max 100:
min(0.7, 0.25, 1.0) = 0.25 --> 25/100

== Highest grade ==
The result is the highest grade after [https://en.wikipedia.org/wiki/Normalization_(statistics) normalisation].
A1: 70/100, A2; 20/80, A3: 10/10, category max 100:
A: max(0.7, 0.25, 1.0) = 1.0 --> 100/100

== Mode of grades ==
The mode is the [https://en.wikipedia.org/wiki/Normalization_(statistics) normalised] grade that occurs the most frequently. It is often used for non-numerical grades. The advantage over the mean is that it is not affected by outliers (grades which are uncommonly far from the mean). However, it loses its meaning once there is more than one most frequently occurring grade (only one is kept) or when all the grades differ.
A1 70/100, A2 35/50, A3 20/80, A4 10/10, A5 7/10 category max 100:
A: mode(0.7, 0.7, 0.25, 1.0, 0.7) = 0.7 --> 70/100

== Natural ==

This is the sum of all grade values, scaled by relative weights. The Maximum grade of the category is the sum of the maximums of all aggregated items.
A1 70/100, A2 20/80, A3 10/10, without forcing weights:
A: (70 + 20 + 10)/(100 + 80 + 10) --> 100/190

'''Note''': Scale grades are included in aggregation by default. The admin can change this from Site administration > Grades > General settings > Include scales in aggregation.

When the "Natural" aggregation strategy is used, a grade item can act as Extra credit for the category. This means that the grade item's maximum grade will not be added to the category total's maximum grade, but the item's grade will. Following is an example:

* Item 1 is graded 0-100
* Item 2 is graded 0-75
* Item 1 has the "Act as extra credit" checkbox ticked; Item 2 doesn't.
* Both items belong to Category 1, which has "Natural" as its aggregation strategy
* Category 1's total will be graded 0-75
* A student gets graded 20 on Item 1 and 70 on Item 2
* The student's total for Category 1 will be 75/75 (20+70 = 90 but Item 1 only acts as extra credit, so it brings the total to its maximum)

Natural aggregation functions as a sum of grades when the weight boxes are left alone. In this situation, the numbers in the weight boxes are informational and represent the effective weights in the sum. Natural aggregation can also function as a mean of grades when the weight boxes are checked and then adjusted so that the weights are equal across a set of items in a category or a set of categories. Items can still be marked as "Extra credit" while using the weights to calculate a mean and contribute to the total for the category.

==Available aggregation types menu==
[[Image:availableaggregationtypes1.png|thumb|Available aggregation types setting]]

By default, the only available aggregation type is 'Natural.'

To choose any of the other types in a course, other aggregation types must be made available in ''Site administration > Grades > Grade category settings > Available aggregation types''.

The default is 'Natural,' but the administrator can specify other types from ''Site administration >administration > Grades > [[Grade category settings]] > Aggregation''. This default can be set to Forced or Advanced.

Note that reducing the number of aggregation types simply results in disabled aggregation types not appearing in the aggregation type dropdown menu. All existing grade category calculations remain the same, regardless of whether an administrator later disables the aggregation type.

[[ca:Agregació de les categories]]
[[fr:Tendance centrale de la catégorie]]
[[es:Agregación de categoría]]
[[de:Bewertungen zusammenfassen]]
[[pt-br:Agregação de Notas]]

Question behaviours

2024-08-25T13:35:39Z

Marycooch: clarifying manual grading

{{Questions}}
==How questions behave==
The following question behaviours are available when [[Quiz settings|creating a quiz]] (also when previewing questions):

;Deferred feedback
:Students must enter an answer to each question and then submit the entire quiz before anything is graded or they get any feedback.
;Adaptive mode and Adaptive mode (no penalties)
:Allows students to have multiple attempts at the question before moving on to the next question. This behaviour requires that the "Whether correct" box is ticked under "During the attempt" in the "Review options" section, at a minimum.
;Manual grading (disabled by default)
:This is disabled by default because of potential confusion when selecting a question behaviour. If it is enabled and you select manual grading here, then learners will not get a result until you have manually graded all their questions. Think very carefully about this!
;Interactive with multiple tries
:Used for allowing multiple attempts on the same question (perhaps with a grade penalty). Students answer the question and click the 'Check' button. If the answer is wrong, the student can click the 'Try again' button to try a new response. Importantly, the question definition must contain hints that will be shown after each incorrect attempt, though the hint text can be as minimal as an HTML non-breaking space. Once the student has got the question right, they can no longer change their response. Once the student has got the question wrong too many times, they are just graded wrong (or partially correct) and get shown the feedback. Unless 'Allow redo within an attempt' was enabled in the '[[Quiz_settings#Question_behaviour|Question behaviour]]' settings of the quiz, they can no longer change their answer. There can be specific feedback after each attempt the student makes, in addition to overall feedback about incorrect or correct answers and answer choices. The number of tries the student gets is the number of hints in the question definition plus one, with a minimum of three.
;Immediate feedback
:Similar to interactive mode in that the student can submit their response immediately during the quiz attempt, and get it graded. However, they can only submit one response, they cannot change it later.
;Deferred feedback or Immediate feedback with Certainty-based marking (CBM)
:With CBM, the student does not only answer the question, but they also indicate how sure they are they got the question right. The grading is adjusted by the choice of certainty so that students have to reflect honestly on their own level of knowledge in order to get the best mark.
;Conditional questions
:If using the Interactive with multiple tries or Immediate Feedback behaviour and with the navigation method set to 'Free', it is possible to make the display of a question dependent on a previous question being answered first.
:The question editing page will display padlock icons to the right of each question.

==Certainty-based marking==
When a student answers a question they also have to state how sure they are of the answer: not very (less than 67%); fairly (more than 67%) or very (more than 80%). Their grading is then adjusted according to how certain they are, which means that for example if they answered correctly but were only guessing, their mark is adjusted from 1 to 0.33. If they answered wrongly but were very sure, their mark is adjusted from 0 to -2.

For detailed information on how CBM works and how students can benefit from it, see [[Using certainty-based marking]].
{|
| [[File:cbm03.png|thumb|correct answer; very sure]]
| [[File:cbm05.png|thumb|correct answer; fairly sure]]
| [[File:cmb04.png|thumb|correct answer; not very sure]]
| [[File:cbm01.png|thumb|wrong answer; very sure]]
| [[File:cbm99.png|thumb|wrong answer; not very sure]]
|}

==Managing question behaviours==

An administrator can manage question behaviours available across the site in ''Administration > Site administration > Plugins > Question behaviours > Manage question behaviours''.

==Deferred feedback with explanation==
[https://moodle.org/plugins/view.php?plugin=qbehaviour_deferredfeedbackexplain Deferred feedback with explanation] is an additional question behaviour, available for Moodle 2.6+, that is just like deferred feedback, but with an additional input box where students can give a reason why they gave the answer they did. No attempt is made to automatically grade the explanation, nor is it required.
* It may be used in various ways, for example:
** The teacher may want to manually edit the grades where the student gave a wrong answer, to give partial credit if the student used the right method or approach.
** The student might want to explain their thinking, so that later when the results and feedback are revealed, they are reminded of what they were thinking at the time, and so can reflect more deeply.
* You can use [[Language customization]] to change the default text string "Explain your reasons" in the file qbehaviour_deferredfeedbackexplain.php to a more specific text such as "Enter justifications below if you want partial credit in numerical problems by showing your steps, ignore otherwise." as described in https://moodle.org/mod/forum/discuss.php?d=275752

==Interactive with explanation==
[[qbehaviour interactiveexplain]] is an additional question behaviour, available for Moodle 3.x, that is based heavily on Tim Hunt's deferred feedback with explanation question behaviour. This behaviour is like the interactive with multiple attempts behaviour, but with an additional text box where students can give a reason why they gave the answer they did. No attempt is made to automatically grade the explanation, nor is it required. The code can be found at https://github.com/marcusgreen/moodle-qbehaviour_interactiveexplain

==See also==

* [http://www.ucl.ac.uk/lapt/ LAPT: UCL home of Certainty-Based Marking]
* [https://moodle.org/mod/forum/discuss.php?d=225920 CBM too harsh?] forum discussion
* [http://school.moodledemo.net/mod/quiz/view.php?id=1496 School demo example of a quiz with CBM] Log into with username "parent" and password "moodle"
* [http://helderenwijzer.nl/2011/10/certainty-based-marking-in-moodle/ Certainty Based Marking in Moodle] blog post by Isabelle Langeveld
* [http://www.open.edu/openlearnworks/mod/oucontent/view.php?id=51788&section=6 Styles of interactive computer marked assessments] from the Open University
*[https://moodle.org/mod/forum/discuss.php?d=313947 This forum thread] about adding an 'all or nothing' behaviour for adaptive and deferred feedback for questions in a quiz.

[[Category:Site administration]]

[[de:Frageverhalten]]
[[es:Comportamientos de preguntas]]
[[fr:Comportements de question]]

File:saveaspublic.png

2024-04-29T07:03:19Z

Marycooch:

File:feedbacktemplate.png

2024-04-29T07:02:59Z

Marycooch:

Using Feedback

2024-04-29T07:02:45Z

Marycooch: /* Template */

{{Feedback}}
This page explains how students and teachers can use the [[Feedback activity]] and explores ways to make the most of it in your Moodle course.

==What the student sees==
*When first clicking on a feedback activity, the student will be presented with an entry page with description and link to the feedback questions:

[[File:Feedbackstudententry.png]]

*Clicking the link takes them to the feedback questions which they complete and then submit by clicking the "Submit your answers" button.

[[File:Studentfeedbackquestions.png]]

*On submitting their responses, they will be directed to a particular URL or a "thankyou" page whose message can be personalised in the [[Feedback settings]]

==What the teacher sees==
===Overview===
*When a feedback survey has been completed the teacher will see, via the Overview tab, the number of students who have responded so far:

[[File:Teachertabs.png]]

===Edit questions===

The Edit Questions tab will allow them to tweak their questions.

===Template===
* Feeeback questions can be saved as a template from the Edit questions button

[[File:feedbacktemplate.png]]

**An administrator(or other user with system permissions) can then save a template as "public" to allow it to be reused in different courses. A regular editing teacher does not have this capability. See [[Template creator]] for how to allow teachers the ability to save templates as "public"

[[File:saveaspublic.png]]

*The Template tab shows any available templates which have been created. See [[Feedback templates]] for more detailed information.

===Analysis===

This screen shows a graphical summary of the results of each question:

[[File:Analysis.png]]

===Show responses===
This screen allows for the teacher to see and then delete individual responses if required, and download table data in various [[Data formats|formats]].

===Show non-respondents===

Unless the responses are set to anonymous, there will also be a "Show non-respondents" tab where the Teacher or Feedback activity administrator can select some or all users who have not yet completed the feedback and send them a reminder message.

Note: users may be able to control when or how they receive this message, depending on the configuration of Messaging Outputs on your particular site. See [https://docs.moodle.org/402/en/Messaging_settings#List_of_message_types here for details].

[[File:feeback-non-respondents-25.png]]

==Why use Feedback?==
Apart from the obvious use here of evaluating a course, feedback surveys have a variety of uses, both within a course and for non-logged in users on the front page. The ability to set them as "anonymous" means also that sensitive issues can be surveyed without students worrying who might see their responses. Some ideas:

====Guest surveys====
Anonymously, on the front page, non-logged in users such as parents can be questioned on their opinions about, e.g., the website design, school policies, school meals.

To set up a guest survey, you need to enable some settings at site level, see '''How can I allow non-logged in users to give feedback?''' in [[Feedback FAQ]]

====Sign up!====
Guests can be invited to sign up for events/courses via the feedback module.

====Contact us====
Non-logged in users can use an instance of the feedback module as a "contact us" form.

====Anti-bullying surveys====
Students can be asked to highlight anonymously any incidences of bullying, along with their location and type.
====Making choices====
Students can select course modules or subjects they wish to study in a subsequent year/semester. The results can be exported and easily collated to match availability.
====Use of Moodle!====
Staff can be surveyed on which Moodle modules they use/would like more training in
====IT Skills audit====
Staff - or students - can be surveyed to discover their IT skills and weaknesses to highlight training needs.

== See also ==
*[https://school.moodledemo.net/mod/feedback/view.php?id=53 Example of feedback on a school's performance from School demo site] (Log in with username:parent/password:moodle)
*[https://school.moodledemo.net/mod/feedback/analysis.php?id=53&courseid=&do_show=analysis Example of analysis of feedback on a school's performance from School demo site] (Log in with username:teacher/password:moodle)

[[de:Feedback nutzen]]
[[es:Usando retroalimentación]]

BigBlueButton

2024-04-25T13:25:16Z

Marycooch: /* What is the BigBlueButton activity? */

{{Activities}}

==What is the BigBlueButton activity?==
BigBlueButton lets you create from within Moodle links to real-time on-line classrooms using BigBlueButton, an open source web conferencing system for distance education. You can specify conference times, which are then added to the calendar, and, if allowed in your installation, the sessions may be recorded for viewing later.

<p class="note">Note: For data protection reasons, BigBlueButton is disabled by default. Administrators must enable it from Site administration > Plugins > Manage activities and then check the box to accept the data processing agreement. From 22 April 2024 they must also register on the BBB portal from the Settings page.</p>

''
Free Tier Hosting is currently restricted as follows:
# The maximum length for each session is 60 minutes;
# The maximum number of concurrent users per session is 25;
# Recordings expire after seven (7) days and are not downloadable; and
# Viewers' (student) webcams are only visible to the moderator.

==How is it set up?==

{{MediaPlayer | url = https://youtu.be/fHJqq_pjUPc | desc = How to set up and use BigBlueButton}}
*In a course, with Edit mode enabled, choose, BigBlueButton from the activity chooser.
*Choose a name and description, and, if desired, a welcome message which will appear in the Chat box when participants join the session.
*If you tick "wait for moderator", students can only join once someone with the moderator role has entered the room.
*From the Participants list you can, if needed, give specific roles to specific people, such as a moderator role.

If enabled by the administrator from ''Site administration > Plugins >Activity modules> BigBlueButton> Experimental settings'', a new section, Guest access, becomes available to course teachers.

'''Note: Guest access to a BBB session is not possible if your site forces users to log in (ie, if 'forcelogin' is enabled).'''

*From Guest access, you can check the box to allow external users without accounts to join the room. When the box is checked, a meeting link and password become available.
[[File:BBBguestlink.png|center]]
*In the Schedule section you can set a start time and also a time after which student will not be able to enter the room.

==How does it work?==
*Once set up, the activity appears with a link to join when the time is correct. (Before then, or if a moderator is required first. a message appears saying the conference has not yet started.)
[[File:bbb-room.png|alt=]]
*On entering the room, a message will appear asking if you want to use your microphone or just listen. If you choose microphone you will need to check your settings.
*The moderator can choose whether to allow participants to use webcams and microphones or not.
*The central area can display presentations, polls, screensharing or an interactive whiteboard.
*There is also a chat option with public and private chat.
[[File:bbb24 test-moodle.png|center|frameless|600x600px]]

==Admin settings==
From Site administration > Plugins > BigBlueButton, administrators can set the defaults for BBB sessions and recordings in courses.
{{New features}}
* From ''BigBlueButton > Extended capabilities'', admins can control whether or not participant profile photos are shown in sessions.
* From ''BigBlueButton > Recordings'', admins can specify which recording formats (such as presentations) may be viewed by everyone, and which (such as statistics) are restricted to those with the capability [[Capabilities/mod/bigbluebuttonbn:viewallrecordingformats| mod/bigbluebuttonbn:viewallrecordingformats.]]

[[Category:BigBlueButton]]
[[es:BigBlueButton]]
[[de:BigBlueButton]]

Migrations

2024-04-09T11:11:22Z

Marycooch: copied from 4.1 docs

{{Workplace}}
Moodle Workplace provides a powerful '''Migration''' tool that lets you copy data and elements between tenants and sites. It also lets you import and export data from external systems.
== Overview ==
The migration tool can export various parts of your Moodle Workplace instance and import them into the same site or different sites.
The following diagram shows a high-level migration overview, visualising the typical workflows of exporting and importing Moodle Workplace data:
[[File:Migration - Overview.png|border|center|frameless|900x900px|link=Special:FilePath/Migration_-_Overview.png]]
The [[Migrations#Migration Export|export process]] contains the following key steps:
# [[Migrations#Step 1 - General settings|Selecting the exporter]]: Initiating the respective wizard of the selected exporter
# [[Migrations#Step 2 - Options|Export options]]: This step covers two parts, namely '''content''' (what data must be exported) and '''instances''' (which elements should be exported)
# [[Migrations#Step 3 - Review|Review and export]]: Executing/scheduling the actual export and creating the export file
The [[Migrations#Migration Import|import process]] contains the following steps:
# [[Migrations#Step 1 - Select source|Selecting a source]]: Choosing the import file you will be dealing with.
# [[Migrations#Step 2 - General settings|Selecting a tenant]]: Choosing the tenant where the data must be imported to.
# [[Migrations#Step 3 - Options|Import options]]: This step covers two parts: '''content''' (what data must be imported) and '''instances''' (which elements should be imported).
# [[Migrations#Step 4 - Conflicts|Conflict resolution]]: If the import file contains any inconsistencies, manual intervention is required.
# [[Migrations#Step 5 - Review|Review and importing]]: Executing/scheduling the actual import.
Migration exporters and importers can be chained together – that way, import and export workflows can be created. For example, the tenant exporter makes use of all other exporters through internal cascading.

Third-party plugins are fully supported, if the activity supports Moodle's backup and restore mechanism.
== Migration Export ==
You can access the migration tool via '''Site administration > Migration''' or directly via the '''Migration''' icon in the Workplace launcher. On the '''Exports''' tab, you will see a list of any exports, which contains the following columns:
* '''Date''' (filter): Date and time the export was created
* '''First name / Surname''': User account that initiated the export
*'''Tenant name''' (filter): Name of the tenant that the export was created for
* '''Exporter''' (filter): Type of exporter
* '''Status''' (filter): Scheduled / In progress / Success / Error
*'''Size''': Size of the export file
* '''Actions''':
**'''New import from this file''': Use the export file as input and start the migration importer. This will take you directly to [[Migrations#Step 2 - General settings|Step 2]] of the import process.
**'''Download''': Download the export file
**'''View export''': Show a status report that includes a status or error log
**'''Delete''': Remove the export file
[[File:Migration - Exports.png|border|center|frameless|900x900px|alt=]]
To create a new migration export, select the '''+ Export''' button on the '''Exports''' tab. You will then be guided through the 3-step export process.
=== Step 1 - General settings ===
The first step of the migration process is to choose an exporter.
[[File:Migration - Export Step 1.png|border|center|frameless|900x900px|alt=]]
Some exporters offer a '''Site / Current tenant''' switch, which allows you to define whether you want to export entities from the whole site, or only those associated with the current tenant.
{| class="wikitable"
|'''Exporter'''
|'''Site / Current tenant switch'''
| colspan="2" |'''Description'''
|-
|'''Certificates'''
|Yes
| colspan="2" |Issued certificates and templates
|-
|'''Certifications'''
|No
| colspan="2" |Certifications with their associated programs, courses, user allocations and component dynamic rules
|-
|'''Cohorts'''
|Yes
| colspan="2" |Cohorts, including cohort members without user data
|-
|'''Course categories'''
|Yes
| colspan="2" |Course categories and subcategories
|-
|'''Courses'''
|Yes
| colspan="2" |Courses without user data, using [https://docs.moodle.org/401/en/Course_backup#General_backup_defaults default course backup configuration] (see details below table)
|-
|'''Custom reports'''
|No
| colspan="2" |Custom reports, including audience and schedule data
|-
|'''Custom reports from outdated version'''
|No
| colspan="2" |Custom reports, including audience and schedule data from Moodle Workplace version 3.x
|-
|'''Dynamic rules'''
|No
| colspan="2" |Dynamic rules definition, conditions and actions
|-
|'''Organisation structure frameworks'''
|No
| colspan="2" |Frameworks with the whole hierarchy for departments and/or positions
|-
|'''Organisation structure jobs'''
|No
| colspan="2" |Jobs with their associated department and position frameworks
|-
|'''Programs'''
|No
| colspan="2" |Programs with their courses, user allocations and component dynamic rules
|-
|'''Site'''
|No
| colspan="2" |Full site content including all tenants along with all entities contained within them. Course backups will include all content and user data except logs.
|-
|'''Tenants'''
|Yes
| colspan="2" |Tenants along with all entities contained within them
|-
|'''Users'''
|Yes
| colspan="2" |Site and tenant users
|}
When courses are included in the export, the following default course backup configuration settings are taken into account:
* Include filters
* Include groups and groupings

When all course content is exported, for example, when exporting the entire site or a tenant, the following default course backup configuration settings are also taken into account:
* Include users
* Include role assignments
* Include activities and resources
* Include blocks
* Include comments
* Include badges
* Include calendar events
* Include user completion information
* Include histories
* Include question bank
* Include competencies
* Include content bank content
=== Step 2 - Options ===
During the second step, you can narrow down your selection and specify which elements you want to export. The exporter options always contain the following two elements (except when exporting the entire site):
* '''Content''': Which attributes and settings may or may not be included in the export file.
* '''Instances''': Which elements will be included in the export file.
The content and instances available depend on the chosen exporter. Details about each setting are displayed in the balloon help indicated by a question mark.
[[File:Migration - Export Step 2.png|border|center|frameless|900x900px|alt=]]
The table below lists all '''Content''' and '''Instances''' settings (l''ocked entries in italics'') for each exporter plugin.
{| class="wikitable"
|'''Exporter'''
|'''Content'''
| colspan="2" |'''Instances'''
|-
|'''Certificates'''
|''Certificate template details''
Issued certificates
| colspan="2" |Select all certificate templates
Select categories and subcategories manually…

Select certificate templates manually...
|-
|'''Certifications'''
|''Settings''
Associated programs

Course structure

Include course content

Certification user allocations

Dynamic rules
| colspan="2" |Select all active certifications
Select active and archived certifications

Select manually…

Include shared entities
|-
|'''Cohorts'''
|''Cohort details''
Cohort members
| colspan="2" |All cohorts
All system cohorts

Select categories and subcategories manually...

Select manually...
|-
|'''Course categories'''
|''Course category details''
Course structure

Include course content

Certificate templates

Cohort details including members
| colspan="2" |Select categories
|-
|'''Courses'''
|''Course structure''
Include course content
| colspan="2" |Select categories and subcategories manually…
Select courses manually...
|-
|'''Custom reports'''
|''Report definitions''
Audiences

Schedules
| colspan="2" |Export all custom reports
Export specific custom reports...
|-
|'''Custom reports from outdated version'''
|''Report definitions''
Audiences

Schedules
| colspan="2" |Export all custom reports
Export specific custom reports...
|-
|'''Dynamic rules'''
|''Rule definitions, conditions and actions''
| colspan="2" |Select all Dynamic rules (excluding archived)
Select all enabled Dynamic rules

Select all Dynamic rules (including archived)
|-
|'''Organisation structure frameworks'''
|''Descriptions, hierarchy and permissions''
| colspan="2" |Select all department and position frameworks
Select all department frameworks

Select all position frameworks

Select manually...

Include shared entities
|-
|'''Organisation structure jobs'''
|''Job assignments''
Department and position frameworks
| colspan="2" |Select all active jobs
Select all active and past jobs

Select all jobs in any of the selected frameworks...
|-
|'''Programs'''
|''Settings''
Course structure

Include course content

Program user allocations

Dynamic rules
| colspan="2" |Select all active programs
Select all active and archived programs

Select manually...

Include shared entities
|-
|'''Site'''
|''Details''
''Appearance''

''Users''

''Content: courses, categories, programs and certifications''

Cohort details including members

Certificate templates

Organisation structure

Dynamic rules

Custom reports
| colspan="2" |
|-
|'''Tenants'''
|''Details''
Appearance

Users

Course categories, with cohorts and course structure

Include course content

Certificate templates

Programs

Certifications

Organisation structure

Dynamic rules

Custom reports
| colspan="2" |Select all tenants (excluding archived)
Select all tenants (including archived)

Select tenants manually...
|-
|'''Users'''
|''User profiles''
User pictures

Include suspended users
| colspan="2" |Select all users
Select users manually...
|}
=== Step 3 - Review ===
During the third and final step, you need to review and execute the export process. You will be presented with a summary of the selected and unselected options for content and instances.
The export can only be started when the resulting file will be non-empty; that is, at least one instance has been selected. For instance, if you choose a course category that does not contain any courses, the Export button will remain deactivated. Finally, you have to confirm the execution of the export.
[[File:Migration - Export Step 3.png|border|center|frameless|900x900px|alt=]]
Once the export has been initiated, its status will be set to '''Scheduled'''. The export will commence on the subsequent [[Cron|cron]] execution. While the export file is being generated, the status will be changed to '''In progress'''. This might take some time on larger exports. When the export file is ready for download or import, the status changes again to '''Success'''. You will also receive a notification via the usual on-board mechanism. If an '''Error''' occurred during the export process, details would be displayed on the status page.
== Migration Import ==
You can access the migration tool via '''Site administration > Migration''' or directly via the '''Migration''' icon in the Workplace launcher.

On the '''Imports''' tab, you will see a list of any imports which contains the following columns:
* '''Date''' (filter): Date and time the import was created
* '''First name / Surname''': User account that initiated the import
*'''Tenant name''' (filter): Name of the tenant that the import was created for
*'''Importer''' (filter): Type of importer
*'''Status''' (filter): Scheduled / In progress / Success / Error
*'''Size''': Size of the import file
*'''Actions''':
**'''Download''': Download the import file
** '''View import''': Show a status report that includes a status or error log
** '''Delete''': Remove the import file
[[File:Migration - Imports.png|border|center|frameless|900x900px|alt=]]
To create a new migration export, select the '''+ Import''' button on the '''Imports''' tab. You will then be guided through the 5-step import process.
=== Step 1 - Select source ===
In step 1, you must provide an input file: You will need to upload either a migration export file or a CSV file.
[[File:Migration - Import Step 1.png|border|center|frameless|900x900px|alt=]]
By default, the importer automatically detects what export type has been used before proceeding to step 2. In addition to the '''Detect automatically''' option, you can also select the '''File format''', choosing between '''Workplace format''' and '''CSV'''. When the latter is used, make sure the '''CSV delimiter''' and '''Encoding''' settings are correct. The CSV import format only supports departments and positions.
=== Step 2 - General settings ===
The second step differs depending on what type of import file you have uploaded.
==== Step 2a - General settings (Importing a file in Workplace format) ====
The following two sections are available when importing a file in Workplace format:
* '''About this file''': Metadata about the file and its content is displayed
* '''Destination''': Select the tenant the file has to be imported to. You can either opt for the current tenant or select a tenant from your site. This section is not available when you wish to import a tenant import file. For some import files, the option '''Available for all tenants''' is offered; that is, it will be imported into Shared space.
[[File:Migration - Import Step 2a.png|border|center|frameless|900x900px|alt=]]
==== Step 2b - General settings (Importing a file in CSV format) ====
The following three sections are available when importing a file in CSV format:
* '''About this file''': A preview of the first three rows is displayed, along with an option to show additional records.
* '''Select importer''': Moodle Workplace supports a '''Departments importer''' and a '''Positions importer'''. The formats of those files will be shown in [[Migrations#Step 3b - Options (Importing a file in CSV format)|Step 3b - Options]].
* '''Destination''': Select the tenant the file has to be imported to. You can either opt for the current tenant or select a tenant from your site.
[[File:Migration - Import Step 2b.png|border|center|frameless|900x900px|alt=]]
=== Step 3 - Options ===
During the third step, you can narrow down your selection and specify which elements you want to import.
==== Step 3a - Options (Importing a file in Workplace format) ====
When importing a file in Workplace format, the importer options always contains at least the following two elements (except when importing tenants or the entire site):
* '''Content''': Which attributes and settings may or may not be included when importing the file.
* '''Instances''': Which elements will be included when importing the file.
The content and instances available depend on the chosen importer. Details about each setting are displayed in the balloon help indicated by a question mark.
[[File:Migration - Import Step 3a.png|border|center|frameless|900x900px|alt=]]
The table below lists all '''Content''' and '''Instances''' settings (''locked entries in italics'') for each importer plugin.
{| class="wikitable"
|'''Importer'''
|'''Content'''
| colspan="2" |'''Instances'''
|-
|'''Certificates'''
|Certificate template details
Issued certificates
| colspan="2" |Select all certificate templates in this file
Select certificate templates manually…

Course category…
|-
|'''Certifications'''
|Settings
Associated programs

Course backups excluding user data

Select course category...

Certification user allocations (if available)

Dynamic rules
| colspan="2" |Select all certifications in this file
Select manually...
|-
|'''Cohorts'''
|Cohort details
Cohort members
| colspan="2" |Select all cohorts in this file
Select manually...

Import all in system context

Import all in the selected category...
|-
|'''Course categories'''
|Course category details
Course backups excluding user data

Certificate templates (if available)

Cohort details including members (if available)
| colspan="2" |Select all course categories in this file
Select categories and subcategories manually…

Parent category...
|-
|'''Courses'''
|Course backups excluding user data
| colspan="2" |Select all courses in this file
Select courses manually…

Course category...
|-
|'''Custom reports'''
|Report definitions
Audiences

Schedules
| colspan="2" |Import all custom reports
Import specific custom reports...
|-
|'''Custom reports from outdated version'''
|Report definitions
Audiences

Schedules
| colspan="2" |Import all custom reports
Import specific custom reports...
|-
|'''Dynamic rules'''
|Rule definitions, conditions and actions
| colspan="2" |Select all Dynamic rules in this file
Select manually...
|-
|'''Organisation structure frameworks'''
|Descriptions, hierarchy and permissions
| colspan="2" |Select all department and position frameworks
Select all department frameworks

Select all position frameworks

Select manually...
|-
|'''Organisation structure jobs'''
|Job assignments
Department and position frameworks
| colspan="2" |Select all jobs in this file
Select all jobs from specific frameworks...
|-
|'''Programs'''
|Settings
Course backups excluding user data

Course category...

Dynamic rules
| colspan="2" |Select all the programs in this file
Select manually...
|-
|'''Site'''
|Details
Appearance

Users

Content: courses, categories, programs and certifications

Cohort details including members

Certificate templates

Organisation structure

Dynamic rules

Custom reports
| colspan="2" |
|-
|'''Tenants'''
|Details
Appearance

Users

Course categories, with cohorts and course structure

Certificate templates

Programs

Certifications

Organisation structure

Dynamic rules

Custom reports
| colspan="2" |Merge into existing tenant...
Create new tenants

Select all tenants

Select tenants manually...
|-
|'''Users'''
|User profiles
User pictures
| colspan="2" |Select all users
Select users manually...
|}
==== Step 3b - Options (Importing a file in CSV format) ====
The following three sections exist when you're importing either departments or positions via CSV files:
* '''Position/Department framework''': Either create a new (generic) framework where a name will be provided automatically (Import <name of import file>) or select an existing framework.
* '''Hierarchy''': Positions and departments can either be arranged hierarchically or as a list. If the organisation structure is hierarchical, a position identifier must be provided, which will be used to identify the parent.
* '''Departments field mapping''': The departments import file contains the following fields:
{| class="wikitable"
|+
!Field name
!Description
|-
|'''path'''
|Department hierarchy identifier using backslashes as separators
|-
|'''idnumber'''
|ID number of the department
|-
|'''parent'''
|ID number of the parent. The mapping for this field cannot be the same as the position identifier provided in the hierarchy section.
|-
|'''name'''
|Department name
|-
|'''description'''
|Textual description of the department
|-
|'''descriptionformat'''
|1 = Moodle auto format (default), 2 = Plain text format, 3 = HTML format, 4 = Markdown format
|}
'''Positions field mapping''': The positions import file contains the following fields:
{| class="wikitable"
!Field name
!Description
|-
|'''path'''
|Position hierarchy identifier using backslashes as separators
|-
|'''idnumber'''
|ID number of the position
|-
|'''parent'''
|ID number of the parent. The mapping for this field cannot be the same as the position identifier provided in the hierarchy section.
|-
|'''name'''
|Position name
|-
|'''description'''
|Textual description of the position
|-
|'''descriptionformat'''
|1 = Moodle auto format (default), 2 = Plain text format, 3 = HTML format, 4 = Markdown format
|-
|'''ismanager'''
|Toggle whether the manager role permissions are all available (1) or not (0)
|-
|'''managerpermissions'''
|Manager permissions, either in human-readable format or using 0-7 notation:
* allocate = 1 (Permission to allocate managed users to programs and certifications)
* reports = 2 (Permission to view reports on managed users)
* notifications = 4 (Permission to receive notifications on managed users)
* all = 7 (default if the field ''managerpermissions'' is missing from the CSV file)
* "" = 0
|-
|'''isdepartmentlead'''
|Toggle whether the department lead role permissions are all available (1) or not (0)
|-
|'''departmentleadpermissions'''
|Department lead permissions, either in human-readable format or using 0-7 notation:
* allocate = 1 (Permission to allocate managed users to programs and certifications)
* reports = 2 (Permission to view reports on managed users)
* notifications = 4 (Permission to receive notifications on managed users)
* all = 7 (default if the field ''departmentleadpermissions'' is missing from the CSV file)
* "" = 0
|}
The following CSV positions files utilizes most of the supported field names, and the resulting position hierarchy:
[[File:Migration - Sample CSV Import.png|border|center|frameless|900x900px]]

When the import file does not follow the notation laid out here, you have the option to select CSV columns manually.[[File:Migration - Import Step 3b.png|border|center|frameless|900x900px|alt=]]
Sample departments import file:<syntaxhighlight lang="text">
idnumber,parent,name,description
SAL,,Sales,Sales department
SAD,SAL,Sales development,Sales development department
CSC,SAL,Customer Success,Customer Success department
EDI,,Editorial,Editorial department
AND,EDI,Art and design,Art and design department
PRO,EDI,Production,Production department
RNE,EDI,Research and Education,Research and Education department
MED,RNE,Medical advising,Medical advising department
MHR,RNE,Mental Health research,Mental Health research department
ONR,RNE,Oncology research,Oncology research department
MKT,,"Marketing, Promotion and Advertising","Marketing, Promotion and Advertising department"
PUB,MKT,Publicity,Publicity department
MH,MKT,Mental Health,Mental Health department
ONC,MKT,Oncology,Oncology department
IT,,Information and Technology,Information and Technology department
SUP,IT,ICT Support,ICT Support department
ASP,IT,Applications support,Applications support department
ADE,IT,Applications development,Applications development department
INF,IT,Infraestructure,Infraestructure department
HR,,Human Resources,Human Resources department
LND,HR,Learning and Development,Learning and Development department
ADM,,Administration,Administration department
LNC,ADM,Legal and Contracts,Legal and Contracts department
SRI,LNC,Subsidiary Rights,Subsidiary Rights department
FNA,ADM,Finance and Accounting,Finance and Accounting department
</syntaxhighlight>Sample positions import file:<syntaxhighlight lang="text">
idnumber,parent,name,description,ismanager
CEO,,Chief Executive Officer,Chief Executive Officer position,1
COO,CEO,Chief Operating Officer,Chief Operating Officer position,1
HMD,COO,Head of Marketing and Design,Head of Marketing and Design position,1
DES,HMD,Designer,Designer position,0
MCO,HMD,Marketing Consultant,Marketing Consultant position,0
OM,COO,Office Manager,Office Manager position,0
PM,COO,Project Manager,Project Manager position,1
EDI,PM,Editor,Editor position,0
MEW,PM,Medical Writer,Medical Writer position,0
CTO,CEO,Chief Technology Officer,Chief Technology Officer position,1
LDE,CTO,Lead Developer,Lead Developer position,1
DEV,LDE,Developer,Developer position,0
LDO,CTO,Lead DevOps,Lead DevOps position,1
DEO,LDO,DevOps,DevOps position,0
SA,CTO,Sysadmin,Sysadmin position,1
OPE,SA,Operator,Operator position,0
CFO,CEO,Chief Financial Officer,Chief Financial Officer position,1
AC,CFO,Accountant,Accountant position,0
DPO,CFO,Data Privacy Officer,Data Privacy Officer position,0
LEA,CFO,Legal advisor,Legal advisor position,0
HHR,CFO,HR Manager,HR Manager position,1
ODA,HHR,Organisational Development advisor,Organisational Development advisor position,0
CCO,CEO,Chief Commercial Officer,Chief Commercial Officer position,1
AMG,CCO,Account Manager,Account Manager position,0
SAR,CCO,Sales Representative,Sales Representative position,0
</syntaxhighlight>

=== Step 4 - Conflicts ===
If the import file contains any inconsistencies that the migration tool cannot resolve automatically, the conflict resolution screen will be shown, and action must be taken.
[[File:Migration - Import Step 4.png|border|center|frameless|900x900px|alt=]]
Typical conflicts are that a record already exists (for instance, the username or an organisation ID) or an associated user account does not exist. Depending on the conflict, two types of resolution mechanisms are offered: either a solution is provided, or the record has to be skipped.
=== Step 5 - Review ===
During the fifth and final step, you need to review and execute the import process. You will be presented with a summary of the content that will be imported.
[[File:Migration - Import Step 5.png|border|center|frameless|900x900px|alt=]]
Once the import has been initiated, its status will be set to '''Scheduled'''. The import will commence on the subsequent [[Cron|cron]] execution. While the import is being processed, the status will be changed to '''In progress'''. This might take some time on larger imports. When the import is completed, the status changes again to '''Success'''. You will also receive a notification via the usual on-board mechanism. If an '''Error''' occurred during the import process, details would be displayed on the status page.
== Command-line interface ==
The following commands will allow you to perform export and import from CLI:

<code>php admin/tool/wp/cli/export.php</code>

<code>php admin/tool/wp/cli/import.php</code>

Use the <code>--help</code> parameter to display all the available options, alongside a short description of each parameter. Exporter and importer-specific parameters are passed as JSON-encoded strings.

The two migration CLIs support interactive and non-interactive modes.

During '''interactive mode''', you will be asked various questions, such as the program name to be exported, and you have to confirm actions, such as the usage of default values. This is particularly useful during one-off operations and when testing new processes.

In '''non-interactive mode''', no questions are asked, no confirmations are needed, and default values are used. It is intended for usage in scripts to automate regular processes fully.

When run in interactive mode, the non-interactive counterpart, that is, the valid command will be displayed. That way, you can create your command step by step and, once completed, use it in your shell scripts.

[[File:workplace_migration_cli.mov|600px]]

BigBlueButtonBN

2024-03-08T11:53:17Z

Marycooch: redirecting

#Redirect [[BigBlueButton]]

Quiz submission email notification

2024-02-17T13:56:14Z

Marycooch: /* Quiz submission notifications */

{{Quiz}}
==Quiz submission notifications==
It is possible for a message to be sent out to confirm that the student submitted the quiz.

There are two types of notification:
#A confirmation to the student that their attempt has finished successfully
#A notification to the teacher(s) that someone has submitted an attempt. Messages are never sent for preview attempts.

Note that although the capabilities are "emailnotifysubmission/emailconfirmsubmission" the notifications do NOT have to be via email. The notifications come via Moodle's messaging system. Admins can set the defaults from ''Administration > Site administration > Plugins > Message outputs > Default message outputs'' to enable/disabe the desired notification type(s)
[[File:quiz submission notification.png|center]]

See [[Messaging settings]] for more details. (Notification messages in Moodle quiz are disabled by default.)

==Allow Quiz notification messages to teachers==

To do this for an individual quiz, click into the quiz, click More and then and Permissions (Boost theme) or for other themes, click Permissions from the Quiz administration block.

This may also be done on the site level by the administrator in ''Administration > Site administration > Users > Permissions > Define roles > Teacher''

#In the filter, type "email" to locate the capability "mod/quiz:emailnotifysubmission"
#Click on the + for "Roles with permission"
#On the next screen, select Teacher and click "Allow"

[[File:QuizEmailNotifySub.png]]
===Messages in a specific quiz to specific teacher(s)===
The system administrator will need to create a new role, and allow the capability ''mod/quiz:emailnotifysubmission'' for that role. Do not give the capability to the teacher role on the system or course level. The new role is similar to a teacher role and should be available on the activity level.

In the course, go to ''Quiz settings > More > Locally assigned roles'', assign the user(s) who should get emails/messages for a submitted quiz to the new role.

==Allow confirmation messages to students==
To do this for an individual quiz, go to: ''Quiz settings > More > Permissions''

This may also be done on the site level by the administrator in ''Administration > Site administration > Users > Permissions > Define roles > Student''

#In the Capability column under ''Activity: Quiz'' find the capability ''mod/quiz:emailconfirmsubmission''
#Click on the +
#On the next screen, select Student and click "Allow"

==Notes==
:Note that if the quiz is set to separate groups, then teachers will only get a notification if either
* the student is in the same group as the teacher, or
* the teacher has moodle/site:accessallgroups.

==How to configure the text of the messages==
''Administration > Site administration > Language > Language customization''

This can only be done by a user that has permission to alter the language files. To reconfigure the way the email reads, you will need to understand string variables and how they work as part of another string. While not complicated, this will require attention to detail. This section assumes you also have read [[Language customization]].

The subject and body of the emails are defined in the quiz.php language file that are in the "mod" group. The strings to edit are 'emailconfirmsubject', 'emailconfirmbody', 'emailnotifysubject' and 'emailnotifybody'. The $a string passed in when these language strings are loaded contains all the following information:

===The emailconfirmbody string===
<nowiki> Dear {$a->username}, Thank you for submitting your answers to '{$a->quizname}' in course '{$a->coursename}' at {$a->submissiontime}. This message confirms that we have safely received your answers. You can access this quiz at {$a->quizurl}.</nowiki>

===The emailnotifybody string===
<nowiki>Dear {$a->username}, {$a->studentname} has completed the quiz '{$a->quizname}' ({$a->quizurl}) in course '{$a->coursename}' You can review this attempt at {$a->quizreviewurl}.</nowiki>

=== The emailnotifysmall===
<nowiki>{$a->studentname} has completed {$a->quizname}</nowiki>

===The emailnotifysubject string===
<nowiki>Quiz submission confirmation: {$a->quizname}</nowiki>

===Potential strings to use in an email===
;$a->coursename
:The name of the course
;$a->courseshortname
:The shortname of the course
;$a->quizname
:The name of the quiz
;$a->quizreporturl
:The URL of the results overview for this quiz (.../mod/quiz/report.php?q=''quizid'')
;$a->quizreportlink
:The URL of the results overview URL and quiz name as a HTML link
;$a->quizreviewurl
:The URL of the review page for this attempt (.../mod/quiz/review.php?attempt=''attemptid'')
;$a->quizreviewlink
:The attempt review URL and quiz name as a HTML link
;$a->quizurl
:The URL of the main page of the quiz (.../mod/quiz/view.php?q=''quizid'')
;$a->quizlink
:The URL of the quiz and the quiz name as a HTML link
;$a->attemptsubmissiontime
:The time the attempt was submitted, formatted using userdate().
;$a->timetaken
:How long the quiz attempt lasted.
;$a->studentname
:The name of the person who submitted the quiz.
;$a->studentidnumber
:The idnumber of the person who submitted the quiz.
;$a->studentusername
:The username of the person who submitted the quiz.
;$a->username
:The name of the user the email is being sent to.
;$a->useridnumber
:The idnumber of the user the email is being sent to.
;$a->userusername
:The username of the user the email is being sent to.

[[ja:解答送信の通知メール]]
[[de:E-Mail-Benachrichtigung bei Testabgabe]]
[[es:Notificación Email sobre envío de examen]]

File:quiz submission notification.png

2024-02-17T13:56:03Z

Marycooch:

Quiz submission email notification

2024-02-17T13:55:53Z

Marycooch: updated

Debugging

2024-02-07T21:00:10Z

Marycooch: removed email debugging

{{Developer tools}}
==Using debugging messages==
Debugging messages are intended to help diagnose problems and/or help Moodle developers. If you have a problem with your Moodle site and ask for help in a Moodle.org forum, a developer may ask you to turn enable debugging i.e. turn debugging messages on, in order to locate the cause of the problem. If you are having problems such as a blank screen or incomplete screens, then turning on debugging is usually the first thing to try.
==Enabling debugging==
To enable debugging, go to ''Site administration > Development > Debugging'' .
===Debug messages===
The options are:
* NONE: Do not show any errors or warnings (Default)
* MINIMAL: Show only fatal errors
* NORMAL: Show warnings, errors and notices
* ALL: Show all reasonable PHP debug messages
* DEVELOPER: extra Moodle debug messages for developers
Notes:
# It is recommended that a record of error messages is kept, and for the admin to regularly monitor the error logs. This may be done by setting 'Debug messages' (debug) to Normal and leaving 'Display debug messages' (debugdisplay) off (unticked). Error messages are then recorded in the server logs.
# If 'Debug messages' is set to Developer on a production (public) site, it is recommended to copy and paste the debugging message obtained and then turn off Developer debugging. This is because debugging messages can give clues to a hacker as to the set-up of your site.
===Display debug messages===
If you select this checkbox, the debug messages are displayed directly in the browser, otherwise they are stored in the server logs.
==== Tools for debugging outgoing mail (SMTP) ====
You can use the config.php file to turn on more "tools" which will assist you with debugging the outgoing emails (and SMTP server configuration):
* Redirect all outgoing emails to a specific address:
<syntaxhighlight lang="php">
// Divert all outgoing emails to this address to test and debug emailing features
// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
</syntaxhighlight>
* Turn on the CRON debugging and run CLI cron.php script.
<syntaxhighlight lang="php">
// Force developer level debug and add debug info to the output of cron
// $CFG->showcrondebugging = true;
</syntaxhighlight>
And then use SSH (or putty.exe, on windows) to run:
<syntaxhighlight lang="php">
you@moodle-server(/var/www/html/moodle)# php admin/cli/cron.php
</syntaxhighlight>
* Turn on verbose SMTP debugging and output it into system's error_log (code hack):
As [https://moodle.org/mod/forum/discuss.php?d=316222#p1289850 suggested] on Moodle's discussion forums:
Open [https://github.com/moodle/moodle/blob/master/lib/moodlelib.php#L5379 lib/moodlelib.php L5379] and change it to:
<syntaxhighlight lang="php">
if (!empty($CFG->debugsmtp)) {
$mailer->SMTPDebug = 1; // 0 - no debug ... 4 - low level full debug
$mailer->Debugoutput = "error_log";
}
</syntaxhighlight>
See more info about [https://github.com/moodle/moodle/blob/master/lib/phpmailer/class.phpmailer.php#L314 SMTPDebug] parameters & [https://github.com/moodle/moodle/blob/master/lib/phpmailer/class.phpmailer.php#L328 Debugoutput] parameters,
Set-up mailcatcher (https://mailcatcher.me/).
===Performance info===
The Performance info option determines whether performance info will be included in the footer of the standard theme (and some other themes). Performance info includes the time for the page to load, the amount of memory used to generate the page, cpu usage, load, and the record cache hit/miss ration.

If you add
<syntaxhighlight lang="php">
define('MDL_PERF', true);
define('MDL_PERFDB', true);
define('MDL_PERFTOLOG', true);
define('MDL_PERFTOFOOT', true);
</syntaxhighlight>
to your config.php file, then it will also count database queries. (This has to be in config.php, because Moodle starts doing DB queries before it loads the config information in the database!)

To hide performance info from ordinary users, see the discussion [https://moodle.org/mod/forum/discuss.php?d=358032 Performance info only for admins?]
===Show origin of languages strings===
Helps with [[:dev:Translation|translation]] and also with [[Language customization]]. Sometimes <code>?strings=1</code> should be added; other times <code>&strings=1</code>. See the Wikipedia article [http://en.wikipedia.org/wiki/Query_string Query string] for details.
=== Show origin of SQL calls ===
If you turn this on, then for every bit of SQL send to the Database server, an SQL comment is added with all or part of the PHP stack trace. That means that if something happens which causes the query to be logged by the database (e.g. and error, or a slow query) you can find where in Moodle that query came from.
===Show validator links===
Be careful, read the warning.
===Show page information===
To show page information printed in the page footer.
===Show template information===
{{New features}}To shown templates used for rendering as comments in the page HTML.
Example of how the templates are shown in the page HTML source:<syntaxhighlight lang="html">

<i class="icon fa fa-window-close fa-fw " aria-hidden="true"></i>

</syntaxhighlight>It is important to note the added comments can interfere with some scripts.

===Debug SQL queries===
You can add (turn ON) any of the following dboptions in your config.php files, which log different types of SQL queries into mdl_log_queries table:
* '''logall''' - log all queries - suitable only for developers, causes high server loads and NOT recommended for production.
* '''logslow''' - log queries that take longer than specified number of seconds (float values are accepted).
* '''logerrors''' - log all error queries.
Full sample:
<syntaxhighlight lang="php">
$CFG->dboptions = array (
//'logall' => true,
'logslow' => 5,
'logerrors' => true,
);
</syntaxhighlight>However, if you are in control of your Database server, your database probably has an option to log slow database queries in the database logs, and that is probably a techncially better solution, if it is available to you.
==What to do if you cannot get to the admin screens==
If the error is stopping you even getting to the admin screens to turn on debugging, then you can set the debugging setting manually.
===Try typing the URL directly===
The debug settings are at the URL <code><nowiki>http://.../admin/settings.php?section=debugging</nowiki></code> on your server. Sometimes that URL will work, even though the pages you need to go to get there (for example the site front page) do not. So it is worth trying to enter that URL directly.
===In config.php===
In [[Configuration file|config.php]] you can uncomment lines (delete the // at the start of the line) under Section 7 to enable debugging for all or just specific users:
<syntaxhighlight lang="php">
//=========================================================================
// 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
//=========================================================================
//
// Force a debugging mode regardless the settings in the site administration
// @error_reporting(E_ALL | E_STRICT); // NOT FOR PRODUCTION SERVERS!
// @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
// $CFG->debug = (E_ALL | E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!
// $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!
//
// You can specify a comma separated list of user ids that that always see
// debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
// for these users only.
// $CFG->debugusers = '2';
</syntaxhighlight>
Remember to comment those lines again (reinsert the // at the start of the line) when you have finished diagnosing your problem.

'''NOTE 1''': do not try to modify the config database table directly, it will not work because the values are cached in MUC.

'''NOTE 2''': if you find your config.php does not have the above settings (you have a cut down approx 30 lines config.php) look for a "config-dist.php" file that contains the full details. I would suggest transferring your details in the current config.php file you have into the full config file and renaming that one to "config.php".
==See also==
* If you are a developer looking for usage information on the <tt>debugging()</tt> statement, try lib/weblib.php for documentation on how it is used, and lib/setuplib.php for definitions of which PHP error levels the <tt>DEBUG_*</tt> flags map to.
* Developers can also use [http://xdebug.org/ XDEBUG] (Installed as a module on the Apache server) to further dig into the code, step by step using an [http://xdebug.org/docs/remote XDEBUG client application]. Probably, as part of their favorite IDE. For example: [http://php.netbeans.org/ NetBeans], [http://www.jetbrains.com/phpstorm/ phpStorm] or...

[[es:Depuración]]
[[fr:Débogage]]
[[de:Debugging]]

Capabilities/enrol/manual:unenrolself

2024-02-02T11:21:29Z

Marycooch:

{{Capabilities}}
*This allows a user to manually unenrol themselves from a course in which they were previously manually enrolled via ''Course navigation > More > Unenrol me from this 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:unenrolself

2024-02-02T11:20:38Z

Marycooch: nav

{{Capabilities}}
*This allows a user to manually unenrol themselves from a course in which they were previously manually enrolled via ''Course navigation > More > Unenrol me from this course''
*This capability adds an "Unenrol 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]]

Multitopic course format

2024-01-28T11:17:58Z

Marycooch: new docs link

{{Infobox plugin
|type = Course format
|entry = N/A
|tracker = https://github.com/james-cnz/moodle-format_multitopic/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=394619
|maintainer = [[User:James Calder|James Calder]]
|float = right
}}

Information about this plugin can be found in the [https://github.com/james-cnz/moodle-format_multitopic/wiki Multitopic course format documentation.]

VPAT

2024-01-18T17:13:38Z

Marycooch: /* Legal disclaimer */

= Moodle accessibility conformance report =
WCAG Edition

(Based on VPAT® Version 2.4)
{| class="wikitable"
|<small>'''Name of product/version'''</small>
|<small>'''Moodle 4.0'''</small>
|-
|<small>'''Report date'''</small>
|<small>May 2023</small>
|-
|<small>'''Product description'''</small>
|<small>The world’s most customisable and trusted open-source learning management system</small>
|-
|<small>'''Contact information'''</small>
|<small>support@moodle.com</small>
|}
== Revision history ==
{| class="wikitable"
|<small>'''Revision'''</small>
|<small>'''Date'''</small>
|<small>'''Remarks'''</small>
|-
|<small>4.0-v0.1</small>
|<small>2023-05-10</small>
|<small>Initial issue of this accessibility conformance report for Moodle 4.0</small>
|}
== Notes ==
This accessibility conformance report is based on an audit of Moodle version 4.0. The audit was completed by Web Key IT in May 2022. In May 2023, Moodle 4.0 received the WCAG 2.1 Level AA accreditation.
== Evaluation methods used ==
This conformance report is based on the results of an accessibility audit conducted by Web Key IT on a sample of 20 key pages. These pages were selected and agreed on by Moodle and Web Key IT as representative of the overall accessibility and functionality of the Moodle learning management system (LMS).

The evaluation was completed following the [http://www.w3.org/TR/WCAG-EM/ WCAG Evaluation Methodology (WCAG-EM)].

The pages were audited manually and cross-checked using a team of website evaluators to ensure that the results and comments presented are valid and comprehensive. Separate and external testing of these pages has been conducted by a group of trained testers, all with disabilities.

The following tools and applications were used as part of the audit:
* Desktop browsers
** Google Chrome
** Firefox
* Screen reader
** JAWS
** NVDA
* Other tools
** NU HTML Validator
== Applicable standards and guidelines ==
This report covers the degree of conformance for the following accessibility standards/guidelines:
{| class="wikitable"
|'''Standard/Guideline'''
|'''Included In Report'''
|-
|[http://www.w3.org/TR/2008/REC-WCAG20-20081211 Web Content Accessibility Guidelines 2.0]
|Level A (Yes )
Level AA (Yes)

Level AAA (Yes)
|-
|[https://www.w3.org/TR/WCAG21 Web Content Accessibility Guidelines 2.1]
|Level A (Yes)
Level AA (Yes)

Level AAA (Yes)
|}
== Terms ==
The terms used in the Conformance Level information are defined as follows:
* '''Supports''': The functionality of the product has at least one method that meets the criterion without known defects or meets with equivalent facilitation.
* '''Partially Supports''': Some functionality of the product does not meet the criterion.
* '''Does Not Support''': The majority of product functionality does not meet the criterion.
* '''Not Applicable''': The criterion is not relevant to the product.
* '''Not Evaluated''': The product has not been evaluated against the criterion. This can be used only in WCAG 2.0 Level AAA.
== WCAG 2.1 report ==
=== Table 1: Success criteria, Level A ===
Notes:
{| class="wikitable"
| colspan="2" |'''Criteria'''
| colspan="2" |'''Conformance Level'''
| colspan="2" |'''Remarks and Explanations'''
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#text-equiv-all 1.1.1 Non-text Content]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-av-only-alt 1.2.1 Audio-only and Video-only (Prerecorded)]
| colspan="2" |Supports
| colspan="2" |Moodle does not natively have audio and video content but it provides options for content creators to upload video/audio content with captions and subtitles.
Video/audio transcripts can also be provided by content creators.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-captions 1.2.2 Captions (Prerecorded)]
| colspan="2" |Supports
| colspan="2" |Moodle provides options for content creators to attach captions to uploaded audio and video content.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-audio-desc 1.2.3 Audio Description or Media Alternative (Prerecorded)]
| colspan="2" |Not applicable
| colspan="2" |Content creators can upload audio and video content with audio descriptions or media alternatives.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#content-structure-separation-programmatic 1.3.1 Info and Relationships]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#content-structure-separation-sequence 1.3.2 Meaningful Sequence]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#content-structure-separation-understanding 1.3.3 Sensory Characteristics]
| colspan="2" |Partially supports
| colspan="2" |Moodle does not solely rely on sensory characteristics.
However, it has question types that require users to drag and drop answers to questions in a quiz.

A disclaimer is provided to warn quiz creators that drag and drop question types are not accessible for visually impaired users.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-without-color 1.4.1 Use of Color]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-dis-audio 1.4.2 Audio Control]
| colspan="2" |Supports
| colspan="2" |User-uploaded audio and video content are set not auto-play by default although content creators have the option to enable or disable automatic playback of audio and video content.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#keyboard-operation-keyboard-operable 2.1.1 Keyboard]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#keyboard-operation-trapping 2.1.2 No Keyboard Trap]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#character-key-shortcuts 2.1.4 Character Key Shortcuts] (2.1 only)
| colspan="2" |Supports
| colspan="2" |Moodle’s rich text editor supports keyboard shortcuts. These shortcuts are only active when the user is in the editing area.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#time-limits-required-behaviors 2.2.1 Timing Adjustable]
| colspan="2" |Supports
| colspan="2" |When a user’s session is about to expire, a warning dialogue is being displayed to the user which allows them to extend their session.
There’s no limit as to how many times they can extend their session.

By default, the warning dialogue will be displayed 20 minutes before the session expires.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#time-limits-pause 2.2.2 Pause, Stop, Hide]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not natively contain moving, blinking, and scrolling content.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#seizure-does-not-violate 2.3.1 Three Flashes or Below Threshold]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-skip 2.4.1 Bypass Blocks]
| colspan="2" |Supports
| colspan="2" |Skip links are supported in all main browsers, with the exception of Internet Explorer.
With Microsoft ending its support for Internet Explorer, Moodle has ceased support for this browser from Moodle 3.10 onwards.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-title 2.4.2 Page Titled]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-focus-order 2.4.3 Focus Order]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-refs 2.4.4 Link Purpose (In Context)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#pointer-gestures 2.5.1 Pointer Gestures] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#pointer-cancellation 2.5.2 Pointer Cancellation] (2.1 only)
| colspan="2" |Supports
| colspan="2" |Pointer cancellation is supported in all main browsers with the exception of Internet Explorer.
With Microsoft ending its support for Internet Explorer, Moodle has ceased support for this browser from Moodle 3.10 onwards.
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#label-in-name 2.5.3 Label in Name] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#motion-actuation 2.5.4 Motion Actuation] (2.1 only)
| colspan="2" |Not applicable
| colspan="2" |Moodle does not have built-in features that offer functionalities that are operated by device or user motion.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-doc-lang-id 3.1.1 Language of Page]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#consistent-behavior-receive-focus 3.2.1 On Focus]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#consistent-behavior-unpredictable-change 3.2.2 On Input]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#minimize-error-identified 3.3.1 Error Identification]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#minimize-error-cues 3.3.2 Labels or Instructions]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#ensure-compat-parses 4.1.1 Parsing]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#ensure-compat-rsv 4.1.2 Name, Role, Value]
| colspan="2" |Supports
| colspan="2" |
|}
=== Table 2: Success criteria, Level AA ===
Notes:
{| class="wikitable"
| colspan="2" |'''Criteria'''
| colspan="2" |'''Conformance Level'''
| colspan="2" |'''Remarks and Explanations'''
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-real-time-captions 1.2.4 Captions (Live)]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not contain synchronised media with live audio content.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-audio-desc-only 1.2.5 Audio Description (Prerecorded)]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not natively have audio and video content but content creators can upload audio and video content with audio descriptions or media alternatives to these content.
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#orientation 1.3.4 Orientation] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#identify-input-purpose 1.3.5 Identify Input Purpose] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast 1.4.3 Contrast (Minimum)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-scale 1.4.4 Resize text]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-text-presentation 1.4.5 Images of Text]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#reflow 1.4.10 Reflow] (2.1 only)
| colspan="2" |Supports
| colspan="2" |Reflow is supported in all main browsers with the exception of Internet Explorer.
With Microsoft ending its support for Internet Explorer, Moodle has ceased support for this browser from Moodle 3.10 onwards.
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#non-text-contrast 1.4.11 Non-text Contrast] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#text-spacing 1.4.12 Text Spacing] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus 1.4.13 Content on Hover or Focus] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-mult-loc 2.4.5 Multiple Ways]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-descriptive 2.4.6 Headings and Labels]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-focus-visible 2.4.7 Focus Visible]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-other-lang-id 3.1.2 Language of Parts]
| colspan="2" |Supports
| colspan="2" |The language selector menu options have the <code>lang</code> attribute to convey to assistive technologies the language the menu options belong to.

For user-generated content, it is up to the content creator to ensure that their content meets this success criterion.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#consistent-behavior-consistent-locations 3.2.3 Consistent Navigation]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#consistent-behavior-consistent-functionality 3.2.4 Consistent Identification]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#minimize-error-suggestions 3.3.3 Error Suggestion]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG20/#minimize-error-reversible 3.3.4 Error Prevention (Legal, Financial, Data)]
| colspan="2" |Supports
| colspan="2" |Moodle provides various mechanisms to prevent errors from happening. e.g. a review page before submitting a quiz, a confirmation dialogue before deleting a user or before user un-enrolment, etc.
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#status-messages 4.1.3 Status Messages] (2.1 only)
| colspan="2" |Supports
| colspan="2" |
|}
=== Table 3: Success criteria, Level AAA ===
Notes:
{| class="wikitable"
| colspan="2" |'''Criteria'''
| colspan="2" |'''Conformance Level'''
| colspan="2" |'''Remarks and Explanations'''
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-sign 1.2.6 Sign Language (Prerecorded)]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not natively have audio and video content but content creators can upload prerecorded video content with sign language.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-extended-ad 1.2.7 Extended Audio Description (Prerecorded)]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not natively have audio and video content but content creators can upload prerecorded multimedia content with extended audio descriptions.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-text-doc 1.2.8 Media Alternative (Prerecorded)]
| colspan="2" |Not applicable
| colspan="2" |Moodle does not natively have audio and video content but content creators can provide media alternatives for their prerecorded multimedia content.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#media-equiv-live-audio-only 1.2.9 Audio-only (Live)]
| colspan="2" |Not applicable
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#identify-purpose 1.3.6 Identify Purpose (2.1 only)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast7 1.4.6 Contrast (Enhanced)]
| colspan="2" |Partially supports
| colspan="2" |Text colours in Moodle usually have a contrast ratio greater than 7:1 against their background.
There are some texts with colours that meet the minimum contrast ratio of 4.5:1 for WCAG 2.1 Level AA but do not meet the enhanced colour contrast requirement of 7:1 for WCAG 2.1 Level AAA.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-noaudio 1.4.7 Low or No Background Audio]
| colspan="2" |Not applicable
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-visual-presentation 1.4.8 Visual Presentation]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#visual-audio-contrast-text-images 1.4.9 Images of Text (No Exception)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#keyboard-operation-all-funcs 2.1.3 Keyboard (No Exception)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#time-limits-no-exceptions 2.2.3 No Timing]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#time-limits-postponed 2.2.4 Interruptions]
| colspan="2" |Not applicable
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#time-limits-server-timeout 2.2.5 Re-authenticating]
| colspan="2" |Partially supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#timeouts 2.2.6 Timeouts (2.1 only)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#seizure-three-times 2.3.2 Three Flashes]
| colspan="2" |Not applicable
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#animation-from-interactions 2.3.3 Animation from Interactions (2.1 only)]
| colspan="2" |Not applicable
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-location 2.4.8 Location]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-link 2.4.9 Link Purpose (Link Only)]
| colspan="2" |Partially supports
| colspan="2" |Most links are uniquely identifiable by the link text only. However, some known areas where the link purpose cannot be determined by the link text only are:
* Edit, delete, reply links in a list of posts within a forum discussion
* The letter links for filtering a list of users by first name or surname do not make sense out of context.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#navigation-mechanisms-headings 2.4.10 Section Headings]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#target-size 2.5.5 Target Size (2.1 only)]
| colspan="2" |Partially supports
| colspan="2" |Button icons do not have the recommended target size of at least 44 x 44 pixels.
|-
| colspan="2" |[https://www.w3.org/TR/WCAG21/#concurrent-input-mechanisms 2.5.6 Concurrent Input Mechanisms (2.1 only)]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-idioms 3.1.3 Unusual Words]
| colspan="2" |Not evaluated
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-located 3.1.4 Abbreviations]
| colspan="2" |Partially supports
| colspan="2" |Abbreviations in Moodle’s language strings such as KB, MB, PDF, Doc, etc., are not enclosed in <nowiki><abbr> tags nor auto-linked to a dictionary definition. </nowiki>
However, there is a mechanism that can enable auto-linking of user-generated content to a glossary.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-supplements 3.1.5 Reading Level]
| colspan="2" |Supports
| colspan="2" |Moodle’s language strings in its user interface are aimed to be descriptive and concise.
It also has several language packs that can be downloaded and installed for sites that have children as the primary users.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#meaning-pronunciation 3.1.6 Pronunciation]
| colspan="2" |Not evaluated
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#consistent-behavior-no-extreme-changes-context 3.2.5 Change on Request]
| colspan="2" |Supports
| colspan="2" |
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#minimize-error-context-help 3.3.5 Help]
| colspan="2" |Partially supports
| colspan="2" |Context-sensitive help is provided for input elements in forms where the label may not be sufficient to explain the purpose of the input element.
|-
| colspan="2" |[http://www.w3.org/TR/WCAG20/#minimize-error-reversible-all 3.3.6 Error Prevention (All)]
| colspan="2" |Supports
| colspan="2" |Form validation mechanisms are provided to allow users to correct their inputs when completing a form.
Confirmation dialogues or pages are also present to prevent users from accidentally performing an irreversible action (e.g. data deletion, etc).
|}
== Legal disclaimer ==
The information herein is provided in good faith based on Moodle 4.0 at the time of the accessibility audit and does not represent a legally binding claim. Please [https://moodle.com/contact/ contact Moodle Pty Ltd] to report any accessibility errors or conformance claim errors for re-evaluation and correction, if necessary.
[[Category:About Moodle]]

Rubrics

2024-01-12T12:39:49Z

Marycooch: /* How teachers access the rubric */

{{Advanced grading methods}}
==About rubrics==
'''Rubrics''' are an [[Advanced grading methods|advanced grading method]] used for criteria-based assessment. The rubric consists of a set of criteria plotted against levels of achievement. A numeric grade is assigned to each level. For each criterion, the assessor chooses the level they judge the work to have reached. The raw rubric score is calculated as a sum of all criteria grades. The final grade is calculated by comparing the actual score with the worst/best possible score that could be received.

==Enable a rubric in your assignment==
There are two ways.

The first is at the point of setting up the Assignment.
#In your assignment's Settings, expand the '''Grade''' section.
#From the '''Grading method''' menu, choose Rubric.
#Note the '''Maximum grade''' setting - whatever numeric grade you assign to your criteria levels, the ultimate grade for the assignment will be recalculated as the proportion of that maximum grade.
#Save the settings; Rubric is now enabled for that particular Assignment.

The other is via the Assignment's '''Settings''' block:
#From the Assignment's summary page, in its Settings block, click '''Advanced grading'''; a new page displays a menu.
#From the '''Change active grading method to''' menu, choose '''Rubric'''; this initiates the rubric setup process.

==Define your rubric==

[[image:gradingfrom-rubric-editor.png|thumb|right|A rubric]]
To define a new rubric from scratch:
#Go to the '''Rubric editor''' via the '''Advanced grading''' link in the assignment's '''Settings''' block.
#Click '''Define a new rubric from scratch'''.
#Type in a brief distinctive '''Name''' and (if needed) a description.
#'''Click to edit a criterion''' and '''Click to edit level''' lets you tab through the rubric to type a description and assign points to each level.
#Describe further criteria and levels as appropriate.
#Set '''Rubric options'''.
#Finally save the rubric definition by clicking '''Save rubric and make it ready''' or '''Save as draft'''. These set the form definition status respectively as described at the [[Advanced grading methods]] page.

Notes:
*Unless there is a good reason otherwise, enable '''Allow users to preview rubric''' so that they know in advance the standards by which they will be judged. Enabling '''Remarks''' allows assessors to make constructive suggestions for each criterion.
*Numeric points are required, but if you want to use your rubric to give feedback without a numeric grade it is possible to hide these from students, and hide the final calculated grade from students.
*You can enter negative points, for example as a late submission penalty.
*You can modify the weight of any criterion by setting the value of the points assigned to its levels. If there is one criterion with levels 0, 1, 2, 3 and the second one with levels 0, 2, 4, 6 then the latter's impact on the final grade is twice as much as the former's.
*You can use the Tab key to jump to the next level/criteria and even to add new criteria.
* In Moodle 3.2 onwards, a new rubric option 'Calculate grade based on the rubric having a minimum score of 0' allows you to choose whether the grade is calculated as in previous versions of Moodle (box unticked) or whether an improved calculation method is used (box ticked). Please see below for details of the calculation.

== Grading submissions with a rubric==

[[image:gradingfrom-rubric-usage.png|thumb|right|Filling in the rubric to assess an assignment submission]]

#To access the submissions, click a link to the Assignment; its summary page displays.
#Click '''Grade'''; the Student Grading Page displays the work of the first student listed in the Grading Table.
#The rubric you have set up will display as a table on one side of the screen - you can display it larger by clicking its Expand / arrowheads icon (to dock the rubric, click the icon again).
#For each criterion, select a level by clicking in its cell; when selected the level displays shaded (default pale green).
#If enabled on the rubric form, you can type in comments for each criterion.
#Save changes.

Notes:
*As well as the rubric you can add summary '''Feedback comments''' for the work, and optionally '''Feedback files'''.
*A level must be selected for each criterion, otherwise the rubric is not validated by the server as the final grade can't be calculated.
*If the rubric filling is re-edited later, the previously selected level displays temporarily shaded (default: pink).
*Students may need to be instructed to scroll down to find the completed rubric and any other comments - the example rubric continues to display at the top of their assignment '''Submission status''' page.

== Grade calculation ==

The rubric normalized score (ie basically a percentage grade) is calculated as

: <math>G_s = \frac{\sum_{i=1}^N (g_i - min_i) }{\sum_{i=1}^N (max_i - min_i)}</math>
: where <math>g_i \in \mathbb{N}</math> is the number of points given to the i-th criterion, <math>min_i \in \mathbb{N}</math> is the minimal possible number of points for of the i-th criterion, <math>max_i \in \mathbb{N}</math> is the maximal possible number of points for the i-th criterion and <math>N \in \mathbb{N} </math> is the number of criteria in the rubric.

Example of a single criterion can be: ''Overall quality of the paper'' with the levels ''5 - An excellent paper'', ''3 - A mediocre paper'', ''0 - A weak paper'' (the number represent the number of points).

''Example:'' let us have an assessment form with two criteria, which both have four levels 1, 2, 3, 4. The teacher chooses level with 2 points for the first criterion and 3 points for the second criterion. Then the normalized score is:

: <math>G_s = \frac{(2 - 1) + (3 - 1)}{(4 - 1) + (4 - 1)} = \frac{3}{6} = 50 %</math>

Note that this calculation may be different from how you intuitively use rubric. For example, when the teacher in the previous example chose both levels with 1 point, the plain sum would be 2 points. But that is actually the lowest possible score so it maps to the grade 0 in Moodle.

==How students access the rubric==

{|
|[[image:rubricbeforesubmission.png|thumb|How students view a rubric]]
|}

Assuming 'Allow users to preview rubric' is ticked (recommended), when students click on an assignment which has a rubric attached to it, they will see the rubric as part of the information about their assignment. Thus, they can see the rubric before they submit.

==How teachers access the rubric==
Teachers will see the rubric when they click 'View/grade all submissions' and access the work of a particular student. They don't by default see the rubric on the grading page before grading. If you wish to allow teachers to see the rubric, then the site administrator must set the capability [[Capabilities/mod/assign:viewownsubmissionsummary|mod/assign:viewownsubmissionsummary]] to 'Allow' for the editing teacher role in that assignment (or sitewide if really necessary).

==FAQ==
===Where do you go to edit a rubric?===
To edit a rubric go to
''Administration > Assignment Administration > Advanced grading > Define Rubric''.
Select 'Rubric' from Change active grading method to drop down menu.
You can see your created rubric with three options above Edit the current form definition, Delete the currently defined form, Publish the form as a new template. Click "Edit the current form definition" to edit your predefined rubric form.
===Can you copy rows of the rubric?===

A 'duplicate' button allows you to quickly make a copy of a row:

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

===How do you choose another rubric for an assignment?===
From ''Administration>Assignment administration>Advanced grading'' access your rubric and delete it. The see #5 in [[Advanced grading methods]]

===Why are total grades coming out strange?===

If you are using a criterion without a 0-points level or with a level with negative points, then the rubric option 'When converting rubric score to points/scale assume that minimum number of points is 0' (new in 3.2) should be ticked to avoid unexpected grades.

==See also==

* [[Advanced grading methods]] page for general concepts of advanced grading in Moodle
* [https://school.moodledemo.net/grade/grading/form/rubric/preview.php?areaid=33 School demo example of student view of rubric] (Log in as username '''student'''/password '''moodle''')
* [https://school.moodledemo.net/mod/assign/view.php?id=205&rownum=1&action=grade School demo example of teacher view of rubric in student assignment] (Log in as username '''teacher'''/password '''moodle''')
* [http://en.wikipedia.org/wiki/Rubric_(academic) Rubric description] at Wikipedia
* http://rubistar.4teachers.org/ - a free tool to help teachers create quality rubrics
* [https://digiteacher.wordpress.com/2014/11/20/my-teacher-is-a-zombie-marking-by-rubric-on-moodle/ My Teacher is a Zombie – Marking by Rubric on Moodle] Using an electronic rubric frees up the time to ...

[[fr:Grille d'évaluation]]
[[de:Rubriken]]
[[es:Rúbricas]]

File resource settings

2024-01-12T12:25:56Z

Marycooch: /* Appearance */

{{File}}
This page explores in more detail the settings for the File resource once you have added it to your course and also covers the Site administration settings.
==Adding files to your course==

There are two ways to add files to your course:
* Dragging and dropping. You will know if drag and drop is available to you because you will (briefly) see a message at the top of your screen when the editing is turned on.

[[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.
* From the Activity chooser > File. (See [[File resource]].

==General==
Give the file a name and a description if required, checking the box if you want the description to display on the course page.
*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.
*If you see a box with an arrow, you can drag and drop a file straight from your desktop into Moodle.
[[File:31File.png|thumb|center|400px|Settings for uploading a file]]
==Appearance==
;Display:
* ''Automatic'' - let Moodle decide the best option for you.
* ''Embed'' - show the file as part of the Moodle page (images, PDFs, videos)
* ''Force download'' - force the user to save the file or open it in a program on their computer.
* ''Open'' - show the file in the browser, but without the Moodle page decorations (images, PDFs, videos)
* ''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.

Other options are visible if the admin has enabled them in the site settings:

* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizable 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.
;Show size or type
:This might be useful for learners with poor bandwidth who need to download your content.
;Show upload/modified date
:This might be useful if you are regularly updating content.
:Display resource description
:If enabled, this setting will display any content from the description box above the file.
;Use filters on file content
: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.

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

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

==Extracting or unzipping 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, and optionally images, CSS style sheet files and JavaScript files.
{|
| [[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 resource 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]]

Page FAQ

2024-01-09T11:01:14Z

Marycooch: removed out of date info

{{Page}}
==I've finished my page but it won't let me save it. Why not?==

The most common reason for this is that you added all your content to the description and not the page itself - go back and look in the Page content section and make sure you have content there :)

==How do I make my page open in a pop-up?==

An administrator can enable page resources to open in a pop-up by selecting the display option 'In pop-up' in ''Administration > Site administration > Plugins > Activity modules > Page''.

==How do I enter text and media in the description and content areas?==

Use the [[Text_editor|Text Editor]] to add text, images, video, audio and more to a page.

==How do I search within a page resource?==

There is no internal search facility, though you can always use your web browser's search capability.

[[Category:FAQ]]

[[es:Página FAQ]]
[[de:Textseite FAQ]]

MediaWiki:MoodleDocsVersionLinks

2023-12-13T16:27:14Z

Marycooch:

4.2 docs: /402/en/{{FULLPAGENAMEE}}
4.3 docs: /403/en/{{FULLPAGENAMEE}}
4.1 docs: /401/en/{{FULLPAGENAMEE}}

Administration via command line

2023-12-05T17:37:40Z

Marycooch: /* Ad hoc tasks */

{{Installing Moodle}}
{{Update}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins may provide CLI functionality via scripts in their own <code>cli</code> folder.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or www-data or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:
$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params
Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:
$ sudo -u apache /usr/bin/php admin/cli/install.php --help
{{Note|These scripts are supposed to be run under the identity of the web server user. Examples on this page use the <tt>apache</tt> user for illustration. The particular value depends on your OS distribution and local set-up. Typical values may be <tt>apache</tt>, <tt>www-data</tt> or <tt>httpd</tt>.}}
== Upgrading ==
Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:
$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable
== Installation ==
There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.
$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs
If your arguments contain some specials characters for Linux-based systems, don't forget to ''escape'' them with a backslash. For example, if you want to create an admin with ''pa$sword'' as password you should wrote ''pa\$sword'' instead!

If required, the database install may be skipped, with just config.php populated.
$ sudo -u apache /usr/bin/php admin/cli/install.php --skip-database
== Maintenance mode ==
To switch your site into the maintenance mode via CLI, you can use
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
To turn maintenance mode off, execute the same script with the --disable parameter:
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable
If you don't want to enable maintenance mode immediately, but show a countdown to your users, execute the same script with the --enablelater parameter and the number of minutes which the countdown should run:
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enablelater=10
This script will also create and remove the climaintenance.html file for "Offline" mode.
== Offline mode ==
In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.
$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html
You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.
== Custom site defaults ==
During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like
<syntaxhighlight lang="php">
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</syntaxhighlight>
These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.
== Reset user password ==
If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.
$ sudo -u apache /usr/bin/php admin/cli/reset_password.php
==Converting InnoDB to Barracuda==
Newer versions of MySQL and MariaDB have an improved file format called Barracuda. To take advantage of this:
# Ensure your version of MySQL/MariaDB is using Barracuda with the large index key prefix (innodb_large_prefix). See below for details.
# Change to the compressed row format (see [[#Changing_tables_to_compressed_row_format|Changing tables to compressed row format]])
# Change the character set and collation for full Unicode support (see [[#Converting_character_set_and_collation|Converting character set and collation]]).

If you have MySQL 8.0.0 or later, or MariaDB 10.3.0 or later, then these versions only support Barracuda with the large index key prefix. For earlier versions to check if MySQL/MariaDB is using Barracuda run the following statement in the MySQL/MariaDB client or phpMyAdmin SQL tab:
SHOW GLOBAL VARIABLES WHERE variable_name IN ('innodb_file_format', 'innodb_large_prefix', 'innodb_file_per_table');
If your settings do not match any of the tables below, see [[MySQL#Configure_full_UTF-8_support|Configure full UTF-8 support]] for how to change these settings:

[[File:phpMyAdmin1.png|alt=innodb_file_format=Barracuda;innodb_file_per_table=ON;innodb_large_prefix=ON]] or [[File:phpMyAdmin2.png|alt=innodb_file_format=(blank);innodb_file_per_table=ON;innodb_large_prefix=(blank)]] or [[File:phpMyAdmin3.png|alt=innodb_file_per_table=ON]]

If your settings match one of these tables then MySQL/MariaDB is using Barracuda with the large index key prefix.
===Changing tables to compressed row format===
This script changes tables with many text columns to use ROW_FORMAT=COMPRESSED. This change isn’t required but is recommended. If the database error ''Row size too large (> 8126)'' occurs when using Moodle then run this script to fix this.

'''Note:''' If you have MariaDB version 10.6.0 to 10.6.6 or version 10.7.0 to 10.7.2 you must upgrade to a later version before running this script. See MDL-72131 for details.

To view tables requiring conversion, use the --list option:
$ php admin/cli/mysql_compressed_rows.php --list
Here is an example output:
mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)
To proceed with the conversion, run the command using the fix option:
$ php admin/cli/mysql_compressed_rows.php --fix
Successful table conversion will be reported in the output, for example:
mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed
If you get errors due to having insufficient privileges to run these commands use --showsql to generate the required SQL commands:
$ php admin/cli/mysql_compressed_rows.php --showsql
You can then copy the generated SQL into your MySQL/MariaDB client running as the 'root' user.
===Converting character set and collation===
This script changes the Moodle database tables to enable full Unicode support.
$ php admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci
After making this change edit config.php and change the 'dbcollation' to 'utf8mb4_unicode_ci' in the $CFG->dboptions array.

For further details see: [[MySQL_full_unicode_support|MySQL full unicode support]]
== Running cron via command line ==
In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.
== Scheduled tasks ==
Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/cli/scheduled_task.php script.

This script accepts the following arguments:
--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

--showsql - Shows sql queries before they are execute

--showdebugging - Shows developer debugging info
'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:
<pre>php admin/cli/scheduled_task.php --list</pre>
will return something like:
<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>
To run the first task in that list, you would execute
php admin/cli/scheduled_task.php --execute='\enrol_imsenterprise\task\cron_task'
Be aware of the single quotes. Without them, you would need to use double backlashes to avoid escaping by the shell.
=== Ad hoc tasks ===
[[Cron#Low_latency_adhoc_tasks|Ad hoc tasks]] are low-latency tasks that are normally run by the cron. You can run just the queued ad hoc tasks with admin/cli/adhoc_task.php.

This script accepts the following options and arguments:
<pre>
-h, --help Print out this help
--showsql Show sql queries before they are executed
--showdebugging Show developer level debugging information
-e, --execute Run all queued adhoc tasks
-k, --keep-alive=N Keep this script alive for N seconds and poll for new adhoc tasks
-i --ignorelimits Ignore task_adhoc_concurrency_limit and task_adhoc_max_runtime limits
-f, --force Run even if cron is disabled
</pre>
For example to run the currently queued ad hoc tasks:
sudo -u apache php admin/cli/adhoc_task.php -e

See also the '''New in 4.2''' improvements in [[Scheduled_tasks#Ad_hoc_tasks]].

==Database transfer==
A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.
==Purge caches==
You can purge caches using this script:
php admin/cli/purge_caches.php
==Kill all sessions==
If needed for administrative reasons, you can kill all user sessions using this script:
php admin/cli/kill_all_sessions.php
As a result, all users will be logged out from Moodle.
==Backup and restore of large courses==
See Backup via CLI in [[Course backup]] and Restore via CLI in [[Course restore]] (new in 3.10 onwards).
==Fix course / module sequences==
In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:
php admin/cli/fix_course_sequence.php -c=* --fix
This will check every course in Moodle and report which ones had errors and were fixed.
==Fix orphaned question categories==
When a quiz is created, a new question category for the quiz is automatically created. In versions of Moodle prior to 2.9.1, if the quiz is deleted, the question category and any questions in the category remain in database. These orphaned question categories may be fixed by running the admin/cli/fix_orphaned_question_categories.php script with the --fix option.
==Search and replace text==
This script can be used to search and replace text throughout the whole database. Use carefully and backup first always. More info in [[Search and replace tool]].
php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost
==Build theme CSS cache==
If Moodle is not running in theme designer mode it will keep a copy of the compiled CSS on local disk and serve that to the browser when it requests a page. If there isn't a copy on local disk then a copy will be built the first time a page within Moodle is requested.

With this script you can pre-compile the cached CSS files for themes within Moodle to avoid having a user wait for the theme to compile during the first page request.
php admin/cli/build_theme_css.php --themes=boost
==Get and set configuration values==
Displays the current value of the given setting, or set the given setting to the specified value.
$ php admin/cli/cfg.php [--component=<componentname>] [--json] [--shell-arg]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] [--shell-arg] [--no-eol]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --set=<value>
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --unset
$ php admin/cli/cfg.php [--help|-h]
Examples:
$ php admin/cli/cfg.php --name=langmenu
will display the value of ''Display language menu'' in ''Site administration > Language > Language settings'' (0 for ''No'' or 1 for ''Yes'').
$ php cfg.php --name=maxsizetodownload --component=folder
will display the value of ''Maximum folder download size (MB)'' accessible from ''Site administration > Plugins > Activity modules > Folder''.
$ php admin/cli/cfg.php --name=langmenu --set=0
will disable the ''Language menu''.
== Dashboard reset ==
If you make changes to the dashboard and want all users to have their dashboard reset to reflect the changes this can be done on the cli:
php admin/cli/dashboard_reset.php -e
==E-mail flag for users==
'''New in 4.2'''
The CLI script to change the email flag for one or many users at a time can be found on the page [[E-Mail flag for users]]
== Managing plugins via command line ==
=== List and uninstall Moodle plugins ===
Moodle includes a handy command-line tool to display a list of plugins and remove plugins.
$ php admin/cli/uninstall_plugins.php
This command line tool accepts the following arguments.

Options:
-h --help Print this help.
--show-all Displays a list of all installed plugins.
--show-contrib Displays a list of all third-party installed plugins.
--show-missing Displays a list of plugins missing from disk.
--purge-missing Uninstall all missing from disk plugins.
--plugins=<plugin name> A comma separated list of plugins to be uninstalled. E.g. mod_assign,mod_forum
--run Execute uninstall. If this option is not set, then the script will be run in a dry mode.
--showsql Show sql queries before they are executed.
--showdebugging Show developer level debugging information.
Dry Mode does everything the script would normally do except for actually making any changes. This is useful when you want to test the validity of your command.

Run this command from the Moodle wwwroot directory. Here are some examples:
# php admin/cli/uninstall_plugins.php --show-all
Prints tab-separated list of all installed plugins.
# php admin/cli/uninstall_plugins.php --show-contrib
Prints tab-separated list of all third-party installed plugins.
# php admin/cli/uninstall_plugins.php --show-missing
<blockquote> Prints tab-separated list of all missing from disk plugins.</blockquote>
# php admin/cli/uninstall_plugins.php --purge-missing
A dry run of uninstalling all missing plugins. This will NOT uninstall the plugin. To actually uninstall, you need to add the '--run' arguments.
# php admin/cli/uninstall_plugins.php --purge-missing --run
Run uninstall of all missing plugins.
# php admin/cli/uninstall_plugins.php --plugins=mod_assign,mod_forum
A dry run of uninstalling mod_assign and mod_forum plugins. This will NOT uninstall the plugin. To actually uninstall, you need to add the '--run' arguments.
# php admin/cli/uninstall_plugins.php --plugins=mod_assign,mod_forum --run
Run uninstall for mod_assign and mod_forum plugins.

This tool does not perform all of the steps needed to fully uninstall a plugin. You must then:
* Remove the files belonging to the plugin manually;
* [[Administration via command line#Upgrading|Update the Moodle database]] as previously described.
If you skip one or both of these steps, you will be prompted to update the Moodle database or re-install the plugin the next time you log in as a site administrator and access the Site Administration > Notifications page.
==See also==
* MDL-35736 - Manage plugins via command-line
* MDL-36237 - Resort course list via CLI
* [http://moosh-online.com/ MOOSH] - MOOdle SHell. It is a command-line tool that will allow you to perform many of the most common Moodle tasks.
[[https://docs.moodle.org/fr/Administration en ligne de commande]]
[[https://docs.moodle.org/de/Administration über Kommandozeile]]
[[https://docs.moodle.org/es/Administración por línea de comando]]
[[it:Amministrazione via linea di comando]]
[[https://docs.moodle.org/ja/コマンドライン経由の管理]]

Administration via command line

2023-12-05T17:36:15Z

Marycooch: /* Ad hoc tasks */

{{Installing Moodle}}
{{Update}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins may provide CLI functionality via scripts in their own <code>cli</code> folder.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or www-data or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:
$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params
Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:
$ sudo -u apache /usr/bin/php admin/cli/install.php --help
{{Note|These scripts are supposed to be run under the identity of the web server user. Examples on this page use the <tt>apache</tt> user for illustration. The particular value depends on your OS distribution and local set-up. Typical values may be <tt>apache</tt>, <tt>www-data</tt> or <tt>httpd</tt>.}}
== Upgrading ==
Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:
$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable
== Installation ==
There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.
$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs
If your arguments contain some specials characters for Linux-based systems, don't forget to ''escape'' them with a backslash. For example, if you want to create an admin with ''pa$sword'' as password you should wrote ''pa\$sword'' instead!

If required, the database install may be skipped, with just config.php populated.
$ sudo -u apache /usr/bin/php admin/cli/install.php --skip-database
== Maintenance mode ==
To switch your site into the maintenance mode via CLI, you can use
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
To turn maintenance mode off, execute the same script with the --disable parameter:
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable
If you don't want to enable maintenance mode immediately, but show a countdown to your users, execute the same script with the --enablelater parameter and the number of minutes which the countdown should run:
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enablelater=10
This script will also create and remove the climaintenance.html file for "Offline" mode.
== Offline mode ==
In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.
$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html
You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.
== Custom site defaults ==
During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like
<syntaxhighlight lang="php">
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</syntaxhighlight>
These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.
== Reset user password ==
If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.
$ sudo -u apache /usr/bin/php admin/cli/reset_password.php
==Converting InnoDB to Barracuda==
Newer versions of MySQL and MariaDB have an improved file format called Barracuda. To take advantage of this:
# Ensure your version of MySQL/MariaDB is using Barracuda with the large index key prefix (innodb_large_prefix). See below for details.
# Change to the compressed row format (see [[#Changing_tables_to_compressed_row_format|Changing tables to compressed row format]])
# Change the character set and collation for full Unicode support (see [[#Converting_character_set_and_collation|Converting character set and collation]]).

If you have MySQL 8.0.0 or later, or MariaDB 10.3.0 or later, then these versions only support Barracuda with the large index key prefix. For earlier versions to check if MySQL/MariaDB is using Barracuda run the following statement in the MySQL/MariaDB client or phpMyAdmin SQL tab:
SHOW GLOBAL VARIABLES WHERE variable_name IN ('innodb_file_format', 'innodb_large_prefix', 'innodb_file_per_table');
If your settings do not match any of the tables below, see [[MySQL#Configure_full_UTF-8_support|Configure full UTF-8 support]] for how to change these settings:

[[File:phpMyAdmin1.png|alt=innodb_file_format=Barracuda;innodb_file_per_table=ON;innodb_large_prefix=ON]] or [[File:phpMyAdmin2.png|alt=innodb_file_format=(blank);innodb_file_per_table=ON;innodb_large_prefix=(blank)]] or [[File:phpMyAdmin3.png|alt=innodb_file_per_table=ON]]

If your settings match one of these tables then MySQL/MariaDB is using Barracuda with the large index key prefix.
===Changing tables to compressed row format===
This script changes tables with many text columns to use ROW_FORMAT=COMPRESSED. This change isn’t required but is recommended. If the database error ''Row size too large (> 8126)'' occurs when using Moodle then run this script to fix this.

'''Note:''' If you have MariaDB version 10.6.0 to 10.6.6 or version 10.7.0 to 10.7.2 you must upgrade to a later version before running this script. See MDL-72131 for details.

To view tables requiring conversion, use the --list option:
$ php admin/cli/mysql_compressed_rows.php --list
Here is an example output:
mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)
To proceed with the conversion, run the command using the fix option:
$ php admin/cli/mysql_compressed_rows.php --fix
Successful table conversion will be reported in the output, for example:
mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed
If you get errors due to having insufficient privileges to run these commands use --showsql to generate the required SQL commands:
$ php admin/cli/mysql_compressed_rows.php --showsql
You can then copy the generated SQL into your MySQL/MariaDB client running as the 'root' user.
===Converting character set and collation===
This script changes the Moodle database tables to enable full Unicode support.
$ php admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci
After making this change edit config.php and change the 'dbcollation' to 'utf8mb4_unicode_ci' in the $CFG->dboptions array.

For further details see: [[MySQL_full_unicode_support|MySQL full unicode support]]
== Running cron via command line ==
In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.
== Scheduled tasks ==
Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/cli/scheduled_task.php script.

This script accepts the following arguments:
--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

--showsql - Shows sql queries before they are execute

--showdebugging - Shows developer debugging info
'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:
<pre>php admin/cli/scheduled_task.php --list</pre>
will return something like:
<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>
To run the first task in that list, you would execute
php admin/cli/scheduled_task.php --execute='\enrol_imsenterprise\task\cron_task'
Be aware of the single quotes. Without them, you would need to use double backlashes to avoid escaping by the shell.
=== Ad hoc tasks ===
[[Cron#Low_latency_adhoc_tasks|Ad hoc tasks]] are low-latency tasks that are normally run by the cron. You can run just the queued ad hoc tasks with admin/cli/adhoc_task.php.

This script accepts the following options and arguments:
<pre>
-h, --help Print out this help
--showsql Show sql queries before they are executed
--showdebugging Show developer level debugging information
-e, --execute Run all queued adhoc tasks
-k, --keep-alive=N Keep this script alive for N seconds and poll for new adhoc tasks
-i --ignorelimits Ignore task_adhoc_concurrency_limit and task_adhoc_max_runtime limits
-f, --force Run even if cron is disabled
</pre>
For example to run the currently queued ad hoc tasks:
sudo -u apache php admin/cli/adhoc_task.php -e

See also the '''New in 4.2''' improvements in the ad hoc tasks in [[Scheduled tasks]].

==Database transfer==
A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.
==Purge caches==
You can purge caches using this script:
php admin/cli/purge_caches.php
==Kill all sessions==
If needed for administrative reasons, you can kill all user sessions using this script:
php admin/cli/kill_all_sessions.php
As a result, all users will be logged out from Moodle.
==Backup and restore of large courses==
See Backup via CLI in [[Course backup]] and Restore via CLI in [[Course restore]] (new in 3.10 onwards).
==Fix course / module sequences==
In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:
php admin/cli/fix_course_sequence.php -c=* --fix
This will check every course in Moodle and report which ones had errors and were fixed.
==Fix orphaned question categories==
When a quiz is created, a new question category for the quiz is automatically created. In versions of Moodle prior to 2.9.1, if the quiz is deleted, the question category and any questions in the category remain in database. These orphaned question categories may be fixed by running the admin/cli/fix_orphaned_question_categories.php script with the --fix option.
==Search and replace text==
This script can be used to search and replace text throughout the whole database. Use carefully and backup first always. More info in [[Search and replace tool]].
php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost
==Build theme CSS cache==
If Moodle is not running in theme designer mode it will keep a copy of the compiled CSS on local disk and serve that to the browser when it requests a page. If there isn't a copy on local disk then a copy will be built the first time a page within Moodle is requested.

With this script you can pre-compile the cached CSS files for themes within Moodle to avoid having a user wait for the theme to compile during the first page request.
php admin/cli/build_theme_css.php --themes=boost
==Get and set configuration values==
Displays the current value of the given setting, or set the given setting to the specified value.
$ php admin/cli/cfg.php [--component=<componentname>] [--json] [--shell-arg]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] [--shell-arg] [--no-eol]
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --set=<value>
$ php admin/cli/cfg.php --name=<configname> [--component=<componentname>] --unset
$ php admin/cli/cfg.php [--help|-h]
Examples:
$ php admin/cli/cfg.php --name=langmenu
will display the value of ''Display language menu'' in ''Site administration > Language > Language settings'' (0 for ''No'' or 1 for ''Yes'').
$ php cfg.php --name=maxsizetodownload --component=folder
will display the value of ''Maximum folder download size (MB)'' accessible from ''Site administration > Plugins > Activity modules > Folder''.
$ php admin/cli/cfg.php --name=langmenu --set=0
will disable the ''Language menu''.
== Dashboard reset ==
If you make changes to the dashboard and want all users to have their dashboard reset to reflect the changes this can be done on the cli:
php admin/cli/dashboard_reset.php -e
==E-mail flag for users==
'''New in 4.2'''
The CLI script to change the email flag for one or many users at a time can be found on the page [[E-Mail flag for users]]
== Managing plugins via command line ==
=== List and uninstall Moodle plugins ===
Moodle includes a handy command-line tool to display a list of plugins and remove plugins.
$ php admin/cli/uninstall_plugins.php
This command line tool accepts the following arguments.

Options:
-h --help Print this help.
--show-all Displays a list of all installed plugins.
--show-contrib Displays a list of all third-party installed plugins.
--show-missing Displays a list of plugins missing from disk.
--purge-missing Uninstall all missing from disk plugins.
--plugins=<plugin name> A comma separated list of plugins to be uninstalled. E.g. mod_assign,mod_forum
--run Execute uninstall. If this option is not set, then the script will be run in a dry mode.
--showsql Show sql queries before they are executed.
--showdebugging Show developer level debugging information.
Dry Mode does everything the script would normally do except for actually making any changes. This is useful when you want to test the validity of your command.

Run this command from the Moodle wwwroot directory. Here are some examples:
# php admin/cli/uninstall_plugins.php --show-all
Prints tab-separated list of all installed plugins.
# php admin/cli/uninstall_plugins.php --show-contrib
Prints tab-separated list of all third-party installed plugins.
# php admin/cli/uninstall_plugins.php --show-missing
<blockquote> Prints tab-separated list of all missing from disk plugins.</blockquote>
# php admin/cli/uninstall_plugins.php --purge-missing
A dry run of uninstalling all missing plugins. This will NOT uninstall the plugin. To actually uninstall, you need to add the '--run' arguments.
# php admin/cli/uninstall_plugins.php --purge-missing --run
Run uninstall of all missing plugins.
# php admin/cli/uninstall_plugins.php --plugins=mod_assign,mod_forum
A dry run of uninstalling mod_assign and mod_forum plugins. This will NOT uninstall the plugin. To actually uninstall, you need to add the '--run' arguments.
# php admin/cli/uninstall_plugins.php --plugins=mod_assign,mod_forum --run
Run uninstall for mod_assign and mod_forum plugins.

This tool does not perform all of the steps needed to fully uninstall a plugin. You must then:
* Remove the files belonging to the plugin manually;
* [[Administration via command line#Upgrading|Update the Moodle database]] as previously described.
If you skip one or both of these steps, you will be prompted to update the Moodle database or re-install the plugin the next time you log in as a site administrator and access the Site Administration > Notifications page.
==See also==
* MDL-35736 - Manage plugins via command-line
* MDL-36237 - Resort course list via CLI
* [http://moosh-online.com/ MOOSH] - MOOdle SHell. It is a command-line tool that will allow you to perform many of the most common Moodle tasks.
[[https://docs.moodle.org/fr/Administration en ligne de commande]]
[[https://docs.moodle.org/de/Administration über Kommandozeile]]
[[https://docs.moodle.org/es/Administración por línea de comando]]
[[it:Amministrazione via linea di comando]]
[[https://docs.moodle.org/ja/コマンドライン経由の管理]]

Scheduled tasks

2023-12-05T17:34:57Z

Marycooch: MDL-70975 ad hoc task improvement

{{Server settings}}
==Managing scheduled tasks==
An administrator can schedule routine tasks very precisely from ''Administration > Site administration > Server > Tasks > Scheduled tasks.''

Note that you still need to run the [[Cron|cron scripts]] (admin/cli/cron.php or <nowiki>https://yoursite/admin/cron.php</nowiki>) at regular intervals. It is recommended that the cron is run every minute.
{|
|-
|[[File:scheduledtasks1.png|thumb|Scheduled tasks]]
|[[File:scheduledtasks2.png|thumb|Editing a scheduled task]]
|}

Clicking the edit icon allows the administrator to specify the minute/hour/day/month or day of the week the task is to be run. It is also possible to reset the task to its default setting or disable it completely.

The column 'Next run' provides information on whether a plugin or a task is disabled (as well as the date that a task will next run).

==Task processing==
From Site administration > Server > Tasks > Task processing, you can disable/enable cron and view and modify the processing of scheduled and ad hoc tasks.

{{New features}}
The length of time to keep polling for additional tasks can be managed from a 'keep alive'setting (with a default value of 3 minutes.)
==Format for scheduling tasks==

When typing into the fields, the format is the same as for Unix cron. Examples are as follows and are according to which field you are editing:

* is every minute, hour, day, month
*/2 is every two minutes, every two hours or every second day
2-10 is every minute between two and ten past the hour or every hour between 2 and 10 am
0 is every Sunday
1 is every Monday or every January
2,5 is the second and 5th of the month, or February and May, or Tuesday and Friday.

Default: R means that a random value is picked when saving changes. This helps to distribute tasks more equally instead of running too many of them on the hour, midnight etc.

==Fail delay==

If you're trying to debug a cron task, you may notice the Fail Delay becomes populated with a number. This is the time in seconds the cron will delay running the task. To sidestep this problem for development purposes, take a look at the Scheduled Tasks section here: [[Administration via command line#Scheduled tasks]].

==Running individual tasks==

To be able to run individual scheduled tasks via 'Run now' links on the scheduled tasks page, 'Allow 'Run now' for scheduled tasks' (tool_task | enablerunnow) in Site administration / Security / Site security settings should be enabled AND 'Path to PHP CLI' (pathtophp) in Site administration / Server / System paths should be set.

[[File:examplescheduledtasks.png]]
==Ad hoc tasks==
'''New in 4.2:
'''
From Site administration > Server > Tasks > Ad hoc tasks you can see ad hoc tasks grouped by class name.

Clicking on a component/class name you then have a link to run that particular ad hoc task from the UI.

Ad hoc tasks can be also be run individually from the command line via admin/cli/adhoc_task.php. Options are:
*Run by id
*By class
*Only failed
It is also possible to limit the number of tasks to run, eg, no more than four at a time.

See [MDL-70975] for example CLI commands to run the above ad hoc tasks.

==Tasks running now==

Currently running tasks may be viewed from Site administration > Server > Tasks >Tasks running now
[[File:TasksRunningNow.png|600px|center]]

==Launching a task from CLI==
You can also launch individual task from Command Line Interface (see [[Administration via command line#Scheduled tasks|Administration via command line]]).

[[es:Trabajos agendados]]
[[de:Geplante Vorgänge]]
[[fr:Tâches programmées]]

MediaWiki:Sitenotice

2023-12-04T16:36:14Z

Marycooch: site notice

<p class="note">''Note: You are currently viewing documentation for Moodle 4.2. Up-to-date documentation for the latest stable version of Moodle may be available here: '''[[:en:{{NAMESPACE}}:{{PAGENAME}}|{{PAGENAME}}]].'''''</p>

Analytics

2023-12-03T15:49:52Z

Marycooch: /* Using analytics */

{{Tracking progress}}
==Overview==

{{MediaPlayer | url = https://youtu.be/TFhQVwk1CQY | desc = Analytics in Moodle 3.8}}

=== What are learning analytics? ===
Learning analytics are software algorithms that are used to predict or detect unknown aspects of the learning process, based on historical data and current behavior. There are four main categories of learning analytics:
* descriptive (what happened?)
* predictive (what will happen next?)
* diagnostic (why did it happen?)
* prescriptive (do this to improve)

Most commercial solutions are descriptive only. Those that are predictive or proactive make certain assumptions about learning that don't apply to everyone.

=== Analytics vs. reporting ===
Moodle provides a variety of built-in reports based on log data, but they are primarily descriptive in nature—they tell participants what happened, but not why, and they don't predict outcomes or advise participants how to improve outcomes. Log entries, while very detailed, are not in themselves descriptive of the learning process. They tell us “who,” “what,” and “when,” but not “why” or “how well.” Much more context is needed around each micro-action to develop a pattern of engagement.

Many third-party plugins also exist for Moodle that provide descriptive analytics. There are also integrations with third-party off-site reporting solutions. Again, these primarily provide descriptive analytics that rely on human judgment to interpret reports and generate predictions and prescriptions.

Often in the past, learning analytics systems have attempted to analyze past activities to predict future activities in real time. With Moodle Learning Analytics, we are more ambitious. We believe a full learning analytics solution will help us not only predict events, but change them to be more positive.

===Features===
* Two types of models supported:
** Machine-learning based models, including predictive models
** "Static" models to detect situations of concern using simple rules
* Three built-in models: "[[Students at risk of dropping out]]", "Upcoming activities due" and "No Teaching".
* A set of student engagement [[Learning analytics indicators|indicators]] based on the [https://en.wikipedia.org/wiki/Community_of_inquiry Community of Inquiry].
* Built-in tools to evaluate models against your site's data
* Proactive notifications using [[Events list report|Events]]
* A list of suggested Actions is provided with the Insight notifications for each model. For example, in the [[Students at risk of dropping out]] model, instructors can easily send messages to students identified by the model, or jump to the [[Activity report]] for that student for more detail about student activity within the course
* An [[dev:Analytics API|API]] to build indicators and prediction models for third-party Moodle plugins
* Machine learning backend plugin type - supports PHP and Python, and can be extended to implement other ML backends
* The system can be easily extended with new custom models, based on reusable targets, indicators, and other components. For more information, see the [[dev:Analytics API|Analytics API]] developer documentation.

===Limitations===

* Machine learning models such as [[Students at risk of dropping out]] must be trained on a site with data . These models cannot make predictions on a site until this is done.
* Models must be designed and selected to match the educational priorities of the institution.

== Settings ==

The Moodle learning analytics system requires some initial configuration before use. See [[Analytics settings]] for more detail.

== Using analytics ==
The Moodle Learning Analytics API is an open system that can become the basis for a very wide variety of models. Models can contain indicators (a.k.a. predictors), targets (the outcome we are trying to predict), insights (the predictions themselves), notifications (messages sent as a result of insights), and actions (offered to recipients of messages, which can become indicators in turn).

Most learning analytics models are not enabled by default. Enabling models for use should be done after considering the institutional goals the models are meant to support. See [[Using analytics]] for more information.

Analytics models may be restricted to category or course contexts

== Managing models ==
Once models have been enabled and trained, insights will be generated. Models should also be monitored for performance and accuracy. See [[Managing analytics]] for more information.

==See also==

* [[Analytics FAQ]]

[[Category:Analytics]]

[[es:Analítica]]
[[de:Analytics]]
[[fr:Analyses de données]]

OAuth 2 LinkedIn service

2023-12-03T15:27:44Z

Marycooch: /* LinkedIn setup */

{{OAuth2}}

== LinkedIn setup ==
To setup an OAuth 2 client with LinkedIn, first we need to login to the [https://www.linkedin.com/developers/ LinkedIn Developers page] and create a new app.

*Request access and add the product "Sign in with LinkedIn using OpenID Connect".
*Make sure you've set the "Authorized redirect URLs for your app" to: YOURSITE/admin/oauth2callback.php
*Go to your Moodle site and log in as admin.
*Go to "Site admin > Plugins > Authentication" and enable the "OAuth2" authentication plugin
*Go to "Site admin > Server > OAuth 2 Services"
*Click the "LinkedIn" button
*Enter your Client ID and Client secret (You'll find these on the 'Auth' tab of your LinkedIn dev portal app.)
*Decide whether or not to uncheck "Require email verification" -and if you do uncheck it, tick the "I understand that disabling email verification can be a security issue" box to confirm.
*Save changes.

[[File:ouath2linkedin.png]]

Users will now see a LinkedIn option when logging in to your site.

[[File:LinkedInlogin.png|left|500px]]

File:LinkedInlogin.png

2023-12-03T15:27:06Z

Marycooch:

File:ouath2linkedin.png

2023-12-03T15:26:52Z

Marycooch:

OAuth 2 LinkedIn service

2023-12-03T15:26:41Z

Marycooch: updating with ref to MDL-79181

Using Forum

2023-12-01T14:16:45Z

Marycooch: each person posts one discussion

{{Forum}}
This page explains how students and teachers can use the [[Forum activity]] and explores ways to make the most of it in your Moodle course.

==Which forum do I need?==
In the (default) '''Standard forum for general use''', students will see an introduction text in a separate space above the list of discussions. Students see a button to start a new discussion (thread).

[[File:standardforum.png|thumb|center|467px|Student view of "Standard forum" type]]

The '''Each person posts one discussion''' type allows each person to start one discussion but to reply to as many others as they wish. This is very useful if you want learners to 'take ownership' of a particular forum discussion, for example to share something they have created and get feedback from others who will reply to the initial post.

In a '''Single, simple discussion''' the teachers posts a question and students are able only to reply. They cannot start a new topic of discussion. This is useful if you wish to keep a discussion focused. '''Note''': This forum type does not work with separate groups.

[[File:Single simple discussion.png|thumb|center|450px|Student view of "A single simple discussion" forum type]]

The '''Question and Answer forum''' is best used when you have a particular question that you wish to have answered. The teacher posts a question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings. Note that the maximum editing time for forum posts (set globally by the admin in Site administration > Security > Site security settings) has to be passed before students can see the other posts.

{|
| [[File:QA1.png|thumb|Initial view of Q&A forum]]
| [[File:QA2.png|thumb|Students cannot see posts until they post]]
| [[FIle:QA3.png|thumb|Other posts visible when editing time is over]]
|}

The '''Standard forum displayed in a blog-like format''' works like the standard forum for general use, but the first post of each discussion is displayed (as in a blog) so that users can read it and then choose to respond by clicking the "Discuss this topic" button bottom right of the post.

[[File:Bloglikeforum.png|thumb|450px|center|Blog like forum]]

==Using Forum: All users==

===Replying to discussions===
Similar to when starting a new discussion, the reply box appears inline, allowing the user to respond quickly. If a more detailed reply is needed, for example, needing the editing toolbar or attachment box, clicking Advanced will display the full version.

===Star discussions===
Discussions may be favourited or 'starred' either by clicking the three dots to the right of the discussion or by clicking directly on the star. This setting is individual and will move the discussion to the top of the discussion list, under any pinned discussions.
[[File:SmallStar.png|600px]]

===Sort discussions===
Discussions may be sorted by replies, last post or created, by clicking the linked words at the top of the discussion list.

===Permalinks===

A permalink allows you to link directly to a specific forum post so you can share it easily with others. You will see the permalink option when clicking to reply to a post. If you click the permalink ''(1)'', it is highlighted to the side ''(2)'', and you will have a particular web address ''(3)'' which you can then copy and paste to use elsewhere:

[[File:permalinkexample.png|thumb|center|600px|Linking directly to a single post]]

===Forum preferences===
Users can set their forum preferences via Preferences in the user menu top right. (Defaults for each of these settings can be set by an administrator in ''Administration > Site administration > Accounts > User default preferences''.)
====Experimental nested view====

Enabling this will then make available a new discussion view, trialled in Moodle 3.8:
[[File:ExpNest.png|center|Experimental nested view|600px]]

===Subscribing to forum discussions===
Users can subscribe to forum discussions in several ways, to receive notification about new posts.
# From the Preferences link in the user menu they can choose to be automatically subscribed to forum discussions when they post
# They can click on the open envelope icon next to a forum discussion. (It will then change to a closed envelope.)
#They can click into the forum and click the cog icon top right and subscribe to the whole forum.

===Track read and unread forum posts===
*Access the Preferences page from the user menu and select 'Forum preferences'.
* For 'Forum tracking', choose ''Yes: highlight new posts for me'' and if the forum administrator has set the 'Read tracking for this forum?' to On or Optional then unread posts will be highlighted for you:
{|
|[[File:forumtracking1.png|thumb|296px|left|Unread posts alert]]
|}

The posts will be highlighted in the following places:

* Course page
* Within the forum itself
* In forum discussion threads
{|
|[[File:forumtracking2.png|thumb|500px|left|Click to mark as read]]
|}

Only posts made in the last two weeks are tracked as read or unread. Older posts are all reported as read.

Note: You can also choose to have any forum post notifications automatically marked as read (so they don't appear in the Unread list.) Some people find this confusing and prefer to keep them as unread:

{|
|[[File:forumnotificationsread.png|thumb|left|600px|Forum post notification options]]
|}
===Display options===
[[Image:forumviewoptions.jpg|thumb|Reply display options]]A discussion thread may be displayed in four ways. Use the pull-down menu at the top of each forum discussion to select a display type.

* Display replies flat, with oldest first
* Display replies flat, with newest first - The discussion will be displayed in one line and the chronological order from the newest to the oldest. This view is the same as the above, just a different sort order.
* Display replies in threaded form - Only the post starting the discussion will be displayed in its full form; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.
* Display replies in nested form - All posts are displayed in their full forms; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.

{|
| [[Image:Forum Flat form mu.png|thumb|Flat Forum discussion, example from middle]]
| [[Image:Forum threaded form mu.png|thumb|Posts in threaded form]]
| [[Image:Forum nested form mu.png|thumb|"Nested reply example"]]
|}

===Forum posting===

The default content of '''Subject''' is usually 'Re: <the name of the 'parent' post>'. You can change it, though.

==== Adding images, sound and video ====

When an image is "attached" as a file to a forum message, it is immediately displayed full size after the message (i.e. no need to click on an attachment). This is an excellent way of sharing images without having to go through the process of uploading them as files and linking them from within web pages. Images may be dragged and dropped into the box as well as uploading via the "add" link and the [[File picker]].

Audio or video may be added using the Insert audio/video file button in the Atto editor. The file will be shown embedded in an appropriate media player. For more details, see the section 'Using the Moodle media icon' in [[Audio]] and [[Video]]. Alternatively, the audio or video file may added as an attachment to the post, in which case the file will be displayed as an attachment.

====Tags====

Forum posts may be tagged.

Tags can be managed by a site administrator in [[Managing tags|Manage tags]] in the Site administration. Forum post tags may be added to a specified tag collection, and standard tags may be suggested or forced. If desired, forum post tagging may be disabled completely.

====Post editing time limit====
Once a post has been made, students can go back and edit it within a set time limit. This limit is 30 minutes by default and is set by an administrator in [[Site security settings]] in the Site administration. Note that teachers can always edit their posts.

====Moving between forum threads====

Links top and bottom, left and right (where applicable) take you to the previous and next forum discussion in a list:

[[File:navigateforums1.png|thumbnail|center|500px]]

===Reply to posts via email===

If enabled by an administrator (in [[Mail configuration]]), you can reply to forum posts via email.

# Click the Reply by email link in the email. You will see a special unique email address to send your reply to.
# Reply using the email address provided. '''IMPORTANT: Make sure you remove the original email content so that your forum post does not contain the quoted text.'''
# You should receive an email saying your reply has been successfully posted.
# Your post now appears in the forum.

{|
| [[File:forumemailreplylatest.png|thumb|400px|(1) Click to reply by email]]
| [[File:specialemailaddress.png|thumb|300px|(1a) Note the special email address to reply to]]
| [[File:forumemailreply2.png|thumb|400px|(2) Type and send your reply]]
|}

{|
| [[File:forumemailreply3.png|thumb|400px|(3) The success message]]
| [[File:forumemailreply4.png|thumb|400px| (4) Your reply is posted to the forum]]
|}

[[File:navigateforums1.png|thumbnail|center|500px]]

===Exporting forum posts===
Users with the ''mod/forum:exportdiscussion'' or ''mod/forum:exportownpost'' or ''mod/forum:exportpost'' permission can export forum posts to any portfolio the administrator has enabled:

[[File:Exportforum.png|200px]]

See the discussion [https://moodle.org/mod/forum/discuss.php?d=320382 Printing/exporting forum discussions] for further details.

==Using Forum: Teachers==

=== Private replies===

Teachers (or anyone with the capability [[Capabilities/mod/forum:postprivatereply|mod/forum:postprivatereply]] can reply privately to a forum message. By default, the reply is only seen by the recipient and the teachers of the course, and cannot be replied.

[[File:SmallPrivateReply.png|400px]]

===Pinned posts===

When adding a new discussion as a teacher, you can 'pin' it from the three dots to the right of the discussion. (See screenshot below.) Any forum discussions which come after that will appear underneath this pinned post. If you later click to 'unpin' it, it will display as a regular forum discussion, moving down the list when others are posted.

===Manually locking discussion threads===

By clicking 'Lock this discussion' from three dots to the right of a discussion, you can manually lock a thread so that nobody can post to it anymore. A label 'Locked' will appear underneath the locked discussion subject. You can unlock it with the three dots to the right of the discussion again if necessary:

[[File:SmallForumStarPinLock.png|300px]]

==='Send forum post notifications with no editing time delay'===

Teachers (and others with the [[Capabilities/moodle/course:manageactivities|capability to manage course activities]]) will see this option when posting to a forum. Ticking this box will send a notification to everyone subscribed to that forum with no editing time delay. (Users have 30 minutes by default to edit their posts.)

Note: For users who have enabled email digests in their forum preferences, the notification is NOT sent separately from other forum post notifications.

=== Display period ===

Teachers (and others with the capability [[Capabilities/mod/forum:viewhiddentimedposts|mod/forum:viewhiddentimedposts]]) can set a display period of a date and time for the forum post to appear.

[[File:timedposts.png|500px]]

Note: Timed forum posts were included in previous versions of Moodle as an experimental feature. In Moodle 3.1 onwards, it is enabled by default for new installations. For sites upgrading from a previous version, it may be enabled via ''Site administration > Plugins > Activity modules > Forum''.

===Locking a discussion===

Forum threads may be automatically locked after a certain period of inactivity. This is done from the setting 'Discussion locking' when creating or editing a new forum.

[[File:discussionlocking.png|center|thumb|600px|Locked discussion alert when viewing a forum.]]

*A period from a day to a year may be selected. The default is for discussions not to be locked.
*Watch the screencast [https://youtu.be/M9ZxCq50hiQ Discussion locking] to see a demonstration.
*Teachers and other users with the [[Capabilities/mod/forum:canoverridediscussionlock|capability to override locked discussions]] can unlock discussions simply by posting a reply.

===Moving a discussion===

Teachers and other users with the [[Capabilities/mod/forum:movediscussions|capability to move discussions]] can move a discussion to any other forum in the course for which they have appropriate rights.
# Click on the arrow in the 'Move this discussion to...' dropdown menu in the top right corner of the page and select a destination forum.
# Click the Move button.

Note: Moving a forum post will display incorrect results in the [[Participation report|course participation report]] for the affected forums. For example, take a student who posted in forum A and had their post moved to forum B. In the course participation report, the student will still be listed as having made a post in forum A, but will not be listed as having made a post yet in forum B.

Note: Discussion subscriptions are retained when a post is moved.

===Splitting a discussion===

Teachers and other users with the [[Capabilities/mod/forum:splitdiscussions|capability to split discussions]] can split a discussion thread. Splitting a discussion means that beginning with the post selected and going to the end of that sub-thread, the posts are cut from the current discussion topic and put into a newly created discussion topic. If a discussion has strayed away from the original topic, splitting the discussion can provide new attention and space for the tangent discussion while keeping the original discussion on topic.

# Click the link 'Split' in the forum post
# Enter a new discussion name (optional)
# Click the Split button

Note: Discussion subscriptions are NOT retained when a post is split.

===Using groups with forums===
'Group mode' available from the Common module settings has three options. (Note that you must have groups in your course to use this feature.)

====If the group mode is set to separate groups====

* Teachers (and other users with the [[Capabilities/mod/forum:canposttomygroups|capability to post in all groups they have access to]]) are given the option of adding a new discussion topic for all participants or a selected group.
* They should first click the Advanced link at the bottom of the text box in order to see and tick 'Post a copy to all groups'

[[File:postcopyallgroups.png|center]]

If a teacher adds a new discussion topic for a selected group, then only group members can reply to it. If the teacher adds a new discussion topic for all participants, they need to also tick the box 'Post a copy to all groups', otherwise students will only be able to view their post and not reply to it.

[[File:allgroupsposts.png|500px|center|Forum with discussion to all participants with 'Post a copy to all groups' ticked]]

* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or discussions for their group started by a teacher.

====If the group mode is set to visible groups====

* Teachers are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for All participants then students can see it but not reply.
* If a teacher adds a new discussion topic for a selected group, then only group members can reply to it.
* Students can only start and reply to discussions for their group, as long as the teacher selected their group or ticked 'Post a copy to all groups'.
* Students can view, but not reply to discussions in other groups.

Teachers, and other users with the capability [[Capabilities/moodle/site:accessallgroups|moodle/site:accessallgroups]] set to allow, can view and post in all forum discussions, regardless of the group mode setting.

Where visible groups are used, the user's groups will be shown first in the list, followed by other groups:

[[File:mygroupsfirst.png|200px]]

Note: Single simple discussions cannot be set to separate groups (as this feature is not implemented). Instead, a standard forum should be used. If required, a permissions override may be set to prevent students from starting new discussions.
For teachers who have access to all or several groups in a forum, this setting allows them to post the same message once only to all groups.

===Forum grading===

To be able to grade forum posts, in the forum settings in the section 'Whole forum grading', you need to set the grade type to Point or Scale. You can then choose a grading method, such as a marking guide or rubric. After saving the forum settings, you'll find a 'Grade users' button on the forum page.

==Ideas for using forums==

Ask yourself

# you wish to have involvement in the forum or if you want the students to lead and own the space
# you want the forum to add value to the face to face environment or have a life of its own in its own right outside the lecture theatre/classroom or seminar room
# you are prepared to make appropriate contributions to the discussion to:
## encourage discussion if students are quiet
## help shape ideas if students begin to wander off-task
## your role will be defined as discussions/a course progresses
## you will explicitly but gradually relinquish control of the discussions
## you will encourage and support learners to share control of discussions (for example you might ask a learner/group of learners to summarise contributions to a discussion thread/topic, or you might ask learners to initiate discussion topics)

[[de: Forum nutzen]]
[[fr:Afficher un forum]]
[[ja:フォーラムの閲覧]]
[[es:Usando Foro]]

error/cache/ex configcannotsave

2023-11-23T09:30:49Z

Marycooch: created this page from MDL-80040 with thanks to Andrew Lyons

This error can be shown for several related reasons:

*The file system prevented the creation of the directory used for the cache data.
*The directory was created but was not writable.
*The directory was created and is writable, but a file system lock could not be created.

Typically the cache data is stored in $CFG->dataroot in the muc folder. This can be changed in the Moodle config.php by setting the $CFG->altcacheconfigpath setting.

Locks are typically created in $CFG->dataroot in the cache directory. There could for example be a problem creating the lock. This might be because there was a failed install already and the directory needs to be cleared before attempting to install again. It could also be because the file system does not support locking for some reason - although this is unusual.

Advanced grading methods

2023-11-06T14:01:02Z

Marycooch: updating

{{Grades}}'''Advanced grading methods''' enable various assessment forms to be used for calculating grades. They may be used in [[Assignment]] and [[Forum]] activities.

[[image:comicstrip-rubrics.png|600px|They should also have plagiarism plugins installed and apply them to control lazy course content creators.]]

==Advanced grading method types==

* [[Rubrics]]
* [[Marking guide]]

There are also add-ons available in the 'See also' section below.

== Basic concepts ==

By default, the teacher selects numerical grades in Moodle from a range like 0–100. When advanced grading methods are enabled, the grade selection element is replaced with the plugin's more complex assessment form. The plugin contains the logic of how to calculate the grade. The calculated grade is then passed back to the activity module as if the teacher used the standard grade value selector.

:''Example:'' The teacher creates a new Assignment in the course with the grade up to 30. She defines a rubric to be used for grading. The rubric itself produces a raw score up to 12 (e.g. it has four criteria with levels 0, 1, 2, 3). So the rubric's score of 12 leads to the assignment grade of 30, the score of 6 leads to the grade of 15 etc.

For each activity, a new copy of the assessment form is created. Note that this is different from how [[scales]] work. While scales are defined at the site level or course level and can be used in all activities, advanced grading forms create a new copy of the form definition for every activity that uses it. So a change in the form definition in one assignment does not affect other places where the same rubric is used.

:''Example:'' The teacher defines a rubric for an assignment in the course. Then she re-uses the rubric in another assignment (see below on how to do this). When the teacher modifies the second assignment's rubric, the first one still uses the original rubric.

The grading form definition is part of the activity data. It is included in the activity's backup, and it is copied when the activity is duplicated via the "x2" icon or imported from another course.

== Configuring an activity module to use advanced grading methods ==

[[image:grading-method-selection-modform.png|thumb|right|Choosing the grading method in the activity settings form.]]

Modules that support advanced grading methods have the grading method selector included in their settings form (for example, in the [[Assignment settings]] form). The teacher can choose either 'Simple direct grading' or one of the installed grading methods plugins. Selecting 'Simple direct grading' means that the advanced grading is not used and the standard grade selector is displayed.

An alternative way is to follow the' Advanced grading' link in ''Administration > Activity administration''. The link leads to a page where the current active grading method can be changed, too.

The form definition and the associated assessment data are stashed when the grading method is changed from one type to another. That means it is safe to change the current active grading method from 'Rubric' to 'Simple direct grading' and back to 'Rubric'. The rubric definition is kept in the database, although it may not be available while the current grading method is set to another method.

== Assessment form definition ==

[[image:grading-manage-initial.png|thumb|right|Grading method management screen (no assessment form of the selected type is not defined yet).]]

The link 'Advance grading' in the activity settings form leads to a management screen where the assessment form can be defined, edited, deleted and eventually shared as a public template (if the user has such permission). If there is no form of the selected method defined yet, there are two options:

* Define new grading form from scratch - creates a blank grading form and lets you define it. Each grading plugin provides its own grading form editor.
* Create a new grading form from a template - lets you re-use a previously defined form. You can copy any of your grading forms (that is, those you have created elsewhere) or a grading form that was shared as a public template at your site.

Every grading form has a name and a description. These are not displayed to students. The description should summarize the form, explain its usage etc.

The grading form definition can be saved as a draft or as a final version. If the grading form is saved as a draft, it can't be used for assessment. To release the form and make it available for assessment, save it using the button 'Save and make it ready'. The current status of the form definition is indicated via a tag displayed next to the form name.

=== Modifying the form after it has been used ===

It may happen that you define a grading form, make it ready for usage and start assessing students with it. After some time, you realize there is a typo in the form or that it should be improved significantly (like adding another criterion into the rubric). In such a case, you are about to edit a form already used for assessment.

If the grading plugin considers your change significant, it may force you to mark all current assessments with a special flag 'Needs review'. You have to go through all existing assessments made by the previous form and re-assess them to make the calculated grades valid a comparable. If the change seems to be trivial (e.g. fixing a typo in the text), the form editor may ask you to decide whether the existing assessment should be marked with the 'Needs review' flag or not.

Please note, when other people are using the form for assessment (e.g. several non-editing teachers in the course participate in the submissions assessment), even a trivial rewording can be understood as a significant change in the criterion meaning. Make sure you communicate the changes well with your colleagues.

== Re-using assessment forms ==

[[image:grading-pick-search.png|thumb|right|Searching for a grading form to re-use]]

Instead of defining the new grading form from scratch, you can use some existing form as the initial template to create it from. When clicking the 'Create new grading form from a template' icon, a new page opens, and you can search for a grading form there. Type words that appear somewhere in the form name, its description or the form body itself. To search for a phrase, wrap the whole query in double quotes.

=== Shared templates ===

Users who were given special permission can save their grading forms as shared templates on the site. Such forms can be then picked and re-used by all teachers in their courses. Users who published the form as a template can also delete it from the list of shared templates. See [[Grading forms publisher]] for more information. There is also another permission to manage the whole "bank" of shared templates. Users with this permission can delete any shared template, even if they are not its authors. See [[Grading forms manager]] for more information.

Grading forms can be shared at the site level only. There is no way to share forms at lower context levels (e.g. at the course category level as the question bank does).

=== Re-using own forms without sharing them ===

[[image:grading-pick-ownform.png|thumb|right|Re-using a form that was previously used in another activity]]

By default, only the grading forms that have been saved as shared templates are included in the search results. You can also include all your grading forms in the search results. This way, you can re-use your grading forms without sharing them. Only forms marked as 'Ready for usage' can be re-used this way.

=== Permissions ===

Two capabilities affect the user's permission to work with templates.

* Share advanced grading form as a template ([[Capabilities/moodle/grade:sharegradingforms|moodle/grade:sharegradingforms]]) - grants the ability to save a grading form as a new shared template and eventually edit and remove own templates (templates originally shared by that user). Users with the role of manager are given this permission by default. To allow others to do this, see [[Grading forms publisher]].
* Manage advanced grading form templates ([[Capabilities/moodle/grade:managesharedforms|moodle/grade:managesharedforms]]) - grants the ability to edit and remove any shared template, even those originally shared by other users. To allow trusted teachers to do this, see [[Grading forms manager]].

=== Sharing your grading forms world-wide ===

At the moment, there is no way how to export/import grading form definitions. The known workaround is to create an empty assignment module and attach the grading form to it. Then make a standard activity backup of this assignment in the MBZ format and share it. By restoring the assignment, the attached grading form is restored, too. It can be then picked for your activities or shared as a template at your site.

==What the students see==

When students click on an assignment with a rubric or marking guide attached to it, they will see the rubric or marking guide as part of the information about their assignment.

{|
|[[File:rubricbeforesubmission.png|thumb|Student view of rubric '''before''' submission]]
|}

==Rubric feedback for student view when Anonymous Marking is used==
Note: When '''[[Assignment settings#Anonymous marking|anonymous marking]]''' is used, students ''will'' receive a notification, but will ''not'' see rubric feedback until ''all'' submissions are marked and '''reveal student identities''' is clicked. That releases rubric marks and inline comment feedback to all students.

==See also==
* [[Learning Analytics Enriched Rubric]]
* [[BTEC marking]] for use with Moodle assignments

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=193460 A few Advanced Grading questions for Moodle 2.2.1]
* [http://moodle.org/mod/forum/discuss.php?d=193961 Wrong Gradebook Calculation from 2.2 Rubric]

[[de:Erweiterte Bewertungsmethoden]]
[[es:Métodos avanzados de calificar]]

Security report on default user role

2023-10-26T09:52:04Z

Marycooch: MDL- 79139

{{Security overview report}}
==Default role for all users==
In general the default role for all users should be set to authenticated user. Normally all permissions for the role of authenticated user should be left as default.
==Default user role is incorrectly defined==
If the security overview report shows the default role for all users with status 'Critical' and states that 'The default user role "Authenticated user" is incorrectly defined!' it means that one or more risky capabilities are allowed for the role.

This could also refer to a bug in Moodle. Check the ''tool/dataprivacy:requestdeleteforotheruser'' capability in the Authenticated User role. This setting now defaults to "Not Set". If the Authenticated User role on your site has this capability set to the default "Not Set" and you have not changed any of the other permissions on this role then no further action is required. See the MDL-67852: '''Security overview report shows critical warning for "Default role for all users" with default requestdelete config''' Tracker issue and the following Using Moodle Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=387143 Security overview]
* [https://moodle.org/mod/forum/discuss.php?d=403379 Security checks and Default role for all users]
==Reviewing authenticated user role permissions==
The permissions for the role of authenticated user can be reviewed either by clicking the link 'Definition of role of authenticated user' from ''Site administration > Reports > Security checks'' - or as follows:
# Go to ''Administration > Site administration > Users > Permissions > Define roles''
# In the role column, click the link 'Authenticated user'
# Browse the permissions column
If there is no reason for changing permissions from default, then the role can be reset by clicking the Reset button at the top of the page.

[[File:ResetRoleButton.jpg]]

After resetting the authenticated user role, the security overview report will show the default role for all users with status OK.

==See also==
* Using Moodle [http://moodle.org/mod/forum/view.php?id=7301 Security and Privacy forum]
* Using Moodle [https://moodle.org/mod/forum/discuss.php?d=387143 Security overview] discussion
[[es:Reporte de seguridad sobre rol del usuario por defecto]]

Talk:New features

2023-10-04T21:00:26Z

Marycooch:

)

Please update links for Spanish and French pages to new 4.3 versions [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

German - this is the 4.2 documentation - you need the 4.3 documentation for the links and I have already done them on that page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 20:59, 4 October 2023 (UTC)

Talk:New features

2023-10-04T21:00:10Z

Marycooch: replying to German

Please update links for Spanish and French pages to new 3.10 versions

Done - --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 09:12, 11 November 2020 (UTC)

Please update links for Spanish and French pages to new 3.11 versions [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]]) 12:09, 5 May 2021 (UTC)

Please update links for Spanish and French pages to new 4.2 versions.--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 10:38, 21 April 2023 (UTC)

Please update links for Spanish and French pages to new 4.3 versions [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

German - this is the 4.2 documentation - you need the 4.3 documentation for the links and I have already done them on that page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 20:59, 4 October 2023 (UTC)

Standard themes

2023-10-03T07:45:28Z

Marycooch: removed sentence about legacy theme selector.

{{Themes}}

==Standard themes==

Moodle has two standard themes: ''[[Boost theme|Boost]]'' and ''[[Classic theme|Classic]],'' a responsive, bootstrap-based theme combining the navigation structure of the deprecated Clean and More themes and the customisation options of the Boost theme.

Other themes are available from the [https://moodle.org/plugins/browse.php?list=category&id=3 Themes section of the Moodle plugins directory].

===Example of a customised Boost theme===

The following code uses standard Boost with customisations as follows:
* An image for the front page and a background image need to be uploaded and referenced in the code.
*'''Front page topic section:'''

<syntaxhighlight lang="html">
<div class="frontpage container-fluid">

<div class="jumbotron jumbotron-fluid" style="background-image: url('YOUR UPLOADED FRONT PAGE IMAGE.jpg');">
<div class="texts">
<h2>YOUR HEADING</h2>
<p class="lead">SENTENCE/TAG LINE</p>
</div>
</div>

<div class="row-fluid">
<div class="fp-block col-md-6">
<h3>SMALLER HEADING</h3>
<p>Paragraph of text</p>
<p class="button"><a class="btn btn-primary" href="BUTTON LINK URL">BUTTON TEXT »</a></p>
</div>
<div class="fp-block col-md-6">
<h3>SMALLER HEADING</h3>
<p>Paragraph of text.</p>
<p class="button"><a class="btn btn-primary" href="BUTTON LINK URL">BUTTON TEXT »</a></p>
</div>
</div>

</div>
</syntaxhighlight>

*'''Boost theme Advanced settings - Raw initial SCSS:'''

<syntaxhighlight lang="css">
$brand-primary: #0070a8;
$body-color: #336;
$font-family-sans-serif: "Helvetica Neue", Helvetica, Arial, sans-serif;
$breadcrumb-bg: #fff;
</syntaxhighlight>

*'''Boost theme Advanced settings - Raw SCSS:'''

<syntaxhighlight lang="css">
body {
background-image: url("YOUR UPLOADED BACKGROUND IMAGE.png");
background-size: cover;
background-repeat: no-repeat;
background-attachment: fixed;
letter-spacing: .3px;
}
h1, h2, h3, h4, h5, h6 {
color: #f98012;
font-weight: normal;
}
.navbar-brand {
display: none;
}
#nav-drawer {
background-color: rgba(236, 238, 239, .9);
}
#page-header.row {
margin-left: -30px;
margin-right: -30px;
}
#page-header .card {
background-color: transparent;
border: none;
margin-bottom: 0;
}
#page-header h1 {
color: #fff;
font-weight: 500;
text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.2);
}
#page-header .breadcrumb {
padding: .50rem 1rem;
}
.block-region .card-block .card-title {
color: #f98012;
font-size: 1.07rem;
font-weight: 400;
}
#page-footer a {
color: #f98012;
}
#page-site-index #page-header {
display:none;
}
#page-site-index #region-main .card.card-block {
padding: 0;
border: 0;
background-color: transparent;
}
#page-site-index #block-region-side-pre {
margin-top: 15px;
}
#page-site-index .label {
padding: 0;
}
#page-site-index .activity > div {
padding: 0;
}
#page-site-index .mod-indent-outer {
padding-left: 0;
}
#page-site-index .contentwithoutlink {
padding-right: 0;
}
.frontpage.container-fluid {
padding: 0;
}
.frontpage .jumbotron {
padding:0;
border-radius:0;
background: transparent no-repeat right bottom / cover;
line-height: 250px;
}
.frontpage .jumbotron .texts {
color: #fff;
letter-spacing: .5px;
background-color: rgba(255, 99, 0, 0.70);
padding: 0 20px;
margin-bottom:20px;
display: inline-block;
vertical-align: bottom;
}
.frontpage .jumbotron h2 {
color: #fff;
font-size: 32px;
font-weight: 300;
text-shadow: 1px 1px 1px #444;
margin-bottom: 0;
margin-top: 10px;
}
.frontpage .jumbotron .lead {
text-shadow: 1px 1px 1px #333;
line-height: 30px;
font-size: 21px;
}
.frontpage .row-fluid {
line-height: 24px;
background-color: #fff;
padding: 10px 20px 20px;
box-sizing: border-box;
}
.frontpage .row-fluid::after {
display: table;
content: "";
clear: both;
line-height: 0;
}
.frontpage .fp-block {
padding: 10px 20px 0;
}
.frontpage h3 {
font-size: 26px;
line-height: 30px;
font-weight: 300;
margin-top: 20px;
margin-bottom: 20px;
}
.frontpage .button {
text-align: right;
}
.empty-region-side-pre.empty-region-side-post #region-main-box,
.empty-region-side-pre.empty-region-side-post #region-main {
width: 100%;
}

#settingsnav.box.block_tree_box.p-y-1 {
padding-top: 0!important;
}</syntaxhighlight>

==Theme selector==

An administrator can set a theme for the site from ''Site administration > Appearance > Themes > Theme selector''.

Go to ''Administration > Site administration > Appearance > Themes > Theme selector''
*Click on the "Select theme" button next to the type you wish to change
*Scroll down to see the previews of the available themes and click on the "Use theme" button to chose the theme
*The next screen will provide information about the theme. Click "Continue"

Note 1: Moodle caches themes so if you don't immediately see changed settings that you were expecting, click the "Clear theme caches" button at the top of the Theme selector page.

Note 2: The selected theme may be overridden if user/course or category themes have been allowed in the [[Theme settings]].

==See also==

* [[Boost theme]]
* [[Classic theme]]
* [[Theme credits]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=189573 What counts as a 'legacy' device type?] forum discussion

[[de:Standard-Designs]]
[[es:Temas estándar]]
[[fr:Thèmes standards]]

H5P activity

2023-09-24T07:09:17Z

Marycooch: /* Student view */

{{Activities}}
__NOTOC__
==What is the H5P activity?==
The H5P activity enables H5P content created in the [[Content bank]], or on the [https://h5p.com/ h5p.com site], or the [https://next.lumi.education/ LUMI] app for desktop, to be easily added to a course as an activity.,

Make sure you download the newly created H5P file on the [https://h5p.com/ h5p.com site] that you will later upload to your Moodle course to be easily added to a course as an activity.

If you are linking to H5P content on another site, such as [https://h5p.com/ h5p.com site], then you need to enter it as an allowed source (Administration -> Plugins -> Filters -> Display H5p -> Allowed sources). Nothing needs to be entered if you are adding H5P content to your course from the content bank or by uploading an H5P package.

{{MediaPlayer | url = https://youtu.be/5_GoXCCDFWg | desc = The H5P activity}}

Note: You can also embed H5P content into any activity or resource, such as a [[Lesson]] or a [[Book]], via the H5P button in the Atto editor, as described in the [[H5P|H5P overview]].

==How is it set up?==
#Ensure that you first have an existing H5P activity to upload, or that you have created one in the [[Content bank]].
#In a course, with the editing turned on, choose 'H5P' from the activity chooser.
#Give it a name and, if needed, a description.
# From Package file > File picker, add your H5P file from the Upload a file link or from the Content bank. '''Note:''' If you add the content as an alias, any modifications will be displayed here but if you add it as a copy, the modified version will not display. For more information see [[Working with files]]
#Expand the other sections to select the settings you want, and then click Save and return to course.

==How does it work?==
===Student view===
Students click on the H5P icon in the course to access it.
[[File:StudentH5Pview.png|center]]
Depending on the H5P activity and the teacher's settings, the activity may be gradeable. Students can see their attempts from the Attempts report link in the H5P settings.
[[File:studentattemptsh5p.png|800px|center]]
In the attempts report, the success column reports when the student has obtained 100% in the activity. The completion column reports whether the student went through the H5P content to the end. (The attempts report only displays data from the H5P content - there is no connection with the 'Grade to pass' activity setting nor with activity completion settings.)

===Teacher view===
Teachers can see all attempts by all users from the Attempts report link. Note the figure refers to the number of attempts, not to the number of students who have attempted the activity.
[[File:TeacherH5Pattemptsreport.png|center]]

==Capabilities==

There are 4 capabilities relating to the H5P activity:

* [[Capabilities/mod/h5pactivity:addinstance|Add a new H5P]] activity to the course
* [[Capabilities/mod/h5pactivity:reviewattempts|Review H5P attempts]]
* [[Capabilities/mod/h5pactivity:submit|Submit H5P attempts]]
* [[Capabilities/mod/h5pactivity:view|View H5P]]

==More information==
* [https://moodle.org/mod/forum/discuss.php?d=446887#p1795902 Add a timer to an H5P activity]
* [[H5P]] for more information on H5P in Moodle, including embedding H5P content.
* [[H5P FAQ]]
* [[H5P migration tool]] for migrating content from the mod_hvp plugin to the H5P activity
* [[H5P essay]] an auto-grading H5P essay question type

[[Category:H5P]]

[[es:Actividad H5P]]
[[de:H5P-Aktivität]]

File:studentattemptsh5p.png

2023-09-24T07:08:40Z

Marycooch:

H5P activity

2023-09-24T07:08:27Z

Marycooch: /* Student view */

{{Activities}}
__NOTOC__
==What is the H5P activity?==
The H5P activity enables H5P content created in the [[Content bank]], or on the [https://h5p.com/ h5p.com site], or the [https://next.lumi.education/ LUMI] app for desktop, to be easily added to a course as an activity.,

Make sure you download the newly created H5P file on the [https://h5p.com/ h5p.com site] that you will later upload to your Moodle course to be easily added to a course as an activity.

If you are linking to H5P content on another site, such as [https://h5p.com/ h5p.com site], then you need to enter it as an allowed source (Administration -> Plugins -> Filters -> Display H5p -> Allowed sources). Nothing needs to be entered if you are adding H5P content to your course from the content bank or by uploading an H5P package.

{{MediaPlayer | url = https://youtu.be/5_GoXCCDFWg | desc = The H5P activity}}

Note: You can also embed H5P content into any activity or resource, such as a [[Lesson]] or a [[Book]], via the H5P button in the Atto editor, as described in the [[H5P|H5P overview]].

==How is it set up?==
#Ensure that you first have an existing H5P activity to upload, or that you have created one in the [[Content bank]].
#In a course, with the editing turned on, choose 'H5P' from the activity chooser.
#Give it a name and, if needed, a description.
# From Package file > File picker, add your H5P file from the Upload a file link or from the Content bank. '''Note:''' If you add the content as an alias, any modifications will be displayed here but if you add it as a copy, the modified version will not display. For more information see [[Working with files]]
#Expand the other sections to select the settings you want, and then click Save and return to course.

==How does it work?==
===Student view===
Students click on the H5P icon in the course to access it.
[[File:StudentH5Pview.png|center]]
Depending on the H5P activity and teacher's settings, the activity may be gradeable. Students can see their attempts from the Attempts report link in the H5P settings.
[[File:studentattemptsh5p.png|800px|center]]
In the attempts report, the success column reports when the student has obtained 100% in the activity. The completion column reports whether the student went through the H5P content to the end. (The attempts report only displays data from the H5P content - there is no connection with the 'Grade to pass' activity setting nor with activity completion settings.)

===Teacher view===
Teachers can see all attempts by all users from the Attempts report link. Note the figure refers to the number of attempts, not to the number of students who have attempted the activity.
[[File:TeacherH5Pattemptsreport.png|center]]

==Capabilities==

There are 4 capabilities relating to the H5P activity:

* [[Capabilities/mod/h5pactivity:addinstance|Add a new H5P]] activity to the course
* [[Capabilities/mod/h5pactivity:reviewattempts|Review H5P attempts]]
* [[Capabilities/mod/h5pactivity:submit|Submit H5P attempts]]
* [[Capabilities/mod/h5pactivity:view|View H5P]]

==More information==
* [https://moodle.org/mod/forum/discuss.php?d=446887#p1795902 Add a timer to an H5P activity]
* [[H5P]] for more information on H5P in Moodle, including embedding H5P content.
* [[H5P FAQ]]
* [[H5P migration tool]] for migrating content from the mod_hvp plugin to the H5P activity
* [[H5P essay]] an auto-grading H5P essay question type

[[Category:H5P]]

[[es:Actividad H5P]]
[[de:H5P-Aktivität]]

H5P activity

2023-09-24T07:01:06Z

Marycooch: /* Teacher view */

{{Activities}}
__NOTOC__
==What is the H5P activity?==
The H5P activity enables H5P content created in the [[Content bank]], or on the [https://h5p.com/ h5p.com site], or the [https://next.lumi.education/ LUMI] app for desktop, to be easily added to a course as an activity.,

Make sure you download the newly created H5P file on the [https://h5p.com/ h5p.com site] that you will later upload to your Moodle course to be easily added to a course as an activity.

If you are linking to H5P content on another site, such as [https://h5p.com/ h5p.com site], then you need to enter it as an allowed source (Administration -> Plugins -> Filters -> Display H5p -> Allowed sources). Nothing needs to be entered if you are adding H5P content to your course from the content bank or by uploading an H5P package.

{{MediaPlayer | url = https://youtu.be/5_GoXCCDFWg | desc = The H5P activity}}

Note: You can also embed H5P content into any activity or resource, such as a [[Lesson]] or a [[Book]], via the H5P button in the Atto editor, as described in the [[H5P|H5P overview]].

==How is it set up?==
#Ensure that you first have an existing H5P activity to upload, or that you have created one in the [[Content bank]].
#In a course, with the editing turned on, choose 'H5P' from the activity chooser.
#Give it a name and, if needed, a description.
# From Package file > File picker, add your H5P file from the Upload a file link or from the Content bank. '''Note:''' If you add the content as an alias, any modifications will be displayed here but if you add it as a copy, the modified version will not display. For more information see [[Working with files]]
#Expand the other sections to select the settings you want, and then click Save and return to course.

==How does it work?==
===Student view===
Students click on the H5P icon in the course to access it.
[[File:StudentH5Pview.png|center]]
Depending on the H5P activity and teacher's settings, the activity may be gradeable. Students can see their attempts from the Attempts report link in the H5P settings.
[[File:StudentH5PScore.png|center]]
In the attempts report, the success column reports when the student has obtained 100% in the activity. The completion column reports whether the student went through the H5P content to the end. (The attempts report only displays data from the H5P content - there is no connection with the 'Grade to pass' activity setting nor with activity completion settings.)

===Teacher view===
Teachers can see all attempts by all users from the Attempts report link. Note the figure refers to the number of attempts, not to the number of students who have attempted the activity.
[[File:TeacherH5Pattemptsreport.png|center]]

==Capabilities==

There are 4 capabilities relating to the H5P activity:

* [[Capabilities/mod/h5pactivity:addinstance|Add a new H5P]] activity to the course
* [[Capabilities/mod/h5pactivity:reviewattempts|Review H5P attempts]]
* [[Capabilities/mod/h5pactivity:submit|Submit H5P attempts]]
* [[Capabilities/mod/h5pactivity:view|View H5P]]

==More information==
* [https://moodle.org/mod/forum/discuss.php?d=446887#p1795902 Add a timer to an H5P activity]
* [[H5P]] for more information on H5P in Moodle, including embedding H5P content.
* [[H5P FAQ]]
* [[H5P migration tool]] for migrating content from the mod_hvp plugin to the H5P activity
* [[H5P essay]] an auto-grading H5P essay question type

[[Category:H5P]]

[[es:Actividad H5P]]
[[de:H5P-Aktivität]]

File:TeacherH5Pattemptsreport.png

2023-09-24T07:00:00Z

Marycooch:

H5P activity

2023-09-24T06:59:44Z

Marycooch:

{{Activities}}
__NOTOC__
==What is the H5P activity?==
The H5P activity enables H5P content created in the [[Content bank]], or on the [https://h5p.com/ h5p.com site], or the [https://next.lumi.education/ LUMI] app for desktop, to be easily added to a course as an activity.,

Make sure you download the newly created H5P file on the [https://h5p.com/ h5p.com site] that you will later upload to your Moodle course to be easily added to a course as an activity.

If you are linking to H5P content on another site, such as [https://h5p.com/ h5p.com site], then you need to enter it as an allowed source (Administration -> Plugins -> Filters -> Display H5p -> Allowed sources). Nothing needs to be entered if you are adding H5P content to your course from the content bank or by uploading an H5P package.

{{MediaPlayer | url = https://youtu.be/5_GoXCCDFWg | desc = The H5P activity}}

Note: You can also embed H5P content into any activity or resource, such as a [[Lesson]] or a [[Book]], via the H5P button in the Atto editor, as described in the [[H5P|H5P overview]].

==How is it set up?==
#Ensure that you first have an existing H5P activity to upload, or that you have created one in the [[Content bank]].
#In a course, with the editing turned on, choose 'H5P' from the activity chooser.
#Give it a name and, if needed, a description.
# From Package file > File picker, add your H5P file from the Upload a file link or from the Content bank. '''Note:''' If you add the content as an alias, any modifications will be displayed here but if you add it as a copy, the modified version will not display. For more information see [[Working with files]]
#Expand the other sections to select the settings you want, and then click Save and return to course.

==How does it work?==
===Student view===
Students click on the H5P icon in the course to access it.
[[File:StudentH5Pview.png|center]]
Depending on the H5P activity and teacher's settings, the activity may be gradeable. Students can see their attempts from the Attempts report link in the H5P settings.
[[File:StudentH5PScore.png|center]]
In the attempts report, the success column reports when the student has obtained 100% in the activity. The completion column reports whether the student went through the H5P content to the end. (The attempts report only displays data from the H5P content - there is no connection with the 'Grade to pass' activity setting nor with activity completion settings.)

===Teacher view===
Teachers can see all attempts by all users from the Attempts report link. Note that the figure refers to the number of attempts, not to the number of students who have attempted the activity.
[[File:TeacherH5Pattemptsreport.png|center]]

==Capabilities==

There are 4 capabilities relating to the H5P activity:

* [[Capabilities/mod/h5pactivity:addinstance|Add a new H5P]] activity to the course
* [[Capabilities/mod/h5pactivity:reviewattempts|Review H5P attempts]]
* [[Capabilities/mod/h5pactivity:submit|Submit H5P attempts]]
* [[Capabilities/mod/h5pactivity:view|View H5P]]

==More information==
* [https://moodle.org/mod/forum/discuss.php?d=446887#p1795902 Add a timer to an H5P activity]
* [[H5P]] for more information on H5P in Moodle, including embedding H5P content.
* [[H5P FAQ]]
* [[H5P migration tool]] for migrating content from the mod_hvp plugin to the H5P activity
* [[H5P essay]] an auto-grading H5P essay question type

[[Category:H5P]]

[[es:Actividad H5P]]
[[de:H5P-Aktivität]]

New for mobile

2023-09-11T18:24:34Z

Marycooch:

{{Mobile}}

For information about the App, see the [https://moodledev.io/general/app_releases Moodle App release notes]

[[Category:New features]]
[[es:Nuevo para mobile]]
[[de:Moodle App - Neuigkeiten]]
[[fr:Fonctionnalités additionnelles de l'app Moodle]]
[[pt-br:Novo para dispositivos móveis]]

Creating mobile-friendly courses

2023-09-01T16:09:19Z

Marycooch: updates re blocks and App course

{{Mobile}}
As more and more students access courses from their smartphones, tablets or other mobile devices, it is increasingly important to ensure your courses are mobile-friendly.

Encouraging students to install the [https://download.moodle.org/mobile/ official Moodle mobile app] is one way to improve their learning experience. Below are some suggestions for optimising your course materials for students both using the app and accessing Moodle from mobile devices.
==Setting up your course==
*Topics or weekly course format is best suited to mobile devices. In topics format, the first section or the highlighted section is shown by default in the app. In weekly format, the current week is shown.
*Don't use orphaned activities or direct links to activities (the links will work but is not the best experience for mobile).
*Blocks are collapsed by default and can be expanded by clicking the arrow-like tab on the right.
*If you have a mix of students accessing the course on mobile and desktop, consider asking your admin to install the [[Moodle Mobile availability plugin]] which restricts items to desktop or mobile users.
==Course content==
*Use responsive HTML in pages.
*Use a [[Page]] or [[Book]] instead of downloadable documents where possible.
*Avoid uploading many documents or having numerous, text heavy pages. Think more in terms of short "information-bytes".
*If you include YouTube videos, keep them short and consider providing them for download and offline viewing in a [[Folder resource|folder]]. Not all video formats are supported so add them in different formats. (MP4 is probably the most widely accepted format.)
* For YouTube or Vimeo videos, you may use Bootstrap responsive classes: https://getbootstrap.com/docs/4.0/utilities/embed/, for example:
<pre><div class="embed-responsive"><video...</pre>
*Note that drag and drop questions behave differently in the app. You can't drag images, you need to tap to select and tap to drop.
*Note that if you add YouTube video links or map links as URL resources, they will open automatically in the app.
{|
| [[File:moodlemobile_short_text_intro.png|thumb|Short text for label]]
| [[File:moodlemobile_responsive_html.png|thumb|Responsive HTML]]
| [[File:moodlemobile_youtube_maps_links.png|thumb|Map link]]
|}
* Use only plugins with mobile app support so they can be accessed via the mobile app - see [https://moodle.org/plugins/browse.php?list=award&id=6 Moodle plugins directory: Award: mobile app support].
* If you want to include large audio files in your course, consider including them embedded in a label or page rather than as a file resource. The reason is that embedded files will play even if the screen is locked but files won't play with the screen locked.
===Media download for offline usage===
To enable media files, such as video, to be automatically downloaded when viewed.
* The file must be uploaded to the course, rather than being linked to (from YouTube, Vimeo etc.)
* The file must be small - less than 2MB for 3G users or less than 20MB for WiFi users
When a page containing the video is viewed (without playing the video), the file will then be downloaded.

When using Moodle Mobile 3.1 or later with a WiFi connection, when the video is played, the file will be downloaded in the background. The next time the video is played, the downloaded file will be used.

Please note that if the user did a full download of the courses, the files will be downloaded regardless its size.

===Offline activities===
All the supported activities work offline, although some require specific settings like the lesson and quiz module, you can find bellow additional information:
* [[Moodle Mobile quiz offline attempts]]
* [[Moodle app H5P support#Working offline|Moodle H5P]]
* [[Moodle app SCORM player]]
=== Things to avoid===
Some activities are not yet fully supported by the mobile app, so find alternatives. See [[Moodle Mobile SCORM player]] for things to avoid in SCORM packages.

You can find the list of activities supported by the app in the [[Moodle Mobile features]] page.
==Use the latest stable version of Moodle==
As indicated in [[Moodle Mobile features]] some features are only available in recent Moodle versions.

It is recommended to use the latest stable version or, if is not possible to upgrade your site, install the [[Moodle Mobile additional features]] plugin.
==Notifications and messages==
Encourage your students to enable mobile notifications so they are alerted about calendar events, forum posts, messages, assignment submissions and so on. Find out more in [[Mobile app notifications]].

You can also enable mobile notifications for all the users by default via the [[Messaging settings]] default message outputs. Students can disable Mobile notifications within the app.
==Mobile device considerations==
The app works better on devices running
* Android 5.1 onwards
* iOs 11 onwards
In old devices you may find problems related to:
* User interface
* Connection problems (specifically when connecting to sites using https certificates)
* Slowness
The first version of the app was supported in Windows Phone and Windows 7. This version is not supported any more and it was withdrawn from the Windows Store. Its usage is not advised.

==Links to open the Moodle app==
If required, links which open the Moodle app may be provided in the course (for users browsing the site using a mobile device with the app installed).

Links are of the form <code>moodlemobile://https://username@domain.com?token=TOKEN&privatetoken=PRIVATETOKEN&redirect=http://domain.com/course/view.php?id=2</code>.<br />
Please notice that this kind of links are only supported in Moodle app 3.7.0 onwards. If your app has an older version you'll have to use the old format: <code>moodlemobile://link=https://yourmoodlesite.org/mod/...</code>.

For more information about this, please read [https://docs.moodle.org/dev/Open_the_Moodle_app_from_another_app Open the Moodle app from another app].
==Learn more==
* Free course on Moodle Academy [https://moodle.academy/enrol/index.php?id=100 Moodle App configuration]
* Forum post: [https://moodle.org/mod/forum/discuss.php?d=349160 Try the Moodle Mobile app with a mobile-friendly course].
* [https://docs.moodle.org/dev/Creating_mobile_question_types How to make third party question types work in Mobile] documentation for developers
[[de:Moodle Mobile - Websites optimieren]]
[[es:Crear sitios amistosos para Moodle Mobile]]
[[fr:Créer des cours pour appareils mobiles]]

OAuth 2 services

2023-09-01T10:57:10Z

Marycooch: /* Login domains */

{{Server settings}}
==OAuth2 services==
* Moodle supports OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
* OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like [[Google Drive repository|Google Drive]] and [[OneDrive repository|OneDrive]] without having to re-authenticate.
* OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.
== Login ==
See [[OAuth 2 authentication]] for details of how to enable the feature.
== Open ID Connect ==
Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.
== Issuer Configuration ==
First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".
To configure OAuth 2 services, go to '''Site administration > Server > Server > OAuth 2 services'''.
[[File:OAuth - Services.png|border|center|frameless|900x900px|

]]At the bottom, you can see all supported service providers. Select the respective button to add a preconfigured service, which will direct you to the form to create a new service. The service specifications are already populated – all you must do is add the '''Client ID''' and the '''Client secret''' details of the respective service provider.

=== How do I get a client ID and secret? ===
The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.
* [[OAuth 2 Google service]]
* [[OAuth 2 Microsoft service]]
* [[OAuth 2 Facebook service]]
* [[OAuth 2 Nextcloud service]]
* [[OAuth 2 MoodleNet service]]
* [[OAuth 2 Open Badges service]]
* [[OAuth 2 LinkedIn service]]
* [[OAuth 2 Clever service]]

For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is '''<wwwroot>/admin/oauth2callback.php''', e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.

=== Adding an issuer ===
If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on.

Choose from the list, then the following settings appear:

[[Image:OAuthservicesGoogle.png|frame|center|Issuer settings]]
As a general rule, don't change any settings, except for '''Name''', '''Client ID''', '''Client Secret''', and '''Service Base URL''', unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services.
See [[#Advanced_issuer_settings|Advanced issuer settings (below)]] for explanations of some of the settings.
====Login domains====

Optionally, add here a comma separated list of domains that logins will be restricted to when using this provider.

This restriction will apply on top of the allowed and denied email domains settings in [[Managing_authentication|Manage authentication]], however the latter are only checked when a user is created and are not checked again when the user logs in.

====Further configuration options====
After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.
[[Image:OAuth2-issuer-other-settings.png|frame|center|Further configuration options for OAuth 2 issuers]]
; Edit : Go to the settings screen again.
; Configure endpoints : Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: '''authorization_endpoint''', '''token_endpoint''' and '''userinfo_endpoint'''. (Example image below).
; Configure user field mappings : If you use the issuer as an identity provider, you can configure how the provider's response (from the '''userinfo_endpoint''') should be mapped to Moodle user fields. You should set up mappings for internal field names '''firstname''', '''lastname''' and '''email''' so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their [[Edit profile]] page and prompted for the missing information. (Example image below).
; Delete : Delete the issuer configuration.
; Disable : Mark the issuer as disabled; plugins may not use them.
; Move up / down : Change the order that services are listed on the login page.
[[File:endpoints.png|frame|center|Example endpoints for a custom service]][[File:user_field_mappings.png|frame|center|Example user field mappings]]

=== Connecting a system account ===
A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the [[Nextcloud repository]], [[Google Drive repository]] or [[OneDrive repository]].
[[File:connecting a system account.png|frame|center|Connecting a system account]]
To connect to a system account, click the Connect icon (half open box with arrow), then select the appropriate account.

The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it. A system account is not needed for login functionality.
[[File:errorsNotification.png|thumb|right|Notification preferences page]]
==== Refreshing Access Token ====
There is a scheduled task to regularly update the OAuth token for service accounts, ''Refresh OAuth tokens for service accounts'' (''\core\oauth2\refresh_system_tokens_task''). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.

If an admin user does not wish to receive these notifications, it can be set up on the [[Notifications|Notification preferences]] page. The notification option to deactivate is ''Important errors with the site''.

'''Caution''': A user who turns off the ''Important errors with the site'' notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider ''errors''.
Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.
=== Advanced issuer settings ===
; Authenticate token requests via HTTP headers : This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.
==See also==
* [[OAuth 2 authentication]]
* [[OAuth 2 Troubleshooting]]
* [https://moodle.org/mod/forum/discuss.php?d=351727 Oauth2 problems in Moodle 3.3] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=362593 Problem to configure Oauth2 with Microsoft Office365] forum discussion
[[Category:OAuth 2]]
[[es:Servicios OAuth 2]]
[[de:OAuth2 Services]]

OAuth 2 services

2023-09-01T10:51:01Z

Marycooch: updated image

{{Server settings}}
==OAuth2 services==
* Moodle supports OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
* OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like [[Google Drive repository|Google Drive]] and [[OneDrive repository|OneDrive]] without having to re-authenticate.
* OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.
== Login ==
See [[OAuth 2 authentication]] for details of how to enable the feature.
== Open ID Connect ==
Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.
== Issuer Configuration ==
First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".
To configure OAuth 2 services, go to '''Site administration > Server > Server > OAuth 2 services'''.
[[File:OAuth - Services.png|border|center|frameless|900x900px|

]]At the bottom, you can see all supported service providers. Select the respective button to add a preconfigured service, which will direct you to the form to create a new service. The service specifications are already populated – all you must do is add the '''Client ID''' and the '''Client secret''' details of the respective service provider.

=== How do I get a client ID and secret? ===
The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.
* [[OAuth 2 Google service]]
* [[OAuth 2 Microsoft service]]
* [[OAuth 2 Facebook service]]
* [[OAuth 2 Nextcloud service]]
* [[OAuth 2 MoodleNet service]]
* [[OAuth 2 Open Badges service]]
* [[OAuth 2 LinkedIn service]]
* [[OAuth 2 Clever service]]

For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is '''<wwwroot>/admin/oauth2callback.php''', e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.

=== Adding an issuer ===
If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on.

Choose from the list, then the following settings appear:

[[Image:OAuthservicesGoogle.png|frame|center|Issuer settings]]
As a general rule, don't change any settings, except for '''Name''', '''Client ID''', '''Client Secret''', and '''Service Base URL''', unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services.
See [[#Advanced_issuer_settings|Advanced issuer settings (below)]] for explanations of some of the settings.
====Login domains====
This setting only applies if "Show on login page" is checked. If specified, only users with matching emails will be able to sign-up and log in using this service.

This restriction will apply on top of the allowed and denied email domains settings in [[Managing_authentication|Manage authentication]], however the latter are only checked when a user is created and are not checked again when the user logs in.
====Further configuration options====
After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.
[[Image:OAuth2-issuer-other-settings.png|frame|center|Further configuration options for OAuth 2 issuers]]
; Edit : Go to the settings screen again.
; Configure endpoints : Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: '''authorization_endpoint''', '''token_endpoint''' and '''userinfo_endpoint'''. (Example image below).
; Configure user field mappings : If you use the issuer as an identity provider, you can configure how the provider's response (from the '''userinfo_endpoint''') should be mapped to Moodle user fields. You should set up mappings for internal field names '''firstname''', '''lastname''' and '''email''' so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their [[Edit profile]] page and prompted for the missing information. (Example image below).
; Delete : Delete the issuer configuration.
; Disable : Mark the issuer as disabled; plugins may not use them.
; Move up / down : Change the order that services are listed on the login page.
[[File:endpoints.png|frame|center|Example endpoints for a custom service]][[File:user_field_mappings.png|frame|center|Example user field mappings]]

=== Connecting a system account ===
A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the [[Nextcloud repository]], [[Google Drive repository]] or [[OneDrive repository]].
[[File:connecting a system account.png|frame|center|Connecting a system account]]
To connect to a system account, click the Connect icon (half open box with arrow), then select the appropriate account.

The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it. A system account is not needed for login functionality.
[[File:errorsNotification.png|thumb|right|Notification preferences page]]
==== Refreshing Access Token ====
There is a scheduled task to regularly update the OAuth token for service accounts, ''Refresh OAuth tokens for service accounts'' (''\core\oauth2\refresh_system_tokens_task''). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.

If an admin user does not wish to receive these notifications, it can be set up on the [[Notifications|Notification preferences]] page. The notification option to deactivate is ''Important errors with the site''.

'''Caution''': A user who turns off the ''Important errors with the site'' notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider ''errors''.
Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.
=== Advanced issuer settings ===
; Authenticate token requests via HTTP headers : This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.
==See also==
* [[OAuth 2 authentication]]
* [[OAuth 2 Troubleshooting]]
* [https://moodle.org/mod/forum/discuss.php?d=351727 Oauth2 problems in Moodle 3.3] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=362593 Problem to configure Oauth2 with Microsoft Office365] forum discussion
[[Category:OAuth 2]]
[[es:Servicios OAuth 2]]
[[de:OAuth2 Services]]

File:OAuthservicesGoogle.png

2023-09-01T10:49:53Z

Marycooch:

Issuer settings

Analytics quick guide

2023-08-31T08:48:16Z

Marycooch: added Update template

{{Analytics}}
{{Update}}

This quick guide is intended to introduce teachers to Moodle [[Analytics]].

== Overview ==
If your Moodle site administrator has enabled Analytics, you may receive special notifications called "insights" sent by learning analytics models.
[[File:insight_notifications_38.png|frame|center|Insight notifications]]

These will vary based on the models enabled on your site. Insights may be predictions about future performance or may detect current, hidden aspects or processes of learning. They may apply to students, courses, cohorts, or any other entity in Moodle. One model that is included with Moodle core is [[Students at risk of dropping out]], which makes predictions about the performance of all students enrolled in current courses (those with a start date in the past and an end date in the future). The system is flexible and allows the creation of many other types of models, as well. Each model is defined around one target. See [[Learning analytics targets]] for more details.

== View Insights ==
Models will start generating predictions at different points in time, depending on the site prediction models and details like the course start and end dates.

Each model defines which samples (e.g. student enrolments) will generate insights and which samples will be ignored. For example, the [Students at risk of dropping out]] prediction model does not generate an insight if a student is predicted as "not at risk," since the primary interest is which students are at risk of dropping out of courses, not which students are not at risk.

Users can specify how they wish to receive insights notifications, or turn them off, via their User menu > Preferences > Notification preferences.
[[File:insight_notification_settings.png|thumb|left|Insight notification settings]]
<br clear=all>
To access insights as a teacher, go to an ongoing course and access Course administration > Reports > Insights

<gallery>
File:course_admin_menu_more.png|Course administration menu
File:course_insights_report.png|Reports tab
</gallery>

A user with the tool/inspire:listinsights capability in the context of the model will also automatically receive notifications when new predictions are available for them. In this case, Course teachers will receive a notification about their students at risk of dropping out.

[[File:insight_notifications_38.png|frame|center|Insight notifications]]

Notifications may contain a list of insights or may consist of a single insight directed to a specific user. Click the notification text to see details:
[[File:insight_list_38.png|thumb|center|View insights]]

Click "View full notification" to see the text of the insight message:
[[File:teacher_notification.png|thumb|center|View full notification]]

== Prediction details ==
[[File:prediction_details_38.png|thumb|Prediction details]]
The prediction details show which of the indicator values were used in the prediction, and what the student's values for those indicators are. Indicator calculated values that are low and are affecting the prediction are highlighted.

Each model can contain different indicators. These are included in the calculations of the model target. For more information, see [[Learning analytics indicators]].

== Actions==

Each insight can have one or more actions defined. Actions provide a way to act on the insight as it is read. These actions may include a way to send a message to another user, a link to a report providing information about the sample the prediction has been generated for (e.g. a report for an existing student), or a way to view the details of the model prediction.

In the [[Students at risk of dropping out]] prediction model, the teacher can send a message to each student included in the Insights list, view the student's Outline report for the Course, or view Prediction details.

The teacher can also simply acknowledge the Insight or can mark the insight as Not applicable. Both of these options will remove the Insight from the list of current predictions. This data can be incorporated into the model in the future to help improve model quality.

[[Image:insights_actions_38.png|thumb|right|Insights and Actions]]

Insights can also offer two important general actions that are applicable to all insights. First, the user can acknowledge the insight by clicking "Accept". This removes that particular prediction from the view of the user, e.g. a notification about a particular student at risk is removed from the display.

The second general action is to mark the insight as "Not applicable." This also removes the insight associated with this calculation from the display, but the model is adjusted to make this prediction less likely in the future.

[[Category:Quick guide]]
[[Category:Analytics]]

[[es:Guía rápida de analítica del aprendizaje]]
[[de:Analytics-Kurzanleitung]]

Upload users

2023-08-31T08:39:16Z

Marycooch: /* Optional user fields */

{{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]] 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/UCuOOGD7XPI| 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 (e.g., [https://notepad-plus-plus.org/ Notepad++]) for verification.
===Valid upload file for testing===
*From Site administration / Users / Upload users, an example text (example.csv) file is available. It can be downloaded and adapted to your needs. It includes:

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, e.g. AU,ES,GB,US. These are all UPPER CASE. Using "au" or "es" or "USA" as a country code will result in a database error. If you are having trouble working out the two-letter code for a country, you can consult the list of [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 letter) code as defined in the Moodle language packs, e.g. en, es, en_us, de, in ''Site administration > Language > Language packs''.

'''auth''' - The auth field must be used if the site uses an alternative authentication method, such as LDAP, as otherwise the authentication method will default to manual and users using a different auth method won't be able to log in.
Use the shortname codes defined in Plugins > Authentication for the various types, e.g. manual, nlogin, ldap, cas, mnet, db, none. If you do not include an auth column, then newly created users will be created with the manual account type.

You can set "auth" to "nologin" in your csv file which will mean that then created users cannot login.

'''timezone''' - Should be in the format as found in the Location settings in terms of Zone/Region, e.g. Australia/Sydney, Asia/Kathmandu, Europe/Madrid, etc. The entry is case sensitive so Europe/London will work but europe/london will not.

NOTE: Needed: settings for '''mailformat''','''maildisplay''','''htmleditor''','''autosubscribe'''

'''maildigest''' To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

'''maildisplay''' allows you to set the email display option for a user. The options for this field are 0 = Hide my email address from non-privileged users, 1 = Allow everyone to see my email address and 2 = Allow only other course members to see my email address.

'''emailstop''' allows you to prevent notifications. The options for this field are 0 = no notifications and 1 = allow notifications.

'''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, e.g. 2014-06-19 which will then be properly localized in the interfaced. For example, a field called dohire for date of hire, the fields could be:
<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. E.g.
<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 successful enrolment. All the others are optional.

'''type#''' sets the role to be used for the enrolment. A value of 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.

'''role#''' may be used to specify roles directly, using either role short name or the role id (numeric names of roles are not supported). Usually you will use the role name that is the shortname of the role as defined in Users > Permissions > Define roles, e.g. student, editingteacher. If the role column is left out, the users will be enroled in the course with the default role, which is normally student.

'''group#''' may be used to assign users to groups in course, using name or id (numeric group names are not supported). NOTE: if the group does not already exist, it will be created.

'''enroltimestart#''' may be used to set the enrolment start time, for each course. If not explicitly set here, the enrolment start time is set to be today. To set a date: "2021-02-15" and to set a date and time "2021-02-15 15:30"

'''enrolperiod#''' may be used to set the enrolment duration, in days, for each course. If not explicitly set here, all the users will get the duration as set in the Manual enrolment method of the course (which defaults to 0 meaning unlimited.)

'''enrolstatus#''' is optional as by default all newly enrolled users are set to active. If used a value of 1, it will suspend users in the course and if a user is previously set as inactive / suspended then a value of 0 will unsuspend them and make them active again.
=== Cohort membership assignment===
You can assign users to any already existing Cohort by using only the "username" and the "Cohort ID" with just two fields in the file. Note that this is an exception to the usual case where the firstname, lastname and email address of the user are required.

'''cohort#''' is the form to use and like enrolment in courses, you have to add a number to each header, so cohort1,cohort2, etc.

Internal cohort ID numbers or non-numeric Cohort IDs of existing cohorts must be used; do not use the full name as this is not allowed. (Note that cohort ID is what is usually known elsewhere as the "shortname".)

Here is a sample CSV file:
<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 file and leaves the existing user account data unchanged.
;Override with file : overwrites data in the existing user account with the data provided in the uploaded file.
;Override with file and defaults : overwrites data in the existing user account with data provided in the uploaded file and fills in the default values for existing user details when no data is provided in the uploaded file.
;Fill in missing from file and defaults : adds data in the existing user account with data provided in the uploaded file if the field is empty (does not already contain data) and fills in the default values for existing user details when no data is provided in the uploaded file.
====Existing user password====
The Existing user password option appears when you you have set the "Existing user details" setting to "Overwrite with file". It specifies how to handle password data for existing user accounts, to change them or leave them as it. This is a bit of insurance to make sure that you really want to mass change user passwords.
;No changes : ignores password field in the uploaded user file and leaves the existing user account password untouched
;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.

====Match on email address====
This option allows you to optionally match users by emails when uploading them if allowaccountssameemail is set to no.

====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 '''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 '''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 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,profile_field_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).
==Upload users via CLI==
In Moodle 3.10 onwards, an administrator can upload users via a CLI script.

To obtain instructions on how to use the script, in the command line from the moodle directory run
php admin/tool/uploaduser/cli/uploaduser.php --help
== 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]]