MoodleDocs - User contributions [en]

LTI Moodle to Moodle

2024-03-12T09:18:44Z

Jaked: /* Moodle to Moodle LTI */

==Moodle to Moodle LTI==

This document focusses on connecting Two instances of Moodle 4.3 or later via LTI1.3 (Advantage). For more general details of Moodle's LTI tool setup, see
[[Publish as LTI tool]]. For details on the platform setup, see [[LTI External tools]].

==LTI Advantage==
This document will focus on LTI Advantage, which is described here https://www.imsglobal.org/activity/learning-tools-interoperability.
And covers Assignment and Grade Services, Names and Role provisioning and Deep Linking.
Term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. So where you see Platform think “Consumer” and where you see Tool you can think “Provider”

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

#Go to Site administration > Plugins > Authentication > Manage authentication and enable LTI (admin/settings.php?section=manageauths)
#Go to Site administration > Plugins > Enrolments > Manage enrol plugins and enable 'Publish as LTI tool' (/admin/settings.php?section=manageenrols)

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired. (/admin/search.php?query=allowframembedding)
Configure Moodle as the Tool
Registration between Tool (producer) and Platform (consumer) is essentially a security contract between those two systems.
Dynamic registration automates the exchange of the relevant URLs and IDs.

As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration" (/admin/settings.php?section=enrolsettingslti_registrations)
Click the "Register a platform" button to create a new platform registration
Enter the name of the platform and click "Continue"
When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

==Configure Moodle as the Platform==

On the Platform (consumer) as an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools" (/mod/lti/toolconfigure.php)
Paste the registration URL into the "Tool URL" field
Click "Add LTI Advantage"
If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been automatically added to the registration in the Moodle tool. To see this, go to

"Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". (/admin/settings.php?section=enrolsettingslti_registrations)

You'll see the updated registration listed as "Active". Clicking the "View platform details" action will display the relevant platform information, while the "Manage deployments" action will allow you to add or remove deployments. No changes to either of these sections are required, however.

==Sharing access to a course or activity==

On the Moodle tool (provider), from the course navigation, select "Published as LTI tools"
Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
In "Tool to be published" select the course or activity to be shared
Enable grade and user sync for the resource, if required
Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

Note: The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.
Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.
If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings;

* Student first launch provisioning mode
* Teacher first launch provisioning mode

Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently, accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site.

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==Common issues==

===Mixed protocol limitations===

If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See Transitioning to HTTPS.

===A required parameter (oauth_consumer_key) was missing===
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

===User has free access to the entire site, isn't contained to the course===
This can happen when the course content isn't embedded. Enable Allow frame embedding in Site Administration > Security > HTTP Security and, on the consumer site LTI tool settings, add force_embed=1 in the custom parameters settings.

===Invalid request===
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that deep linking is enabled in the tool consumer.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==
Please post in the LTI and Moodle forum on moodle.org

LTI Moodle to Moodle

2024-03-12T09:16:25Z

Jaked: /* Configure Moodle as the Platform */

==Moodle to Moodle LTI==

This document focusses on connecting Two instances of Moodle 4.3 or later via LTI1.3 (Advantage). For more general details of LTI see
[[Publish as LTI tool]]

==LTI Advantage==
This document will focus on LTI Advantage, which is described here https://www.imsglobal.org/activity/learning-tools-interoperability.
And covers Assignment and Grade Services, Names and Role provisioning and Deep Linking.
Term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. So where you see Platform think “Consumer” and where you see Tool you can think “Provider”

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

#Go to Site administration > Plugins > Authentication > Manage authentication and enable LTI (admin/settings.php?section=manageauths)
#Go to Site administration > Plugins > Enrolments > Manage enrol plugins and enable 'Publish as LTI tool' (/admin/settings.php?section=manageenrols)

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired. (/admin/search.php?query=allowframembedding)
Configure Moodle as the Tool
Registration between Tool (producer) and Platform (consumer) is essentially a security contract between those two systems.
Dynamic registration automates the exchange of the relevant URLs and IDs.

As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration" (/admin/settings.php?section=enrolsettingslti_registrations)
Click the "Register a platform" button to create a new platform registration
Enter the name of the platform and click "Continue"
When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

==Configure Moodle as the Platform==

On the Platform (consumer) as an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools" (/mod/lti/toolconfigure.php)
Paste the registration URL into the "Tool URL" field
Click "Add LTI Advantage"
If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been automatically added to the registration in the Moodle tool. To see this, go to

"Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". (/admin/settings.php?section=enrolsettingslti_registrations)

You'll see the updated registration listed as "Active". Clicking the "View platform details" action will display the relevant platform information, while the "Manage deployments" action will allow you to add or remove deployments. No changes to either of these sections are required, however.

==Sharing access to a course or activity==

On the Moodle tool (provider), from the course navigation, select "Published as LTI tools"
Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
In "Tool to be published" select the course or activity to be shared
Enable grade and user sync for the resource, if required
Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

Note: The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.
Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.
If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings;

* Student first launch provisioning mode
* Teacher first launch provisioning mode

Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently, accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site.

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==Common issues==

===Mixed protocol limitations===

If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See Transitioning to HTTPS.

===A required parameter (oauth_consumer_key) was missing===
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

===User has free access to the entire site, isn't contained to the course===
This can happen when the course content isn't embedded. Enable Allow frame embedding in Site Administration > Security > HTTP Security and, on the consumer site LTI tool settings, add force_embed=1 in the custom parameters settings.

===Invalid request===
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that deep linking is enabled in the tool consumer.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==
Please post in the LTI and Moodle forum on moodle.org

Share to MoodleNet

2023-04-28T02:43:17Z

Jaked:

