Difference between revisions of "External tool settings"

Jump to: navigation, search
(updating screenshot and info)
(External tool capabilities: mod/lti:admin (MDL-58851))
 
(36 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{External tool}}
 
{{External tool}}
 +
==Adding a new external tool to a course==
 +
[[File:preconfigured tool in activity chooser.png|frame|right|A preconfigured tool 'Chemistry quiz' shown in the activity chooser]]
  
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.
+
#With the editing turned on, in the section you wish to add your external tool, click the "Add an activity or resource" link and choose either 'External tool' or a preconfigured tool.
 
 
==Adding a new external tool to a course==
 
#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.  
 
#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.
+
#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===
+
==General settings==
 
{|
 
{|
|[[File:externaltoolgeneral25.png|thumb|General settings expanded]]
+
|[[File:externaltool26.png|thumb|400px|General settings before expanding. When expanded, [https://docs.moodle.org/en/File:externaltoolexpanded.png extra options are available.]]]
 
|}
 
|}
 
 
 
*'''Activity name''' -  give the title you wish the students to see on the course page
 
*'''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:
+
*'''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:sitewidetool.png|thumb|Selecting a preconfigured tool]]
+
| [[File:sitewidetool.png|Selecting a preconfigured tool]]
 
|}
 
|}
 
+
*'Select content' button - for LTI Content-Item configuration
*'''Launch URL''' - This is the URL for connecting to site.  
+
*'''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.
 
*'''Launch container'''- this is how the external tool will be displayed.
**Default -if in doubt; leave as default
+
**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 - 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
 
**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. '''Warning!''' Your students may have popups blocked and this might prevent them from accessing the link. If you choose "New window", add a note on the course page reminding students to unblock popups.
+
**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.)
  
===Privacy settings===
+
''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", 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. 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 settings==
 
(These settings are collapsed by default)
 
(These settings are collapsed by default)
 
{|
 
{|
|[[File:externaltoolprivacy25.png|thumb|Privacy settings expanded]]
+
|[[File:externaltoolprivacy25.png|Privacy settings expanded]]
 
|}
 
|}
  
Line 37: Line 46:
 
*'''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.
 
*'''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.
  
====Advanced settings====
+
==Site administration settings==
The settings below are revealed by clicking the "show advanced" button
+
 
*'''Activity description''' - give a short description here
+
===Adding a tool site-wide===
*'''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.
+
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.
*'''Display activity description when launched''' - have this appear when the student clicks the link.
+
 
*'''Secure launch URL''' -
+
[[File:LTIAddTool.png|thumb|center|450px|Adding an external tool]]
*'''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.
+
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.
*'''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
+
===Registering a tool using a cartridge===
*'''Secure Icon URL''' - enter the URL of a different icon here if your students are accessing Moodle securely via SSL.
+
 
 +
You can register a 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'. 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 tool===
 +
 
 +
To register an external tool, simply enter the url to a tool in the 'Tool URL' and press 'Add'.
 +
 
 +
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.
  
===Common module settings===
+
=== Viewing more details ===
The [[Common module settings]] section appears in many modules besides External tool.  It sets [[Groups]] interactions levels and the ID number.
 
===Restrict access settings===
 
The [[Restrict_access_settings|Restrict access]] area becomes visible in Moodle activities and resource settings if [[Conditional_activities|Conditional Activities]] have been enabled.
 
  
==Site administration settings==
+
On the 'Manage tools' page you can also visit 'Manage preconfigured tools' to view the preconfigured tools in a tabular format.
===Adding a tool sitewide===
 
  
An administrator can configure external tools in Settings > Site administration > Plugins > Activity modules > External tool 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:
+
There are tabs to add an external tool, to view those which are pending and to view those which have been rejected:
 
{|
 
{|
| [[File:adminexternaltoolnew.png|thumb|Setting up a new external tool]]
+
| [[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]]
 +
 +
See the screencast [http://www.spvsoftwareproducts.com/temp/lti2-moodle/ External tool registration] for a demonstration of the above steps.
  
 
==External tool capabilities==
 
==External tool capabilities==
  
*[[Capabilities/mod/lti:addcoursetool|Add external tool]]
+
*[[Capabilities/mod/lti:addcoursetool|Add course-specific tool configurations]]
 +
*[[Capabilities/mod/lti:addinstance|Add a new external tool]]
 
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
 
*[[Capabilities/mod/lti:requesttooladd|Submit a tool to admins for configuration]]
*[[Capabilities/mod/lti:grade|Grade external tool activities]]
+
*[[Capabilities/mod/lti:admin|Be an admin when the tool is launched]]
*[[Capabilities/mod/lti:manage|Edit external tool activities]]
+
*[[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]]
+
*[[Capabilities/mod/lti:view|View external tool activities]] i.e. launch external tool activities
*[[Capabilities/mod/lti:addinstance|Add a new external tool activity]]
+
 
 +
 
 +
[[es:Configuraciones de herramienta externa]]
 +
[[de:Externes Tool konfigurieren]]

Latest revision as of 13:12, 3 September 2018

Adding a new external tool to a course

A preconfigured tool 'Chemistry quiz' shown in the activity chooser
  1. With the editing turned on, in the section you wish to add your external tool, click the "Add an activity or resource" link and choose either 'External tool' or a preconfigured tool.
  2. 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.
  3. 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

General settings before expanding. When expanded, extra options are available.
  • Activity name - give the title you wish the students to see on the course page
  • 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:
Selecting a preconfigured tool
  • 'Select content' button - for LTI Content-Item configuration
  • Tool URL - This is the URL for connecting to site. If your moodle site uses SSL (is on HTTPS) you will only be able to use a tool that also uses 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 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", 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. 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 SSL.

Privacy settings

(These settings are collapsed by default)

Privacy settings expanded
  • Share launcher's name with the tool - this means that the student's name will be displayed on the connected site 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 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.

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 a tool using a cartridge

You can register a 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'. 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.

Entering a consumer key and secret

Registering an external tool

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

This will open the tool, which may in turn ask you to decide on some settings.

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:

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'

Registering an external tool

2. Configure the details on the settings page:

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:

Activating

4. After obtaining a success message, click to complete the process:

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:

Activating from the Pending tab

See the screencast External tool registration for a demonstration of the above steps.

External tool capabilities