LTI External tool activity: Difference between revisions

Latest revision as of 13:41, 14 December 2023

This page explores how to use LTI External tools in your course as activities.

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. For more information, see Managing LTI External tools.

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.

Using an LTI External tool as an activity

When students click the tool link they are automatically signed into the connecting site/tool provider (screenshot 1 below) and can take the quiz immediately.

When the student has completed the quiz, the tool provider displays their grade (screenshot 2 below) and when the student logs out of the tool provider, the grade is passed back into Moodle (screenshot 3 below).

1.Student logged directly into tool provider

2. Tool provider displays score

3. Score passed to Moodle's gradebook

@@ Line 1: / Line 1: @@
-{{External tool}}
+{{LTI External tools}}
+This page explores how to use [[LTI External tools]] in your course as activities.
-A teacher can add an external tool from their course page and an administrator can make an external tool  available to all teachers on the site.
+==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.
-==Adding a new external tool to a course==
+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. For more information, see [[Managing LTI External tools]].
-#With the editing turned on,in the section you wish to add your external tool, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu )and choose ''External tool''
-#This will take you to the settings page titled "Adding a new external tool". All settings may expanded by clicking the "Expand all" link top right.
-#If the external tool has not been configured by the administrator, you will need to have in advance the correct URL, consumer key and secret. These should have been provided to you by the managers of the LTI compliant website you are going to be connecting to. Click "Show more" to access the consumer key and secret fields.
-==General settings==
+Once you select the tool in the Activity chooser, you can continue with activity creation and select the settings you'd like.
-{|
+=== General ===
-|[[File:externaltool26.png|thumb|400px|General settings before expanding. When expanded, [https://docs.moodle.org/en/File:externaltoolexpanded.png extra options are available.]]]
+===== 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.
-*'''Activity name''' -  give the title you wish the students to see on the course page
-*'''External tool type''' -this is how Moodle communicates with the tool provider. If in doubt, leave as default. If your administrator has made a tool available sitewide, you will be able to select it here:
-{|
-| [[File:sitewidetool.png|Selecting a preconfigured tool]]
-|}
-*'''Launch URL''' - This is the URL for connecting to site.
-*'''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 launch URL''' -
-*'''Consumer key''' -this tells the connecting LTI compliant site that your Moodle is allowed to connect. The "tool provider", ie 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.
-*'''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 SSL.
-==Privacy settings==
-(These settings are collapsed by default)
-{|
-|[[File:externaltoolprivacy25.png|Privacy settings expanded]]
-|}
-*'''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]]
+Once you select content, the Activity name and Activity description might be automatically populated by the tool.
-*'''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==
+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’.
-===Adding a tool site-wide===
+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’.
-An administrator can manually configure external tools in  ''Site administration > Plugins > Activity modules > LTI > Manage external tool types'' so that they are available across the site. There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
+This setting determines whether the activity description is displayed on the screen once your students access it.
-{|
+==== Grade ====
-| [[File:LTItype.png|thumb|450px|Setting up a new external tool]]
+Your activity will only have a Grade section if the tool it is using has been given permission to write grades in the gradebook.
-|}
-===Registering an external tool===
+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.
-An external tool can be registered by an admin as follows:
+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]].
-. Go to ''Site administration > Plugins > Activity modules > LTI > Manage external tool registrations''
+==Using an LTI External tool as an activity==
-[[File:LTIreg.png|thumb|450px|center|Registering an external tool]]
-. Configure the details on the settings page:
-[[File:LTIregdetails1.png|450px|center|Registration settings page]]
-{{New features}}A new service available in Moodle 3.0 onwards is 'Memberships', allowing the external tool to request a list of users with a certain role in a specified context e.g. users enrolled in a course.
-. Click the tick/checkmark to register:
+When students click the tool link they are automatically signed into the connecting site/tool provider (screenshot 1 below) and can take the quiz immediately.
-[[File:ticktoreg.png|center|thumb|450px|Activating]]
-. After obtaining a success message, click to complete the process:
-[[File:reqmet.png|450|thumb|center|Completing the registration]]
-. If all requirements are met then you will be able to register automatically.
-. Now go to ''Site administration > Plugins > Activity modules > LTI > Manage external tool types'' and click the 'Pending tab'
+When the student has completed the quiz, the tool provider displays their grade (screenshot 2 below) and when the student logs out of the tool provider, the grade is passed back into Moodle (screenshot 3 below).
-. Click the tick/checkmark to activate it:
+{|
-[[File:pendingactivate.png|thumb|center|450px|Activating from the Pending tab]]
+| [[File:mark3.png|thumb|1.Student logged directly into tool provider]]
+| [[File:markscore1.png|thumb|2. Tool provider displays score]]
-See the screencast [http://www.spvsoftwareproducts.com/temp/lti2-moodle/ External tool registration] for a demonstration of the above steps.
+| [[File:markscore2.png|thumb|3. Score passed to Moodle's gradebook]]
+|}
-==External tool capabilities==
-*[[Capabilities/mod/lti:addcoursetool|Add external tool]]
-*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
-*[[Capabilities/mod/lti:grade|Grade external tool activities]]
-*[[Capabilities/mod/lti:manage|Edit external tool activities]]
-*[[Capabilities/mod/lti:view|View external tool activities]]
-*[[Capabilities/mod/lti:addinstance|Add a new external tool activity]]
-[[es:Configuraciones de herramienta externa]]
+[[es:Actividad herramienta externa LTI]]
+[[de:Aktivität Externes Tool]]

Documentation