MoodleDocs - User contributions [en]

Database activity settings

2024-03-27T15:26:27Z

Juliaverdaguer: /* Availability */ updating this to add some more context to the dates

{{Database}}
This page explores in more detail the settings for the [[Database activity]] once you have added it to your course and also covers the Site administration settings.

==General==
In the Description, provide instructions for students. Check the box if you want these instructions to display on the course page.

==Entries==
;Approval required?
:If set to "yes", the entry will only be visible to everyone once a teacher has checked and approved it
:Entries waiting for approval can be shown as highlighted to the teacher and also to the user who added the entry (new in Moodle 3.0).
:If approval required is set to "yes", the teacher can choose whether approved entries can still be edited or not.
:Allow comments on entries===
:If set to "yes", users will be able to comment on database entries.
;Entries required before viewing===
:Select here how many entries you wish the student to add before they are allowed to see entries by other people. ''Note'': If entries are required before viewing, the database auto-linking filter should be disabled. This is because the database auto-linking filter can't determine whether a user has submitted the required number of entries.
:Maximum number of entries===
:Select here the maximum number of entries you wish students to make.
==Availability==
Availability dates allow you to specify when the database will be available for students to view and contribute to.

If you want to define a period when students can view entries in the database but can't add their own, you can do it with the Read only dates.

If you set both Availability and Read only dates, the Availability settings override the Read only. So if a database has 'read only' from 1st January, and 'available from' 1st February, students will not be able to view its content during January.
==Ratings==
If you enable [[Ratings]] then a Scale dropdown will appear, Grade category and Grade to pass. The Grade to pass may be connected with [[Activity completion]] and [[Restrict access]] to prevent students accessing the next activity until they have reached the required grade in the database activity.
==RSS==
This is disabled by default and only visible if RSS is enabled site wide.
==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]]

==Save and display==
Once you have specified the settings for your database, see [[Building Database]] for help configuring the fields.

==Site administration settings==

Database activity defaults and additional settings may changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Database''.

==Database activity capabilities==

*[[Capabilities/mod/data:approve|Approve unapproved entries]]
*[[Capabilities/mod/data:comment|Write comments]]
*[[Capabilities/mod/data:exportallentries|Export all database entries]]
*[[Capabilities/mod/data:exportentry|Export a database entry]]
*[[Capabilities/mod/data:exportownentry|Export own database entry]]
*[[Capabilities/mod/data:managecomments|Manage database activity comments]]
*[[Capabilities/mod/data:manageentries|Manage database activity entries]]
*[[Capabilities/mod/data:managetemplates|Manage templates]]
*[[Capabilities/mod/data:manageuserpresets|Manage all template presets]]
*[[Capabilities/mod/data:rate|Rate entries]]
*[[Capabilities/mod/data:viewallratings|View all raw ratings given by individuals]]
*[[Capabilities/mod/data:viewalluserpresets|View presets from all users]]
*[[Capabilities/mod/data:viewanyrating|View total ratings that anyone received]]
*[[Capabilities/mod/data:viewentry|View entries]]
*[[Capabilities/mod/data:viewrating|View the total rating you received]]
*[[Capabilities/mod/data:writeentry|Write entries]]
*[[Capabilities/mod/data:addinstance|Add a new database activity]]

[[de:Datenbank konfigurieren]]
[[fr:Paramètres de la base de données]]
[[ja:データベースの追加/編集]]
[[es:Configuraciones de actividad BasedeDatos]]

TinyMCE editor

2024-03-08T12:38:58Z

Juliaverdaguer:

{{Editing text}}
==What is TinyMCE?==
TinyMCE is a powerful rich-text editor that allows users to create formatted content within a user-friendly interface.

The popular editor is the default editor in new installations of Moodle 4.2 onwards and can be made default in upgraded sites from ''Administration > Site administration > Plugins > Text editors > Manage editors''.