[https://moodle.net/ MoodleNet] is an open, social, media platform for educators, initially focused on sharing and curating collections of open content. It is a central place from where educators can easily detect quality content to meet the needs of their learners and courses. You can either use MoodleNet Central, the global public MoodleNet, or install your own instance of MoodleNet. Read the [https://docs.moodle.org/moodlenet/Main_Page MoodleNet documentation] for more information about MoodleNet.
==MoodleNet inbound settings==
As an administrator you can connect to an instance of MoodleNet so course teachers can browse for and import content.

# From ''Site administration > Advanced features,'' make sure Enable MoodleNet integration (inbound) is checked. (It is enabled by default.)
# From ''Site administration > General > MoodleNet settings'', check the settings in the link MoodleNet inbound settings.
# Optionally, from Site administration > Courses > Activity chooser > Activity chooser settings, select MoodleNet from the footer dropdown. This will then display a link in the [[Activity chooser]].

==MoodleNet outbound settings==
{{New features}}
As an administrator you can connect to an instance of MoodleNet so that course teachers or others with the capability [[Capabilities/moodle/moodlenet:shareactivity| moodlenet:shareactivity]] can send course content to the selected MoodleNet site. (Note that the feature does not currently support sharing whole courses.)

# From ''Site administration > Development > Experimental settings'', check the box Enable sharing to MoodleNet (outbound)
# You will then have an extra setting (Enable sharing to MoodleNet (outbound)) from ''Site administration > General > MoodleNet settings'', prompting you to set up a MoodleNet OAuth 2 service.
# From ''Site administration > Server > OAuth2 services'', click the MoodleNet button and set up your service. See [[OAuth 2 MoodleNet service]].
# Once the service is created, go to ''Site administration > General > MoodleNet outbound settings'' and set the OAuth 2 service to the service you just created.
# When everything is configured correctly, users with the Capabilities/moodle/moodlenet:shareactivity will see a link "Share to MoodleNet" from the More tab of an item they want to share.

[[File:ShareMoodleNet.png|More link to share to MoodleNet]]

OAuth 2 MoodleNet service

2023-04-28T02:39:11Z

Jaked:

{{OAuth2}}
==Features requiring the MoodleNet OAuth 2 service==

You will need to set up a MoodleNet OAuth 2 service in order to use the following features:

* [[MoodleNet]] (Only the outbound "Share to MoodleNet" feature, not the inbound features)

==MoodleNet OAuth 2 service setup==

Note: Currently, only MoodleNet central ([https://moodle.net/ MoodleNet]) supports the share API. The OAuth 2 service template is preset to support configuration of this MoodleNet central application.

To set up the service in Moodle:

1. Go to OAuth 2 services (Site administration > Server > OAuth 2 services) and create a new MoodleNet service.

2. The service configuration form is now shown. Note the Service base URL is preset to MoodleNet central. You may change the name of the service here if you wish, however, please leave other fields unchanged.

3. Save the changes.

4. The service will now auto-configure itself and Moodle will redirect to the services listing. If you see a green tick in the "Discovery" column, your newly created service is ready for use.

Publish as LTI tool

2022-04-04T04:04:15Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

[[File:registration completed active.png|thumb|Completed registrations are denoted by an "Active" status in the registrations listing. From here, administrators can view tool endpoints or edit platform details or deployments via the respective registration actions.]]
Once complete, platform details and an associated deployment id will have been automatically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "View platform details" action will display the relevant platform information, while the "Manage deployments" action will allow you to add or remove deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action. You'll see a table listing the various platform endpoints and identifiers.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T04:02:38Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

[[File:registration completed active.png|thumb|Completed registrations are denoted by an "Active" status in the registrations listing. From here, administrators can view tool endpoints or edit platform details or deployments via the respective registration actions.]]
Once complete, platform details and an associated deployment id will have been automatically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "View platform details" action will display the relevant platform information, while the "Manage deployments" action will allow you to add or remove deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T04:01:05Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

[[File:registration completed active.png|thumb|Completed registrations are denoted by an "Active" status in the registrations listing. From here, administrators can view tool endpoints or edit platform details or deployments via the respective registration actions.]]
Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T04:00:07Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

[[File:registration completed active.png|thumb|Completed registrations are denoted by an "Active" status in the registrations listing. From here, administrators can view tool endpoints or edit platform details or deployments via the respective registration actions.]]
Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

File:registration completed active.png

2022-04-04T03:58:38Z

Jaked:

Completed registrations are denoted by an "Active" status in the registrations listing. From here, administrators can view tool endpoints, platform details or tool deployments via the registration actions.

Publish as LTI tool

2022-04-04T03:49:30Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:49:04Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:registration tool details.png|thumb|Once the registration has been created, the endpoint URLs used for either dynamic or manual registration can be accessed via the "Tool details" tab.]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

File:registration tool details.png

2022-04-04T03:47:25Z

Jaked:

Once a registration has been created, the various endpoint URLs used for either dynamic and manual registration can be accessed via the "Tool details" tab

Publish as LTI tool

2022-04-04T03:26:00Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the Moodle tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:24:33Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:24:13Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, platform details and an associated deployment id will have been autoamtically added to the registration in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". You'll see the updated registration listed as "Active". Clicking the "Platform details" action will display the relevant platform information, while the "Deployments" action will list the deployments. No changes to either of these sections are required, however.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action icon.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:19:23Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action icon.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete. Click the "Back" button or navigate to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration", where you will now see the registration listed as "Active".

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:18:01Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action icon.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Save
# Next, select the "Deployments" tab
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:15:51Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "View platform details" action icon.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:15:00Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# If you have the registration open still, simply click the "Platform details" tab. If not, from the registration table, click the "Platform details" action icon.
# Click "Edit platform details"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:12:33Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# You'll see a "Tool details" tab. Leave this browser window open.

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependent but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:09:29Z

Jaked: /* Register Moodle with the platform */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

Regardless of the registration method, the first step is always to create a platform registration via Site administration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-04-04T03:07:52Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==
{{New features}}

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Click the "Register a platform" button to create a new platform registration
# Enter the name of the platform and click "Continue"
# When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". Clicking the "Platform details" action icon for the registration in question will display the relevant platform information, while the "Deployments" action icon will list the deployments.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-22T03:56:14Z

Jaked: /* User account provisioning */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)". Users without an account in Moodle cannot use this feature.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-22T03:54:30Z

Jaked: /* Link creation via content selection */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)".

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book by selecting "Add to gradebook"]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-22T03:51:24Z

Jaked: /* Link creation via content selection */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)".

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

