External tool settings: Difference between revisions

Latest revision as of 16:47, 23 November 2015

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.

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.
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
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:

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)

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 > 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:

Setting up a new external tool

Registering an external tool

An external tool can be registered by an admin as follows:

1. Go to Site administration > Plugins > Activity modules > LTI > Manage external tool registrations

Registering an external tool

2. Configure the details on the settings page:

New feature
in Moodle 3.0! 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.

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 > LTI > 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

@@ Line 1: / Line 1: @@
 {{External tool}}
-To add an external tool:
-#As an editing teacher for a course, click "Turn Editing On", and go to the topic or week section in which you want to add the external tool.
-#From the dropdown menu labeled "Add an activity", select "External tool". This will take you to the external tool settings page titled "Adding a new external tool" page.
-==External tool administration settings==
+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.
-[[File:externaltoolexample.png]]
-===General===
+==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.
+#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==
+{|
+|[[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
-*'''External tool type''' -this is how Moodle communicates with the tool provider. If in doubt, leave as default.
+*'''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:
-*'''Launch URL''' - this is the URL of the external tool you are connecting to.
+{|
+| [[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.
+**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===
-*Share launcher's name with the tool
-*Share launcher's email with the tool
-*Accept grades from the tool
-====Advanced settings====
+''The following settings are available by clicking ""Show more":''
-The settings below are revealed by clicking the "show advanced" button
 *'''Activity description''' - give a short description here
 *'''Display description on course page''' - choose to show the description along with the activity name
@@ Line 29: / Line 31: @@
 *'''Display activity description when launched''' - have this appear when the student clicks the link.
 *'''Secure launch URL''' -
-*'''Consumer key''' -
+*'''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''' -
+*'''Shared secret''' - this is the "password" to connect to the tool - the LTI compliant site.
-*'''Custom parameters''' -
+*'''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''' -
+*'''Icon URL''' - you can display a different icon from the default External Tool icon by entering its URL here
-*'''Secure Icon URL''' -
+*'''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]]
+|}
-===Common module settings===
+*'''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]]
-The [[Common module settings]] section appears in many modules besides External tool.  It sets [[Groups]] interactions levels and the ID number.
+*'''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]]
-===Restrict access settings===
+*'''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.
-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==
-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:
+===Adding a tool site-wide===
+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:
+{|
+| [[File:LTItype.png|thumb|450px|Setting up a new external tool]]
+|}
+===Registering an external tool===
+An external tool can be registered by an admin as follows:
+. Go to ''Site administration > Plugins > Activity modules > LTI > Manage external tool registrations''
+[[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:
+[[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'
-[[File:adminexternaltool.png]]
+. 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==
@@ Line 53: / Line 86: @@
 *[[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]]

Documentation

External tool settings: Difference between revisions

Latest revision as of 16:47, 23 November 2015

Contents

Adding a new external tool to a course

General settings

Privacy settings

Site administration settings

Adding a tool site-wide

Registering an external tool

External tool capabilities