If enabled, users may select the '''TinyMCE editor''' from the ''User menu > Preferences > Editor preferences.''
{{MediaPlayer | url = https://youtu.be/Q-D6nWSusrY | desc = Overview of TinyMCE}}

== Tiny Toolbar ==
The following buttons are available on the toolbar (not all buttons might show in all scenarios:)
[[File:latestTiny.png|center]]

The available buttons are as follows:
{| class="wikitable"
|+
!#
!Button
!#
!Button
!#
!Button
|-
|1
|Undo and Redo
|10
|No auto-link NEW IN 4.3
|18
|Numbered list
|-
|2
|Bold and Italic
|11
|Full screen NEW IN 4.3
|19
|Equation editor
|-
|3
|Insert image/modify properties
|12
|Align left
|20
|Toggle second toolbar (if present)
|-
|4
|Insert audio/video/modify properties
|13
|Align centre
|21
|
|-
|5
|[[Audio|Record audio]]
|14
|Align right
|
|
|-
|6
|[[Video|Record video]]
|15
|L/R and R/L directionality
|
|
|-
|7
|Insert H5P / modify H5P properties
|16
|Decrease/increase indent
|
|
|-
|8
|Link
|17
|Bullets list
|
|
|-
|9
|Unlink
|
|
|
|
|}
Some button have pre-requisites to display, for instance, the equation editor button will only show if either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Site administration > Plugins > Filters > Manage filters''), while the H5P option will only show if the ''tiny/h5p:addembed'' capability has been granted.

== Tiny features ==
[[File:Tiny - Insert menu.png|thumb]]
The following features are available from the '''Insert''' menu:
=== Insert / Edit image ===
The easiest way to insert an image is via drag'n'drop. Alternatively, you can use the ''Insert image'' tool, which gives you more control over some image properties:
* '''URL''': The (internal or external) address of the image. You can either enter a URL manually or select an image from the repository browser, which adds the URL automatically.
*'''Description''': Unless the image is labelled decorative only, a description must be provided for screenreader users
*'''Size''': Initially, the image's width and height are set. These can be adjusted to fit your text. When the ''Auto size'' checkbox remains ticked, the image's width-height ratio stays intact.
* '''Alignment''': Options are ''Top'', ''Middle'', and ''Bottom''.
[[File:Tiny - Image.png|border|center|frameless|450x450px]]
To modify image properties once it has been added to your text, select the image and press the ''Image'' button on the mini toolbar that shows up.
=== Insert / Edit Link ===
When inserting or editing a link to another (internal or external) page, you can provide the following settings:
* '''URL''': The address of the page to navigate to. If left empty, the option ''<top>'' and ''<bottom>'' are available
* '''Text to display''': The text that is shown in the text, represented as a link
* '''Title''': The text shown when hovering over the link
* '''Browse repositories''': Upload a file to link to.
* '''Open link in...''': The page can either be opened in the '''Current Window''' or a '''New window'''
[[File:Tiny - Link.png|border|center|frameless|450x450px]]
=== Insert / Edit Multimedia ===
To insert existing audio or videos clips, the TinyMCE editor supports Moodle standard [[Media embedding|Media embedding interface]].
[[File:Tiny - Audio & Video.png|thumb]]
=== Record audio and video ===
TinyMCE lets users record [[audio]] and [[video]] clips which will attach to the text once recorded. Each recording comprises three steps:
# '''Start recording''': when ready, press the ''Start recording'' button
# '''Stop recording''': when completed, press the ''Stop recording'' button
# '''Review recording''': you can listen to or watch the recording via the provided controls. Either attach the clip to your text or record it again.

The maximum length and quality (bitrate) can be [[TinyMCE editor#Tiny Record RTC plugin for Moodle|configured]] at admin level.
=== Insert / Edit code sample ===
The Tiny editor lets you insert and embed syntax color highlighted code snippets into the editable area.
[[File:Tiny - Code Sample.png|border|center|frameless|600x600px]]
While you can select the (programming) language at the top, it doesn't have any impact on the way the code is displayed.

Tiny also supports formatting of code elements (''Format -> Code''), which changes the selected text to the internally defined <code>code style</code>.
=== Insert Table ===
Tiny comes with comprehensive table management functionality to handle grid-like structures in your text. In addition to the Insert table menu item, an entire main menu has been dedicated to tables.
[[File:Tiny - Table.png|border|center|frameless|450x450px]]
Once a table has been added, you can customise individual cells, row, columns, and the properties of the entire table. The following self-explanatory menu items are available, all supporting standard HTML table options:
* Cell
** Cell properties
** Merge cells
** Split cells
* Row
** Insert row before
** Insert row after
** Delete row
** Row properties
** Cut row
** Copy row
** Paste row before
** Paste row after
* Column
** Insert column before
** Insert column after
** Delete column
** Cut column
** Copy column
** Paste column before
** Paste column after
* Table properties
* Delete table
[[File:Tiny - Table operations.png|border|center|frameless|600x600px]]
The table editor also shows context-sensitive menus when editing different table elements.
=== Insert special character ===
The special character picker lets you insert letters and symbols (a map of special unicode characters) that are difficult or impossible to access via your keyboard. You can either search by keyword and / or browse categories.
[[File:Tiny - Special character.png|border|center|frameless|450x450px]]
=== Insert Emojis ===
Bring a smiley to your content: The emoji picker lets you insert pictograms. You can either search by keyword and / or browse categories.
[[File:Tiny - Emojis.png|border|center|frameless|450x450px]]
=== Insert HTML elements ===
The following 4 HTML elements are supported by TinyMCE via menus:
* '''Insert horizontal line''': Adds an HTML line to your text.

* '''Insert page break''': Adds a page break (<code><nowiki></nowiki></code>) to your text.

* '''Insert nonbreaking space''': Add an nonbreaking space (<code>&nbsp;</code>) at the current cursor location.

* '''Insert anchor''': Insert anchors (sometimes referred to as a bookmarks) to your text. Users will be prompted via a dialog box to enter a string. The string will be inserted into the HTML as an anchor id at the location of the cursor. For example, a user places their cursor at the beginning of "Moodle" and clicks on the anchor button and enters "start" in the dialog box. The resulting HTML will take the form of <code><nowiki><a id="start"></a></nowiki>Moodle<nowiki></nowiki></code>.
=== Insert date/time ===
The Insert date/time options lets you easily insert the current date and/or time into the editable area at the cursor insertion point.
[[File:Tiny - DateTime.png|border|center|frameless]]
The available format options depend on the selected language.
[[File:Tiny - Equation editor.png|thumb]]
=== Equation editor ===
If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX]] filters are enabled (in ''Site administration > Plugins > Filters > Manage filters'') then the ''Insert equation'' option is provided in the TinyMCE editor for launching the equation editor.

Internally, the equation editor uses the [https://docs.moodle.org/400/en/TeX_notation_filter TeX notation] which can either be entered manually and / or interactively. The interactive elements are grouped into 4 categories (Operators, Arrows, Greek symbols, and Advanced). The content of each tab can be configured via the [[Equation editor settings]].

At the bottom of the editor, a preview is shown.
=== Configure H5P content ===
You can embed [[H5P]] content via the ''Configure H5P content'' menu as follows:
# Browse the Content bank repository and select an H5P file
# Choose to either make a copy of the file or create a shortcut
# Optionally, configure the H5P options (Allow download, Embed button, Copyright button)
# Click the button 'Select this file'
# Click 'Insert H5P'These steps will automatically enter the internal address in the H5P URL field. Alternatively, you can enter any internal or external H5P URL manually.
Note: If you create a shortcut to the file, you can edit it in the Content bank and any activities with a link to the file will be updated.
== Tiny tools ==
[[File:Tiny - Tools menu.png|thumb]]
The following tools are available in vie the '''Tools''' menu:
=== View source code ===
The source code pop up window displays the code of the page, usually HTML or JS. The code can be modified in plain text; once the window is closed, any changes will be reflected in the WYSIWYG mode.
[[File:Tiny - Source code.png|center|frameless|900x900px]]
=== Word count ===
The word pop up windows displays the number of words and the number of characters (with and without spaces) of the entire document and the selected text, respectively.
[[File:Tiny - Word count.png|border|center|frameless|600x600px|alt=]]

The number of words are also shown in the editor's footer.
=== Accessibility checker ===
The automated [[accessibility]] checker checks for some common errors in the text. These are usually elements in the way the text is constructed that can prevent all users from having equal access to information and functionality. The list of problems that the accessibility checker looks for is:
* Images with missing or empty alt text (unless they have the presentation role)
* Contrast of font colour and background colour meets [https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines WCAG AA guidelines]
* Long blocks of text are sufficiently broken up into headings
* All tables require captions
* Tables should not contain merged cells as they are difficult to navigate with screen readers
* All tables should contain row or column headers
=== Media Manager ===
The media manager shows all media files that have been embedded in the text.

The top part of the media manager shows the familiar file management element where you can add, download, and delete attached files.

Files that have been attached and deleted again are shown at the bottom half of the screen.
[[File:Tiny - Media manager.png|border|center|frameless|600x600px]]
== Keyboard shortcuts ==
The following keyboard shortcuts will work in the Tiny text editor in most browsers. Note that for many of these commands to work you need to either click in the text editor or select content in the text editor.
=== Editor shortcuts ===
{| class="wikitable"
!Windows Command
!Mac Command
!Function
|-
|Ctrl + Shift + f
|⌘ + Shift + f
|Full screen toggle
|-
|Ctrl + c
|⌘ + c
|Copy
|-
|Ctrl + v
|⌘ + v
|Paste
|-
|Ctrl + Shift + v
|⌘ + Shift + v
|Paste without formatting (very useful)
|-
|Ctrl + x
|⌘ + x
|Cut
|-
|Ctrl + z
|⌘ + z
|Undo
|-
|Ctrl + y
|⌘ + y
|Redo
|-
|Ctrl + a
|⌘ + a
|Select all
|-
|Ctrl + f
|⌘ + f
|Find and replace
|-
|F3
|<s>F3</s>
|Find next
|-
|Shift + F3
|<s>Shift + F3</s>
|Find previous
|-
|Ctrl + b
|⌘ + b
|Bold
|-
|Ctrl + i
|⌘ + i
|Italics
|-
|Ctrl + u
|⌘ + u
|Underline
|-
|Ctrl + k
|⌘ + k
|Insert/edit link
|-
|Ctrl + Right arrow
|Option + Right arrow
|Move to the end of the next word
|-
|Ctrl + Left arrow
|Option + Left arrow
|Move to the end of the previous word
|-
|Ctrl + Shift + Right arrow
|Shift + Option + Right arrow
|Select the next word or letter
|-
|Ctrl + Shift + Left arrow
|Shift + Option + Left arrow
|Select the previous word or letter
|-
|Ctrl + Shift + Home
|<s>⌘ + Shift + Home</s>
|Select from the cursor to the beginning of the page
|-
|Ctrl + Shift + End
|<s>⌘ + Shift + End</s>
|Select from the cursor to the end of the page
|-
|Ctrl + Home
|⌘ + Up arrow
|Move to the beginning of the page
|-
|Ctrl + End
|⌘ + Down arrow
|Move to the end of the page
|-
|Ctrl + Backspace
|<s>⌘ + Backspace</s>
|Delete word or letter to the left
|-
|Ctrl + Delete
|<s>⌘ + Delete</s>
|Delete word or letter to the right
|-
|Ctrl + P
|⌘ + P
|Print
|-
|Alt+Shift+1
|Ctrl+Option+1
|Header 1
|-
|Alt+Shift+2
|Ctrl+Option+2
|Header 2
|-
|Alt+Shift+3
|Ctrl+Option+3
|Header 3
|-
|Alt+Shift+4
|Ctrl+Option+4
|Header 4
|-
|Alt+Shift+5
|Ctrl+Option+5
|Header 5
|-
|Alt+Shift+6
|Ctrl+Option+6
|Header 6
|-
|Alt+Shift+7
|Ctrl+Option+7
|Paragraph
|-
|Alt+Shift+8
|Ctrl+Option+8
|Div
|-
|Alt+Shift+9
|Ctrl+Option+9
|Address
|-
|Alt+0
|Option+0
|Help dialogue (list of shortcuts)
|-
|Ctrl and +
|⌘ and +
|Zoom in (not specific to the editor, but very useful)
|-
|Ctrl and -
|⌘ and -
|Zoom out (not specific to the editor, but very useful)
|-
|Ctrl and 0
|⌘ and 0
|Reset zoom (not specific to the editor, but very useful)
|-
|Double-click
|Double-click
|Select word
|-
|Triple-click
|Triple-click
|Select line
|}
=== Keyboard navigation ===
The sections of the outer UI of the editor - the menubar, toolbar, sidebar and footer - are all keyboard navigable.
==== Activating keyboard navigation ====
There are multiple ways to activate keyboard navigation:
* Focus the menubar: Alt + F9 (Windows) or ⌥F9 (MacOS)
* Focus the toolbar: Alt + F10 (Windows) or ⌥F10 (MacOS)
* Focus the footer: Alt + F11 (Windows) or ⌥F11 (MacOS)
Focusing the menubar or toolbar will start keyboard navigation at the first item in the menubar or toolbar, which will be highlighted with a gray background. Focusing the footer will start keyboard navigation at the first item in the element path, which will be highlighted with an underline.
==== Moving between UI sections ====
When keyboard navigation is active, pressing tab will move the focus to the next major section of the UI, where applicable. These sections are:
* the menubar
* each group of the toolbar
* the sidebar
* the element path in the footer
* the wordcount toggle button in the footer
* the branding link in the footer
* the editor resize handle in the footer
Pressing shift + tab will move backwards through the same sections, except when moving from the footer to the toolbar. Focusing the element path then pressing shift + tab will move focus to the first toolbar group, not the last.
==== Moving within UI sections ====
Keyboard navigation within UI sections can usually be achieved using the left and right arrow keys. This includes:
* moving between menus in the menubar
* moving between buttons in a toolbar group
* moving between items in the element path
In all these UI sections, keyboard navigation will cycle within the section. For example, focusing the last button in a toolbar group then pressing right arrow will move focus to the first item in the same toolbar group.
==== Executing buttons ====
To execute a button, navigate the selection to the desired button and hit space or enter.
==== Opening, navigating and closing menus ====
When focusing a menubar button or a toolbar button with a menu, pressing space, enter or down arrow will open the menu. When the menu opens the first item will be selected. To move up or down the menu, press the up or down arrow key respectively. This is the same for submenus, which can also be opened and closed using the left and right arrow keys.

To close any active menu, hit the escape key. When a menu is closed the selection will be restored to its previous selection. This also works for closing submenus.
==== Context toolbars and menus ====
To focus an open context toolbar such as the table context toolbar, press Ctrl + F9 (Windows) or ⌃F9 (MacOS).

Context toolbar navigation is the same as toolbar navigation, and context menu navigation is the same as standard menu navigation.
==== Dialog navigation ====
There are two types of dialog UIs in TinyMCE: tabbed dialogs and non-tabbed dialogs.

When a non-tabbed dialog is opened, the first interactive component in the dialog will be focused. Users can navigate between interactive components by pressing tab. This includes any footer buttons. Navigation will cycle back to the first dialog component if tab is pressed while focusing the last component in the dialog. Pressing shift + tab will navigate backwards.

When a tabbed dialog is opened, the first button in the tab menu is focused. Pressing tab will navigate to the first interactive component in that tab, and will cycle through the tab's components, the footer buttons, then back to the tab button. To switch to another tab, focus the tab button for the current tab, then use the arrow keys to cycle through the tab buttons.
==== Accessibility shortcuts ====
This is a list of available keyboard shortcuts within the editor user interface.
{| class="wikitable"
!Windows Command
!Mac Command
!Function
|-
|Enter / Spacebar
|Enter / Spacebar
|Execute command
|-
|Tab
|Tab
|Focus on next UI Element(such as: Menu bar, Toolbar, Toolbar Group, Status Bar Item)
|-
|Shift+Tab
|Shift+Tab
|Focus on previous UI Element(such as: Menu bar, Toolbar, Toolbar Group, Status Bar Item)
|-
|Right Arrow / Down Arrow
|Right Arrow / Down Arrow
|Focus next Control(such as: toolbar button, menu, or menu item)
|-
|Left Arrow / Up Arrow
|Left Arrow / Up Arrow
|Focus previous Control(such as: toolbar button, menu, or menu item)
|-
|Down Arrow / Spacebar
|Down Arrow / Spacebar
|Open menu or toolbar menu button
|-
|Spacebar
|Spacebar
|Open group toolbar button
|-
|Down Arrow
|Down Arrow
|Open split toolbar button
|-
|Shift+Enter
|Shift+Enter
|Open the popup menu on split toolbar buttons
|-
|Right Arrow
|Right Arrow
|Open submenu
|-
|Left Arrow / Esc
|Left Arrow / Esc
|Close submenu
|-
|Esc
|Esc
|Close dialog
|-
|Esc
|Esc
|Close menu
|-
|Esc
|Esc
|Move focus back to editor body
|}
'''Note''': Browsers and Screen Readers provide additional shortcuts within the editor context.
==Site administration settings==
=== General settings ===
From ''Site administration > Plugins > Text editors > TinyMCE editor'' you can disable and enable certain settings, for example '''New in 4.3''' the Tiny HTML formatter, Tiny no-auto link and access the setting for the paid service Tiny premium.

You can also disable the TinyMCE branding logo which appears at the bottom of the editor.
{{New features}}
====Tiny premium====
TinyMCE Premium requires a paid subscription. Your API key is available on your [https://www.tiny.cloud/ Tiny Cloud] account page if you have purchased a subscription, or if you are on a free trial. Enter the API key from Site administration > Plugins > Text editors > Tiny premium

The TinyMCE features you can choose from with a Premium subscription are:

* Advanced Tables
* Advanced Typography
* Case Change
* Checklist
* Enhanced Image Editing
* Export
* Footnotes
* Format Painter
* Link Checker
* Page Embed
* Permanent Pen
* PowerPaste
* Spell Checker Pro
* Spelling Autocorrect
* Table of Contents

You can learn more about these features on [https://www.tiny.cloud/tinymce/features/#productivity TinyMCE's website]. Please note that not all plugins listed on TinyMCE's website are currently available to Moodle users.

=== Equation editor settings ===
[[File:Tiny - Equation editor settings.png|thumb]]
The equation editor has 4 tabs: Operators, Arrows, Greek symbols, and Advanced. The commands that are available on each tab and their order can be configured in ''Site administration > Plugins > Text editors > TinyMCE editor > Equation editor settings''.

For each group, the list of commands is shown in TeX format.
=== Tiny Record RTC plugin for Moodle ===
[[File:Tiny - RTC settings.png|thumb]]
Tiny fully supports media recording through. Internally, RecordRTC is utilised, an open source JavaScript library using WebRTC for audio and video recording. To configure its settings, navigate to ''Site administration > Plugins > Text editors > TinyMCE editor > RecordRTC'':

The following options have an impact on server resources, both in terms of bandwidth and disk usage:
* '''Allowed types''': You can specify whether '''Audio and video''' recording are supported or '''Audio only''' or '''Video only'''. There are two capabilities to control access to the TinyMCE buttons: '''[[Capabilities/tiny/recordrtc:recordvideo]]''' and '''[[Capabilities/tiny/recordrtc:recordaudio]]'''
* '''Audio bitrate''' and '''Video bitrate''': The lower the bitrates, the smaller the file sizes, and vice versa. The default bitrate for recorded audio (128000) should generate files of about 15 KB per minute; the default bitrate for recorded video (2500000) to files of approximately 20 MB per minute.
* '''Audio time limit in seconds''' and '''Video time limit in seconds''': The default time limit is 2 minutes for audio and video recording. Again, the longer the maximum recording length, the bigger the resulting files.

Recordings are stored in subdirectories of ''$CFG->dataroot>/filedir''. Ensure ''post_max_size'' and ''upload_max_filesize'' are configured in line with your expected maximum recording sizes.

[[es:Editor TinyMCE]]
[[de:TinyMCE-Editor]]
[[fr:Éditeur TinyMCE]]

Quiz grades report

2024-01-02T09:35:02Z

Juliaverdaguer: /* Re-grading attempts */ updated section to add new information following MDL-79546, also made the spelling of regrade consistent.

{{Quiz reports}}
The quiz grades report may be viewed by clicking on the quiz and accessing ''Administration > Quiz administration >Results > Grades''

The Results Grade link shows the grade, date/time started, completed, time taken for every quiz attempt for a specific quiz. There is also a graph which shows all scores.
==Grades report==
This shows all the students' quiz attempts, with the overall grade, and the grade for each question. There are links to review all the details of a student's attempt, just as the student would see it.

The results can be downloaded in a variety of formats.

There is a setting form at the top of the page that can be used to control what is displayed.

At the bottom of the page is a graph showing the distribution of scores.

There are check boxes to allow you to individually regrade or delete the selected attempts.
===Deleting attempts===
The grading report can be used to delete selected quiz attempts, which may sometimes be necessary.

Note that you cannot edit the quiz after it has been attempted, so that is one reason you may wish to delete all attempts.
===Regrading attempts===
Regrading allows instructors to recalculate the automated grading of quiz attempts using the current version of each question if possible. A dry-run option provides an opportunity to preview the grade changes without affecting attempts.

'''Question version used for regrading'''

The version of the question used for regrading depends on the quiz configuration. For questions set to "Always latest" in the Questions page, regrading will use the most recent version of the question. However, if a specific question version is selected in the Questions page, that version will be used for regrading.

'''Limitations of regrading'''

Regrading isn't always possible. For example, if a teacher changes a multiple-choice question from five answer choices to four after a student has taken the quiz, regrading won't work for that student's attempt. That is because the system can't figure out how to update the student's response with a different number of choices. So, in such cases, regrading will keep the question as the student originally saw it.
::Warning: Regrading does not touch automatically graded questions. If you have accidentally set [[Quiz_settings#Question_behaviour|Question behaviour]] to "Manual grading", this means all questions, even usually automatically graded questions will ''not'' be automatically graded. Changing this setting to something like Deferred feedback, and then clicking Regrade will NOT change the state of the ungraded Multi-choice questions etc. You need to manually grade all the questions or hack the database. See https://moodle.org/mod/forum/discuss.php?d=221113
===Report options===
* Which students/attempts
* Whether to show the individual question grades
* How many attempts per page

===Report columns===
# First name / Surname -
# Started on - the date and time quiz was started
# Completed - the date and time completed
# Time taken - the amount of time it took the student to start and submit the quiz
# Grade/x - the number of points students scored; 'x' is the maximum number of points
# Feedback - any feed back remarks
<gallery>
File:quizreportform1.png|Grades report page preference settings
File:Quiz_result_report_min_6_col_report.png|Grades report showing grades, feedback, start & end times
File:Quiz results grades report show marks.png|Grades report showing marks, grades, comments
File:Quiz_results_grades_chart.png|Grades report chart
</gallery>
===Display options===
Show / download options :
* Participants who have attempted the quiz
* Participants who have not attempted the quiz
* All attempts - list all the students in the course, no matter if they took the quiz or not
* All Participants who have or have not attempted the quiz
Only show / download attempts check boxes for:
* That are graded for each user (Highest grade)
* That have been regraded / are marked as needing regrading
Report preferences
* Page size
* Show/download marks for each question
:''Tip:'' To sort the results by two columns, first click on the column heading you want to be the '''second''' key, and then click on the column heading you want to be the '''primary''' key.
[[https://docs.moodle.org/de/Test-Bewertung]]
[[https://docs.moodle.org/es/Reporte de calificaciones de examen]]

Multi-factor authentication

2023-12-20T10:58:06Z

Juliaverdaguer: /* Example setups */ fixed verbal forms

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is a security measure that requires users to verify their identity using two or more factors of authentication. Factors can be something users know, like a password, something they have, like a phone or security token, or something they are, like a fingerprint.

MFA helps improve security of your Moodle site because it is more difficult for attackers to compromise multiple factors.
==Manage multi-factor authentication==
From Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can turn MFA on by checking the box MFA plugin enabled.

If you’re configuring MFA for your site for the first time, we recommend that you check out the [[Multi-factor authentication#Recommendations and example setups|Recommendations and example setups]] to streamline the experience for your users.
=== Weights and factors ===
In Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can see a list of the available factors and select the ones that make up MFA for your site.

These factors have weight points, and users have to reach 100 points in order to be able to log in. By configuring multiple factors and adjusting their weights, you can create complex and flexible rules for multi-factor authentication.

For example, you could have two factors with 100 points each, if you want to give users different methods of authentication. Or you could have two factors with 50 points each, meaning that users will have to go through both factors to be able to log in.

During the login process, factors that don't require user input, like IP address or user role, are assessed first. Then, the remaining factors are evaluated in order of weight, starting from the highest, until either the cumulative points reach the login threshold (100) or all factors have been checked and login is denied.
==== Available authentication factors ====
===== Standard authentication factors =====
These are well known, usual authentication factors used in many products and software:

'''Email''': This factor requires users to enter a code received via email during the login process. When a user attempts to log in, the system generates a unique, temporary code and sends it to the user’s registered email address. The user must then enter this code along with their password to successfully complete the login process. This code has a limited validity period, which you can customise, ensuring that it cannot be used for unauthorised access.

'''Authenticator app''': This factor uses a mobile application to generate a temporary code for user authentication. During the login process, Moodle prompts the user to enter a code generated by their authenticator app, in addition to their password. This code changes periodically, ensuring that it can’t be reused for unauthorised access. '''Users must have an app installed on their mobile device and configure this factor themselves.'''

'''Security key''': This factor utilises physical hardware tokens, like USB or NFC security keys, or physical biometrics such as fingerprints. During the login process, users must physically use their security on their device to verify their identity. '''Users must configure this factor themselves'''.

'''IP range''': This factor utilises users’ IP address to verify their identity, providing enhanced security when accessing from a trusted network. It requires no upfront setup from your users, allowing you to configure full login access on a trusted network. '''This factor requires no setup by your users.'''
===== User-filtering factors =====
User-filtering factors are a way to easily create groups of users who will or will not be required to use multi-factor authentication (MFA).

'''Non administrator''': This factor requires only administrators to have two or more authentication factors, while not affecting other users. It does so by giving factor points to all users who are not an administrator.
'''Authentication type:''' This factor allows certain users to skip additional authentication steps based on their authentication type. This can be useful for situations where certain authentication types, such as [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] , already provide a high level of security, making additional authentication checks unnecessary.

'''Role''': This factor has to be used in combination with other factors, as it allows you to specify which roles must use other factors to authenticate. For example, it enables you to require that individuals with elevated access privileges, such as managers and administrators, undergo a more stringent authentication process, while other non-specified roles such students can bypass MFA.

'''Cohort''': This factor has to be used in combination with other factors, as it allows you to specify which cohorts must use other factors to authenticate.

'''User capability''': This factor is similar to the Role factor, and must also be combined with other factors, as it allows you to specify which users must use other factors to authenticate. It does so by checking whether users have the capability ‘factor/capability:cannotpassfactor’ at system level. Users who do not have the capability ‘factor/capability:cannotpassfactor’ will be given points for this factor and can bypass MFA, while users with this capability will need to use another type of authentication.

For example: You assign the capability ‘factor/capability:cannotpassfactor’ to all Managers, and also enable the Email factor. When a Manager logs in, they will have to use the Email factor. But when a student tries to log in, they will not.

Since Admin users have all capabilities allowed by default, including “factor/capability:cannotpassfactor”, there’s an additional setting that will allow Admins to gain points for this factor despite having the capability.
===== Other factors =====
These factors provide additional flexibility and control over the authentication process.

'''Trust this device''': This factor allows users to mark a device as trusted during MFA logins. Once a device is designated as trusted, users can bypass MFA for a specified period of time when logging in from that device.

To implement this feature effectively, assign a score of 100 points to this factor.

'''Grace period''': This factor is essential when you turn on factors that require upfront setup from users, like authenticator app or security key. It allows users to log in without engaging with multi-factor authentication (MFA) for a specified time frame, providing a buffer period to complete the setup of additional authentication factors. If a user is still within their grace period upon reaching the first post-login page, regardless of whether they used grace mode as a login factor, a notification will inform them of the remaining grace period length and the potential need to set up additional factors to prevent account lockout when the grace period expires.

To implement this feature effectively, assign a score of 100 points to this factor. To receive points for this factor, there must be no other user-input factors requiring user interaction during the login process. Place this factor at the end of the list to ensure all other factors are addressed first.

If the grace period ends and users have not set up their authentication methods, they will not be able to log in to your site. You can extend the grace period to allow them to log in, or enable other factors temporarily, such as IP range or role.

'''No other factors''': This factor allows people to log in if they have not set up any other MFA factors. For example, if you want to offer MFA to your users but not make it compulsory, give 100 points to ‘no other factors’ to allow those who don’t want to use MFA to log in to the site. Once another factor is set up for a user, they will no longer gain points for this one.
=== User setup ===
If you enable the factors '''Authenticator app''' and '''Security key''', your users will need to configure multi-factor authentication themselves. The authentication settings can be accessed through User menu > Preferences > Multi-factor authentication preferences. There, they will be able to set up and see their authenticator apps or security keys, as well as revoke access to any factors they have configured.
== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:
# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.
=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''
# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''
# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourage them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourage them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourage them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]
[[https://docs.moodle.org/de/Multi-Faktor-Authentifizierung]]

Multi-factor authentication

2023-11-29T19:09:26Z

Juliaverdaguer: Added information about User setup

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is a security measure that requires users to verify their identity using two or more factors of authentication. Factors can be something users know, like a password, something they have, like a phone or security token, or something they are, like a fingerprint.

MFA helps improve security of your Moodle site because it is more difficult for attackers to compromise multiple factors.
==Manage multi-factor authentication==
From Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can turn MFA on by checking the box MFA plugin enabled.

If you’re configuring MFA for your site for the first time, we recommend that you check out the [[Multi-factor authentication#Recommendations and example setups|Recommendations and example setups]] to streamline the experience for your users.
=== Weights and factors ===
In Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can see a list of the available factors and select the ones that make up MFA for your site.

These factors have weight points, and users have to reach 100 points in order to be able to log in. By configuring multiple factors and adjusting their weights, you can create complex and flexible rules for multi-factor authentication.

For example, you could have two factors with 100 points each, if you want to give users different methods of authentication. Or you could have two factors with 50 points each, meaning that users will have to go through both factors to be able to log in.

During the login process, factors that don't require user input, like IP address or user role, are assessed first. Then, the remaining factors are evaluated in order of weight, starting from the highest, until either the cumulative points reach the login threshold (100) or all factors have been checked and login is denied.
==== Available authentication factors ====
===== Standard authentication factors =====
These are well known, usual authentication factors used in many products and software:

'''Email''': This factor requires users to enter a code received via email during the login process. When a user attempts to log in, the system generates a unique, temporary code and sends it to the user’s registered email address. The user must then enter this code along with their password to successfully complete the login process. This code has a limited validity period, which you can customise, ensuring that it cannot be used for unauthorised access.

'''Authenticator app''': This factor uses a mobile application to generate a temporary code for user authentication. During the login process, Moodle prompts the user to enter a code generated by their authenticator app, in addition to their password. This code changes periodically, ensuring that it can’t be reused for unauthorised access. '''Users must have an app installed on their mobile device and configure this factor themselves.'''

'''Security key''': This factor utilises physical hardware tokens, like USB or NFC security keys, or physical biometrics such as fingerprints. During the login process, users must physically use their security on their device to verify their identity. '''Users must configure this factor themselves'''.

'''IP range''': This factor utilises users’ IP address to verify their identity, providing enhanced security when accessing from a trusted network. It requires no upfront setup from your users, allowing you to configure full login access on a trusted network. '''This factor requires no setup by your users.'''
===== User-filtering factors =====
User-filtering factors are a way to easily create groups of users who will or will not be required to use multi-factor authentication (MFA).

'''Non administrator''': This factor requires only administrators to have two or more authentication factors, while not affecting other users. It does so by giving factor points to all users who are not an administrator.
'''Authentication type:''' This factor allows certain users to skip additional authentication steps based on their authentication type. This can be useful for situations where certain authentication types, such as [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] , already provide a high level of security, making additional authentication checks unnecessary.

'''Role''': This factor has to be used in combination with other factors, as it allows you to specify which roles must use other factors to authenticate. For example, it enables you to require that individuals with elevated access privileges, such as managers and administrators, undergo a more stringent authentication process, while other non-specified roles such students can bypass MFA.

'''Cohort''': This factor has to be used in combination with other factors, as it allows you to specify which cohorts must use other factors to authenticate.

'''User capability''': This factor is similar to the Role factor, and must also be combined with other factors, as it allows you to specify which users must use other factors to authenticate. It does so by checking whether users have the capability ‘factor/capability:cannotpassfactor’ at system level. Users who do not have the capability ‘factor/capability:cannotpassfactor’ will be given points for this factor and can bypass MFA, while users with this capability will need to use another type of authentication.

For example: You assign the capability ‘factor/capability:cannotpassfactor’ to all Managers, and also enable the Email factor. When a Manager logs in, they will have to use the Email factor. But when a student tries to log in, they will not.

Since Admin users have all capabilities allowed by default, including “factor/capability:cannotpassfactor”, there’s an additional setting that will allow Admins to gain points for this factor despite having the capability.
===== Other factors =====
These factors provide additional flexibility and control over the authentication process.

'''Trust this device''': This factor allows users to mark a device as trusted during MFA logins. Once a device is designated as trusted, users can bypass MFA for a specified period of time when logging in from that device.

To implement this feature effectively, assign a score of 100 points to this factor.

'''Grace period''': This factor is essential when you turn on factors that require upfront setup from users, like authenticator app or security key. It allows users to log in without engaging with multi-factor authentication (MFA) for a specified time frame, providing a buffer period to complete the setup of additional authentication factors. If a user is still within their grace period upon reaching the first post-login page, regardless of whether they used grace mode as a login factor, a notification will inform them of the remaining grace period length and the potential need to set up additional factors to prevent account lockout when the grace period expires.

To implement this feature effectively, assign a score of 100 points to this factor. To receive points for this factor, there must be no other user-input factors requiring user interaction during the login process. Place this factor at the end of the list to ensure all other factors are addressed first.

If the grace period ends and users have not set up their authentication methods, they will not be able to log in to your site. You can extend the grace period to allow them to log in, or enable other factors temporarily, such as IP range or role.

'''No other factors''': This factor allows people to log in if they have not set up any other MFA factors. For example, if you want to offer MFA to your users but not make it compulsory, give 100 points to ‘no other factors’ to allow those who don’t want to use MFA to log in to the site. Once another factor is set up for a user, they will no longer gain points for this one.

=== User setup ===
If you enable the factors '''Authenticator app''' and '''Security key''', your users will need to configure multi-factor authentication themselves. The authentication settings can be accessed through User menu > Preferences > Multi-factor authentication preferences. There, they will be able to set up and see their authenticator apps or security keys, as well as revoke access to any factors they have configured.

== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:
# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.
=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''
# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''
# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]

Multi-factor authentication

2023-11-29T13:39:59Z

Juliaverdaguer: /* Manage multi-factor authentication */

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is a security measure that requires users to verify their identity using two or more factors of authentication. Factors can be something users know, like a password, something they have, like a phone or security token, or something they are, like a fingerprint.

MFA helps improve security of your Moodle site because it is more difficult for attackers to compromise multiple factors.
==Manage multi-factor authentication==
From Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can turn MFA on by checking the box MFA plugin enabled.

If you’re configuring MFA for your site for the first time, we recommend that you check out the [[Multi-factor authentication#Recommendations and example setups|Recommendations and example setups]] to streamline the experience for your users.
=== Weights and factors ===
In Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can see a list of the available factors and select the ones that make up MFA for your site.

These factors have weight points, and users have to reach 100 points in order to be able to log in. By configuring multiple factors and adjusting their weights, you can create complex and flexible rules for multi-factor authentication.

For example, you could have two factors with 100 points each, if you want to give users different methods of authentication. Or you could have two factors with 50 points each, meaning that users will have to go through both factors to be able to log in.

During the login process, factors that don't require user input, like IP address or user role, are assessed first. Then, the remaining factors are evaluated in order of weight, starting from the highest, until either the cumulative points reach the login threshold (100) or all factors have been checked and login is denied.
==== Available authentication factors ====
===== Standard authentication factors =====
These are well known, usual authentication factors used in many products and software:

'''Email''': This factor requires users to enter a code received via email during the login process. When a user attempts to log in, the system generates a unique, temporary code and sends it to the user’s registered email address. The user must then enter this code along with their password to successfully complete the login process. This code has a limited validity period, which you can customise, ensuring that it cannot be used for unauthorised access.

'''Authenticator app''': This factor uses a mobile application to generate a temporary code for user authentication. During the login process, Moodle prompts the user to enter a code generated by their authenticator app, in addition to their password. This code changes periodically, ensuring that it can’t be reused for unauthorised access. '''Users must have an app installed on their mobile device and configure this factor themselves.'''

'''Security key''': This factor utilises physical hardware tokens, like USB or NFC security keys, or physical biometrics such as fingerprints. During the login process, users must physically use their security on their device to verify their identity. '''Users must configure this factor themselves'''.

'''IP range''': This factor utilises users’ IP address to verify their identity, providing enhanced security when accessing from a trusted network. It requires no upfront setup from your users, allowing you to configure full login access on a trusted network. '''This factor requires no setup by your users.'''
===== User-filtering factors =====
User-filtering factors are a way to easily create groups of users who will or will not be required to use multi-factor authentication (MFA).

'''Non administrator''': This factor requires only administrators to have two or more authentication factors, while not affecting other users. It does so by giving factor points to all users who are not an administrator.
'''Authentication type:''' This factor allows certain users to skip additional authentication steps based on their authentication type. This can be useful for situations where certain authentication types, such as [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] , already provide a high level of security, making additional authentication checks unnecessary.

'''Role''': This factor has to be used in combination with other factors, as it allows you to specify which roles must use other factors to authenticate. For example, it enables you to require that individuals with elevated access privileges, such as managers and administrators, undergo a more stringent authentication process, while other non-specified roles such students can bypass MFA.

'''Cohort''': This factor has to be used in combination with other factors, as it allows you to specify which cohorts must use other factors to authenticate.

'''User capability''': This factor is similar to the Role factor, and must also be combined with other factors, as it allows you to specify which users must use other factors to authenticate. It does so by checking whether users have the capability ‘factor/capability:cannotpassfactor’ at system level. Users who do not have the capability ‘factor/capability:cannotpassfactor’ will be given points for this factor and can bypass MFA, while users with this capability will need to use another type of authentication.

For example: You assign the capability ‘factor/capability:cannotpassfactor’ to all Managers, and also enable the Email factor. When a Manager logs in, they will have to use the Email factor. But when a student tries to log in, they will not.

Since Admin users have all capabilities allowed by default, including “factor/capability:cannotpassfactor”, there’s an additional setting that will allow Admins to gain points for this factor despite having the capability.
===== Other factors =====
These factors provide additional flexibility and control over the authentication process.

'''Trust this device''': This factor allows users to mark a device as trusted during MFA logins. Once a device is designated as trusted, users can bypass MFA for a specified period of time when logging in from that device.

To implement this feature effectively, assign a score of 100 points to this factor.

'''Grace period''': This factor is essential when you turn on factors that require upfront setup from users, like authenticator app or security key. It allows users to log in without engaging with multi-factor authentication (MFA) for a specified time frame, providing a buffer period to complete the setup of additional authentication factors. If a user is still within their grace period upon reaching the first post-login page, regardless of whether they used grace mode as a login factor, a notification will inform them of the remaining grace period length and the potential need to set up additional factors to prevent account lockout when the grace period expires.

To implement this feature effectively, assign a score of 100 points to this factor. To receive points for this factor, there must be no other user-input factors requiring user interaction during the login process. Place this factor at the end of the list to ensure all other factors are addressed first.

If the grace period ends and users have not set up their authentication methods, they will not be able to log in to your site. You can extend the grace period to allow them to log in, or enable other factors temporarily, such as IP range or role.

'''No other factors''': This factor allows people to log in if they have not set up any other MFA factors. For example, if you want to offer MFA to your users but not make it compulsory, give 100 points to ‘no other factors’ to allow those who don’t want to use MFA to log in to the site. Once another factor is set up for a user, they will no longer gain points for this one.
== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:
# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.
=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''
# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''
# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]

Multi-factor authentication

2023-11-29T13:38:48Z

Juliaverdaguer: Updated descriptions of all factors, reorganised them.

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is a security measure that requires users to verify their identity using two or more factors of authentication. Factors can be something users know, like a password, something they have, like a phone or security token, or something they are, like a fingerprint.

MFA helps improve security of your Moodle site because it is more difficult for attackers to compromise multiple factors.
==Manage multi-factor authentication==
From Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can turn MFA on by checking the box MFA plugin enabled.

If you’re configuring MFA for your site for the first time, we recommend that you check out the [[Recommendations and example setups]] to streamline the experience for your users.
=== Weights and factors ===
In Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can see a list of the available factors and select the ones that make up MFA for your site.

These factors have weight points, and users have to reach 100 points in order to be able to log in. By configuring multiple factors and adjusting their weights, you can create complex and flexible rules for multi-factor authentication.

For example, you could have two factors with 100 points each, if you want to give users different methods of authentication. Or you could have two factors with 50 points each, meaning that users will have to go through both factors to be able to log in.

During the login process, factors that don't require user input, like IP address or user role, are assessed first. Then, the remaining factors are evaluated in order of weight, starting from the highest, until either the cumulative points reach the login threshold (100) or all factors have been checked and login is denied.
==== Available authentication factors ====

===== Standard authentication factors =====
These are well known, usual authentication factors used in many products and software:

'''Email''': This factor requires users to enter a code received via email during the login process. When a user attempts to log in, the system generates a unique, temporary code and sends it to the user’s registered email address. The user must then enter this code along with their password to successfully complete the login process. This code has a limited validity period, which you can customise, ensuring that it cannot be used for unauthorised access.

'''Authenticator app''': This factor uses a mobile application to generate a temporary code for user authentication. During the login process, Moodle prompts the user to enter a code generated by their authenticator app, in addition to their password. This code changes periodically, ensuring that it can’t be reused for unauthorised access. '''Users must have an app installed on their mobile device and configure this factor themselves.'''

'''Security key''': This factor utilises physical hardware tokens, like USB or NFC security keys, or physical biometrics such as fingerprints. During the login process, users must physically use their security on their device to verify their identity. '''Users must configure this factor themselves'''.

'''IP range''': This factor utilises users’ IP address to verify their identity, providing enhanced security when accessing from a trusted network. It requires no upfront setup from your users, allowing you to configure full login access on a trusted network. '''This factor requires no setup by your users.'''

===== User-filtering factors =====
User-filtering factors are a way to easily create groups of users who will or will not be required to use multi-factor authentication (MFA).

'''Non administrator''': This factor requires only administrators to have two or more authentication factors, while not affecting other users. It does so by giving factor points to all users who are not an administrator.
'''Authentication type:''' This factor allows certain users to skip additional authentication steps based on their authentication type. This can be useful for situations where certain authentication types, such as [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] , already provide a high level of security, making additional authentication checks unnecessary.

'''Role''': This factor has to be used in combination with other factors, as it allows you to specify which roles must use other factors to authenticate. For example, it enables you to require that individuals with elevated access privileges, such as managers and administrators, undergo a more stringent authentication process, while other non-specified roles such students can bypass MFA.

'''Cohort''': This factor has to be used in combination with other factors, as it allows you to specify which cohorts must use other factors to authenticate.

'''User capability''': This factor is similar to the Role factor, and must also be combined with other factors, as it allows you to specify which users must use other factors to authenticate. It does so by checking whether users have the capability ‘factor/capability:cannotpassfactor’ at system level. Users who do not have the capability ‘factor/capability:cannotpassfactor’ will be given points for this factor and can bypass MFA, while users with this capability will need to use another type of authentication.

For example: You assign the capability ‘factor/capability:cannotpassfactor’ to all Managers, and also enable the Email factor. When a Manager logs in, they will have to use the Email factor. But when a student tries to log in, they will not.

Since Admin users have all capabilities allowed by default, including “factor/capability:cannotpassfactor”, there’s an additional setting that will allow Admins to gain points for this factor despite having the capability.

===== Other factors =====
These factors provide additional flexibility and control over the authentication process.

'''Trust this device''': This factor allows users to mark a device as trusted during MFA logins. Once a device is designated as trusted, users can bypass MFA for a specified period of time when logging in from that device.

To implement this feature effectively, assign a score of 100 points to this factor.

'''Grace period''': This factor is essential when you turn on factors that require upfront setup from users, like authenticator app or security key. It allows users to log in without engaging with multi-factor authentication (MFA) for a specified time frame, providing a buffer period to complete the setup of additional authentication factors. If a user is still within their grace period upon reaching the first post-login page, regardless of whether they used grace mode as a login factor, a notification will inform them of the remaining grace period length and the potential need to set up additional factors to prevent account lockout when the grace period expires.

To implement this feature effectively, assign a score of 100 points to this factor. To receive points for this factor, there must be no other user-input factors requiring user interaction during the login process. Place this factor at the end of the list to ensure all other factors are addressed first.

If the grace period ends and users have not set up their authentication methods, they will not be able to log in to your site. You can extend the grace period to allow them to log in, or enable other factors temporarily, such as IP range or role.

'''No other factors''': This factor allows people to log in if they have not set up any other MFA factors. For example, if you want to offer MFA to your users but not make it compulsory, give 100 points to ‘no other factors’ to allow those who don’t want to use MFA to log in to the site. Once another factor is set up for a user, they will no longer gain points for this one.

== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:
# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.
=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''
# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''
# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]

Multi-factor authentication

2023-11-29T13:33:40Z

Juliaverdaguer: /* What is multi-factor authentication (MFA)? */ Updated description. /* Manage multi-factor authentication */ updated description and added link to new section with recommendations. Created new Weights and factors section and an 'Available factors' subsection.

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is a security measure that requires users to verify their identity using two or more factors of authentication. Factors can be something users know, like a password, something they have, like a phone or security token, or something they are, like a fingerprint.

MFA helps improve security of your Moodle site because it is more difficult for attackers to compromise multiple factors.
==Manage multi-factor authentication==
From Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can turn MFA on by checking the box MFA plugin enabled.

If you’re configuring MFA for your site for the first time, we recommend that you check out the [[Recommendations and example setups]] to streamline the experience for your users.

=== Weights and factors ===
In Site administration > Plugins > Admin tools > Manage multi-factor authentication, you can see a list of the available factors and select the ones that make up MFA for your site.

These factors have weight points, and users have to reach 100 points in order to be able to log in. By configuring multiple factors and adjusting their weights, you can create complex and flexible rules for multi-factor authentication.

For example, you could have two factors with 100 points each, if you want to give users different methods of authentication. Or you could have two factors with 50 points each, meaning that users will have to go through both factors to be able to log in.

During the login process, factors that don't require user input, like IP address or user role, are assessed first. Then, the remaining factors are evaluated in order of weight, starting from the highest, until either the cumulative points reach the login threshold (100) or all factors have been checked and login is denied.

==== Available authentication factors ====
'''Non administrator:''' This factor enables you to give points for free to a user who is not an admin. This makes it easy to require admin users to have 2 or more factors while not affecting normal users.
'''Authentication type:''' Here you can specify that users with certain auth types, eg [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] already have 100 points, making them exempt from additional checks.

'''User capability:''' This factor checks whether a user has a capability, in the system context. If the user has this capability, they will not gain the points for this factor, and must instead use other factors to authenticate with the system. This is similar to the non-admin factor, however it operates on a role basis. In practice, the capability 'factor/capability:cannotpassfactor' should be given to roles who must use other factors to authenticate to the system. There is an additional setting for this factor that will allow admins to gain points for this factor, as by default they will always gain no points for this factor.

'''Cohort:''' This factor requires the user to be in a particular cohort in order to log in.

'''Email:''' A simple factor which sends a short lived code to your email which you then need to enter to login. Generally speaking this is a low security factor because typically the same username and password which logs you into moodle is the same which logs you into your email so it doesn't add much value.

'''Grace period:''' This allows users to log in without interacting with MFA for a set period of time. Users can only achieve the points for this factor if there are no other input factors for them to interact with during the login process. This factor should be placed last in the list, that way all other factors are interacted with during the login process first. On the first page after login, if a user is currently within their grace period, regardless of whether they used gracemode as a login factor, they are presented a notification informing them of the grace period length, and that they may need to setup other factors or risk being locked out once the grace period expires.

'''IP range:''' Use this factor if you are on a secure network.This is very useful because it requires no setup by the end user, so you can set it up so that you can log in fully via a secure network, and once logged in they can setup other factors like [https://en.wikipedia.org/wiki/Time-based_one-time_password TOTP], and then use those other factors for logging in when not on a secure network.

'''No other factors:''' This is designed to allow people to pass only if they have not setup other factors for MFA already.

'''Role:'''This factor checks whether a user has any chosen roles assigned in any context, and does not provide points if that is the case. This can be used to ensure the selected roles must use a higher level of authentication such as TOTP, while letting non-specified roles authenticate seamlessly. This factor should generally have high privilege roles such as manager and administrator selected to enforce higher account security for these groups.
'''
Trust this device:'''

'''Authenticator app:''' This factor sends a code to an authenticator app a user has already installed on their smartphone. Another term is TOTP - Time-based one-time password.

'''Security key:'''
== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:
# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.
=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''
# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''
# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''
# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]

Multi-factor authentication

2023-11-29T13:21:00Z

Juliaverdaguer: Added a new section with Recommendations and example setup

{{Authentication}}
==What is multi-factor authentication (MFA)?==
[https://en.wikipedia.org/wiki/Multi-factor_authentication Multi-factor authentication (MFA)] is an authentication method that requires the user to provide two or more verification factors to gain access to an online account such as Moodle site. MFA helps improve security of your site.
==Manage multi-factor authentication==
From ''Site administration > Plugins > Admin tools > Manage multi-factor authentication'' you can select the 'factors' which must satisfy in order to login. These factors must add up to 100. By configuring multiple factors and weighting them you can easily have quite complex and flexible rules.

'''Non administrator:''' This factor enables you to give points for free to a user who is not an admin. This makes it easy to require admin users to have 2 or more factors while not affecting normal users.

'''Authentication type:''' Here you can specify that users with certain auth types, eg [https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language SAML] via [https://en.wikipedia.org/wiki/Active_Directory_Federation_Services ADFS] already have 100 points, making them exempt from additional checks.

'''User capability:''' This factor checks whether a user has a capability, in the system context. If the user has this capability, they will not gain the points for this factor, and must instead use other factors to authenticate with the system. This is similar to the non-admin factor, however it operates on a role basis. In practice, the capability 'factor/capability:cannotpassfactor' should be given to roles who must use other factors to authenticate to the system. There is an additional setting for this factor that will allow admins to gain points for this factor, as by default they will always gain no points for this factor.

'''Cohort:''' This factor requires the user to be in a particular cohort in order to log in.

'''Email:''' A simple factor which sends a short lived code to your email which you then need to enter to login. Generally speaking this is a low security factor because typically the same username and password which logs you into moodle is the same which logs you into your email so it doesn't add much value.

'''Grace period:''' This allows users to log in without interacting with MFA for a set period of time. Users can only achieve the points for this factor if there are no other input factors for them to interact with during the login process. This factor should be placed last in the list, that way all other factors are interacted with during the login process first. On the first page after login, if a user is currently within their grace period, regardless of whether they used gracemode as a login factor, they are presented a notification informing them of the grace period length, and that they may need to setup other factors or risk being locked out once the grace period expires.

'''IP range:''' Use this factor if you are on a secure network.This is very useful because it requires no setup by the end user, so you can set it up so that you can log in fully via a secure network, and once logged in they can setup other factors like [https://en.wikipedia.org/wiki/Time-based_one-time_password TOTP], and then use those other factors for logging in when not on a secure network.

'''No other factors:''' This is designed to allow people to pass only if they have not setup other factors for MFA already.

'''Role:'''This factor checks whether a user has any chosen roles assigned in any context, and does not provide points if that is the case. This can be used to ensure the selected roles must use a higher level of authentication such as TOTP, while letting non-specified roles authenticate seamlessly. This factor should generally have high privilege roles such as manager and administrator selected to enforce higher account security for these groups.
'''
Trust this device:'''

'''Authenticator app:''' This factor sends a code to an authenticator app a user has already installed on their smartphone. Another term is TOTP - Time-based one-time password.

'''Security key:'''

== Recommendations and example setups ==

When setting up MFA for your site, it’s important to ensure that you’re making your site more secure, but also creating a good experience for your users, including making sure that they are able to log in if they follow the right steps. Here are some recommendations to ensure that MFA is streamlined for your users:

# Make sure you turn on the '''Grace period''' factor when you turn on an authentication factor that requires users to configure something themselves ('''Authenticator app''' or '''Security key'''). This will give your users time to set up MFA before they are required to use it.
# If you don’t want to make MFA mandatory, enable '''No other factors'''. This will allow users with no other factors to log in using only their password.
# '''IP range''' factor is a very straightforward authentication method if all your users are using the same network. Once users are logged in using this factor, you can allow them to set up additional factors, such as an authenticator app, and then use those other factors to log in when not on your secure network.

=== Example setups ===

These are some examples of common MFA setups to increase the security of your Moodle site.

'''a) Email verification'''

# Enable MFA.
# Turn on factor '''Email''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.
# Let your users know that email verification is now enabled. Next time your users try to log in, they will see a message that asks them to check their email and enter a code that has been sent there.

'''b) Authenticator app'''

# Enable MFA.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''c) Email OR authenticator app'''

# Enable MFA.
# Turn on the factor '''Email''' and give it 100 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 100 points.
# You can turn on '''Trust your device''' to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

'''d) Email AND authenticator app'''

# Enable MFA.
# Turn on the factor '''Email''' and give it 50 points.
# Turn on the factor '''Grace period''' and give it 100 points. This will allow your users a period of time to set up their authenticator apps and prevent them from being locked out of your site. Use the '''Grace period warning banner''' to let your users know that MFA will be enabled soon and encourages them to set up their authenticator app.
# Turn on the factor '''Authenticator app''' and give it 50 points. Users will have to pass both factors to get to 100 points and be able to log in.
# You can turn on Trust your device to allow your users to bypass MFA for a specified period of time after they have verified it with MFA for the first time.

==Summary of good conditions for login==
Here are listed the factors selected and their total weighting, adding up to 100.
==General MFA settings==
*The MFA plugin enabled box should be checked for MFA to work.
*From this section you can add any relative URL from the siteroot for which the MFA check will not redirect from
*Links to any guidance pages or files may be uploaded here.
===Admin locked out of site - how to resolve===
Be careful as an administrator when configuring and testing the factors that you do not lock yourself out of the site. If you do then MFA can be disable from the command line by entering:
<syntaxhighlight lang="php">
: php admin/cli/cfg.php --component=tool_mfa --name=enabled --set=0</syntaxhighlight>
[[https://docs.moodle.org/es/Autenticación de múltiples factores]]

Moodle app guide for admins

2023-11-23T15:57:08Z

Juliaverdaguer: /* Simplify user onboarding */ small changes

{{Mobile}}
==Enable mobile services on your site==
Your site needs to have mobile access enabled so users can use the mobile app.

For sites using https, mobile access is enabled by default in new installations of Moodle 3.0 onwards.

For http sites, mobile access can be enabled by an administrator as follows:
# In ''Site administration > Mobile app > Mobile settings'' tick the 'Enable web services for mobile devices' checkbox. (For 4.0 version: In ''Site administration > Advanced features'' tick the 'Enable web services for mobile devices' checkbox
# Click the button to save changes.
If your site uses a [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL certificate], it must be a trusted certificate. For security reasons the app doesn't work with self-signed certificates.

Please, verify that your certificate is valid via: https://www.geocerts.com/ssl_checker (you shouldn't see any warning).

If your site has the /login directory protected (frequently done when using the Shibboleth authentication method), you must enable access to the login/token.php script.
===Frame embedding===
If your sites uses [https://en.wikipedia.org/wiki/ReCAPTCHA reCaptcha], Vimeo videos or custom menu items (as described bellow) you must enable the admin setting "Allow frame embedding" (allowframembedding). Please, note this is not necessary since Moodle 3.7
===Is your site behind a proxy, or load balancer or complex network infrastructure?===
In that case, you may need to configure the "Ignore reserver proxies" settings in Site administration > Administration > Server > HTTP
==Register your site on the Moodle Apps Portal==
We strongly recommend you to register your site for free on the Moodle Apps portal: https://apps.moodle.com

You will be able to retrieve statistics like the number of active user devices receiving Push Notifications and upgrade to a Pro/Premium plan for enjoying exclusive features.
==Simplify user onboarding==
Upon opening the Moodle app, first-time users encounter a "Your site" field, where they have to input the URL of their Moodle site to access their courses. To ensure a smooth onboarding experience for new users, follow these steps:
# Enable the '''Site finder''' feature that allows users to find their Moodle site by name, eliminating the need to manually enter the site URL. To enable this feature, view [[Moodle app guide for admins#Have your site listed in the Moodle app site finder|Have your site listed in the Moodle app site finder]] below.
# Enable the '''QR login''' feature (view [[Moodle app guide for admins#QR Login|instructions]] below). This feature allows users to scan a QR code available on their Moodle profile to access their Moodle site directly from the app.
# For Android users and Moodle LMS 4.3 and later: Encourage users to install the Moodle app by following the '''Get the mobile app''' link at the bottom of any Moodle page (located within the "'''?'''" icon on the desktop version). When users install the app through this link, they will be automatically redirected to their site login screen, eliminating the need to manually enter the site URL.
# Alternatively, you can create a dedicated help page for the Moodle app. This help page should include a link to the Google Play version of the app and clearly indicate the site URL referrer. For example, if your Moodle site is mymoodlesite.com the link will be https://play.google.com/store/apps/details?id=com.moodle.moodlemobile&referrer=siteurl%3Dhttps%3A%2F%2Fmymoodlesite.com
Please note that options 3&4 are not compatible with Google Workspace accounts (the installation referrer will be ignored in that case).
==Have your site listed in the Moodle app site finder==
The Moodle apps site finder enables a user to easily find their Moodle site by entering the name (no need to enter the site URL)
===How can I have my site listed in the Moodle app site finder?===
Your site will be automatically listed in the site finder if:
* either your site is registered and listed with a link on [https://stats.moodle.org/sites/ Registered sites] and has over five hundred mobile users and you have been using the Moodle app for over a year
* or you have purchased a [https://moodle.com/app/ Pro or Premium Moodle app subscription].
You can arrange for your site to be listed in the site finder as follows:
* If your site is hosted by a Moodle Partner, please contact them to request for your site to be listed.
* If you have a MoodleCloud site, please log in to the Moodle Apps Portal where you will find an option to have your site listed.
Otherwise, to have your site listed in the site finder, you need to purchase a [https://moodle.com/app/ Pro or Premium Moodle app subscription] from the Moodle Apps Portal.
===I don’t want my site listed in the Moodle app site finder. How can I remove it?===
You can remove your site from the site finder as follows:
# Log in to the [https://apps.moodle.com/ Moodle Apps Portal]. (If you don't yet have an account, you can create one for free.)
# Go to ‘App customisation’ -> ‘Site Listing’ and uncheck the option ‘Visible’ then save changes.
Your site will then be immediately removed from the site finder.

Alternatively, you can remove your site from the site finder by updating your site registration:
# Log in to your Moodle site as admin and go to ‘Site administration’ -> Registration.
# Change ‘Site listing’ to either ‘Do not list my site’ or ‘Only display my site name’.
Your site will then be removed from the site finder within 24 hours.
==Mobile authentication==
===SSO authentication method===
If your site uses a SSO authentication method (CAS, Shibboleth, LDAP SSO, OAuth...), then select via a browser window or via an embedded browser for 'Type of login' (typeoflogin) in 'Mobile authentication' in the Site administration. (This setting is provided for older pre-Moodle 3.2 sites via the [[Moodle Mobile additional features]] plugin.)

The options 'browser window' and 'embedded browser' are very similar; the only difference is when redirecting the user to enter their credentials in the site, the site will be opened in the device's default browser (for browser window) or the site will be opened "embedded" in the mobile app (for embedded browser). The user experience is better in embedded browser, but not all the authentication plugins will work in embedded browser (for example, if JavaScript popups are required they must use the 'browser window'). The admin should check whether both options work, and if so, choose 'embedded browser'.

If you are using Google OAuth you will have to use the 'browser window' method because Google recently blocked authentication via 'embedded browsers'.

If your organisation uses a custom branded app and 'Type of login' is set to 'Via a browser window' or 'Via embedded browser', then a URL scheme (forcedurlscheme) may be set. This will result in only the custom branded app working for the site: the official Moodle Mobile app will not work.
===QR Login===
Please note that this feature requires Moodle 3.9 and is only available if you are enjoying a [https://moodle.com/app/ Pro/Premium plan].

As a site administrator, you can enable login via QR. Please go to Site administration > Mobile app > Mobile authentication and select "QR code with automatic login" in the "QR code access" setting

Once enabled, your students will be able to login in the app by scanning a QR code available on their Moodle site profile.
===Biometric Login===
This feature is only available to Pro and [https://apps.moodle.com Premium plan customers].

Biometric login allows your users to log in to your site via the Moodle App on Android and iOS devices using their fingerprint, face recognition or any other biometric option available on their mobile device. This makes the login process simpler, faster and more secure, and is specially useful if Autologout is enabled on your site.

'''Enabling biometric login for your site'''

You can enable Biometric login as an authentication method through the Moodle Apps Portal, going to App customisation > Authentication > Biometric login, and then selecting “Enable biometric login”. Your users will then be able to choose whether they want to use Biometric login or not.

For security reasons, users may be prompted to re-enter their credentials periodically. This interval is determined by the 'User created token duration' (tokenduration) security setting, which is set to a default duration of three months.

'''Setting up biometric login as a user'''

To use biometric login in the Moodle App, users must have biometric authentication enabled in their own device’s settings (e.g. FaceID or TouchID for iOs users, or Fingerprints for Android users).

The first three times users log in to the app after you enable Biometric login, they will see a notification telling them that they can activate this new authentication method to access the app (provided that they have biometric authentication enabled in their device’s settings).

Users can activate and deactivate their biometric login any time in the Moodle App in User account > Preferences.
===Auto logout===
From Moodle LMS 4.3 onwards, you can enhance security by enforcing automatic logout for your users when they leave or close the app, or it goes to the background.

You can even set your own custom re-authentication time, to suit your organisation's security requirements.

To activate auto logout, go to Site administration > Mobile app > Mobile authentication.

This feature is particularly effective when paired with Biometric login, since that streamlines the login process for your users.
== Customise your app theme ==
The app can also retrieve your custom styles from your Moodle site. Since the app is a HTML5 app, you can safely apply any CSS, CSS2 and CSS3 style.

Go to ''Administration > Site administration > Mobile app > Mobile appearance'' and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles.

The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin).

'''For example:''' ''https://mymoodlesite.com/theme/mytheme/style/mymobileapp.css''

Once the user is logged in the app, remote CSS files for applying your custom styles are regularly retrieved.

Notice that on the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.

For further information, see the dev docs [https://docs.moodle.org/dev/Moodle%20Mobile%20Themes Moodle Mobile Themes].

If you want your own custom branding for your organization, Moodle offers the The [https://moodle.com/branded-app Branded Moodle Mobile app] service, please visit https://moodle.com/app/ for more information.
== Moodle Mobile additional features plugin for old Moodle sites ==
For old Moodle sites it is recommended to install the [[Moodle Mobile additional features]] plugin.
== Notifications ==
You might find them annoying but push notifications keeps you and your users informed and updated on everything about the app. Moodle only send useful and important notifications such as new features or service disruptions.

Enabling push notifications is easy! An administrator can enable it by connecting their Moodle site/s to our free Notifications server available (only) for registered Moodle sites.

An access key can be obtained via ''Site administration > General > Messaging > Notification settings''. Be sure the 'Mobile' is enabled and then click the link to settings, on the next page select ''Request access key''. (For Moodle site versions 3.5 and 3.6 an access key can be obtained via ''Site administration > Plugins > Message outputs > Manage message outputs''. Then by clicking the link to the Mobile settings, on the next page select ''Request access key''.)

The full guide on enabling push notifications can be found here: [[Mobile app notifications]]
== App banners ==
[[File:app banner.png|thumb|Moodle Mobile app banner]]
App banners let your users know that there is a mobile app available for the site. App banners are only displayed when accessing the site using a mobile browser.

In Moodle 3.3 onwards, app banners for Android are supported as well as for iOS.

App banners are disabled by default. They can be enabled in 'Mobile appearance' in the Site administration.

If you are using a custom mobile app, you need to provide the unique identifier for the iOS and Android app; if you are using the Moodle Mobile app, the settings may be left as default.

Please, notice the following:
* App banners for iOS devices (iPhone, iPad or iPod) are only shown when accessing the site using the Safari browser
* App banners for Android devices are only shown in very recent Chrome browser versions and when the app is not installed. Note also that Chrome uses an engagement heuristic that will display the banner only on certain conditions, like interactions with the site, the last time you interacted with it, etc. You can remove the engagement restriction check by disabling this special chrome flag: chrome://flags/#bypass-app-banner-engagement-checks. Please notice also that certain custom Android versions (such as Samsung and Huawei ones) does not always support this feature
=='Get the mobile app' link==
In Moodle 3.4 onwards, the link 'Get the mobile app' in the footer of each page on the site encourages users to make use of the mobile app.

By default, the link is https://download.moodle.org/mobile however the setting 'App download page' can be changed e.g. for sites using a branded mobile app.

If mobile services are not enabled for the site, then the 'Get the mobile app' link is not displayed.

To prevent the 'Get the mobile app' link being displayed, simply remove the URL from the 'App download page' setting and save changes.
== Configuring the app from your site ==
'''IMPORTANT''': Please notice that the type and number of features that you can customise depend on your Moodle Apps plan, you can register for free on https://apps.moodle.com to check the different plans.

In Moodle 3.3 onwards, or with the [[Moodle Mobile additional features]] plugin, settings in the Site administration enable admins to configure the app.
* In Moodle 3.3 onwards go to ''Site administration > Mobile features''
* In sites with the Moodle Mobile additional features plugin installed, go to ''Site administration > Plugins > Local plugins > Mobile additional features''
===Force log out===
Replace the Change site option to "Log out" so that users must enter their credentials on their next access. This is useful for custom mobile apps, as there is no reason for users wanting to switch to a different site.
===Disabled features===
The mobile app may be simplified by removing unwanted features. Some items may already be not available in the app because they are not enabled on your site.

Options to remove include:
* Offline use
* Blocks
* Comments
* Ratings
* Tags
* Create new account
* Responsive menu items (new in 3.7)
* Main menu
** Site home
** My courses
** Dashboard
** Calendar
** Notifications
** Messages
** Grades
** My learning plans
** Blog
** Files
** Web page
** Help
* Course
** Blocks
** Blog
** Search
** Competencies
** Participants
** Grades
** Course completion
** Notes
** Download course (new in 3.5)
** Download courses (new in 3.5)
* User
** Blog
** Badges
** Competencies
** Course completion
** Grades
** Send message
** Add contact
** Block contact
** Add a new note
** User picture
* Files
** Private files
** Ste files
** Upload
* Modules (Each module can be disabled separately)
* Blocks (Each block available in the app can be disabled separately)
===Custom menu items===
Additional items can be added to the app main menu (the more menu), such as a link to a different grade book.

Each custom menu item should have format: item text, link URL, link-opening method and language code (optional, for displaying the item to users of the specified language only), icon (optional, the name of the icon from https://ionicons.com) separated by pipe characters.

Possible link-opening methods are:
* app - for linking to an activity supported by the app i.e. almost all activity types, as listed in [[Moodle Mobile features]].
* inappbrowser - for linking to external URLs or site functionalities not supported by the app. The link will open in a browser inside the app overlaying the complete screen.
* browser - as for inappbrowser except that the link will instead open in the device default browser outside the app.
* embedded - as for inappbrowser except that the link will instead open in an iframe in a new page in the app. (For this option you may need to enable the admin setting "Allow frame embedding" (allowframembedding)
Tip: If you add a custom menu item and save changes, then it doesn't appear in the app main menu, double check that the item is correctly formatted.

Please, note that if custom menu items have the same URL, same link-opening method, and same language only the first custom menu item will be shown.

Please, note that if the app is using a language not indicated in the previous list, the first language in the list will be used. (So if you have a custom menu item in English (en) and French (fr), and the app is using Spanish the user will still see that custom menu item in English)

If you want options tied to a language, you can append _only to the language code, for example:
en_only
es_only, will display the custom menu item only when the app language is English or Spanish.

Example of a menu item (it will display a home icon followed by Academy information linking to the URL indicated):
Academy information|https://yoursite.com/mod/page/view.php?id=X |app|en|home
===Responsive menu items===
From 3.7 onwards menu items on bottom tabs are moved to the side of the screen on big screens. Also the number of items displayed on the menu may vary:
* On small screens (usually phones) from 2 to 5 items will be displayed depending on the size of the screen.
* On big screens (usually tablets an desktop version) more than 2 items will be displayed without limit.
If '''Responsive menu items''' is selected in Disabled features items will be displayed in side of bottom anyway but 5 items will be displayed in all cases without depending on the size of the screen.
===Custom language strings ===
Words and phrases displayed in the app can be customised via the "Custom language strings" (customlangstrings) setting.

Enter each custom language string on a new line with format: string identifier, custom language string and language code, separated by pipe characters. For example:
core.user.student|Learner|en
core.user.student|Aprendiz|es
The complete list of string identifiers is listed in https://latest.apps.moodledemo.net/assets/lang/en.json

The string identifier is before the colon.

For example:

"core.user.student": "Student",

means that the string "Student" has string identifier "core.user.student".
==Analytics and stats==
To retrieve information about the Moodle app usage, site administrators and teachers can check the system, course or activity logs.

Among the log filters, there is a field called "All sources" with an option "Web Service" that can be used to filter the entry logs generated by the mobile application.

You can compare the number of log entries generated by the "Web" versus "Web Service" (mobile app) to have an overall idea about how your users use the platform.

Please, notice that if you have custom "Web Services" or an installed plugin that uses Web Services, you will also see entries for them under the same filter.
===Integration with Matomo analytics===
Note: This feature is available for [https://apps.moodle.com Premium app plans and Branded Moodle Apps]. To use this integration, you will need to have your own instance of Matomo.

Matomo is an open source web analytics tool that helps you monitor traffic to your Moodle site, including app activity.

'''Connecting to your Matomo instance in the Apps portal'''
[[File:Captura de pantalla 2023-11-14 a las 12.03.36.png|thumb|Moodle App Matomo Integration set up]]
To use Matomo to track app activity on your Moodle site, you will need to have your own instance of Matomo analytics, and to add your Moodle site as one of your measurable websites (see instructions on [https://matomo.org/faq/how-to/create-and-manage-websites/ Matomo’s website]). Then, follow these steps:
# Log in to the [https://apps.moodle.com Apps portal].
# Go to '''App customisation''' > '''Analytics''' > '''Matomo analytics'''.
# Check '''Track app activity'''.
# Add your '''Matomo URL''' - that’s the URL of your Matomo instance, for example https://yoursite.matomo.cloud.
# Add the '''Website ID''' associated with your Moodle site in Matomo. To obtain this ID:
## Log in to your Matomo account.
## Go to '''Administration''' using the gear icon on the right side of the top navigation bar.
## On the left-hand panel, select '''Websites''' > '''Manage'''.
## In your list of measurables, find the Moodle site in which you want to track app activity. The '''ID''' of the measurable is the '''Website ID''' you need to enter in the apps portal.
# Click '''Save changes''' to establish the connection and start tracking app activity.
# If you’d like to stop tracking at any time, uncheck '''Track app activity''' and then save changes.

To filter Matomo data to isolate mobile app usage from Moodle site interactions, follow these steps:
[[File:Captura de pantalla 2023-11-14 a las 12.05.05.png|thumb|Moodle App Matomo referrer set-up]]
# Log in to your Matomo account.
# Click '''All visits''' at the top of the page
# Create a custom segment by applying this configuration: “Referrer URL” “is” “https://moodlemobile”
# To only see Moodle site interactions, do the following: “Referrer URL” “is not” “https://moodlemobile”
===Google Analytics for Firebase===
Only available when purchasing a [https://moodle.com/branded-app/ Branded Moodle App].

Google Analytics for Firebase is a free tool that provides valuable insights and data about how users interact with mobile apps.
==Web services token duration==
From Moodle 3.4 onwards, an admin can set how long a web services token created by a user (for example via the mobile app) is valid. (In previous versions of Moodle a token was valid for 3 months.)

The setting that dictates the previous 'User created token duration' (tokenduration) can be found under the Security section.
==App's cache==
The app caches WebService requests to decrease data usage and increase the app's speed. When the app needs to get some data from Moodle, it will use a cached request as long as it isn't expired.

This cache was improved in Moodle App 3.7.0, now there are several cache times depending on the WS being called. This means that some requests will expire more often than others. Also, if the user isn't using a WiFi connection, the expiration time will also be longer to decrease the data usage. These cache times cannot be configured using a Moodle setting.
==See also==
* [https://moodle.academy/course/view.php?id=100 Moodle App Configuration]- a free self-paced course for admins on Moodle Academy.
* [[Moodle Mobile FAQ]] for other administration-related mobile app questions.
* [[Moodle app security]]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20debugging%20WS%20requests dev:Moodle Mobile debugging WS requests] - a guide to helping you find and report problems with the Moodle Mobile app on your site
* [https://docs.moodle.org/dev/%20Moodle%20Mobile%20Roadmap dev: Moodle Mobile Roadmap]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20release%20notes dev:Moodle Mobile release notes]
* [https://docs.moodle.org/dev/Moodle%20Mobile Moodle Mobile developer docs]
* [[Moodle Mobile availability plugin]]
* [[Mobile web services]]
[[https://docs.moodle.org/fr/ Guide mobile pour administrateurs]]
[[https://docs.moodle.org/es/Moodle app guía para administradores]]
[[https://docs.moodle.org/de/Moodle App - Anleitung für Administrator/innen]]

Moodle app guide for admins

2023-11-23T15:17:26Z

Juliaverdaguer: Small changes in Matomo and Firebase sections.

{{Mobile}}
==Enable mobile services on your site==
Your site needs to have mobile access enabled so users can use the mobile app.

For sites using https, mobile access is enabled by default in new installations of Moodle 3.0 onwards.

For http sites, mobile access can be enabled by an administrator as follows:
# In ''Site administration > Mobile app > Mobile settings'' tick the 'Enable web services for mobile devices' checkbox. (For 4.0 version: In ''Site administration > Advanced features'' tick the 'Enable web services for mobile devices' checkbox
# Click the button to save changes.
If your site uses a [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL certificate], it must be a trusted certificate. For security reasons the app doesn't work with self-signed certificates.

Please, verify that your certificate is valid via: https://www.geocerts.com/ssl_checker (you shouldn't see any warning).

If your site has the /login directory protected (frequently done when using the Shibboleth authentication method), you must enable access to the login/token.php script.
===Frame embedding===
If your sites uses [https://en.wikipedia.org/wiki/ReCAPTCHA reCaptcha], Vimeo videos or custom menu items (as described bellow) you must enable the admin setting "Allow frame embedding" (allowframembedding). Please, note this is not necessary since Moodle 3.7
===Is your site behind a proxy, or load balancer or complex network infrastructure?===
In that case, you may need to configure the "Ignore reserver proxies" settings in Site administration > Administration > Server > HTTP
==Register your site on the Moodle Apps Portal==
We strongly recommend you to register your site for free on the Moodle Apps portal: https://apps.moodle.com

You will be able to retrieve statistics like the number of active user devices receiving Push Notifications and upgrade to a Pro/Premium plan for enjoying exclusive features.
==Simplify user onboarding==
It's not uncommon for first-time users of the Moodle app to feel a bit lost when they encounter the "Your site" box upon opening the app. This box is where users need to input the URL of their Moodle site in order to access their courses. Here are some steps you can follow to help new users navigate this process:
# Enable the "Site finder" feature that allows users to find their Moodle site by name, eliminating the need to manually enter the site URL. To enable this feature see the next section.
# Enable the “QR login” feature (see below) so they can use the “Scan QR code” button to scan the QR Code available on their profile.
# For Android users and Moodle LMS 4.3 onward only, encourage them to install the app by following the “Get the mobile app” link at the bottom of any Moodle page (within the “?” icon on desktop). If they install the app by following the link, they will be automatically redirected to their site login screen.
# Custom help page: Alternatively and regardless of the Moodle LMS version, you can have your own help page for the Mobile app including a link to the Google Play version of the app indicating your site URL referrer. For example, if your Moodle site is mymoodlesite.com the link will be https://play.google.com/store/apps/details?id=com.moodle.moodlemobile&referrer=siteurl%3Dhttps%3A%2F%2Fmymoodlesite.com
Please notice that options 3&4 are not compatible with Google Workspace accounts (the installation referrer will be ignored in this case)
==Have your site listed in the Moodle app site finder==
The Moodle apps site finder enables a user to easily find their Moodle site by entering the name (no need to enter the site URL)
===How can I have my site listed in the Moodle app site finder?===
Your site will be automatically listed in the site finder if:
* either your site is registered and listed with a link on [https://stats.moodle.org/sites/ Registered sites] and has over five hundred mobile users and you have been using the Moodle app for over a year
* or you have purchased a [https://moodle.com/app/ Pro or Premium Moodle app subscription].
You can arrange for your site to be listed in the site finder as follows:
* If your site is hosted by a Moodle Partner, please contact them to request for your site to be listed.
* If you have a MoodleCloud site, please log in to the Moodle Apps Portal where you will find an option to have your site listed.
Otherwise, to have your site listed in the site finder, you need to purchase a [https://moodle.com/app/ Pro or Premium Moodle app subscription] from the Moodle Apps Portal.
===I don’t want my site listed in the Moodle app site finder. How can I remove it?===
You can remove your site from the site finder as follows:
# Log in to the [https://apps.moodle.com/ Moodle Apps Portal]. (If you don't yet have an account, you can create one for free.)
# Go to ‘App customisation’ -> ‘Site Listing’ and uncheck the option ‘Visible’ then save changes.
Your site will then be immediately removed from the site finder.

Alternatively, you can remove your site from the site finder by updating your site registration:
# Log in to your Moodle site as admin and go to ‘Site administration’ -> Registration.
# Change ‘Site listing’ to either ‘Do not list my site’ or ‘Only display my site name’.
Your site will then be removed from the site finder within 24 hours.
==Mobile authentication==
===SSO authentication method===
If your site uses a SSO authentication method (CAS, Shibboleth, LDAP SSO, OAuth...), then select via a browser window or via an embedded browser for 'Type of login' (typeoflogin) in 'Mobile authentication' in the Site administration. (This setting is provided for older pre-Moodle 3.2 sites via the [[Moodle Mobile additional features]] plugin.)

The options 'browser window' and 'embedded browser' are very similar; the only difference is when redirecting the user to enter their credentials in the site, the site will be opened in the device's default browser (for browser window) or the site will be opened "embedded" in the mobile app (for embedded browser). The user experience is better in embedded browser, but not all the authentication plugins will work in embedded browser (for example, if JavaScript popups are required they must use the 'browser window'). The admin should check whether both options work, and if so, choose 'embedded browser'.

If you are using Google OAuth you will have to use the 'browser window' method because Google recently blocked authentication via 'embedded browsers'.

If your organisation uses a custom branded app and 'Type of login' is set to 'Via a browser window' or 'Via embedded browser', then a URL scheme (forcedurlscheme) may be set. This will result in only the custom branded app working for the site: the official Moodle Mobile app will not work.
===QR Login===
Please note that this feature requires Moodle 3.9 and is only available if you are enjoying a [https://moodle.com/app/ Pro/Premium plan].

As a site administrator, you can enable login via QR. Please go to Site administration > Mobile app > Mobile authentication and select "QR code with automatic login" in the "QR code access" setting

Once enabled, your students will be able to login in the app by scanning a QR code available on their Moodle site profile.
===Biometric Login===
This feature is only available to Pro and [https://apps.moodle.com Premium plan customers].

Biometric login allows your users to log in to your site via the Moodle App on Android and iOS devices using their fingerprint, face recognition or any other biometric option available on their mobile device. This makes the login process simpler, faster and more secure, and is specially useful if Autologout is enabled on your site.

'''Enabling biometric login for your site'''

You can enable Biometric login as an authentication method through the Moodle Apps Portal, going to App customisation > Authentication > Biometric login, and then selecting “Enable biometric login”. Your users will then be able to choose whether they want to use Biometric login or not.

For security reasons, users may be prompted to re-enter their credentials periodically. This interval is determined by the 'User created token duration' (tokenduration) security setting, which is set to a default duration of three months.

'''Setting up biometric login as a user'''

To use biometric login in the Moodle App, users must have biometric authentication enabled in their own device’s settings (e.g. FaceID or TouchID for iOs users, or Fingerprints for Android users).

The first three times users log in to the app after you enable Biometric login, they will see a notification telling them that they can activate this new authentication method to access the app (provided that they have biometric authentication enabled in their device’s settings).

Users can activate and deactivate their biometric login any time in the Moodle App in User account > Preferences.
===Auto logout===
From Moodle LMS 4.3 onwards, you can enhance security by enforcing automatic logout for your users when they leave or close the app, or it goes to the background.

You can even set your own custom re-authentication time, to suit your organisation's security requirements.

To activate auto logout, go to Site administration > Mobile app > Mobile authentication.

This feature is particularly effective when paired with Biometric login, since that streamlines the login process for your users.
== Customise your app theme ==
The app can also retrieve your custom styles from your Moodle site. Since the app is a HTML5 app, you can safely apply any CSS, CSS2 and CSS3 style.

Go to ''Administration > Site administration > Mobile app > Mobile appearance'' and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles.

The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin).

'''For example:''' ''https://mymoodlesite.com/theme/mytheme/style/mymobileapp.css''

Once the user is logged in the app, remote CSS files for applying your custom styles are regularly retrieved.

Notice that on the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.

For further information, see the dev docs [https://docs.moodle.org/dev/Moodle%20Mobile%20Themes Moodle Mobile Themes].

If you want your own custom branding for your organization, Moodle offers the The [https://moodle.com/branded-app Branded Moodle Mobile app] service, please visit https://moodle.com/app/ for more information.
== Moodle Mobile additional features plugin for old Moodle sites ==
For old Moodle sites it is recommended to install the [[Moodle Mobile additional features]] plugin.
== Notifications ==
You might find them annoying but push notifications keeps you and your users informed and updated on everything about the app. Moodle only send useful and important notifications such as new features or service disruptions.

Enabling push notifications is easy! An administrator can enable it by connecting their Moodle site/s to our free Notifications server available (only) for registered Moodle sites.

An access key can be obtained via ''Site administration > General > Messaging > Notification settings''. Be sure the 'Mobile' is enabled and then click the link to settings, on the next page select ''Request access key''. (For Moodle site versions 3.5 and 3.6 an access key can be obtained via ''Site administration > Plugins > Message outputs > Manage message outputs''. Then by clicking the link to the Mobile settings, on the next page select ''Request access key''.)

The full guide on enabling push notifications can be found here: [[Mobile app notifications]]
== App banners ==
[[File:app banner.png|thumb|Moodle Mobile app banner]]
App banners let your users know that there is a mobile app available for the site. App banners are only displayed when accessing the site using a mobile browser.

In Moodle 3.3 onwards, app banners for Android are supported as well as for iOS.

App banners are disabled by default. They can be enabled in 'Mobile appearance' in the Site administration.

If you are using a custom mobile app, you need to provide the unique identifier for the iOS and Android app; if you are using the Moodle Mobile app, the settings may be left as default.

Please, notice the following:
* App banners for iOS devices (iPhone, iPad or iPod) are only shown when accessing the site using the Safari browser
* App banners for Android devices are only shown in very recent Chrome browser versions and when the app is not installed. Note also that Chrome uses an engagement heuristic that will display the banner only on certain conditions, like interactions with the site, the last time you interacted with it, etc. You can remove the engagement restriction check by disabling this special chrome flag: chrome://flags/#bypass-app-banner-engagement-checks. Please notice also that certain custom Android versions (such as Samsung and Huawei ones) does not always support this feature
=='Get the mobile app' link==
In Moodle 3.4 onwards, the link 'Get the mobile app' in the footer of each page on the site encourages users to make use of the mobile app.

By default, the link is https://download.moodle.org/mobile however the setting 'App download page' can be changed e.g. for sites using a branded mobile app.

If mobile services are not enabled for the site, then the 'Get the mobile app' link is not displayed.

To prevent the 'Get the mobile app' link being displayed, simply remove the URL from the 'App download page' setting and save changes.
== Configuring the app from your site ==
'''IMPORTANT''': Please notice that the type and number of features that you can customise depend on your Moodle Apps plan, you can register for free on https://apps.moodle.com to check the different plans.

In Moodle 3.3 onwards, or with the [[Moodle Mobile additional features]] plugin, settings in the Site administration enable admins to configure the app.
* In Moodle 3.3 onwards go to ''Site administration > Mobile features''
* In sites with the Moodle Mobile additional features plugin installed, go to ''Site administration > Plugins > Local plugins > Mobile additional features''
===Force log out===
Replace the Change site option to "Log out" so that users must enter their credentials on their next access. This is useful for custom mobile apps, as there is no reason for users wanting to switch to a different site.
===Disabled features===
The mobile app may be simplified by removing unwanted features. Some items may already be not available in the app because they are not enabled on your site.

Options to remove include:
* Offline use
* Blocks
* Comments
* Ratings
* Tags
* Create new account
* Responsive menu items (new in 3.7)
* Main menu
** Site home
** My courses
** Dashboard
** Calendar
** Notifications
** Messages
** Grades
** My learning plans
** Blog
** Files
** Web page
** Help
* Course
** Blocks
** Blog
** Search
** Competencies
** Participants
** Grades
** Course completion
** Notes
** Download course (new in 3.5)
** Download courses (new in 3.5)
* User
** Blog
** Badges
** Competencies
** Course completion
** Grades
** Send message
** Add contact
** Block contact
** Add a new note
** User picture
* Files
** Private files
** Ste files
** Upload
* Modules (Each module can be disabled separately)
* Blocks (Each block available in the app can be disabled separately)
===Custom menu items===
Additional items can be added to the app main menu (the more menu), such as a link to a different grade book.

Each custom menu item should have format: item text, link URL, link-opening method and language code (optional, for displaying the item to users of the specified language only), icon (optional, the name of the icon from https://ionicons.com) separated by pipe characters.

Possible link-opening methods are:
* app - for linking to an activity supported by the app i.e. almost all activity types, as listed in [[Moodle Mobile features]].
* inappbrowser - for linking to external URLs or site functionalities not supported by the app. The link will open in a browser inside the app overlaying the complete screen.
* browser - as for inappbrowser except that the link will instead open in the device default browser outside the app.
* embedded - as for inappbrowser except that the link will instead open in an iframe in a new page in the app. (For this option you may need to enable the admin setting "Allow frame embedding" (allowframembedding)
Tip: If you add a custom menu item and save changes, then it doesn't appear in the app main menu, double check that the item is correctly formatted.

Please, note that if custom menu items have the same URL, same link-opening method, and same language only the first custom menu item will be shown.

Please, note that if the app is using a language not indicated in the previous list, the first language in the list will be used. (So if you have a custom menu item in English (en) and French (fr), and the app is using Spanish the user will still see that custom menu item in English)

If you want options tied to a language, you can append _only to the language code, for example:
en_only
es_only, will display the custom menu item only when the app language is English or Spanish.

Example of a menu item (it will display a home icon followed by Academy information linking to the URL indicated):
Academy information|https://yoursite.com/mod/page/view.php?id=X |app|en|home
===Responsive menu items===
From 3.7 onwards menu items on bottom tabs are moved to the side of the screen on big screens. Also the number of items displayed on the menu may vary:
* On small screens (usually phones) from 2 to 5 items will be displayed depending on the size of the screen.
* On big screens (usually tablets an desktop version) more than 2 items will be displayed without limit.
If '''Responsive menu items''' is selected in Disabled features items will be displayed in side of bottom anyway but 5 items will be displayed in all cases without depending on the size of the screen.
===Custom language strings ===
Words and phrases displayed in the app can be customised via the "Custom language strings" (customlangstrings) setting.

Enter each custom language string on a new line with format: string identifier, custom language string and language code, separated by pipe characters. For example:
core.user.student|Learner|en
core.user.student|Aprendiz|es
The complete list of string identifiers is listed in https://latest.apps.moodledemo.net/assets/lang/en.json

The string identifier is before the colon.

For example:

"core.user.student": "Student",

means that the string "Student" has string identifier "core.user.student".
==Analytics and stats==
To retrieve information about the Moodle app usage, site administrators and teachers can check the system, course or activity logs.

Among the log filters, there is a field called "All sources" with an option "Web Service" that can be used to filter the entry logs generated by the mobile application.

You can compare the number of log entries generated by the "Web" versus "Web Service" (mobile app) to have an overall idea about how your users use the platform.

Please, notice that if you have custom "Web Services" or an installed plugin that uses Web Services, you will also see entries for them under the same filter.
===Integration with Matomo analytics===
Note: This feature is available for [https://apps.moodle.com Premium app plans and Branded Moodle Apps]. To use this integration, you will need to have your own instance of Matomo.

Matomo is an open source web analytics tool that helps you monitor traffic to your Moodle site, including app activity.

'''Connecting to your Matomo instance in the Apps portal'''
[[File:Captura de pantalla 2023-11-14 a las 12.03.36.png|thumb|Moodle App Matomo Integration set up]]
To use Matomo to track app activity on your Moodle site, you will need to have your own instance of Matomo analytics, and to add your Moodle site as one of your measurable websites (see instructions on [https://matomo.org/faq/how-to/create-and-manage-websites/ Matomo’s website]). Then, follow these steps:
# Log in to the [https://apps.moodle.com Apps portal].
# Go to '''App customisation''' > '''Analytics''' > '''Matomo analytics'''.
# Check '''Track app activity'''.
# Add your '''Matomo URL''' - that’s the URL of your Matomo instance, for example https://yoursite.matomo.cloud.
# Add the '''Website ID''' associated with your Moodle site in Matomo. To obtain this ID:
## Log in to your Matomo account.
## Go to '''Administration''' using the gear icon on the right side of the top navigation bar.
## On the left-hand panel, select '''Websites''' > '''Manage'''.
## In your list of measurables, find the Moodle site in which you want to track app activity. The '''ID''' of the measurable is the '''Website ID''' you need to enter in the apps portal.
# Click '''Save changes''' to establish the connection and start tracking app activity.
# If you’d like to stop tracking at any time, uncheck '''Track app activity''' and then save changes.

To filter Matomo data to isolate mobile app usage from Moodle site interactions, follow these steps:
[[File:Captura de pantalla 2023-11-14 a las 12.05.05.png|thumb|Moodle App Matomo referrer set-up]]
# Log in to your Matomo account.
# Click '''All visits''' at the top of the page
# Create a custom segment by applying this configuration: “Referrer URL” “is” “https://moodlemobile”
# To only see Moodle site interactions, do the following: “Referrer URL” “is not” “https://moodlemobile”
===Google Analytics for Firebase===
Only available when purchasing a [https://moodle.com/branded-app/ Branded Moodle App].

Google Analytics for Firebase is a free tool that provides valuable insights and data about how users interact with mobile apps.
==Web services token duration==
From Moodle 3.4 onwards, an admin can set how long a web services token created by a user (for example via the mobile app) is valid. (In previous versions of Moodle a token was valid for 3 months.)

The setting that dictates the previous 'User created token duration' (tokenduration) can be found under the Security section.
==App's cache==
The app caches WebService requests to decrease data usage and increase the app's speed. When the app needs to get some data from Moodle, it will use a cached request as long as it isn't expired.

This cache was improved in Moodle App 3.7.0, now there are several cache times depending on the WS being called. This means that some requests will expire more often than others. Also, if the user isn't using a WiFi connection, the expiration time will also be longer to decrease the data usage. These cache times cannot be configured using a Moodle setting.
==See also==
* [https://moodle.academy/course/view.php?id=100 Moodle App Configuration]- a free self-paced course for admins on Moodle Academy.
* [[Moodle Mobile FAQ]] for other administration-related mobile app questions.
* [[Moodle app security]]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20debugging%20WS%20requests dev:Moodle Mobile debugging WS requests] - a guide to helping you find and report problems with the Moodle Mobile app on your site
* [https://docs.moodle.org/dev/%20Moodle%20Mobile%20Roadmap dev: Moodle Mobile Roadmap]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20release%20notes dev:Moodle Mobile release notes]
* [https://docs.moodle.org/dev/Moodle%20Mobile Moodle Mobile developer docs]
* [[Moodle Mobile availability plugin]]
* [[Mobile web services]]
[[https://docs.moodle.org/fr/ Guide mobile pour administrateurs]]
[[https://docs.moodle.org/es/Moodle app guía para administradores]]
[[https://docs.moodle.org/de/Moodle App - Anleitung für Administrator/innen]]

Moodle app guide for admins

2023-11-23T14:56:28Z

Juliaverdaguer: /* Auto logout */ small changes

{{Mobile}}
==Enable mobile services on your site==
Your site needs to have mobile access enabled so users can use the mobile app.

For sites using https, mobile access is enabled by default in new installations of Moodle 3.0 onwards.

For http sites, mobile access can be enabled by an administrator as follows:
# In ''Site administration > Mobile app > Mobile settings'' tick the 'Enable web services for mobile devices' checkbox. (For 4.0 version: In ''Site administration > Advanced features'' tick the 'Enable web services for mobile devices' checkbox
# Click the button to save changes.
If your site uses a [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL certificate], it must be a trusted certificate. For security reasons the app doesn't work with self-signed certificates.

Please, verify that your certificate is valid via: https://www.geocerts.com/ssl_checker (you shouldn't see any warning).

If your site has the /login directory protected (frequently done when using the Shibboleth authentication method), you must enable access to the login/token.php script.
===Frame embedding===
If your sites uses [https://en.wikipedia.org/wiki/ReCAPTCHA reCaptcha], Vimeo videos or custom menu items (as described bellow) you must enable the admin setting "Allow frame embedding" (allowframembedding). Please, note this is not necessary since Moodle 3.7
===Is your site behind a proxy, or load balancer or complex network infrastructure?===
In that case, you may need to configure the "Ignore reserver proxies" settings in Site administration > Administration > Server > HTTP
==Register your site on the Moodle Apps Portal==
We strongly recommend you to register your site for free on the Moodle Apps portal: https://apps.moodle.com

You will be able to retrieve statistics like the number of active user devices receiving Push Notifications and upgrade to a Pro/Premium plan for enjoying exclusive features.
==Simplify user onboarding==
It's not uncommon for first-time users of the Moodle app to feel a bit lost when they encounter the "Your site" box upon opening the app. This box is where users need to input the URL of their Moodle site in order to access their courses. Here are some steps you can follow to help new users navigate this process:
# Enable the "Site finder" feature that allows users to find their Moodle site by name, eliminating the need to manually enter the site URL. To enable this feature see the next section.
# Enable the “QR login” feature (see below) so they can use the “Scan QR code” button to scan the QR Code available on their profile.
# For Android users and Moodle LMS 4.3 onward only, encourage them to install the app by following the “Get the mobile app” link at the bottom of any Moodle page (within the “?” icon on desktop). If they install the app by following the link, they will be automatically redirected to their site login screen.
# Custom help page: Alternatively and regardless of the Moodle LMS version, you can have your own help page for the Mobile app including a link to the Google Play version of the app indicating your site URL referrer. For example, if your Moodle site is mymoodlesite.com the link will be https://play.google.com/store/apps/details?id=com.moodle.moodlemobile&referrer=siteurl%3Dhttps%3A%2F%2Fmymoodlesite.com
Please notice that options 3&4 are not compatible with Google Workspace accounts (the installation referrer will be ignored in this case)
==Have your site listed in the Moodle app site finder==
The Moodle apps site finder enables a user to easily find their Moodle site by entering the name (no need to enter the site URL)
===How can I have my site listed in the Moodle app site finder?===
Your site will be automatically listed in the site finder if:
* either your site is registered and listed with a link on [https://stats.moodle.org/sites/ Registered sites] and has over five hundred mobile users and you have been using the Moodle app for over a year
* or you have purchased a [https://moodle.com/app/ Pro or Premium Moodle app subscription].
You can arrange for your site to be listed in the site finder as follows:
* If your site is hosted by a Moodle Partner, please contact them to request for your site to be listed.
* If you have a MoodleCloud site, please log in to the Moodle Apps Portal where you will find an option to have your site listed.
Otherwise, to have your site listed in the site finder, you need to purchase a [https://moodle.com/app/ Pro or Premium Moodle app subscription] from the Moodle Apps Portal.
===I don’t want my site listed in the Moodle app site finder. How can I remove it?===
You can remove your site from the site finder as follows:
# Log in to the [https://apps.moodle.com/ Moodle Apps Portal]. (If you don't yet have an account, you can create one for free.)
# Go to ‘App customisation’ -> ‘Site Listing’ and uncheck the option ‘Visible’ then save changes.
Your site will then be immediately removed from the site finder.

Alternatively, you can remove your site from the site finder by updating your site registration:
# Log in to your Moodle site as admin and go to ‘Site administration’ -> Registration.
# Change ‘Site listing’ to either ‘Do not list my site’ or ‘Only display my site name’.
Your site will then be removed from the site finder within 24 hours.
==Mobile authentication==
===SSO authentication method===
If your site uses a SSO authentication method (CAS, Shibboleth, LDAP SSO, OAuth...), then select via a browser window or via an embedded browser for 'Type of login' (typeoflogin) in 'Mobile authentication' in the Site administration. (This setting is provided for older pre-Moodle 3.2 sites via the [[Moodle Mobile additional features]] plugin.)

The options 'browser window' and 'embedded browser' are very similar; the only difference is when redirecting the user to enter their credentials in the site, the site will be opened in the device's default browser (for browser window) or the site will be opened "embedded" in the mobile app (for embedded browser). The user experience is better in embedded browser, but not all the authentication plugins will work in embedded browser (for example, if JavaScript popups are required they must use the 'browser window'). The admin should check whether both options work, and if so, choose 'embedded browser'.

If you are using Google OAuth you will have to use the 'browser window' method because Google recently blocked authentication via 'embedded browsers'.

If your organisation uses a custom branded app and 'Type of login' is set to 'Via a browser window' or 'Via embedded browser', then a URL scheme (forcedurlscheme) may be set. This will result in only the custom branded app working for the site: the official Moodle Mobile app will not work.
===QR Login===
Please note that this feature requires Moodle 3.9 and is only available if you are enjoying a [https://moodle.com/app/ Pro/Premium plan].

As a site administrator, you can enable login via QR. Please go to Site administration > Mobile app > Mobile authentication and select "QR code with automatic login" in the "QR code access" setting

Once enabled, your students will be able to login in the app by scanning a QR code available on their Moodle site profile.
===Biometric Login===
This feature is only available to Pro and [https://apps.moodle.com Premium plan customers].

Biometric login allows your users to log in to your site via the Moodle App on Android and iOS devices using their fingerprint, face recognition or any other biometric option available on their mobile device. This makes the login process simpler, faster and more secure, and is specially useful if Autologout is enabled on your site.

'''Enabling biometric login for your site'''

You can enable Biometric login as an authentication method through the Moodle Apps Portal, going to App customisation > Authentication > Biometric login, and then selecting “Enable biometric login”. Your users will then be able to choose whether they want to use Biometric login or not.

For security reasons, users may be prompted to re-enter their credentials periodically. This interval is determined by the 'User created token duration' (tokenduration) security setting, which is set to a default duration of three months.

'''Setting up biometric login as a user'''

To use biometric login in the Moodle App, users must have biometric authentication enabled in their own device’s settings (e.g. FaceID or TouchID for iOs users, or Fingerprints for Android users).

The first three times users log in to the app after you enable Biometric login, they will see a notification telling them that they can activate this new authentication method to access the app (provided that they have biometric authentication enabled in their device’s settings).

Users can activate and deactivate their biometric login any time in the Moodle App in User account > Preferences.
===Auto logout===
From Moodle LMS 4.3 onwards, you can enhance security by enforcing automatic logout for your users when they leave or close the app, or it goes to the background.

You can even set your own custom re-authentication time, to suit your organisation's security requirements.

To activate auto logout, go to Site administration > Mobile app > Mobile authentication.

This feature is particularly effective when paired with Biometric login, since that streamlines the login process for your users.
== Customise your app theme ==
The app can also retrieve your custom styles from your Moodle site. Since the app is a HTML5 app, you can safely apply any CSS, CSS2 and CSS3 style.

Go to ''Administration > Site administration > Mobile app > Mobile appearance'' and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles.

The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin).

'''For example:''' ''https://mymoodlesite.com/theme/mytheme/style/mymobileapp.css''

Once the user is logged in the app, remote CSS files for applying your custom styles are regularly retrieved.

Notice that on the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.

For further information, see the dev docs [https://docs.moodle.org/dev/Moodle%20Mobile%20Themes Moodle Mobile Themes].

If you want your own custom branding for your organization, Moodle offers the The [https://moodle.com/branded-app Branded Moodle Mobile app] service, please visit https://moodle.com/app/ for more information.
== Moodle Mobile additional features plugin for old Moodle sites ==
For old Moodle sites it is recommended to install the [[Moodle Mobile additional features]] plugin.
== Notifications ==
You might find them annoying but push notifications keeps you and your users informed and updated on everything about the app. Moodle only send useful and important notifications such as new features or service disruptions.

Enabling push notifications is easy! An administrator can enable it by connecting their Moodle site/s to our free Notifications server available (only) for registered Moodle sites.

An access key can be obtained via ''Site administration > General > Messaging > Notification settings''. Be sure the 'Mobile' is enabled and then click the link to settings, on the next page select ''Request access key''. (For Moodle site versions 3.5 and 3.6 an access key can be obtained via ''Site administration > Plugins > Message outputs > Manage message outputs''. Then by clicking the link to the Mobile settings, on the next page select ''Request access key''.)

The full guide on enabling push notifications can be found here: [[Mobile app notifications]]
== App banners ==
[[File:app banner.png|thumb|Moodle Mobile app banner]]
App banners let your users know that there is a mobile app available for the site. App banners are only displayed when accessing the site using a mobile browser.

In Moodle 3.3 onwards, app banners for Android are supported as well as for iOS.

App banners are disabled by default. They can be enabled in 'Mobile appearance' in the Site administration.

If you are using a custom mobile app, you need to provide the unique identifier for the iOS and Android app; if you are using the Moodle Mobile app, the settings may be left as default.

Please, notice the following:
* App banners for iOS devices (iPhone, iPad or iPod) are only shown when accessing the site using the Safari browser
* App banners for Android devices are only shown in very recent Chrome browser versions and when the app is not installed. Note also that Chrome uses an engagement heuristic that will display the banner only on certain conditions, like interactions with the site, the last time you interacted with it, etc. You can remove the engagement restriction check by disabling this special chrome flag: chrome://flags/#bypass-app-banner-engagement-checks. Please notice also that certain custom Android versions (such as Samsung and Huawei ones) does not always support this feature
=='Get the mobile app' link==
In Moodle 3.4 onwards, the link 'Get the mobile app' in the footer of each page on the site encourages users to make use of the mobile app.

By default, the link is https://download.moodle.org/mobile however the setting 'App download page' can be changed e.g. for sites using a branded mobile app.

If mobile services are not enabled for the site, then the 'Get the mobile app' link is not displayed.

To prevent the 'Get the mobile app' link being displayed, simply remove the URL from the 'App download page' setting and save changes.
== Configuring the app from your site ==
'''IMPORTANT''': Please notice that the type and number of features that you can customise depend on your Moodle Apps plan, you can register for free on https://apps.moodle.com to check the different plans.

In Moodle 3.3 onwards, or with the [[Moodle Mobile additional features]] plugin, settings in the Site administration enable admins to configure the app.
* In Moodle 3.3 onwards go to ''Site administration > Mobile features''
* In sites with the Moodle Mobile additional features plugin installed, go to ''Site administration > Plugins > Local plugins > Mobile additional features''
===Force log out===
Replace the Change site option to "Log out" so that users must enter their credentials on their next access. This is useful for custom mobile apps, as there is no reason for users wanting to switch to a different site.
===Disabled features===
The mobile app may be simplified by removing unwanted features. Some items may already be not available in the app because they are not enabled on your site.

Options to remove include:
* Offline use
* Blocks
* Comments
* Ratings
* Tags
* Create new account
* Responsive menu items (new in 3.7)
* Main menu
** Site home
** My courses
** Dashboard
** Calendar
** Notifications
** Messages
** Grades
** My learning plans
** Blog
** Files
** Web page
** Help
* Course
** Blocks
** Blog
** Search
** Competencies
** Participants
** Grades
** Course completion
** Notes
** Download course (new in 3.5)
** Download courses (new in 3.5)
* User
** Blog
** Badges
** Competencies
** Course completion
** Grades
** Send message
** Add contact
** Block contact
** Add a new note
** User picture
* Files
** Private files
** Ste files
** Upload
* Modules (Each module can be disabled separately)
* Blocks (Each block available in the app can be disabled separately)
===Custom menu items===
Additional items can be added to the app main menu (the more menu), such as a link to a different grade book.

Each custom menu item should have format: item text, link URL, link-opening method and language code (optional, for displaying the item to users of the specified language only), icon (optional, the name of the icon from https://ionicons.com) separated by pipe characters.

Possible link-opening methods are:
* app - for linking to an activity supported by the app i.e. almost all activity types, as listed in [[Moodle Mobile features]].
* inappbrowser - for linking to external URLs or site functionalities not supported by the app. The link will open in a browser inside the app overlaying the complete screen.
* browser - as for inappbrowser except that the link will instead open in the device default browser outside the app.
* embedded - as for inappbrowser except that the link will instead open in an iframe in a new page in the app. (For this option you may need to enable the admin setting "Allow frame embedding" (allowframembedding)
Tip: If you add a custom menu item and save changes, then it doesn't appear in the app main menu, double check that the item is correctly formatted.

Please, note that if custom menu items have the same URL, same link-opening method, and same language only the first custom menu item will be shown.

Please, note that if the app is using a language not indicated in the previous list, the first language in the list will be used. (So if you have a custom menu item in English (en) and French (fr), and the app is using Spanish the user will still see that custom menu item in English)

If you want options tied to a language, you can append _only to the language code, for example:
en_only
es_only, will display the custom menu item only when the app language is English or Spanish.

Example of a menu item (it will display a home icon followed by Academy information linking to the URL indicated):
Academy information|https://yoursite.com/mod/page/view.php?id=X |app|en|home
===Responsive menu items===
From 3.7 onwards menu items on bottom tabs are moved to the side of the screen on big screens. Also the number of items displayed on the menu may vary:
* On small screens (usually phones) from 2 to 5 items will be displayed depending on the size of the screen.
* On big screens (usually tablets an desktop version) more than 2 items will be displayed without limit.
If '''Responsive menu items''' is selected in Disabled features items will be displayed in side of bottom anyway but 5 items will be displayed in all cases without depending on the size of the screen.
===Custom language strings ===
Words and phrases displayed in the app can be customised via the "Custom language strings" (customlangstrings) setting.

Enter each custom language string on a new line with format: string identifier, custom language string and language code, separated by pipe characters. For example:
core.user.student|Learner|en
core.user.student|Aprendiz|es
The complete list of string identifiers is listed in https://latest.apps.moodledemo.net/assets/lang/en.json

The string identifier is before the colon.

For example:

"core.user.student": "Student",

means that the string "Student" has string identifier "core.user.student".
==Statistics==
To retrieve information about the Moodle app usage, site administrators and teachers can check the system, course or activity logs.

Among the log filters, there is a field called "All sources" with an option "Web Service" that can be used to filter the entry logs generated by the mobile application.

You can compare the number of log entries generated by the "Web" versus "Web Service" (mobile app) to have an overall idea about how your users use the platform.

Please, notice that if you have custom "Web Services" or an installed plugin that uses Web Services, you will also see entries for them under the same filter.
===Integration with Matomo analytics===
Note: This feature is available for [https://apps.moodle.com Premium app plans and Branded Moodle Apps]. To use this integration, you will need to have your own instance of Matomo.

'''Connecting to your Matomo instance in the Apps portal'''
[[File:Captura de pantalla 2023-11-14 a las 12.03.36.png|thumb|Moodle App Matomo Integration set up]]
To use Matomo to track app activity on your Moodle site, you will need to have your own instance of Matomo analytics, and to add your Moodle site as one of your measurable websites (see instructions on Matomo’s website). Then, follow these steps:
# Log in to the [https://apps.moodle.com Apps portal].
# Go to App customisation > Analytics > Matomo analytics.
# Check Track app activity.
# Add your Matomo URL - that’s the URL of your Matomo instance, for example https://yoursite.matomo.cloud.
# Add the Website ID associated with your Moodle site in Matomo. To obtain this ID:
# Log in to your Matomo account.
# Go to Administration using the gear icon on the right side of the top navigation bar.
# On the left-hand panel, select Websites > Manage.
# In your list of measurables, find the Moodle site in which you want to track app activity. The ID of the measurable is the Website ID you need to enter in the apps portal.
# Click Save changes to establish the connection and start tracking app activity.
# If you’d like to stop tracking at any time, uncheck Track app activity and then save changes.

In order to only view information about the mobile app on Matomo follow these steps:
[[File:Captura de pantalla 2023-11-14 a las 12.05.05.png|thumb|Moodle App Matomo referrer set-up]]
# Log in to your Matomo account.
# Click the “All visits” option at the top of the page
# Create a custom segment by applying this configuration: “Referrer URL” “is” “https://moodlemobile”
# If you want to do the same for the site, you can just apply the following configuration: “Referrer URL” “is not” “https://moodlemobile”
===Google Analytics for Firebase===
Only available when purchasing a [https://moodle.com/branded-app/ Branded Moodle App]. Google Analytics for Firebase is a free tool that provides valuable insights and data about how users interact with mobile apps. It is a free tool that provides valuable insights and data about how users interact with mobile apps.
==Web services token duration==
In Moodle 3.4 onwards, an admin can set how long a web services token created by a user (for example via the mobile app) is valid. (In previous versions of Moodle a token was valid for 3 months.)

The setting that dictates the previous 'User created token duration' (tokenduration) can be found under the Security section.
==App's cache==
The app caches WebService requests to decrease data usage and increase the app's speed. When the app needs to get some data from Moodle, it will use a cached request as long as it isn't expired.

This cache was improved in Moodle App 3.7.0, now there are several cache times depending on the WS being called. This means that some requests will expire more often than others. Also, if the user isn't using a WiFi connection, the expiration time will also be longer to decrease the data usage. These cache times cannot be configured using a Moodle setting.
==See also==
* [https://moodle.academy/course/view.php?id=100 Moodle App Configuration]- a free self-paced course for admins on Moodle Academy.
* [[Moodle Mobile FAQ]] for other administration-related mobile app questions.
* [[Moodle app security]]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20debugging%20WS%20requests dev:Moodle Mobile debugging WS requests] - a guide to helping you find and report problems with the Moodle Mobile app on your site
* [https://docs.moodle.org/dev/%20Moodle%20Mobile%20Roadmap dev: Moodle Mobile Roadmap]
* [https://docs.moodle.org/dev/Moodle%20Mobile%20release%20notes dev:Moodle Mobile release notes]
* [https://docs.moodle.org/dev/Moodle%20Mobile Moodle Mobile developer docs]
* [[Moodle Mobile availability plugin]]
* [[Mobile web services]]
[[https://docs.moodle.org/fr/ Guide mobile pour administrateurs]]
[[https://docs.moodle.org/es/Moodle app guía para administradores]]
[[https://docs.moodle.org/de/Moodle App - Anleitung für Administrator/innen]]

Moodle app FAQ

2023-11-23T13:27:33Z

Juliaverdaguer:

{{Mobile}}
==Students==
===How can I log in?===
To log in to your Moodle site with the Moodle App, you need the URL (web address) of the Moodle site that you’re trying to access. If your organisation has Search enabled, you can try searching by the name of your organisation or eLearning site.

If your organisation allows you to log in via QR code, you’ll find the QR code at the bottom of your user profile on your Moodle site. You just need to press “Scan QR code” on the app, scan the QR code on your profile and you’ll be logged in automatically.

If your organisation allows you to log in using face recognition or fingerprint, you can activate this in the App, going to User account > Preferences. You’ll need to have biometric authentication enabled in your own device’s settings.
===Who can I contact for help with the app?===
If you’re a student and need help with issues related to logging in, registering to a Moodle site or trouble connecting to the app, you should contact your school or learning organisation. For example, one of your teachers, or the person who takes care of Moodle.
Moodle HQ make the Moodle software and the Moodle app, but they don’t manage nor have access to your Moodle site or your user data.
===How can I get the Moodle app?===
You can download the Moodle App for free from [https://play.google.com/store/apps/details?id=com.moodle.moodlemobile Google Play] and the Apple [https://itunes.apple.com/app/moodle-mobile/id633359593?mt=8 App Store]. You will find it by searching “Moodle”, and the author/owner is “Moodle Pty Ltd”.
If you are unable to download the app from Google play, please visit [https://download.moodle.org/mobile/ Moodle app downloads]
===I can't get the app to work. ===
The app only works with Moodle sites that have been set up to allow it, and that are running on at least Moodle 3.5. If you have any trouble connecting to your site, please contact the person who takes care of Moodle in your school or learning organisation.
===I can’t find my Moodle site in the app. ===
To find your Moodle site on the app login screen, try searching for the name of your school or learning organisation.

If your school or organisation doesn’t appear in the search, you can try searching by your Moodle site URL address instead. If you don’t know the address of your Moodle site, here’s how you can find it:
# Open a web browser (like Chrome or Safari) and go to your school’s Moodle site login page.
# At the top of the page in the address bar, you'll see the URL address of your Moodle site, e.g. “campus.example.edu”. [[File:FAQ I cant find my site 1.png|alt=URL|thumb|none|''campus.example.edu'']]
# Copy the URL (don’t copy the /login nor what comes after), paste it into Your site in the app, then select Connect to your site. [[File:FAQ I cant find my site 2.png|alt=Adding an URL to the app|thumb|none|Adding an URL to the app]]
# Now you can log in to your site with your username and password.

If you tried searching by URL address and still can’t find your Moodle site, please get in touch with the person who takes care of Moodle in your school or learning organisation.
===I can’t log in with the app===
To log in to your Moodle site using the app, you first need to connect to your school’s Moodle site (view [[I can’t find my Moodle site in the app]] if you can’t find your site).

Once you’ve connected to your Moodle site, you should be able to log in with your usual username and password.

If you forgot your username or password, select the option '''Forgotten your username or password?'''. If you still have trouble logging in or can’t see any options for retrieving your username or password, please get in touch with the person who takes care of Moodle in your school or learning organisation.
===I see an error message when I try to use the app===
If you see an error message that prevents you from using the app, please get in touch with the person who takes care of Moodle in your school or learning organisation.

Some of the most common errors that your school or learning organisation will be able to fix are:
* Your token is expired or not valid.
* An error mentioning the parameter “includestealthmodules”.
* The web service function is not available.
* A message about site maintenance.

If you’re experiencing any of these errors, contact your school or learning organisation for help.
===What permissions does the app require?===
The app requires the following permissions:
* Record audio - for uploading to your Moodle site
* Read and modify the contents of your SD card - for content to be downloaded to your SD Card for offline access.
* Network access - to be able to connect with your Moodle site and check if you are connected, and if not to switch to offline mode.
* Run at startup - to receive local notifications even when the app is running in the background.
* Prevent phone from sleeping - to receive push notifications anytime.
===What are the minimum device requirements to use the Moodle app?===
Android devices: Require Android 5.1 or later.
iOS devices (iPhones/iPads): Require iOS 11 or later.
===I can't see my course on the app. What do I do?===
Check with your course tutor that you are correctly enrolled.
=== Why can't I upload my assignment on the app?===
If you’re experiencing any issue uploading assignment, please contact your school or learning organisation for help.
===Why can't I sometimes access the app or submit anything to it?===
This could be because of interruptions in your internet connection. Wait a while and try again. If you continue to have problems, contact your school or learning organisation for help.
===Is there a space limit on my files?===
Assignments will have a size limit which you can see, those are set by your teachers. For other space limit questions, check with your your school or learning organisation .
===When are activities completed offline synchronized?===
See [[Moodle app synchronization]].
===Why the site is asking for my username and password when an activity is opened in the browser?===
Auto-login from the app is only supported in sites using Moodle 3.2 onwards. Also, for security reasons, between auto-logins you must wait 6 minutes (this should not be a problem because most of the browsers will keep your Moodle session open).
=== The Moodle app might seem slow (especially on Android devices) ===
There are several factors that could be causing this issue. It could be due to outdated or underperforming devices, or perhaps there are too many applications open, causing limited memory in your mobile device.

To troubleshoot this problem, we recommend trying the application with our demo site: https://school.moodledemo.net. Simply use the username "student" and the password "moodle" to access the site. If you find that the navigation and overall experience with the app are improved, then the issue may be at the server level. In this case, we suggest contacting your school or learning organisation for further assistance.
=== The Moodle app restarts/ closes / reopenes itself ===
This is likely because there are too many apps opened on your mobile device. Mobile devices have a finite amount of memory, and the device's memory manager is responsible for determining which applications to keep open and which to close.
To optimise your device's performance, we recommend closing all applications that are not currently in use. This will free up valuable memory and ensure that your device runs smoothly.
===I use LineageOS and I'm having problems using the app===
LineageOS uses a different WebView implementation not compatible vith the app. You need to install "Android System WebView" from Google Play (or via a trusted apk) and enabling it via Settings > Developer options > WebView implementation.
===H5P packages and external content embedded via iframes are not working on iOS ===
This is caused by a new feature of iOS 14 called ITP that blocks cookies for external sites embedded in the app (the H5P content is played embedded in an iframe pointing to the Moodle website) unless the user enables a setting in the app to allow those cookies.

The quick workaround is to enable the setting "Allow Cross-Website Tracking" available via the Settings app (look for the Moodle app, at the bottom) on your iPhone/iPad with iOS 14.
==Teachers==
===How can I enable videos in my course to be downloaded?===
See the section 'Media download for offline usage' in [[Creating Moodle-app-friendly courses]].
===Video subtitles are not working===
This may happen in old Android versions (Android < 4.4), in modern Android and iOS versions they should work fine.
===Which course format is it best to use?===
Topics or weekly course format is best suited to mobile devices.
===How do I make YouTube links open automatically in the app?===
Add YouTube links as a [[URL resource]].
===Why can't my students see their courses?===
If you or an administrator have correctly enrolled them in a course, they can see it in their mobile app. If they are correctly enrolled but can still not see their course, ask them to check with your Moodle site administrator.
=== I can't mark assignments in the app===
If you are experiencing problems when grading, please review that you are using the correct decimal separators (if the app interface is in English, you must use a period).
===What communications tools can I use in the app to engage with my learners?===
See [[Mobile app notifications]]. Chat, forums and messaging are all supported by the app.
===My Vimeo videos are not playing in the app===
In older versions of Moodle (pre-Moodle 3.7), it may be necessary to activate the "Allow frame embedding" admin setting. However, for those using Moodle version 3.7 or later, it is important to check whether a Proxy/Firewall/Web Server security module is setting the X-Frame-Options header in your HTTP request responses. If this is the case, it is recommended to deactivate this feature as it may cause conflicts, as Moodle already sets this header by default.

You may also use Bootstrap responsive classes: https://getbootstrap.com/docs/4.0/utilities/embed/, for example, <div class="embed-responsive">
For older versions, see this forum discussion with a workaround: https://moodle.org/mod/forum/discuss.php?d=327342

If the issue is with vimeo videos on Moodle sites 3.10 or 3.11, please update the Moodle site to the latest version possible (at least 3.10.10 or 3.11.6). (See https://tracker.moodle.org/browse/MDL-74042)
===ReCaptcha doesn't work on my site===
In older versions of Moodle (pre-Moodle 3.7), it may be necessary to activate the "Allow frame embedding" admin setting. However, for those using Moodle version 3.7 or later, it is important to check whether a Proxy/Firewall/Web Server security module is setting the X-Frame-Options header in your HTTP request responses. If this is the case, it is recommended to deactivate this feature as it may cause conflicts, as Moodle already sets this header by default.
===H5P packages don't work on my site===
In older versions of Moodle (pre-Moodle 3.7), it may be necessary to activate the "Allow frame embedding" admin setting. However, for those using Moodle version 3.7 or later, it is important to check whether a Proxy/Firewall/Web Server security module is setting the X-Frame-Options header in your HTTP request responses. If this is the case, it is recommended to deactivate this feature as it may cause conflicts, as Moodle already sets this header by default.

This can also happen when you are using the non-official H5P plugin (mod_hvp), in that case you will see the following message: This site is not configured properly for displaying mobile H5P content. Please contact a site administrator so they can apply the above suggested configuration changes.

'''Cookies issues'''

If your site uses HTTPS please ensure that the "Secure cookies only" (cookiesecure) setting under Site administration > HTTP security is enabled.

'''Dependency errors'''

When the following error appears "Missing dependency H5P.Editor. something X required by H5P.Editor. something Y". H5P packages need to include all the libraries (dependencies) they use so the package is self-contained. But sometimes packages might be missing at least one dependency.

In order to fix this, you could do the following:

Open Moodle’s Content Bank (from the link in the problematic H5P settings page) and upload your H5P package there, once uploaded, you will see the H5P package and an “Edit” button, click on that button so the editor opens, scroll down and click “Save”.
Now, you can replace the problematic H5P with this new one, for this, you can just include it from the Content bank by opening the activity settings page and the file picker.
=== I use a Moodle plugin but the app says it is not supported ===
You should contact the plugin developer and point him to this documentation: https://docs.moodle.org/dev/Moodle_Mobile_Remote_addons where it is explained how to add support to plugins in the Mobile app.

There is a list of Moodle plugins supported by the app here: https://moodle.org/plugins/browse.php?list=award&id=6
=== I have problems playing SCORM packages ===
This might be caused because:
* The SCORM was added using an advanced option (remote imsmanifest.xml packages or file system repository unzipped SCORMS)
* The SCORM ZIP file was created using a tool that does not create standardised ZIP files (for example, zip files containing the inverted path separator "\" will not work on Android)
Please refer to [[Moodle app SCORM player]] for additional information.
=== My quizzes or lessons are not working offline ===
You need to edit the quiz or lesson activity settings and enable the "Allow lesson/quiz to be attempted offline using the mobile app" configuration option.
=== Maths notation is not displaying correctly in the app ===
If you are having issues with MathJax, please enable the [[TeX notation filter]] also.

If you have both filters enabled, please leave MathJax above TeX so it is always processed before TeX.
=== How can I disable text selection / copy in the app? ===
You can create a remote theme and add some custom CSS rules to disable it, see https://docs.moodle.org/dev/Moodle_Mobile_Themes
=== My images, videos or audios stop working after the first time ===
Please make sure the URL you're using on the media file doesn't have any redirect (e.g. http to https), always try to use the final URL. There's a bug in the library we use to download those files, it doesn't work when downloading files with redirects. We have plans to remove that library from the app, but since then please always try to use URLs without redirects.
==Administrators==
=== What plans are available for the Moodle app? ===
There are three main plans available for the Moodle app: Free, Pro, and Premium, each offering different features and benefits. In addition to the three main plans, there is also a Branded Moodle App (BMA) option. The BMA is a custom-built app that is branded to your organization. Learn more in [[Moodle app plans]].
=== How can I have my site listed in the Moodle app site finder? ===
Please refer to our [[Moodle app guide for admins]] for instructions.
=== How can I debug errors in the app? ===
Go to the More tab and then to Settings > General. Enable "Display debug messages". This will show an explanatory message when an error occurs, alternatively, you can do a full debugging via: https://docs.moodle.org/dev/Moodle_Mobile_debugging_WS_requests
=== I can connect with my iPhone (or iPad) but not with my Android phone ===
This usually happens when the site is using https and the certificate is not correctly configured or it is using an old protocol, please use these pages to check this certificate: https://www.sslshopper.com/ssl-checker.html, https://www.geocerts.com/ssl_checker, and https://www.ssllabs.com/ssltest/analyze.html
=== My certificate is fine but I still can't connect ===
This is usually a server configuration problem caused by any of the following server configuration issues:

'''"Access to XMLHttpRequest at 'https://yoursite/webservice/rest/server.php?moodlewsrestformat=json<nowiki/>...' from origin '<nowiki>http://localhost'</nowiki> has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.'''

This is because a Proxy/Firewall/Web Server security module is removing automatically the Access-Control-Allow-Origin: * header that Moodle sets to allow Web Service requests.

It is totally secure to remove that Proxy/Firewall/Web Server rule/configuration because that header is only set by Moodle when needed.

'''"access-control-allow-origin cannot contain more than one origin".'''

iOS and Android apps do not allow the following header to contain more than one item: "Access-Control-Allow-Origin". For example, a header like this: Access-Control-Allow-Origin: *, https://mydomain.com will cause problems.

This HTTP header is not valid, according to the specification you can only specify a domain or a "*":
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin

Please, review if you have a Proxy/Firewall/Web Server adding automatically values to that HTTP header.

'''Security rules are blocking requests using the Accept-Charset header'''

Some security rules, such as OWASP ModSecurity, are blocking requests with this header that is sent by the Moodle App. In future releases of the app, this problem will be fixed. But in the meantime, you should disable it. Find more about this in MOBILE-4342.
=== My certificate is fine but the Moodle app is detecting http instead of https ===
If the Moodle app is detecting http instead of https, please revise config.php (check "wwwroot" as well as "httpswwwroot")
===I can't get the app to work. What can I do?===
Assuming you have enabled mobile services on your site, please check:
# If your site uses an SSL certificate, it must be a trusted certificate, not self-signed. Please use these tools or a similar one to check that your certificate is fine: [https://www.sslshopper.com/ssl-checker.html SSL Checker], [https://www.geocerts.com/ssl_checker SSL Checker], and [https://www.ssllabs.com/ssltest/analyze.html SSL Server Test]. All the checks must be ok, including the "Certificate Chain Complete". Otherwise the app might work on iOS but not on Android.
# [[Debugging]] is disabled (in ''Site administration > Development > Debugging'')
# The ADOdb debug option is disabled if you are using the external database auth or enrolment plugin (in ''Plugins > Authentication > External database'' and in ''Plugins > Enrolment > External database'').
# SHA-1 https certificates are not supported anymore in Chrome, this means that the Android version of the app won't work for your site. If your site doesn't work in desktop Chrome or Chromium it won't work in the Android app. See https://blog.chromium.org/2014/09/gradually-sunsetting-sha-1.html for more information
# If you are using IIS check that Anonymous access is not disabled for the /webservice directory.
# If you are using a web application firewall like StackPath, Barracuda, Cloudflare, Juniper, etc... try to temporary disable it to check if that's the cause. If so, you'll have to whitelist these endpoints: login/token.php, webservice/*, lib/ajax/*, media/player/vimeo/wsplayer.php and /tokenpluginfile.php
If you still have a problem, please post in the [https://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum].
=== I cannot access with old users, but I can with recently created ones! ===
Please, do a "Purge all caches" via the Moodle administration settings, this will solve the problem.
===I can't view the courses tab as an administrator===
The Moodle app only displays courses you are enrolled in. If you want to view a course as an admin, you need to enrol in it.
===My Moodle site uses a SSO auth method (Shibboleth, CAS, Google OAuth, etc) and the app is not working===
See the section 'Mobile authentication' in the [[Moodle app guide for admins]] for details of how to configure it.

If configured the app is still not connecting: If your site uses an SSL certificate, it must be a trusted certificate, not self-signed. Please use this tool or a similar one to check that your certificate is fine: [https://www.geocerts.com/ssl_checker SSL Checker]. All the checks must be OK, including the "Certificate Chain Complete".

If your SSO method is unable to authenticate when using an "embedded browser" (it gives an authentication error), please check if it works with a "browser window". If it does work with the browser window then it means your SSO is performing an HTTP redirect, and these kind of redirects aren't supported by the app (the request is redirected by the browser not passing the POST parameters). Unfortunately, this is something we cannot control in the Mobile app (it can't be handled via JavaScript). For further information, see http://stackoverflow.com/questions/228225/prevent-redirection-of-xmlhttprequest and http://stackoverflow.com/questions/4168784/ajax-redirection-handling

There are only 2 possible solutions: set the authentication via a "browser window" instead of an embedded one (please notice this won't work in the Linux desktop app), or remove the redirect from the SSO auth method.
===SSO is not working with my custom auth plugin===
SSO should work in any plugin if the plugin handles correctly the $SESSION->wantsurl, this is the way SSO works when it is launched via the app:
* It launchs this URL https://yourmoodle/admin/tool/mobile/launch.php?service=local_mobile&passport=abc in the device browser
* If the user is not logged in, the browser will redirect the user to the login page
* If the auth plugin used implements correctly the handling of the wantsurl session var, once the user has logged in, the browser should redirect back to the https://yourmoodle/admin/tool/mobile/launch.php?service=local_mobile&passport=abc URL that will launch the mobile app via the custom URL protocol
Custom auth plugins may be failing in the last step,not redirecting back to tool/mobile, this will happen only if the plugin does not support correctly the $SESSION->wantsurl.

The SAML plugin works correctly but some modifications of that plugin may not work if important lines are changed.
===I am having problems requesting an airnotifier access key===
If you have registered your site but are still unable to request an access key, please register your site on the Moodle Apps Portal https://apps.moodle.com once your site is registered there, an Airnotifier access key will be automatically generated for you.
=== Push notifications are not working ===
Please check [[Mobile app notifications#Troubleshooting]]
=== How notifications icon badges are updated ===
'''Android''': Not all Android devices support icon badges so in some cases badges will never display numbers, also, depending on the device only a badge indicating that there are new notifications will be displayed when receiving a Push notification when the app is not in the foreground.

'''iOS''': The icon badge counter is only updated when the app is open and it will reflect the number of notifications pending reading or the number of message senders that sent you a message you have not read yet

In general, for iOS the icon badge displayed number should match the one displayed at the bottom of the app (or it should be the sum of the notifications and messages badges) and is not an indicator of the number of Push notifications the user has received, it acts as a reminder of pending notifications to be read that only gets updated when the user open the apps

There is an open issue to improve the behaviour on iOS, please watch MDL-73707
=== I configured 'QR code access' to automatic login, but the app still asks for credentials ===
Automatic authentication only works for Pro and Premium sites. You can see the app plans [https://moodle.com/app/ in this site].

I you're getting an error saying that the device you're using to connect isn't in the same network as the device that displays the QR code but both devices are connected to the same network, please check the section: [[#ipmismatch:_.27Client_IP_address_mismatch.27|ipmissmatch: 'Client IP address mismatch']].
=== Some users are asked to reauthenticate too often when they browse the site ===
This can happen if the app is sending too many variables to a WebService, e.g. because a course has a large number of sections and/or activities. This error will be fixed in the 3.9.3 version of the app, but you can increase the value of ''max_input_vars'' in ''php.ini'' to fix it in your server.
=== After upgrading to 3.9.5 some of my plugins have stopped working ===
The Moodle App 3.9.5 version comes with some breaking changes for plugins, most of the existing plugins have been updated to support the new changes.

Please check the following list of plugins that should work for 3.9.5 once you have upgraded to the latest version indicated in the document: https://docs.google.com/spreadsheets/d/1E9PqcUBpp9SAfQc_zJtX5tf9GeS3UN76A85IrrB4UDw/edit#gid=0
=== After upgrading to 3.9.5 I can log in on my Moodle site but I see a blank page or the app styles broken ===
This is usually because your Moodle site has a customised CSS.

Please try leaving empty CSS (''mobilecssurl'') on Site administration > Mobile app > Mobile appearance. If that works, please read [https://docs.moodle.org/dev/Moodle_App_Remote_Themes Moodle App Remote Themes] and create a new CSS file using the variables mentioned there
=== I cannot access my site after upgrading to 3.9.5 ===
In the v3.9.5 of the app some security checks have become more strict than they used to in Android. Please check the following:
* Make sure your certificate is valid. Please use these pages to check this certificate: https://www.sslshopper.com/ssl-checker.html, https://www.geocerts.com/ssl_checker, and https://www.ssllabs.com/ssltest/analyze.html
* Make sure that the "Access-Control-Allow-Origin" header only contains one item. For example, a header like this: Access-Control-Allow-Origin: *, <nowiki>https://mydomain.com</nowiki> will cause problems.
===Error messages===
==== 'Coding error: version.php file is missing for the component' ====
This error message indicates that that plugin is not correctly installed (or uninstalled) on the Moodle site you use (see [[Installing plugins]]). Please review the mod/certificate folder to check if the version.php file is missing (or has incorrect permissions) as well as purge cache too.
==== 'Can not find data record in database table external_functions' ====
This error usually happens due to a bad configuration or setting value in your Moodle site, please check:
# The user quota global setting should be an integer. For more details, see the discussion [https://moodle.org/mod/forum/discuss.php?d=320873 How to enable Moodle Mobile App for all accounts].
# The ''usermaxuploadfilesize'' should be an integer, please try to decrease the size. It can be configured in ''Site Administration > Security > Site Policies > Maximum uploaded file size''. The default value (Site upload limit) depends on the PHP configuration, you might have to change the value of ''upload_max_filesize'' and ''post_max_size'' in your ''php.ini'' file.
# The user "lang" field in the database is set to a correct value and existing language installed in the site. Some times the lang field is set via external systems to incorrect values or pointing to a language pack that was uninstalled. Please, note that to fix this you need direct access to the database and your 'user' and 'course' table.
===='Cannot connect: Verify that you have typed correctly the URL and that your site uses Moodle 3.5 or later'====
Take into account that the app will only connect to Moodle LMS sites version 3.5 onward.
Please also check:
# Mobile services are enabled for the site.
# The user is entering the correct URL for the site (see FAQ above)
# For https sites, the certificate is valid (see FAQ above)
===='Invalid Moodle site version. The Moodle app only supports Moodle systems 3.5 onwards'====
The app will only connect to Moodle LMS sites version 3.5 onward (see [https://docs.moodle.org/35/en/Upgrading Upgrade to 3.5] as well as [[Upgrade overview]]).
===='We lost connection; you need to reconnect. Your token is now invalid.' on my custom version of the Moodle app ====
Please check:
# You have followed all the steps listed in [https://docs.moodle.org/dev/Moodle%20Mobile%20Developing%20a%20plugin%20tutorial Moodle Mobile Developing a plugin tutorial]
# You have enabled the [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] for the authenticated user
===='No permission to create web service token for the service local_mobile' when attempting to log in (any user that it is not an admin)====
Please check you have enabled the moodle/webservice:createtoken for the authenticated user or any global role you want to allow to use the mobile app
===='No permission to create web service token for the service local_mobile' when attempting to log in as an admin====
You need to create a token for the admin account (only) as follows:
# Go to ''Site administration > Plugins > Web services > Manage tokens''
# Click Add
# Enter the admin username and select 'Moodle app additional features service' (i.e. do NOT leave it as 'Moodle app web service')
# Click the 'Save changes' button.
===='Invalid response value detected' when accessing the site ====
The user quota global setting should be an integer. For more details, see the discussion [https://moodle.org/mod/forum/discuss.php?d=320873 How to enable Moodle Mobile App for all accounts].
==== ' Invalid response value detected: Invalid external api response: the value is "", the server was expecting "raw" type" ====
This usually happens when there is a field with value NULL in a table in the database that should not be there. This may happen if your Moodle has been upgraded over many years and the database schema is broken.

To fix it, you can do the following:
* Detect the field that is causing the problem (it should be indicated before the error message)
* Fix the field, for example, for the password field in the lesson table: UPDATE mdl_lesson SET password = '' WHERE password IS NULL (remember that your table prefix can be different than mdl_)
===='Invalid response value detected' when accessing My Courses or Course Overview ====
This usually happens when a course uses a language that isn't installed in the site. Please make sure that all courses use valid languages. This can be easily checked in the database, table "course", there is a column named "lang".
===='A required parameter (username) was missing'====
This may happen if your site implements HTTP redirects; the request is redirected by the browser not passing the POST parameters.

Unfortunately, this is something we cannot control in the Mobile app (it can't be handled via JavaScript). For further information, see http://stackoverflow.com/questions/228225/prevent-redirection-of-xmlhttprequest and http://stackoverflow.com/questions/4168784/ajax-redirection-handling

The solution is to change the HTTP redirect and use an HTML page with a meta tag or JavaScript redirect.
===='Invalid json in request: No error'====
There is a bug in Moodle 3.3 that can cause this error. Please update to Moodle 3.3.2.
===='Cannot get course contents'====
This usually happens when the course is using a course format plugin that was uninstalled from the server or that was not properly installed.

Please, reinstall again the course format plugin.
===='Access control exception' or 'Your authentication token is invalid or has expired'====
If this error appears as soon as you enter the username and password for a new site, then it probably means that the token expiration time is badly configured. This is how to fix it:
# Go to ''Site administration > Security > Site security settings''.
# Find the setting named ''User created token duration''.
# If the value is set to 0 or it's too low, please set it back to a valid value (the default value is 12 weeks).
# Click the 'Save changes' button.
====ipmismatch: 'Client IP address mismatch'====
This error can appear when a user opens your site in a browser while using the app. This happens if your site is behind a proxy and you're using one of these Moodle versions o higher: 3.5.11, 3.6.9, 3.7.5, 3.8.2, 3.9.0.

To fix it:
# Go to ''Site administration > Administration > Server > HTTP''.
# Find the setting named ''Ignore reverse proxies'' (reverseproxyignore).
# Enter the IP of your proxy (or range of IPs).
# Click the 'Save changes' button.
If you are still experiencing issues please try to change this setting "getremoteaddrconf" (Logged IP address source) to the different existing values.

Finally, it is possible to disable the IP restriction checks for functionality such as the QR login, to do that, go to Site administration > Mobile app > Mobile app authentication, and disable the "QR authentication same IP check" setting.
==== 'The param "includestealthmodules" is invalid' ====
Please contact your learning organisation so they upgrade to at least Moodle 3.5.3 (see [https://docs.moodle.org/35/en/Upgrading Upgrade to 3.5] as well as [[Upgrade overview]]) or they manually apply the patch listed here [[MDL-63542]].
===The Moodle app does not connect to MoodleBox (or other internal self-hosted systems)===
You will need to disable SSL to make the app works, please see this forum discussion for more information: https://moodle.org/mod/forum/discuss.php?d=424353#p1739474
===I think I found a bug with the app. Where can I report it?===
# Log in to the [https://tracker.moodle.org/browse/MOBILE Moodle Mobile tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)
# Check whether the issue has already been reported by doing a [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE search]
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle app' as the project
# Add a detailed description providing as much information as possible (Moodle version, app version, device model and operating system, etc...), then click the Create button
===How can I get the app in my language?===
[[File:setting the app lang.png|thumb|100px|Setting your language]]
The Moodle app automatically detects your mobile's language and displays in the same language (if the translation exists). Otherwise, you can set the app language in App settings > General.

If the Moodle app is not yet available in your language, please contribute a translation! See [https://docs.moodle.org/dev/Translating%20Moodle%20Mobile Translating Moodle Mobile] for details of what to do.
=== Changes made to a Moodle site URL can cause logged-in users’ data to fail when synchronising. ===
We recommend that administrators manually log out all users after a site rename. If your site URL changes and have site users that are using the mobile Moodle App we suggest the following:
* For users that have not yet logged in - we recommend sending them the new URL
* For users already using the mobile Moodle App and potentially logged in request them to:
** log out of the mobile Moodle App,
** delete the old site, and
** log in using the new URL
Logged in Moodle users can continue working with the previous URL (with cached information) but they will not be able to synchronise the new information (therefore not receiving new information from their teachers, and teachers not receiving data or submissions from those students).
* To avoid the risk of data not synchronising, we recommend the site administrator logs out all app users, by manually deleting their tokens:
** Go to Site administration
** Click Server
** Click Web services
** Click Manage tokens
** Delete the tokens
Take into account that you still need to request your users to log in using the new URL.
==Any further questions?==
Please post in the [http://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum] on moodle.org.
[[Category:FAQ]]
[[https://docs.moodle.org/de/Moodle Mobile - FAQ]]
[[ca:Moodle Mobile FAQ]]
[[https://docs.moodle.org/es/Moodle app FAQ]]
[[https://docs.moodle.org/fr/Moodle pour les mobiles]]
[[https://docs.moodle.org/ja/モバイルMoodle FAQ]]

Moodle app plans

2023-11-23T13:05:46Z

Juliaverdaguer: Minor changes on the text

{{Mobile}}
Our mobile application is absolutely free for end users, including students and teachers. They have unrestricted access to all the features they need to access courses, at no cost.

However, organisations can [https://apps.moodle.com subscribe to our Pro or Premium plans, or purchase a Branded Moodle App (BMA)]. These options provide additional, exclusive features to enhance their Moodle experience.

By subscribing to a plan or purchasing a BMA, organisations also contribute to Moodle's sustainability.
== Free plan ==
The free plan is enabled by default for all Moodle Sites. It provides the most common functionality for students. Certain advanced functionalities are restricted, but organisations can enable them by upgrading to a Pro or Premium Plan.

'''What’s included in the Free plan?'''
* Compatible with most Moodle sites, except sites hosted by non-official partners or service providers.
* Access to all course content and most of the features for students available in LMS.
* 50 active devices for push notifications.
* Access to 2 offline courses per device per site.
* Customisable app features via Moodle site administration:
** 1 custom menu item.
** 1 disabled feature.
** 10 custom language strings.
== Pro plan ==
The Pro plan includes all the features from the Free plan, plus additional functionality for organisations to enhance their users' onboarding experience. It also provide Push notifications access to up to 500 user devices, and offers more configuration options.

'''What’s included in the Pro plan?'''
* Compatible with most Moodle sites, except sites hosted by non-official partners or service providers.
* Multimedia Push notifications.
* Custom site listing in search results.
* QR login.
* Biometric login.
* 500 active devices for push notifications.
* Access to 4 offline courses per device per site.
* Customisable app features via Moodle LMS site administration limits:
** 2 custom menu items
** 2 disabled features
** 20 custom language strings
== Premium plan ==
The Premium plan includes all the features of the Pro plan, plus basic branding customisation options and unlimited devices for push notifications and offline courses.

'''What’s included in the Premium plan?'''

Compatible with most Moodle sites.
* Basic branding.
* Integration with Matomo Analytics.
* Unlimited devices for push notifications.
* Unlimited offline courses.
* No limits to the app features that can be configured via Moodle LMS site administration.
== Branded Moodle App (BMA) ==
A Branded Moodle App includes all features from Premium plans, and provides organisations with their own app on Google Play and App store. The app name, logo and branding can be customised to match the organisation's identity, creating a trusted and consistent learning experience.

Your BMA can seamlessly connect with Google Analytics for Firebase, providing you with valuable insights into user behaviour, engagement, and app usage patterns.

For more information, visit the [https://moodle.com/branded-app/ Branded Moodle App page at moodle.com].

For more information about the different subscription options visit the [https://apps.moodle.com Moodle Apps Portal].
== Moodle App features ==
The following features are available to organisations depending on the Moodle App plan they subscribe to.

=== Active devices for Push notifications ===
Calculated monthly, this is the number of unique user devices actively receiving push notifications from a Moodle site.

For example, for a site with 200 users enrolled and using the app with one device configured to receive push notifications, the potential number of active devices per month will be 200.

==== Multimedia Push notifications ====
For Android only, the Push notifications received by your users can include images. Similar messages will be grouped, for example, when receiving private messaging notifications. Requires activation via the Moodle Apps Portal.
=== Custom site listing in search results ===
Enable users to find your site by name when logging in to the app, removing the need to type the full URL of your site. You can configure how the results are displayed in the “Site finder” in the Moodle Apps Portal, including adding an image for your site and additional information.
=== QR login ===
Your users will be able to log in to the app by scanning a QR login, available on their Moodle site profile. Requires activation in your Moodle site's administration settings, and is compatible with Moodle LMS 3.9 and later.
=== Biometric login ===
Streamline login for your users with fingerprint or Face ID authentication. For enhanced security, your users will be prompted to perform a regular standard login at intervals determined by your Moodle site's security settings. Requires activation via the Moodle Apps Portal, and individual user setup.
=== Offline courses per device per site ===
This feature allows users to download entire courses for offline access. Depending on the app plan, there will be varying limits on the number of courses users can download.

The amount of individual activities and resources that users are allowed to download is unlimited.
=== Basic branding ===
Using an online tool in the Moodle Apps Portal, organisations can customise the colour palette of their site in the Moodle App (including the login screen). Requires activation via the Moodle Apps Portal.
=== Integration with Matomo Analytics ===
Organisations with Matomo Analytics integrated into their Moodle site can extend tracking capabilities to the app. To use this integration, you need to have your own instance of Matomo.

Requires activation via the Moodle Apps Portal. For details, see the [[Moodle app guide for admins]].
=== Customisable app features via Moodle LMS site administration ===
Certain app functionality can be configured via the Moodle site. App configuration options vary depending on your subscription plan.
* Custom menu items: you can add your own links within the Moodle app menu. Your custom links will be available via the 'more' menu (the three-dot ⋯ menu at the bottom of the app).
* Disabled features: you can select which Moodle features, such as blocks or modules, won’t be available on your app.
* Custom language strings: you can customise the app's language strings.
For more details, visit [[Moodle app guide for admins]].
=== Google Analytics for Firebase ===
Google Analytics for Firebase is a free tool that provides valuable insights and data about how users interact with mobile apps. For compliance with GDPR, users will be able to disable it at any time.
== See also ==
* [https://support.moodle.com/support/solutions/folders/80000686596 FAQ for Pro and Premium plans]
* [https://support.moodle.com/support/solutions/folders/80000686597 FAQ for BMA]
* [[Moodle app guide for admins]]

LTI External tools

2023-09-26T14:24:37Z

Juliaverdaguer: Update to include improvements in https://tracker.moodle.org/browse/MDL-69489

This page explores the LTI External Tools page, which allows you to see which LTI External tools are available in your course. It also covers how to add new LTI tools to your course, and how administrators can add LTI tools to their site.
== Viewing and managing LTI External tools ==
To view the LTI External tools that are available in your course, go to Course page > More > LTI External tools.

If your administrator or another teacher have already configured tools for your course, they will be shown on this page.

The table on the page contains information about the available LTI tools in the course:
* '''Name'''
* '''Description'''
* '''Usage count''': How many times the tool is being used in the course
* '''Show in Activity chooser''': Whether the tool is displayed in the activity chooser so it can be used as an activity in the course.
* The '''context menu''' (···) contains actions you can perform on the tool, such as Edit its settings, Delete it, or see its registration details (for LTI 1.3 tools only). The actions you can perform depend on the permissions your administrator has given you.
* If instead of the three dots menu there is a '''lock icon''', it means that the tool has been configured by your administrator for the whole site, and you can’t edit it.
== Adding LTI External tools at course level ==
If your administrator has given you permission to manage LTI External tools, you can add new tools to your courses using the ‘Add tool’ button on the LTI External tools page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling them off in the column ‘Show in activity chooser’.
====Tool settings====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
*'''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
*'''LTI version''' - The LTI version of the tool you're adding.
*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
**Embed - The content will appear within the activity page where the tool is used, not moving users away from the page, but hiding any blocks your course may have.
**Embed without blocks - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
**Existing window - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.
''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site. [[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool|link=https://docs.moodle.org/403/en/File:moodle310_external_tool_registration.png]]A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.

====Making a tool available to specific course categories====
When configuring an LTI External tool, administrators have the option to limit its availability to specific course categories by selecting the desired categories in the 'Restrict to category' section during the tool configuration process.

===Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org/ IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret|link=https://docs.moodle.org/403/en/File:LTIKeyAndSecret.png]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities|link=https://docs.moodle.org/403/en/File:LTIConfirmCapabilities.png]]Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool|link=https://docs.moodle.org/403/en/File:LTItype.png]]
|}You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.
To add a tool with limited capabilities. 1. Click 'Configure a new external tool registration'[[File:LTIreg.png|thumb|450px|center|Registering an external tool|link=https://docs.moodle.org/403/en/File:LTIreg.png]]2. Configure the details on the settings page:[[File:LTIregdetails1.png|450px|center|Registration settings page|link=https://docs.moodle.org/403/en/File:LTIregdetails1.png]]'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.
3. Click the tick/checkmark to register:[[File:ticktoreg.png|center|thumb|450px|Activating|link=https://docs.moodle.org/403/en/File:ticktoreg.png]]4. After obtaining a success message, click to complete the process:[[File:reqmet.png|thumb|center|Completing the registration|link=https://docs.moodle.org/403/en/File:reqmet.png]]5. If all requirements are met then you will be able to register automatically.
6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab|link=https://docs.moodle.org/403/en/File:pendingactivate.png]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]] [[https://docs.moodle.org/de/Externes Tool konfigurieren]] [[https://docs.moodle.org/fr/Param%C3%A8tres d'outil externe]]

LTI External tools

2023-09-25T10:57:07Z

Juliaverdaguer: updated launch container settings' descriptions

This page explores the LTI External Tools page, which allows you to see which LTI External tools are available in your course. It also covers how to add new LTI tools to your course, and how administrators can add LTI tools to their site.
== Viewing and managing LTI External tools ==
To view the LTI External tools that are available in your course, go to Course page > More > LTI External tools.

If your administrator or another teacher have already configured tools for your course, they will be shown on this page.

The table on the page contains information about the available LTI tools in the course:
* '''Name'''
* '''Description'''
* '''Usage count''': How many times the tool is being used in the course
* '''Show in Activity chooser''': Whether the tool is displayed in the activity chooser so it can be used as an activity in the course.
* The '''context menu''' (···) contains actions you can perform on the tool, such as Edit its settings, Delete it, or see its registration details (for LTI 1.3 tools only). The actions you can perform depend on the permissions your administrator has given you.
* If instead of the three dots menu there is a '''lock icon''', it means that the tool has been configured by your administrator for the whole site, and you can’t edit it.
== Adding LTI External tools at course level ==
If your administrator has given you permission to manage LTI External tools, you can add new tools to your courses using the ‘Add tool’ button on the LTI External tools page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling them off in the column ‘Show in activity chooser’.
====Tool settings====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
*'''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
*'''LTI version''' - The LTI version of the tool you're adding.
*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
**Embed - The content will appear within the activity page where the tool is used, not moving users away from the page, but hiding any blocks your course may have.
**Embed without blocks - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
**Existing window - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.
''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool|link=https://docs.moodle.org/403/en/File:moodle310_external_tool_registration.png]]A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
===Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org/ IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret|link=https://docs.moodle.org/403/en/File:LTIKeyAndSecret.png]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities|link=https://docs.moodle.org/403/en/File:LTIConfirmCapabilities.png]]Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool|link=https://docs.moodle.org/403/en/File:LTItype.png]]
|}You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.
To add a tool with limited capabilities. 1. Click 'Configure a new external tool registration'[[File:LTIreg.png|thumb|450px|center|Registering an external tool|link=https://docs.moodle.org/403/en/File:LTIreg.png]]2. Configure the details on the settings page:[[File:LTIregdetails1.png|450px|center|Registration settings page|link=https://docs.moodle.org/403/en/File:LTIregdetails1.png]]'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.
3. Click the tick/checkmark to register:[[File:ticktoreg.png|center|thumb|450px|Activating|link=https://docs.moodle.org/403/en/File:ticktoreg.png]]4. After obtaining a success message, click to complete the process:[[File:reqmet.png|thumb|center|Completing the registration|link=https://docs.moodle.org/403/en/File:reqmet.png]]5. If all requirements are met then you will be able to register automatically.
6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab|link=https://docs.moodle.org/403/en/File:pendingactivate.png]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]] [[https://docs.moodle.org/de/Externes Tool konfigurieren]] [[https://docs.moodle.org/fr/Param%C3%A8tres d'outil externe]]

LTI External tool FAQ

2023-09-25T09:36:58Z

Juliaverdaguer: Added a new FAQ about course backups

{{External tool}}
==What are LTI External tools?==
LTI External tools are add-on apps you can integrate into your course, such as interactive content, activities, or assessments It is similar to SCORM as a standard for educational objects, but instead of being a package of content that is uploaded to Moodle, LTI is a way of integrating the functionality provided by another system into your course.
==How can I get my activities created with LTI External tools to display on the Dashboard in the Course overview block?==
Set an 'Expect completed by' date in the [[Activity completion]] section in the External tool settings.
==What versions of LTI does Moodle support?==
===LTI 1.3 Advantage===
'''Moodle 3.7''' added support for LTI 1.3 Advantage as a tool consumer, and the following releases have seen further improvements. 
'''Moodle 3.10''' adds support for copying courses with history, selecting multiple content items at once, and dynamic registration. 
Adding LTI 1.3 Advantage tool provider support is on the roadmap for next releases.
===LTI 1.1 Advantage===
Moodle also supports LTI 1.1 as tool provider and consumer.
==How do I restrict a tool to specific users?==
As site admin, when you configure the tool in Site administration > Plugins > Manage tools, set the tool configuration usage to 'Do not show; use only when a matching tool URL is entered', then email the tool URL to the specific users.

==How do LTI External tools work with course backups?==
When you back up a course that has LTI External tools, only the tools that are being used in an activity will be included in a backup. Tools that are in Course page > More > LTI External tools but are not used in the course will not be included in the backup.

==See also==
*Wordpress (Multisite) [https://github.com/3iPunt/wordpress-lti-1-3 LTI 1.3 provider] by Moodle Partner and Service provider 3iPunt.
*PressBook (wordpress) [https://pressbooks.community/t/planned-deprecation-notice-pressbooks-lti-provider-plugin/1715 LTI 1.3] and [https://docs.pressbooks.org/integrations/lti/ LTI 1.1]
*[http://webmaster.dearbornschools.org/2012/10/25/wordpress-and-moodle-lti-stepsheet-and-tutorial-for-setup/ Wordpress and LTI tutorial] by Chris Kenniburg (2012)
*[https://www.youtube.com/watch?v=Hqezqc3ukhM&feature=youtu.be&a IMS LTI demo] by Gavin Henrick
* [http://www.somerandomthoughts.com/blog/2011/11/28/moodle-2-supports-connecting-to-ims-lti-tools/ Moodle 2.2 will support connecting to IMS LTI tools] blog post by Gavin Henrick
*[https://vimeo.com/8073453 Video explaining LTI (Learning Tools Interoperability)] from Charles Severance
Forum discussions
* [https://moodle.org/mod/forum/discuss.php?d=261527 Adding LTI 2.0 support]
* [https://moodle.org/mod/forum/discuss.php?d=345003 Moodle Cloud https won't connect with an LTI with http location]
==Any further questions?==
Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org
[[Category:FAQ]]
[[https://docs.moodle.org/es/Herramienta externa FAQ]]
[[https://docs.moodle.org/de/Externes Tool FAQ]]
[[https://docs.moodle.org/fr/FAQ sur l'outil externe]]

LTI External tool

2023-09-25T09:23:08Z

Juliaverdaguer:

{{Activities}}
__NOTOC__
==What are LTI External tools?==
LTI External tools are add-on apps you can integrate into your course, such as interactive content, activities, or assessments. Teachers can link to these activities from within their Moodle course page, and students can access them without leaving their Moodle course or having to log in to a different system. Where available, and depending on each tool, teachers can also have grades sent back into Moodle.

The link between Moodle and these tools is made through the Learning Tools Interoperability (LTI) standard, which integrates learning platforms with learning tools to create a richer, seamless learning experience. Essentially, the LTI standard enables a secure, bi-directional exchange of information between Moodle and external learning tools.

LTI External tools can be used in Moodle as activities and resources.
==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]]
==More information==
*[[External tool settings]]
*[[Using External tool]]
*[[External tool FAQ]]
* [[LTI and Moodle]]
[[Category: External tool]]
[[Category:LTI]]
[[https://docs.moodle.org/es/Herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool]]
[[https://docs.moodle.org/fr/Outil externe]]

LTI External tool

2023-09-25T09:21:05Z

Juliaverdaguer: /* What is External tool? */

{{Activities}}
__NOTOC__
==What are LTI External tools?==
LTI External tools are add-on apps you can integrate into your course, such as interactive content, activities, or assessments. Teachers can link to these activities from within their Moodle course page, and students can access them without leaving their Moodle course or having to log in to a different system. Where available, and depending on each tool, teachers can also have grades sent back into Moodle.

The link between Moodle and these tools is made through the Learning Tools Interoperability (LTI) standard, which integrates learning platforms with learning tools to create a richer, seamless learning experience. Essentially, the LTI standard enables a secure, bi-directional exchange of information between Moodle and external learning tools.
==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]]
==More information==
*[[External tool settings]]
*[[Using External tool]]
*[[External tool FAQ]]
* [[LTI and Moodle]]
[[Category: External tool]]
[[Category:LTI]]
[[https://docs.moodle.org/es/Herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool]]
[[https://docs.moodle.org/fr/Outil externe]]

LTI External tools

2023-09-25T09:11:29Z

Juliaverdaguer: New change that covers everything to do with adding LTI External tools at course level and site level.

This page explores the LTI External Tools page, which allows you to see which LTI External tools are available in your course. It also covers how to add new LTI tools to your course, and how administrators can add LTI tools to their site.

== Viewing and managing LTI External tools ==
To view the LTI External tools that are available in your course, go to Course page > More > LTI External tools.

If your administrator or another teacher have already configured tools for your course, they will be shown on this page.

The table on the page contains information about the available LTI tools in the course:

* '''Name'''
* '''Description'''
* '''Usage count''': How many times the tool is being used in the course
* '''Show in Activity chooser''': Whether the tool is displayed in the activity chooser so it can be used as an activity in the course.
* The '''three dots menu''' (···) contains actions you can perform on the tool, such as Edit its settings, Delete it, or see its registration details (for LTI 1.3 tools only). The actions you can perform depend on the permissions your administrator has given you.
* If instead of the three dots menu there is a '''lock icon''', it means that the tool has been configured by your administrator for the whole site, and you can’t edit it.

== Adding LTI External tools at course level ==
If your administrator has given you permission to manage LTI External tools, you can add new tools to your courses using the ‘Add tool’ button on the LTI External tools page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.

====Tool settings====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
*'''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
*'''LTI version''' - The LTI version of the tool you're adding.
*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
**Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.
''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool|link=https://docs.moodle.org/403/en/File:moodle310_external_tool_registration.png]]A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
===Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org/ IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret|link=https://docs.moodle.org/403/en/File:LTIKeyAndSecret.png]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities|link=https://docs.moodle.org/403/en/File:LTIConfirmCapabilities.png]]Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool|link=https://docs.moodle.org/403/en/File:LTItype.png]]
|}You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities. 1. Click 'Configure a new external tool registration'[[File:LTIreg.png|thumb|450px|center|Registering an external tool|link=https://docs.moodle.org/403/en/File:LTIreg.png]]2. Configure the details on the settings page:[[File:LTIregdetails1.png|450px|center|Registration settings page|link=https://docs.moodle.org/403/en/File:LTIregdetails1.png]]'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:[[File:ticktoreg.png|center|thumb|450px|Activating|link=https://docs.moodle.org/403/en/File:ticktoreg.png]]4. After obtaining a success message, click to complete the process:[[File:reqmet.png|thumb|center|Completing the registration|link=https://docs.moodle.org/403/en/File:reqmet.png]]5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab|link=https://docs.moodle.org/403/en/File:pendingactivate.png]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]] [[https://docs.moodle.org/de/Externes Tool konfigurieren]] [[https://docs.moodle.org/fr/Param%C3%A8tres d'outil externe]]

LTI External tool activity

2023-09-25T09:10:58Z

Juliaverdaguer: /* Add an LTI External tool */

LTI External tool activity

2023-09-25T09:07:24Z

Juliaverdaguer: Updating content to focus only on using LTI External Tools as Activities or resources, moving all LTI configuration to a new page "Managing LTI External tools".

LTI External tool activity

2023-09-25T09:01:22Z

Juliaverdaguer:

{{External tool}}
This page explores how to use [[LTI External tools]] in your course as activities or resources.

To learn how to add LTI External tools to your course or site, see [[Managing LTI External tools]].
==How is it set up?==
To create an activity using an LTI External tool, go to the Course page and turn on Edit mode. Click either the link ‘Add an activity or resource’ at the bottom of each section, or click anywhere on the course page where you want to add your item. The Activity chooser will show; then, select the tool you want to create an activity with.

If the tool you want to use is not in the Activity chooser, you need to toggle the 'Show in activity chooser' option in the table in Course page > More > LTI External tools. This page is also where you can see all LTI External tools available in your course.

Once you select the tool in the Activity chooser, you can continue with activity creation and select the settings you'd like.
=== General ===
===== Content =====
If you're using a tool that supports deep linking, you will see a 'Select content' button on top of the activity form. Use this button to select which specific content from the tool you want to use in your activity.

Once you select content, the Activity name and Activity description might be automatically populated by the tool.

If not, give your activity a name and, optionally, a description.
===== Display activity name when students access the tool =====
You will only see this setting if your site uses the Classic theme and, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity name is displayed on the screen once your students access it.
===== Display activity description when students access the tool =====
You will only see this setting if, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity description is displayed on the screen once your students access it.
==== Grade ====
Your activity will only have a Grade section if the tool it is using has been given permission to write grades in the gradebook.

In activities created using LTI External Tools, the grade will always be given by the tool. You might have the option to completely deactivate grading for your activity if the checkbox ‘Allow tool to add grades in the gradebook’ is displayed.

If you see the Grade section, but there is no checkbox ‘Allow tool to add grades in the gradebook’, it means that your site administrator has configured the tool to always write grades in the gradebook.
==== Other settings ====
Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Restrict access]], [[Activity completion]], [[Tags]] and [[Competencies]].
==Add an LTI External tool==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on this page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
====Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
* '''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
* '''LTI version''' - The LTI version of the tool you're adding.
* '''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
* '''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
** Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.

''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
=== Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool activity

2023-09-25T08:58:34Z

Juliaverdaguer:

{{External tool}}
This page explores how to use [[LTI External tools]] in your course as activities or resources.

To learn how to add LTI External tools to your course or site, see [[Adding LTI External tools]].
==How is it set up?==
To create an activity using an LTI External tool, go to the Course page and turn on Edit mode. Click either the link ‘Add an activity or resource’ at the bottom of each section, or click anywhere on the course page where you want to add your item. The Activity chooser will show; then, select the tool you want to create an activity with.

If the tool you want to use is not in the Activity chooser, you need to toggle the 'Show in activity chooser' option in the table in Course page > More > LTI External tools. This page is also where you can see all LTI External tools available in your course.

Once you select the tool in the Activity chooser, you can continue with activity creation and select the settings you'd like.
=== General ===
===== Content =====
If you're using a tool that supports deep linking, you will see a 'Select content' button on top of the activity form. Use this button to select which specific content from the tool you want to use in your activity.

Once you select content, the Activity name and Activity description might be automatically populated by the tool.

If not, give your activity a name and, optionally, a description.
===== Display activity name when students access the tool =====
You will only see this setting if your site uses the Classic theme and, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity name is displayed on the screen once your students access it.
===== Display activity description when students access the tool =====
You will only see this setting if, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity description is displayed on the screen once your students access it.
==== Grade ====
Your activity will only have a Grade section if the tool it is using has been given permission to write grades in the gradebook.

In activities created using LTI External Tools, the grade will always be given by the tool. You might have the option to completely deactivate grading for your activity if the checkbox ‘Allow tool to add grades in the gradebook’ is displayed.

If you see the Grade section, but there is no checkbox ‘Allow tool to add grades in the gradebook’, it means that your site administrator has configured the tool to always write grades in the gradebook.
==== Other settings ====
Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Restrict access]], [[Activity completion]], [[Tags]] and [[Competencies]].
==Add an LTI External tool==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on this page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
====Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
* '''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
* '''LTI version''' - The LTI version of the tool you're adding.
* '''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
* '''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
** Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.

''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
=== Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool activity

2023-09-25T08:55:03Z

Juliaverdaguer:

{{External tool}}
This page explores how to use [[LTI External tools]] in your course as activities or resources. It also covers how to add LTI External tools to your course, and the Site administration settings.
==How is it set up?==
To create an activity using an LTI External tool, go to the Course page and turn on Edit mode. Click either the link ‘Add an activity or resource’ at the bottom of each section, or click anywhere on the course page where you want to add your item. The Activity chooser will show; then, select the tool you want to create an activity with.

If the tool you want to use is not in the Activity chooser, you need to toggle the 'Show in activity chooser' option in the table in Course page > More > LTI External tools. This page is also where you can see all LTI External tools available in your course.

Once you select the tool in the Activity chooser, you can continue with activity creation and select the settings you'd like.

=== General ===

===== Content =====
If you're using a tool that supports deep linking, you will see a 'Select content' button on top of the activity form. Use this button to select which specific content from the tool you want to use in your activity.

Once you select content, the Activity name and Activity description might be automatically populated by the tool.

If not, give your activity a name and, optionally, a description.

===== Display activity name when students access the tool =====
You will only see this setting if your site uses the Classic theme and, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity name is displayed on the screen once your students access it.

===== Display activity description when students access the tool =====
You will only see this setting if, in the tool settings, the tool’s content display has been configured as ‘Embed’ or ‘Embed, without blocks’.

This setting determines whether the activity description is displayed on the screen once your students access it.

==== Grade ====
Your activity will only have a Grade section if the tool it is using has been given permission to write grades in the gradebook.

In activities created using LTI External Tools, the grade will always be given by the tool. You might have the option to completely deactivate grading for your activity if the checkbox ‘Allow tool to add grades in the gradebook’ is displayed.

If you see the Grade section, but there is no checkbox ‘Allow tool to add grades in the gradebook’, it means that your site administrator has configured the tool to always write grades in the gradebook.

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

==Add an LTI External tool==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on this page.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
====Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
* '''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
* '''LTI version''' - The LTI version of the tool you're adding.
* '''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
* '''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
** Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.

''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
=== Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool activity

2023-09-25T08:37:50Z

Juliaverdaguer:

{{External tool}}
This page explores how to use [[LTI External tools]] in your course as activities or resources. It also covers how to add LTI External tools to your course, and the Site administration settings.
==How is it set up?==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on the LTI External tools page.
==Add an LTI External tool==
To add LTI External tools to your course, go to Course navigation > More > LTI External tools and select the ‘Add tool’ button.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
====Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
* '''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
* '''LTI version''' - The LTI version of the tool you're adding.
* '''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
* '''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
** Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.

''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
=== Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool activity

2023-09-25T08:28:27Z

Juliaverdaguer: updated information

{{External tool}}
This page explores how to add [[LTI External tools]] to your course, and also covers the Site administration settings. For information on how to use LTI External tools as activities or resources in your course, see [[Using External tool|Using LTI External tools]].
==How is it set up?==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on the LTI External tools page.
==Add an LTI External tool==
To add LTI External tools to your course, go to Course navigation > More > LTI External tools and select the ‘Add tool’ button.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
====Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.
* '''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
* '''LTI version''' - The LTI version of the tool you're adding.
* '''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
* '''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Default launch container''' - this is how the external tool will be displayed.
** Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
*'''Content selection URL''' - The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.

''The following settings are available by clicking ""Show more":''
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
===Services===
Choose which of the services you want to use with the tool.
===Privacy===
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
*
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
=== Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
|For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
===Viewing more details===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
|[[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool

2023-09-25T06:52:35Z

Juliaverdaguer: Removing information that's no longer relevant.

{{Activities}}
__NOTOC__
==What is External tool?==
LTI External tools are add-on apps you can integrate into your course, such as interactive content, activities, or assessments. Teachers can link to these activities from within their Moodle course page, and students can access them without leaving their Moodle course or having to log in to a different system. Where available, and depending on each tool, teachers can also have grades sent back into Moodle.

The link between Moodle and these tools is made through the Learning Tools Interoperability (LTI) standard, which integrates learning platforms with learning tools to create a richer, seamless learning experience. Essentially, the LTI standard enables a secure, bi-directional exchange of information between Moodle and external learning tools.
==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]]
==More information==
*[[External tool settings]]
*[[Using External tool]]
*[[External tool FAQ]]
* [[LTI and Moodle]]
[[Category: External tool]]
[[Category:LTI]]
[[https://docs.moodle.org/es/Herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool]]
[[https://docs.moodle.org/fr/Outil externe]]

LTI External tool activity

2023-09-21T08:59:07Z

Juliaverdaguer: updated information

{{External tool}}
This page explores in more detail the settings for the [[External tool]] once you have added it to your course and also covers the Site administration settings.
== How is it set up? ==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on the LTI External tools page.
== Add an LTI External tool ==
To add LTI External tools to your course, go to Course navigation > More > LTI External tools and select the ‘Add tool’ button.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.
==== Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.

For Default launch container, choose how you’d like the content of this tool to be displayed:
* ‘Embed’: The content will appear within the activity page where the tool is used, not moving users away from the page.
* ‘Embed without blocks’: The content will appear within the activity page where the tool is used, not moving users away from the page, but hiding any blocks your course may have.
* ‘Existing window’: The content will be displayed in the existing window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
* ‘New window’: The content will be opened in a new tab or window.

=== Services ===
Choose which of the services you want to use with the tool.
=== Privacy ===
Choose your privacy settings.

Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.
==General==
*'''Activity name''' - add a title, description if required, with your choice of display.
*'''Preconfigured tool''' - this is how Moodle communicates with the tool provider. If in doubt, leave as default. If your administrator has made a tool available site-wide, you will be able to select it here:
[[File:Preconfiguredtool.png|center]]
*'Select content' button - allows to import the link definition from the tool rather than entering it manually. This is the preferred flow when available.
*'''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
*'''Launch container'''- this is how the external tool will be displayed.
**Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
''The following settings are available by clicking ""Show more":''
*'''Activity description''' - give a short description here
*'''Display description on course page''' - choose to show the description along with the activity name
*'''Display activity name when launched''' - have this appear when the student clicks the link.
*'''Display activity description when launched''' - have this appear when the student clicks the link.
*'''Secure tool URL''' - This overrides the tool URL when moodle uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (if your site is configured to use [[HTTPS]] in the wwwroot)
*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
==Privacy==
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
===Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
| For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
=== Viewing more details ===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
| [[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities

[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool activity

2023-09-21T08:58:39Z

Juliaverdaguer: updated information

{{External tool}}
This page explores in more detail the settings for the [[External tool]] once you have added it to your course and also covers the Site administration settings.

== How is it set up? ==
As a teacher in your course, to view the LTI External tools that are already available, go to Course navigation > More > LTI External tools.

If your administrator has given you permission to manage LTI External tools, you can add new tools to your course using the ‘Add tool’ button on the LTI External tools page.

== Add an LTI External tool ==
To add LTI External tools to your course, go to Course navigation > More > LTI External tools and select the ‘Add tool’ button.

Tools that you add at course level will appear in your activity chooser by default. You can remove them from the activity chooser by going to Course page > More > LTI External Tools and toggling off the column ‘Show in activity chooser’.

==== Tool settings ====
In Tool settings, give your tool a name (and, optionally, a description). To fill in the rest of the fields in this section, including the LTI version, follow the instructions from your tool provider. If the tool doesn’t provide information about some of these settings, it’s ok to leave them blank.

For Default launch container, choose how you’d like the content of this tool to be displayed:

* ‘Embed’: The content will appear within the activity page where the tool is used, not moving users away from the page.
* ‘Embed without blocks’: The content will appear within the activity page where the tool is used, not moving users away from the page, but hiding any blocks your course may have.
* ‘Existing window’: The content will be displayed in the existing window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.
* ‘New window’: The content will be opened in a new tab or window.

== Services ==
Choose which of the services you want to use with the tool.

== Privacy ==
Choose your privacy settings.

Once you Save changes, the tool will be added to the list of tools in Course page > More > LTI External tools.

==General==
*'''Activity name''' - add a title, description if required, with your choice of display.
*'''Preconfigured tool''' - this is how Moodle communicates with the tool provider. If in doubt, leave as default. If your administrator has made a tool available site-wide, you will be able to select it here:
[[File:Preconfiguredtool.png|center]]
*'Select content' button - allows to import the link definition from the tool rather than entering it manually. This is the preferred flow when available.
*'''Tool URL''' - This is the URL for connecting to site. If your moodle site uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (is on [[HTTPS]]) you will only be able to use a tool that also uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL]. Make sure the tool URL has [[HTTPS]] before attempting to use it or you may get a blank page.
*'''Launch container'''- this is how the external tool will be displayed.
**Default - if in doubt; leave as default
**Embed - the external tool will be embedded in the Moodle course page with blocks and navigation bar
**Embed without blocks - the external tool will be embedded in the Moodle course page but without blocks
**New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
''The following settings are available by clicking ""Show more":''
*'''Activity description''' - give a short description here
*'''Display description on course page''' - choose to show the description along with the activity name
*'''Display activity name when launched''' - have this appear when the student clicks the link.
*'''Display activity description when launched''' - have this appear when the student clicks the link.
*'''Secure tool URL''' - This overrides the tool URL when moodle uses [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL] (if your site is configured to use [[HTTPS]] in the wwwroot)
*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", i.e. the manger of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another Moodle site, then you can add any consumer key.
*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
*'''Custom parameters''' - most times you can leave this blank. The tool provider might use this to allow you to display a specific resource.
*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via [https://en.wikipedia.org/wiki/Transport_Layer_Security SSL].
==Privacy==
*'''Share launcher's name with the tool''' - this means that the student's name will be displayed on the connected site [[Media:demoexternaltool.png|as in this example]]
*'''Share launcher's email with the tool''' - this means that the student's email will be displayed on the connected site [[Media:externaltoolfrontpage.png|as in this example]]
*'''Accept grades from the tool''' - if this is checked, the connecting site will send back grades to Moodle's gradebook. See [[Using External tool]] for more information on this.
==Site administration settings==
===Adding a tool site-wide===
An administrator can manually configure external tools in ''Site administration > Plugins > Activity modules > External tool> Manage tools'' so that they are available across the site.
[[File:moodle310__external_tool_registration.png|thumb|center|450px|Adding an external tool]]
A tool may be configured by an administrator so that it is shown in the activity chooser (in addition to the external tool activity) for a teacher to select to add to a course. Its description, if one is present, will appear in the activity chooser.
===Registering an LTI Advantage tool===
Moodle allows a simple way to deploy an LTI Advantage tool. If the tool provider supports that flow, you should have received a registration URL. Simply enter that url to a tool in the 'Tool URL' and press 'Add LTI Advantage'.

The tool registration UI will open and guide you to the steps for registration. Once completed, the registration panel will close and the list of tools will refresh. If the registration was successful, the newly added tool should be visible in a pending state.

The pending state allows you to review the tool configuration, the privacy and services granted, apply possible modifications (for example how the tool appears in the activity chooser), then activate the tool to make it available.

In case of errors when trying to start the registration, validate the registration URL with the tool's vendor the registration URL is for an LTI Advantage registration and not for the deprecated LTI 2 registration.
{| class="wikitable" border="1"
|-
| For Tool Developers looking to support the automated registration of LTI Advantage tool, there is an [https://moodlelti.theedtech.dev/dynreg/ implementation guide] available. The registration process is also being standardized by [https://imsglobal.org IMS Global] LTI Working Group. There is also a [https://youtu.be/6tcEwiOs5qU Youtube video] demo-ing and explaining the flow.
|}
===Registering an LTI 1.1 tool using a cartridge===
You can register an LTI 1.1 tool type using a cartridge. A cartridge will configure all the information such as launch url, tool name & description and icons for you.

To do this, simply enter the url to a tool's cartridge in the 'Tool URL' and press 'Add Legacy LTI'. You will be asked to enter a key and secret. If you don't have them, you can leave them blank and press save changes.
[[File:LTIKeyAndSecret.png|thumb|center|450px|Entering a consumer key and secret]]
===Registering an external LTI 2.0 external tool===
<big>The LTI 2 specifications have been deprecated by [https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule IMS Global] and are no more the preferred way to integrate an external tool in Moodle.</big>

To register an LTI 2 external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add Legacy LTI'.

This will open the tool, which may in turn ask you to decide on some settings.
[[File:LTIConfirmCapabilities.png|thumb|center|450px|Viewing and confirming capabilities]]
Then you will be shown the capabilities the tool wants to use and you can decide if you want to allow the tool or not.
=== Viewing more details ===
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.

There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
{|
| [[File:LTItype.png|thumb|450px|Setting up a new external tool]]
|}
You can also visit 'Manage external tool registrations' to view the tool registrations in a tabular format, or to add an external registration with limited capabilities.

To add a tool with limited capabilities.
1. Click 'Configure a new external tool registration'
[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
2. Configure the details on the settings page:
[[File:LTIregdetails1.png|450px|center|Registration settings page]]
'Memberships', allow the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.

3. Click the tick/checkmark to register:
[[File:ticktoreg.png|center|thumb|450px|Activating]]
4. After obtaining a success message, click to complete the process:
[[File:reqmet.png|450|thumb|center|Completing the registration]]
5. If all requirements are met then you will be able to register automatically.

6. Now go to ''Site administration > Plugins > Activity modules > External tool > Manage external tool types'' and click the 'Pending tab'

7. Click the tick/checkmark to activate it:
[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
==External tool capabilities==
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
*[[Capabilities/mod/lti:addmanualinstance|Add a manually-configured tool]]
*[[Capabilities/mod/lti:addpreconfiguredinstance|Add a preconfigured tool]]
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]] i.e. be an Instructor when the tool is launched
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities

[[https://docs.moodle.org/es/Configuraciones de herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool konfigurieren]]
[[https://docs.moodle.org/fr/Paramètres d'outil externe]]

LTI External tool

2023-09-21T08:39:56Z

Juliaverdaguer: updated description

{{Activities}}
__NOTOC__
==What is External tool?==
LTI External tools are add-on apps you can integrate into your course, such as interactive content, activities, or assessments. Teachers can link to these activities from within their Moodle course page, and students can access them without leaving their Moodle course or having to log in to a different system. Where available, and depending on each tool, teachers can also have grades sent back into Moodle.

The link between Moodle and these tools is made through the Learning Tools Interoperability (LTI) standard, which integrates learning platforms with learning tools to create a richer, seamless learning experience. Essentially, the LTI standard enables a secure, bi-directional exchange of information between Moodle and external learning tools.

==How is it set up?==
#In a course, with the editing turned on, choose 'External tool' from the activity chooser.
#Give it a name and, if needed, a description.
#Add the tool URL, either one configured by your site's admin or create your own external tool activity, for which you need the Consumer key and Shared secret, both provided by the external tool provider. For more information see [[External tool settings]]
#Specify the Launch container (how the external tool will display)
#Select the services you want
#Specify the privacy settings
#Save the changes.
==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]]
==More information==
*[[External tool settings]]
*[[Using External tool]]
*[[External tool FAQ]]
* [[LTI and Moodle]]
[[Category: External tool]]
[[Category:LTI]]
[[https://docs.moodle.org/es/Herramienta externa]]
[[https://docs.moodle.org/de/Externes Tool]]
[[https://docs.moodle.org/fr/Outil externe]]