[[File:content selection activity list.png|thumb|Teachers can select from a list of published activities and courses, optionally adding a coupled line item to the platform's grade book at the time of link creation.]]
# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

File:content selection activity list.png

2022-02-22T03:48:51Z

Jaked:

Content selection allows teachers to create resource links by picking from a list of published activities and courses

Publish as LTI tool

2022-02-22T03:16:37Z

Jaked: /* User account provisioning */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Content selection launches (Deep linking) require an existing account in Moodle, so always use "Existing accounts only (prompt)".

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-22T02:16:57Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details, along with the deployment id, must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T08:54:39Z

Jaked: /* Sharing access to a course or activity */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
[[File:publishing_resources.png|thumb|Publishing an activity using LTI Advantage. Note the limited launch details, which are only required if manually configuring an activity link in the platform]]
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

File:publishing resources.png

2022-02-21T08:52:13Z

Jaked: Jaked uploaded a new version of File:publishing resources.png

Publishing an assignment using LTI Advantage

File:publishing resources.png

2022-02-21T08:45:45Z

Jaked:

Publishing an assignment using LTI Advantage

Publish as LTI tool

2022-02-21T08:41:43Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

[[File:platform registration.png|thumb|Once Moodle has been configured in the platform, the platform details must be registered with Moodle to complete the registration]]
Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

File:platform registration.png

2022-02-21T08:38:31Z

Jaked:

Registering platform details with the Moodle tool during manual registration

Publish as LTI tool

2022-02-21T08:31:32Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# If prompted, select "Register as a new external tool" (you will only be prompted if another Moodle tool from the same domain is already configured on the platform)
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T08:25:58Z

Jaked: /* Manual registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

[[File:manual registration tool endpoints.png|thumb|The tool endpoints are required if manually configuring Moodle on the platform]]
Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T08:16:26Z

Jaked: /* Dynamic Registration */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

[[File:copying registration url.png|thumb|Generating and copying a dynamic registration URL]]
In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T06:46:37Z

Jaked: /* LTI 1.3 and LTI Advantage */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMS Global website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T06:04:18Z

Jaked: /* Legacy resources */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMSGlobal website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==
The following resources pertain to now deprecated versions of LTI (1.1 and 2.0).

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T06:00:13Z

Jaked: /* Manual registration: */

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMSGlobal website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Publish as LTI tool

2022-02-21T05:59:37Z

Jaked:

{{Enrolment}}
==Moodle as an LTI provider==

The 'Publish as LTI tool' enrolment plugin, together with the LTI authentication plugin, allows remote users on a different platform to access selected courses and activities. In other words, Moodle functions as an LTI tool. Courses and activities can be completed by accessing them from the remote platform. When grades are recorded, these will also be sent back to the remote platform.

==LTI 1.3 and LTI Advantage==

LTI 1.3 describes the core specification needed for securely launching a Tool resource from within a Platform. When the core LTI 1.3 functionality is packaged alongside the three essential services (Assignment and Grade Services v2.0, Names and Role Provisioning Services v2.0 and Deep Linking v2.0), it's called LTI Advantage. More information about LTI Advantage and its services can be found on the IMSGlobal website. See https://www.imsglobal.org/activity/learning-tools-interoperability.

With LTI Advantage, the term 'Tool' is used to refer to the external service providing functionality, while 'Platform' is used to refer to the application wanting to use the functionality provided by the tool. The terms 'Platform' and 'Tool' can be thought of as replacements for the legacy terms 'Consumer' and 'Provider' respectively.

==Enabling the 'Publish as LTI tool' feature==

An administrator can enable the 'Publish as LTI tool' for use across the site:

# Go to ''Site administration > Plugins > Authentication > Manage authentication'' and enable LTI
# Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' and enable 'Publish as LTI tool'

It is recommended that the site administration setting 'Allow frame embedding' is enabled (in "Site Administration > Security > HTTP security") so that tools can be displayed within a frame rather than in a new window, if desired.

==Register Moodle with the platform==

The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time, before activities and courses can be accessed from the platform. This also means that the use of 'consumer key' and 'consumer secret' to secure access to resource is no longer required. Registration happens only once, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.

Registration can be completed one of several ways:
* Manual registration - A manual exchange of URLs and IDs between the platform and tool performed by an admin user.
* Dynamic registration - Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.

Dynamic registration simplifies the configuration process for administrators significantly and should be preferred, provided it is supported by the platform. Manual registration will work on any LTI Advantage compliant platforms, so is the natural choice when the platform doesn't yet support dynamic registration.

===Dynamic Registration===

In the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under the "Dynamic registration" tab, click "Generate registration URL"
# Copy the resulting URL to the clipboard using the copy to clipboard icon

In the platform:
The exact method of using a registration URL is platform-dependent.

In Moodle (for Moodle-to-Moodle LTI):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Paste the registration URL into the "Tool URL" field
# Click "Add LTI Advantage"
# When the page reloads and the tool card is visible, click "Activate".

Once complete, a platform registration and associated deployment will have been automatically configured in the Moodle tool. To see this, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration". The "Registered platforms" table contains the relevant information, however, no changes to this information are required.

===Manual registration:===

There are two parts to the manual registration process. Firstly, it requires information be copied from the Moodle tool into the platform, as part of configuring the tool there. Finally it requires information about the tool configuration in the platform be copied into the tool site to complete the process.

Starting in the Moodle tool:
# As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Select the "Manual registration" tab and leave this browser window open

Now, in the platform (the exact setup is platform dependant but this guide assumes another Moodle site is being used as the platform):
# As an admin user, go to "Site administration > Plugins > Activity modules > External tool > Manage tools"
# Click "Configure a tool manually"
# Change the field "LTI version" to "LTI 1.3"
# Change "Public key type" to "Keyset URL"
# Enable "Supports Deep Linking (Content-Item Message)"
# Copy the following URLs from the tool site into the respective form fields on the platform site:
#* Copy "Tool URL" into both the "Tool URL" field and the "Redirection URI(s)" field
#* Copy "Initiate login URL" into the "Initiate login URL" field
#* Copy "JWKS URL" into the "Public keyset" field
#* Copy "Deep linking URL" into both the "Content selection URL" field and the "Redirection URI(s)" field (on a new line)
# Set a tool name and save the configuration.
# On the resulting tool card, click "View configuration details" and leave this browser window open

Now, back in the Moodle tool again:
# As the admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
# Under "Registered platforms" click "Register a platform"
# Copy the following values from the platform site's tool configuration into the respective form fields:
#* Copy "Platform ID" into the "Platform ID (issuer)" field
#* Copy "Client ID" into the "Client ID" field
#* Copy "Public keyset URL" into the "Public keyset URL" field
#* Copy "Access token URL" into the "Access token URL" field
#* Copy "Authentication request URL" into the "Authentication request URL" field
# Enter a name for the platform and save
# For the registration you just created, click "Manage deployments"
# Click "Add a deployment"
# Copy the "Deployment ID" from the platform site's tool configuration into the "Deployment ID" field
# Enter a deployment name and save.

The registration process is now complete.

==Sharing access to a course or activity==
# From the course navigation, select "Published as LTI tools"
# Under the "LTI Advantage" tab (this is selected by default) click the "Add" button
# In "Tool to be published" select the course or activity to be shared
# Enable grade and user sync for the resource, if required
# Click the "Add method" button

The published activity or course is now ready for use in platforms via the content selection flow.

'''Note:''' The fields "Launch URL" and "Custom properties" are only relevant when sharing the content with instructors who don't have an account in the Moodle tool. If you're using Content selection, you can ignore these values.

Grade and user synchronisation (if configured) is handled asynchronously via the 'Publish as LTI tool grade sync' and 'Publish as LTI tool users sync' scheduled tasks, which run by default every 30 minutes.

If user synchronisation is set to yes, enrolled users in the remote system are synchronised with enrolments in the course, with an account created for each remote user as necessary, and the user enrolled or unenrolled as required. If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

===User account provisioning===

When users access a shared activity or course for the first time, Moodle will need to either find an existing account or create an account for them. Historically, all first launches resulted in the creation of new user accounts in Moodle, meaning users with existing accounts had no way to reuse those accounts. Account provisioning modes solve this problem by providing control over how accounts are created or linked on first launch. Additionally, in the case of teachers, they permit a richer experience via Content Selection, a process allowing the teacher to launch into Moodle using their existing Moodle account and select from any shared course or activity they have access to. More on this in the next section.

There are two relevant settings in the published resource settings; "Student first launch provisioning mode" and "Teacher first launch provisioning mode". Each setting controls how Moodle will handle the first launch for a user of that particular role (the role assigned to the user in the platform from which they launch the tool). Currently, several modes are supported:
* New accounts only (automatic) - A new account will automatically be created for the user during first launch. This account will then be reused on subsequent launches.
* Existing and new accounts (prompt) - The user will be prompted to either link an existing account they have in Moodle, or have a new account created for them. Subsequent launches will use whichever account is the result of this choice.
* Existing accounts only (prompt) - Only existing accounts may be used. If the user does not have an existing Moodle account to use, they will be unable to access the shared resources.

By default, "Teacher first launch provisioning mode" is set to "Existing and new accounts (prompt)", granting teachers flexibility in how they access the tool resources. Those having accounts can choose to use their existing account, while those not having an account can opt for the latter.

The default for "Student first launch provisioning mode" is "New accounts only (automatic)". Students will have accounts created for them automatically during first launch.

Each setting can be changed for each published resource, however, with a caveat. Once a user account is linked to a platform user, subsequent launches by that platform user will use that linked account. If a user accesses one resource using 'automatic' provisioning mode, and then later launches another resource which permits the use of existing accounts, the user will not be prompted to sign in because an account is already associated with them (the account which was automatically created for them during the first launch). The same is not true for the reverse situation. If the user accesses a resource permitting the use of existing accounts first, their existing account can be linked. Subsequently accessing a resource using 'automatic' provisioning mode, will only result in the reuse of their existing (now linked) account, and not the creation of a new account.

==On the LTI platform site==

Different platforms have different means of configuring and using LTI tools. The preferred means of configuring a course or activity link is by using Deep Linking (Content Selection), however, this requires that instructors have an existing account on the Moodle tool site. In instances where this isn't the case, course or activity links can be manually configured in the platform. Both methods are described below.

=== Link creation via content selection===
The following describes the recommended process for teachers when using another Moodle site as the platform and assumes the tool-platform registration process has already been completed. More information on the Moodle external tool setup can be found at [[External tool]].

# Make sure you're signed in to the Moodle tool site in another browser tab (if not, you will be prompted to do so later)
# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click the "Select content" button
# When prompted, link your account
# Select from a list of activities and courses to which you have access (optionally adding line items to the platform gradebook, where applicable - see note below), clicking "Add content" when done
# Save and launch the activity

'''Note:''' For platforms supporting coupled line items, Moodle can send information about the activity's grade to the platform during content selection. This allows the platform to create the respective line item in its grade book at the time of link creation. Whether this information is returned to the platform or not depends on two things: whether the published course or activity supports grades, and whether the 'Add to gradebook' checkbox is ticked during content selection.

===Manual link creation===
For users who don't have an account on the Moodle tool site, content selection isn't possible. These users can manually configure the activity link in the platform via the following process. Again, this assumes the tool-platform registration process has already been completed.

# In the platform site, visit a course
# Add an External Tool activity, or select a pre-configured tool from the activity chooser.
# Click "Show more"
# Enter the published course or activity's "Launch URL" into the "Tool URL" field
# Enter the published course or activity's "Custom properties" into the "Custom parameters" field
# Save and launch the activity

===Custom launch parameters===
'''Note:''' If you would prefer to not show blocks for teachers, you can pass the custom parameter "force_embed = 1". This may limit the functionality available to teachers and admins. To get blocks back, simply remove the parameter.

==LTI Advantage, LTI 1.1 or LTI 2.0?==

Moodle supports publication of content over several IMS LTI standards; LTI Advantage, LTI 1.1 and LTI 2.0. LTI Advantage is the current standard; LTI 1.1 and 2.0 have been deprecated. Courses and activities should be published using LTI Advantage. The legacy publication methods will continue to function in their current state to allow organisations to progressively move to LTI Advantage and will be removed in the future. More information about legacy methods can be found in the "Legacy resources" section below.

==Legacy resources==

{{MediaPlayer | url = https://youtu.be/cMQiKjXdm3A}}

===Sharing access to a course or activity (LTI 1.1 and 2.0)===
[[File:published tools.png|thumb|Published tools]]
# Go to the 'Enrolment methods' page and add 'Publish as LTI tool' as an enrolment method
# In 'Tool to be published' select the course or activity to be shared
# Click the 'Add method' button
# Go to ''Course Administration > Published as LTI tools'' page (/enrol/lti/index.php?courseid=''n'') and make a note of the launch details or the registration URL for the LTI consumer site (see below for info on which to choose). The URL will be of the form: .../enrol/lti/...
# You will also need to give the LTI consumer site a consumer key - this can be anything you want.

The LTI consumer can be another Moodle site or any other LTI-consumer-compliant LMS. Depending on the requirements of the LTI consumer, you can provide either a cartridge URL (also called configuration URL) plus secret OR a launch URL (new in Moodle 3.5.2) OR a registration URL.

Grade and user synchronisation follow the same rules as with LTI 1.3 and LTI Advantage publishing.

===Comparison of LTI 1.1 and 2.0 terms across platforms===
{| class="wikitable"
|-
!IMS Spec
!Moodle
!Canvas
!Edu app center (Canvas)
!Desire2Learn
!Blackboard
!Sakai
!Chamilo
|-
|Tool consumer
|External Tool
|External App
|App
|Link
|LTI Tool provider*
|Sakai Basic LTI portlet
|IMS/LTI Plugin
|-
|Launch URL
|Tool URL
|Launch URL
|n/a
|URL
|Provider Domain
|Remote Tool URL
|Launch URL
|-
|Secret
|Secret
|Secret
|Secret
|Secret
|Tool Provider Secret
|Remote tool secret
|Secret
|-
|Cartridge URL
|Tool URL
|Paste XML
|Configuration URL
|n/a
|n/a
|Tool registration file?
|n/a
|-
|Proxy URL
|Registration URL/Tool URL
|LTI 2 Registration URL
|n/a
|n/a
|n/a
| -
|n/a
|}

==Common issues==
The setup of LTI can be tricky, these are some of the most frequently reported issues by Moodle users. As always, enabling debug information can help trace the roots of a problem.

===LTI 1.1 and 2.0 Common issues===

====Mixed protocol limitations====
If your Moodle instance is using HTTP (and not HTTPS) you will only be able to use the tool on sites that are also using HTTP (and not HTTPS). It's recommended that you use HTTPS on your Moodle instance. See [[Transitioning to HTTPS]].

==== A required parameter (oauth_consumer_key) was missing ====
This exception occurs when the Tool Consumer is missing a Consumer Key parameter. As mentioned above, the consumer key can be anything you want so long as the field isn't left empty. Best keep it simple and without special characters, however.

==== User has free access to the entire site, isn't contained to the course ====
This can happen when the course content isn't embedded. Enable ''Allow frame embedding'' in ''Site Administration > Security > HTTP Security'' and, on the consumer site LTI tool settings, add ''force_embed=1'' in the ''custom parameters'' settings.

==== This XML file does not appear to have any style information associated with it. ====
Some tool consumers do not support cartridge URLs such as Sakai and Chamilo, in that case, it's better to use the launch URL.

==== Invalid request ====
This exception can happen for various reasons, so it can be difficult to trace the root of the problem. One of the possibilities is that ''deep linking'' is enabled in the tool consumer. Disabling it can help in LMS that have it like Chamilo and Canvas.

==See also==

* [[LTI and Moodle]]
* [https://moodle.org/mod/forum/discuss.php?d=345828 LTI authentication not working] forum discussion
* [http://lti.tools/saltire/ saLTIre - a testing system for LTI]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=7978 LTI and Moodle forum] on moodle.org

[[Category:LTI]]

[[es:Herramienta publicar como LTI]]
[[de:Als LTI-Tool bereitstellen]]
[[fr:Publier comme outil LTI]]

Standards

2021-04-01T05:05:42Z

Jaked:

{{About Moodle}}
Moodle is a global learning management platform that supports open standards, and is interoperable by design to enable integration of external applications and information onto a single Moodle platform.

Our commitment to open standards means institutions and organisations can leverage Moodle to customise and extend features for any teaching and learning requirements, and benefit from increased cost efficiencies, flexibility, easier manageability along with performance and scalability advantages of using Moodle.

Moodle has achieved and is compliant with the following international standards:

{| cellpadding="10px"
| style="width: 170px;" | [[File:moodle-opensource.png|left|160px|middle]]
| ''' 1. An Open Source Initiative'''
Moodle is provided as a free, open source software that can be used, modified and freely distributed under the terms of the [[License|GNU General Public License]]. There are also plenty of documentation, course content and resources available on Moodle.org for anyone to use under the terms of various licenses, including:
*'''''Moodle Documentation''''': All documentation on [[Main_page|docs.moodle.org]] is openly licensed under the terms of the GNU General Public License, and is Copyright © 2005 onwards by the individual authors of each page.
|-
| style="width: 170px;" | [[File:moodle-imslticertified.png|left|160px|middle]]
| '''2. IMS LTI™ Certified'''
Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#tab-v310 Learning Tool Interoperability (LTI) Advantage Complete]. The LTI™ certification is a global technical standard of integrating learning applications. [https://www.imsglobal.org/lti-advantage-overview LTI Advantage] is a package of services that improves upon 1.1 and 2.0 and is the current standard. Users can integrate and present externally hosted applications and content within a single Moodle platform without having to develop and maintain custom integrations. Learn more about [[External_tool|integrating LTI resources onto your Moodle platform]]. In Moodle 3.1 onwards, Moodle can also act as an LTI 1.1 and 2.0 tool provider with the [[Publish as LTI tool]].
|-
| style="width: 170px;" | [[File:moodle-scormcertified.png|left|160px|middle]]
| '''3. SCORM-ADL compliant'''
Moodle complies with the SCORM 1.2 specification. The SCORM (Sharable Content Object Reference Model) is a set of specifications and standards for web-based e-learning. Users can [[SCORM_module|deliver SCORM content via Moodle]] by uploading any SCORM or AICC package to the Moodle course. There are also community plugins available that provide limited support for the Experience API (Tin Can). A commercial plugin that provides full support for SCORM 2004 and the Experience API is also available in Plugins [https://moodle.org/plugins/view.php?plugin=mod_scormcloud/ here].
|-
| style="width: 170px;" | [[File:moodle-openbadges.png|left|160px|middle]]
| '''4. Open Badges '''
[http://openbadges.org/ Open Badges] project is an online standard to recognise and verify learning using digital badges. Integrated as a core feature in Moodle, any institution, organisation or individual can create and issue [[Badges|badges]] to learners on their Moodle learning platform. Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#cert_pane_nid_402893 Open Badges v2.0 compliant as Issuer by IMS].
|-
| style="width: 170px;" | [[File:wcag21AA-logo.png|left|160px|middle]]
| '''5. WCAG 2.1 Level AA'''
Moodle has received [https://www.webkeyit.com/accessibility-services/accessibility-accreditations/moodle/ WCAG 2.1 Level AA accreditation] based on successfully resolving the issues identified in an external audit of key pages which were chosen as representative of its overall functionality and accessibility. Continuing work is being done to further improve the accessibility of other areas in Moodle in order to maintain conformance with the [https://www.w3.org/TR/WCAG21/ WCAG 2.1 Level AA guidelines].
|}

== Moodle and Interoperability ==

In supporting the seamless integration and use of content from different sources and multiple vendors, the Moodle platform is designed to exchange data using open industry standards for Web deployments, and supports:
# '''[[Authentication]]''' using:
#* [[LDAP_authentication|LDAP]], the most widely-used standard protocol for authentication.
#* Direct direct database lookup (e.g. in an external Oracle database), or on the Shibboleth protocol, or alternatively using IMAP, NNTP, CAS or FirstClass.
# '''[[Enrolment]]''' using:
#* LDAP server (e.g. Active Directory)
#* [[IMS_Enterprise|IMS Enterprise standard]] (via a downloadable plugin).
# '''Content''' using the import of Reusable Learning Objects, packaged according to the SCORM/AICC/IMS Content Packaging standards.
#* Moodle 1.9.5 is certified [[SCORM_module|SCORM]] 1.2 compliant.
#* Moodle supports [[IMS Common Cartridge import and export]]
#* The use of XML for content import/export (standard in Moodle). The "web services" method of exchanging data with other systems (e.g. via SOAP or XML-RPC) is not yet standard - but is in active development.
# '''Quiz questions''' via [[Import_questions|import]] and [[Export_questions|export]] using a variety of formats.
# '''[[RSS|RSS newsfeeds]]''', integrated into a Moodle site or course.
#* Forum discussions, glossary entries and database content can be accessed as RSS newsfeeds, and therefore integrated into other RSS-capable websites or systems.

[[fr:Standards]]
[[es:Estándares]]
[[de:Standards]]
[[it:Standard]]

Standards

2021-04-01T05:04:43Z

Jaked:

{{About Moodle}}
Moodle is a global learning management platform that supports open standards, and is interoperable by design to enable integration of external applications and information onto a single Moodle platform.

Our commitment to open standards means institutions and organisations can leverage Moodle to customise and extend features for any teaching and learning requirements, and benefit from increased cost efficiencies, flexibility, easier manageability along with performance and scalability advantages of using Moodle.

Moodle has achieved and is compliant with the following international standards:

{| cellpadding="10px"
| style="width: 170px;" | [[File:moodle-opensource.png|left|160px|middle]]
| ''' 1. An Open Source Initiative'''
Moodle is provided as a free, open source software that can be used, modified and freely distributed under the terms of the [[License|GNU General Public License]]. There are also plenty of documentation, course content and resources available on Moodle.org for anyone to use under the terms of various licenses, including:
*'''''Moodle Documentation''''': All documentation on [[Main_page|docs.moodle.org]] is openly licensed under the terms of the GNU General Public License, and is Copyright © 2005 onwards by the individual authors of each page.
|-
| style="width: 170px;" | [[File:moodle-imslticertified.png|left|160px|middle]]
| '''2. IMS LTI™ Certified'''
Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#tab-v310 Learning Tool Interoperability (LTI) Advantage Complete]. The LTI™ certification is a global technical standard of integrating learning applications. [https://www.imsglobal.org/lti-advantage-overview LTI Advantage] is a package of services that improves upon 1.1 and 2.0 and the current standard. Users can integrate and present externally hosted applications and content within a single Moodle platform without having to develop and maintain custom integrations. Learn more about [[External_tool|integrating LTI resources onto your Moodle platform]]. In Moodle 3.1 onwards, Moodle can also act as an LTI 1.1 and 2.0 tool provider with the [[Publish as LTI tool]].
|-
| style="width: 170px;" | [[File:moodle-scormcertified.png|left|160px|middle]]
| '''3. SCORM-ADL compliant'''
Moodle complies with the SCORM 1.2 specification. The SCORM (Sharable Content Object Reference Model) is a set of specifications and standards for web-based e-learning. Users can [[SCORM_module|deliver SCORM content via Moodle]] by uploading any SCORM or AICC package to the Moodle course. There are also community plugins available that provide limited support for the Experience API (Tin Can). A commercial plugin that provides full support for SCORM 2004 and the Experience API is also available in Plugins [https://moodle.org/plugins/view.php?plugin=mod_scormcloud/ here].
|-
| style="width: 170px;" | [[File:moodle-openbadges.png|left|160px|middle]]
| '''4. Open Badges '''
[http://openbadges.org/ Open Badges] project is an online standard to recognise and verify learning using digital badges. Integrated as a core feature in Moodle, any institution, organisation or individual can create and issue [[Badges|badges]] to learners on their Moodle learning platform. Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#cert_pane_nid_402893 Open Badges v2.0 compliant as Issuer by IMS].
|-
| style="width: 170px;" | [[File:wcag21AA-logo.png|left|160px|middle]]
| '''5. WCAG 2.1 Level AA'''
Moodle has received [https://www.webkeyit.com/accessibility-services/accessibility-accreditations/moodle/ WCAG 2.1 Level AA accreditation] based on successfully resolving the issues identified in an external audit of key pages which were chosen as representative of its overall functionality and accessibility. Continuing work is being done to further improve the accessibility of other areas in Moodle in order to maintain conformance with the [https://www.w3.org/TR/WCAG21/ WCAG 2.1 Level AA guidelines].
|}

== Moodle and Interoperability ==

In supporting the seamless integration and use of content from different sources and multiple vendors, the Moodle platform is designed to exchange data using open industry standards for Web deployments, and supports:
# '''[[Authentication]]''' using:
#* [[LDAP_authentication|LDAP]], the most widely-used standard protocol for authentication.
#* Direct direct database lookup (e.g. in an external Oracle database), or on the Shibboleth protocol, or alternatively using IMAP, NNTP, CAS or FirstClass.
# '''[[Enrolment]]''' using:
#* LDAP server (e.g. Active Directory)
#* [[IMS_Enterprise|IMS Enterprise standard]] (via a downloadable plugin).
# '''Content''' using the import of Reusable Learning Objects, packaged according to the SCORM/AICC/IMS Content Packaging standards.
#* Moodle 1.9.5 is certified [[SCORM_module|SCORM]] 1.2 compliant.
#* Moodle supports [[IMS Common Cartridge import and export]]
#* The use of XML for content import/export (standard in Moodle). The "web services" method of exchanging data with other systems (e.g. via SOAP or XML-RPC) is not yet standard - but is in active development.
# '''Quiz questions''' via [[Import_questions|import]] and [[Export_questions|export]] using a variety of formats.
# '''[[RSS|RSS newsfeeds]]''', integrated into a Moodle site or course.
#* Forum discussions, glossary entries and database content can be accessed as RSS newsfeeds, and therefore integrated into other RSS-capable websites or systems.

[[fr:Standards]]
[[es:Estándares]]
[[de:Standards]]
[[it:Standard]]

Standards

2021-04-01T04:57:40Z

Jaked:

{{About Moodle}}
Moodle is a global learning management platform that supports open standards, and is interoperable by design to enable integration of external applications and information onto a single Moodle platform.

Our commitment to open standards means institutions and organisations can leverage Moodle to customise and extend features for any teaching and learning requirements, and benefit from increased cost efficiencies, flexibility, easier manageability along with performance and scalability advantages of using Moodle.

Moodle has achieved and is compliant with the following international standards:

{| cellpadding="10px"
| style="width: 170px;" | [[File:moodle-opensource.png|left|160px|middle]]
| ''' 1. An Open Source Initiative'''
Moodle is provided as a free, open source software that can be used, modified and freely distributed under the terms of the [[License|GNU General Public License]]. There are also plenty of documentation, course content and resources available on Moodle.org for anyone to use under the terms of various licenses, including:
*'''''Moodle Documentation''''': All documentation on [[Main_page|docs.moodle.org]] is openly licensed under the terms of the GNU General Public License, and is Copyright © 2005 onwards by the individual authors of each page.
|-
| style="width: 170px;" | [[File:moodle-imslticertified.png|left|160px|middle]]
| '''2. IMS LTI™ Certified'''
Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#tab-v310 Learning Tool Interoperability (LTI) Advantage Complete]. The LTI™ certification is a global technical standard of integrating learning applications. Users can integrate and present externally hosted applications and content within a single Moodle platform without having to develop and maintain custom integrations. Learn more about [[External_tool|integrating LTI resources onto your Moodle platform]]. In Moodle 3.1 onwards, Moodle can also act as an LTI 1.1 and 2.0 tool provider with the [[Publish as LTI tool]].
|-
| style="width: 170px;" | [[File:moodle-scormcertified.png|left|160px|middle]]
| '''3. SCORM-ADL compliant'''
Moodle complies with the SCORM 1.2 specification. The SCORM (Sharable Content Object Reference Model) is a set of specifications and standards for web-based e-learning. Users can [[SCORM_module|deliver SCORM content via Moodle]] by uploading any SCORM or AICC package to the Moodle course. There are also community plugins available that provide limited support for the Experience API (Tin Can). A commercial plugin that provides full support for SCORM 2004 and the Experience API is also available in Plugins [https://moodle.org/plugins/view.php?plugin=mod_scormcloud/ here].
|-
| style="width: 170px;" | [[File:moodle-openbadges.png|left|160px|middle]]
| '''4. Open Badges '''
[http://openbadges.org/ Open Badges] project is an online standard to recognise and verify learning using digital badges. Integrated as a core feature in Moodle, any institution, organisation or individual can create and issue [[Badges|badges]] to learners on their Moodle learning platform. Moodle is certified [https://site.imsglobal.org/certifications/moodle/moodle#cert_pane_nid_402893 Open Badges v2.0 compliant as Issuer by IMS].
|-
| style="width: 170px;" | [[File:wcag21AA-logo.png|left|160px|middle]]
| '''5. WCAG 2.1 Level AA'''
Moodle has received [https://www.webkeyit.com/accessibility-services/accessibility-accreditations/moodle/ WCAG 2.1 Level AA accreditation] based on successfully resolving the issues identified in an external audit of key pages which were chosen as representative of its overall functionality and accessibility. Continuing work is being done to further improve the accessibility of other areas in Moodle in order to maintain conformance with the [https://www.w3.org/TR/WCAG21/ WCAG 2.1 Level AA guidelines].
|}

== Moodle and Interoperability ==

In supporting the seamless integration and use of content from different sources and multiple vendors, the Moodle platform is designed to exchange data using open industry standards for Web deployments, and supports:
# '''[[Authentication]]''' using:
#* [[LDAP_authentication|LDAP]], the most widely-used standard protocol for authentication.
#* Direct direct database lookup (e.g. in an external Oracle database), or on the Shibboleth protocol, or alternatively using IMAP, NNTP, CAS or FirstClass.
# '''[[Enrolment]]''' using:
#* LDAP server (e.g. Active Directory)
#* [[IMS_Enterprise|IMS Enterprise standard]] (via a downloadable plugin).
# '''Content''' using the import of Reusable Learning Objects, packaged according to the SCORM/AICC/IMS Content Packaging standards.
#* Moodle 1.9.5 is certified [[SCORM_module|SCORM]] 1.2 compliant.
#* Moodle supports [[IMS Common Cartridge import and export]]
#* The use of XML for content import/export (standard in Moodle). The "web services" method of exchanging data with other systems (e.g. via SOAP or XML-RPC) is not yet standard - but is in active development.
# '''Quiz questions''' via [[Import_questions|import]] and [[Export_questions|export]] using a variety of formats.
# '''[[RSS|RSS newsfeeds]]''', integrated into a Moodle site or course.
#* Forum discussions, glossary entries and database content can be accessed as RSS newsfeeds, and therefore integrated into other RSS-capable websites or systems.

[[fr:Standards]]
[[es:Estándares]]
[[de:Standards]]
[[it:Standard]]

OAuth 2 Microsoft service

2020-10-15T06:15:51Z

Jaked: /* Setup App In Microsoft */

{{OAuth2}}
=== Setup App In Microsoft ===

To set up an OAuth 2.0 client with Microsoft, you must first register a new application by using App registrations in the [https://portal.azure.com Azure Portal].

1. From Azure Portal home, under 'Azure services', select 'Azure Active Directory'

2. From the left hand menu, select 'App registrations'

3. Select 'New registration'

[[Image:ms_oauth2_2a.png|none|frame|Register new application]]

4. Choose a good name as this is what is shown to users when they are asked to approve the permissions.

5. For supported account types select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.

6. Choose 'Web' for redirect URI and add the callback URL. The callback URL should point to "your Moodle site URL + /admin/oauth2callback.php". If your Moodle site was available at <nowiki>https://lemon.edu/</nowiki> the callback URL would be <nowiki>https://lemon.edu/admin/oauth2callback.php</nowiki>. It is important that your Moodle site uses https and not http. Microsoft will not allow the callback url if it is not using https.

7. Click 'Register'.

[[File:ms_oauth2_5.png|none|frame|Application settings]]

8. Copy the 'Application (client) ID' to a safe place for later use.

[[File:ms_oauth2_6b.png|none|frame|Application (client) ID]]

9. Select 'Authentication' from side-bar menu.

[[File:ms_oauth2_12.png|none|frame|Authentication]]

10. Ensure implicit grant flow is disabled.

[[File:ms_oauth2_13.png|none|frame|Disable Implict Grant Flow]]

11. Select 'API permissions' from side-bar menu.

[[File:ms_oauth2_6.png|none|frame|API permissions]]

12. Make sure the "Microsoft Graph (1)" permissions section contains the "User.Read" permission.

[[File:ms_oauth2_7.png|none|frame|Microsoft Graph]]

13. Select 'Certificates & secrets' from side-bar menu.

[[File:ms_oauth2_8.png|none|frame|Certificates & secrets]]

14. Click 'New client secret' to create password/client secret.

[[File:ms_oauth2_9.png|none|frame|New client secret]]

15. Add a description and select when the password/secret will expire.

[[File:ms_oauth2_10.png|none|frame|Add a client secret]]

16. Copy the secret string value to a safe place for later use.

[[File:ms_oauth2_11.png|none|frame|Secret string value]]

17. In Moodle go to OAuth2 services (Site administration > Server > OAuth2 services) and create a new Microsoft service.

[[File:ms_oauth2_16.png|none|frame|Create new Microsoft service]]

18. Update the name if desired and enter the password/secret as the "Client secret" and the Application ID as the "Client ID".

[[File:ms_oauth2_14.png|none|frame|Add client ID and secret]]

19. Make any additional configuration changes such as limiting login domains, whether a login button will show on the login page, and if email verification is required.

[[File:ms_oauth2_15.png|none|frame|Addtional settings]]

==See also==

* [[OneDrive repository]]
* [[OAuth 2 authentication]] for enabling users to log in to Moodle with their Microsoft account

[[es:Servicio OAuth 2 Microsoft]]
[[de:OAuth2 Microsoft Service]]

Capabilities/moodle/site:messageanyuser

2019-07-18T07:32:40Z

Jaked:

{{Capabilities}}
* This allows a user to send a message to any user regardless of their messaging privacy settings i.e. they can send a message to a user who has blocked them.
* This capability is allowed for the default roles of manager, teacher and non-editing teacher.

[[Category:Capabilities|Site]]
[[Category:Messaging]]

Global search

2018-05-18T02:58:22Z

Jaked: /* The Solr server */

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator enables the setting "Search all courses" then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr search query features===

''These search features are only available if you use '''Solr''' as your search engine.''

You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

Note: The above features are only available when using the Solr search engine.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

{{New features}}
Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.
* Solr 7 is not currently supported as the field type 'int' has been removed.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites.<br><code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

===How to install Solr===

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

==== Linux (Debian/Ubuntu) ====
With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

==== Linux (Redhat/Centos 6 & 7) ====

===== Using built in php5 packages =====
yum install php-pecl-solr2
service httpd restart

===== Using 3rd party php7 packages (webtactic) =====
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

==== OSX using macports ====

sudo port install apache-solr4
sudo port install php54-solr

==== OSX using homebrew ====

brew install homebrew/php/php56-solr

==== Windows ====

Install the pecl package as usual. (This has not yet been tested.)

==== The Solr server ====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.4.1 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

=====Solr 5/6 schema setup=====

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

=====Solr 4 schema setup=====

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

=====Memory and File indexing considerations=====

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

=====Too many boolean clauses error=====

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

====Commannd for installing Solr Server on Centos 7====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]

[[es:Búsqueda global]]
[[de:Globale Suche]]

Capabilities/moodle/restore:viewautomatedfilearea

2017-09-15T02:59:27Z

Jaked:

{{Capabilities}}
*This allows a user to restore courses from the automated backup storage (as specified in ''Settings > Site administration > > Courses > Backups > Automated backup setup'')
*This capability is not set for any of the default roles

==See also==

* [[Automated course backup]]

[[Category:Capabilities|Backup]]
[[Category:Backup]]

[[es:Capabilities/moodle/restore:viewautomatedfilearea]]