How to Connect External Platform via LTI

How to Connect External Platform via LTI

Idea
Overview

This article provides details about how you can utilise LTI External Tool in your LMS system.

LTI External tools are add-on applications that can be integrated directly into your LMS course. These tools may provide interactive content, learning activities, or assessments.

Trainers/Teachers can add and link to LTI activities from within the LMS course page, allowing students to access them seamlessly without leaving your LMS site or logging in to another system.

Depending on the tool and how it is configured, grades from these activities can also be automatically returned to the Moodle gradebook.

LTI External Tool as the Provider
This function allows remote users on a different platform to access selected courses and activities from your LMS site. In other words, Your LMS site 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.

Access the following link if you want to learn more on How to Publish Courses or Activities from Your LMS as an LTI Tool v2

Alert
If you need further assistance on how you can utilise your LMS system as the LTI External Tool Provider, feel free to open a service ticket with us at support@eskilled.com.au 
LTI External Tool as the Consumer

Adding LTI External Tools at Course Level (Supports LTI 1.0/1.1 and LTI 1.3)

You can add new tools to your courses using the ‘Add tool’ button on the LTI External tools page.

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

Step 1: Go to the course where you would want to add the LTI External Tool, on course settings page choose More → LTI External Tools from the dropdown menu

'

Step 2: Click the Add tool button and fulfill all the needed details:

Info
For new integrations, always use LTI 1.3 where the external tool supports it. Use LTI 1.1 only when working with older tools that do not yet support LTI 1.3
Tool settings
Tool nameUsed to identify the tool provider within LMS. The name entered will be visible to trainers when adding external tools within courses.
Tool URLThis is the URL for connecting to site. If your site uses SSL (is on HTTPS) you will only be able to use a tool that also uses SSL. Make sure the tool URL has HTTPS before attempting to use it or you may get a blank page.
Tool descriptionUsed to describe what the tool is for, what it does, or any additional information the trainer may need to know.
LTI VersionLMS supports LTI 1.0/1.1 and 1.3 LTI versions
Consumer key (for LTI 1.0/1.1)This tells the connecting LTI compliant site that you're allowed to connect. The "tool provider", i.e. the manager of the connecting LTI compliant site will issue you with this key. If you are merely linking to a tool with no secure access or gradebook sharing then you won't need a consumer key. If you are linking to a course or activity from another LMS site, then you can add any consumer key.
Shared secret (for LTI 1.0/1.1)this is the "password" to connect to the tool - the LTI compliant site.
Public key type (for LTI 1.3)
The authentication method used to validate the tool
Public keyset (for LTI 1.3)
This is where your site will retrieve the tool's public key to allow signatures of incoming messages and service requests to be verified.
Initiate login URL (for LTI 1.3)
The tool URL to which requests for initiating a login are to be sent. This URL is required before a message can be successfully sent to the tool.
Redirections URI(s) (for LTI 1.3)
A list of URIs (one per line) which the tool uses when making authorisation requests. At least one must be registered before a message can be successfully sent to the tool.
Custom parameters
Most times, you can leave this blank. The tool provider might use this to allow you to display a specific resource.
Default launch container
This is how the external tool will be displayed.

Embed - The content will appear within the activity page where the tool is used, not moving users away from the page, but hiding any blocks your course may have.

Embed without blocks - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.

Existing window - The content will be displayed in the existing tab or window. Users will have to navigate back to the course using the ‘Back’ button once they’re done.

New Window - the external tool will open in a new window. (A new window or tab will open with the External tool and the old browser window containing the course page will not change.)
Content selection URL
The Content Selection URL will be used to launch the content selection page from the tool provider. If it is empty, the Tool URL will be used.
Icon URL
You can display a different icon from the default External Tool icon by entering its URL here
Secure Icon URL
Enter the URL of a different icon here if your students are accessing your site securely via SSL.

Services
IMS LTI Assignment and Grade Services

Whether to use the IMS LTI Assignment and Grade Services to synchronise grades instead of the Basic Outcomes service.


• Do not use this service - Basic 
Outcomes features and configuration will be used.

• Use this service for grade sync only - The service will populate the grades in an already existing gradebook column, but it will not be able to create new columns.

• Use this service for grade sync and column management - The service will be able to create and update gradebook columns and manage the grades.
IMS LTI Names and Role ProvisioningAllow the tool to retrieve members' info from the course using the IMS LTI Names and Role Provisioning Service. The privacy settings will apply. For course-level requests these will be based on the tool configuration settings. If you wish to always send such details, do not delegate the choice to trainers. Link-level requests will always use the privacy settings which apply to the link.
Tool SettingsAllow the tool to save and retrieve settings values.

Privacy
Share launcher's name with tool

Specify whether the full name of the user launching the tool should be shared with the tool provider. The tool provider may need launchers' names to show meaningful information within the tool.

Share launcher's email with tool

Specify whether the e-mail address of the user launching the tool will be shared with the tool provider. The tool provider may need launcher's e-mail addresses to distinguish users with the same name in the UI or send e-mails to users based on actions within the tool.

Accept grades from the tool

Specify whether the tool provider can add, update, read, and delete grades associated with instances of this tool. Some tool providers support reporting grades back to Moodle based on actions taken within the tool, creating a more integrated experience.

Force SSL (tickbox)
Selecting this option forces all launches to this tool provider to use SSL.

In addition, all web service requests from the tool provider will use SSL.

If using this option, confirm that this site and the tool provider support SSL.

Step 3: Once all the necessary details are filled out, toggle the newly created LTI tool as active from the Show in activity chooser column:



Step 4: Back to the course home page, it will now appear as one of the available items you can choose when adding an activity or resource.


Step 5: Add the necessary activity details as usual then save the changes to complete the setup.


Your LTI External Tool is now successfully added in your unit/course:

LTI Common Issues

Mixed protocol limitations

If your LMS site 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.



    • Related Articles

    • How to Publish Courses or Activities from Your LMS as an LTI Tool v2

      Overview This guide explains how to publish a course activity as an LTI tool using Moodle. LTI (Learning Tools Interoperability) allows learners on a different system (known as an LTI consumer) to access selected activities, with grades sent back to ...
    • Bulk Upload Users via .CSV file v2

      Bulk uploading users will allow you to create and update user details by importing them into the platform via a .CSV file Prepare a .CSV file ready for upload. .CSV Template is available for download. NOTES The upload users file has fields separated ...
    • Bulk Upload Users to Courses and Groups via .CSV file v2

      You need Admin access to be able to perform this action, Bulk updating users information via .CSV file will allow you to update and enrol user/s to course/s and add them to group/s within a course. This tutorial will help you do this step by step: ...
    • Bulk Suspend Users via .CSV file

      You need Admin access to be able to perform this action. This guide shows how to suspend multiple users from the site. Use .CSV files to make changes to a large number of users. Create a .CSV File containing the users you wish to suspend. Sign in to ...
    • How to Setup Language, Literacy, Numeracy, and Digital Skills (LLND) Assessments

      LLND Assessment Setup & Configuration Walkthrough (eSkilled) This tutorial provides a step-by-step walkthrough on how to set up, configure, and manage Language, Literacy, Numeracy, and Digital Skills (LLND) assessments within the eSkilled platform. ...