Canvas Release: LTI 1.3 and LTI Advantage (2019-06-22)

[erinhmcmillan]

This document introduces the LTI 1.3 and LTI Advantage feature option as noted in the Canvas Release Notes (2019-06-22).

For additional feature updates, please refer to the LTI Developer Token release notes entries.

Third-party platform providers can create external tools using IMS Global LTI 1.3 and LTI Advantage. When supported by a tool provider, this framework allows admins to manage all LTI tool configuration data directly in the Developer Keys page. The LTI can then be added to an account or course External Apps page via an associated client ID.

This change allows external tool providers to provide improved integration standards and security between Canvas and their tool data. Additionally, Canvas admins can manage LTI tool configurations and developer keys without instructors requiring their own API key from the tool provider.

• Feature/Integration Setup
• Feature Options
• Account Management
• Permissions
• API
• Account Setup
• Developer Keys Configuration
• LTI Key Type
• LTI Keys Management
• External Apps Installation
• Course Setup
• External Apps Installation
• Community Resources
• Future Enhancements
• Customer Feedback

Feature/Integration Setup

Feature Options

The LTI 1.3 and LTI Advantage framework involves the LTI 1.3 and LTI Advantage account-level feature option, which can be enabled for an entire account. Canvas admins can enable this feature in Account Settings.

This feature option should only be enabled to configure tools that include LTI Advantage services. Specific questions about a provider’s integration or potential integration with the LTI 1.3 and LTI Advantage framework should be sent directly to the tool provider.

Account Management

Permissions

Users who want to manage Developer Keys must have the Developer Keys - manage permission. Additionally, users who want to add an LTI Advantage tool to a course must have the LTI - add / edit / delete permission.

No additional permissions are required to be enabled with this feature.

API

This feature involves the Developer Keys API and External Tools API, which can be used to manage developer keys and external tools, respectively, by users who have the appropriate permissions.

Account Setup

Unlike the current process for adding an external tool, the LTI 1.3 and LTI Advantage platform requires a tool to be initially configured in the Developer Keys page, followed by being added to an account or course.

Developer Keys Configuration

When this feature option is enabled, the Add Developer Key button includes two options: Add API Key and Add LTI Key. Selecting the Add LTI Key option displays a page for creating an LTI Key.

All data is provided by the external tool provider. Depending on the configuration method, data can be entered manually, via JSON, or via URL. The selected method displays the required configuration fields.

For all configuration methods, entries can be made for the key name, owner email, redirect URIs, and notes. The redirect URI data should also be provided by the tool provider.

After the data in the page is saved, the configuration page requires verification, which allows changes to the state of provided services, Canvas placement, and other options.

LTI Key Type

The Developer Keys page indicates LTI Keys by the external tool icon. All LTI Keys automatically generate a Client ID, which displays in the Details column. The state of the LTI Key indicates if the Client ID for the associated tool can be added to an account or course.

LTI Keys Management

LTI Keys can be edited at any time. Any changes to the key may take time to apply, as changes apply to all tools associated with the key throughout the account.

For tools that are turned on, users can add the tool to an account or course if they are given the tool’s client ID. Roles outside of the admin role do not have access to the client ID, which means it must manually be shared with anyone who has permission to manually install external tools.

LTI Keys that are off cannot be added and displayed in an account or course. If a key is turned off and has already been added in an account or course, the account or course where the LTI has been added no longer displays the tool. If re-enabled at a later date, the tool will be reactivated in the account or course.

If an LTI Key is to be deleted, the tool displays a warning—this action will delete all tools associated with the developer key. Once a key is deleted, it cannot be restored. Should an admin want to re-create the LTI Key for a tool, the tool must be re-added to all previous locations where it was installed. Admins could consider disabling the key instead of deleting the key until they are certain the key should be deleted.

External Apps Installation

At the account level, external tools must be installed in the External Apps page in Account Settings.

Users who have the appropriate permission to install an LTI key must also have the Client ID associated with the key. LTI Advantage apps can be added via the Client ID option. Only the Client ID is required to be added.

If the Client ID is associated with an external tool, the tool name displays in the page. The page also confirms the tool should be installed.

If the Client ID is associated with a key that has been turned off, the app will not be able to be installed and the Client ID will display as disabled.

Course Setup

External Apps Installation

At the course level, external tools must be installed in the External Apps page in Course Settings.

Functionality is the same as at the account-level external apps installation process.

Community Resources

Future Enhancements

This document outlines existing functionality included in the initial release of this feature. LTI 1.3 and LTI Advantage will continue to receive additional feature enhancements over future releases as indicated in Canvas Release Notes. Please follow the release notes for future functionality updates, which will be indicated by the developer token tag.

Customer Feedback

Community feedback for the LTI Advantage framework is welcome per Canvas Community Feedback Guidelines, which outlines general feedback, broken functionality, and feature enhancements.

For LTI Advantage, feature enhancements should include the developer token tag. Before submitting a new idea, please review all existing Developer Keys feature ideas.

[brett_g_dalton]

Will LTI 1.3 and LTI Advantage apps turn up in the External Tools API?  Currently LTI 2.0 apps are not listed at all when using 

GET /api/v1/accounts/:account_id/external_tools

[jpoulos]

 @brett_g_dalton ‌ yes, and we've added a "version" field to help.

[rohits_paktolus]

Hi,

Can we add custom parameters for LTI advantage Deep link in Canvas?

We need to add some extra values that one will get in launch details.

[brett_g_dalton]

Thanks Jesse, thats good to know. 

[jpoulos]

 @rohits_paktolus ‌ Unfortunately we have some work to do before we can handle the custom data part of the deep linking specification. For now, is it possible for you to pass that custom data to Canvas as a query parameter or path ID's in the url that you are returning to Canvas that you can pick up in the launch request later?

[mvandevelde]

Will LTI1.3 in Canvas be available for Teachers to install apps from the EduAppCentre without the administrator setting up a developer LTI Key?

And if so, is there a timeline on this, as IMSGlobal seems to be pushing all LTIs are LTI1.3 compliant by the end of 2020-22.

https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule-july-2019 

[erinhmcmillan]

Hi, Mark,

LTI 1.3 apps require an administrator to own the development key attached to the app. So no, administrators must set up the developer key and pass on the key information to the instructor, assuming the instructor has permission to install LTIs at the course level.

Thanks,

Erin

[mvandevelde]

Thanks erinhallmark,

After a bit of research, I can see now this has largely to do with the Oauth2.0 process required.

My concern is that the current workflow means that we will be losing the advantages of LTI Whitelisting with any application using LTI1.3, unless there is some plan to rebuild the Whitelisting tool in the future?

Mark.

[brian_hassler]

Where specifically in account settings is LTI 1.3 enabled?

[tylerweldon]

Hi Brian, 

LTI 1.3 is enabled in the same location as Developer Keys (API Key). On the admin page you click on developer keys link. Once on that page, you will see a drop down button on the top right corner. This will let you toggle between API key and LTI key. 

[brian_hassler]

Thanks, Tyler. I understand that's where admins go to configure a specific tool provider, but the very first line in the document says "The LTI 1.3 and LTI Advantage framework involves the LTI 1.3 and LTI Advantage account-level feature option, which can be enabled for an entire account. Canvas admins can enable this feature in Account Settings."

Specifically, I'm looking at the part that says admins enable the feature in Account Settings (not Developer Keys). Do Canvas admins need to take action in order for LTI 1.3 to be available on their instance, or is the option in Developer Keys automatically enabled?

Brian Hassler

LMS Product Specialist

SAGE Publications Inc

T: 720-982-3814

www.sagepub.com<http://www.sagepub.com/>;

<https://us.sagepub.com/en-us/nam/collegepublishing>

[erinhmcmillan]

Hi, Brian,

This document is an introduction to the feature as it is initially released, which was back in June. The feature option has since been removed and the functionality is now included for all institutions by default.

Thanks,

Erin

[brian_hassler]

Great, thanks!

Brian Hassler

LMS Product Specialist

SAGE Publications Inc

T: 720-982-3814

www.sagepub.com<http://www.sagepub.com/>;

<https://us.sagepub.com/en-us/nam/collegepublishing>

[michael21]

Deactivated user‌ passing the additional query params in the URL does work (e.g. https://my.application.com/path/to/lauch?id=123&code=something) however I found there are caveats.  The URL without the query string (e.g. https://my.application.com/path/to/lauch) must match the Target Link URI field in your LTI Developer Key exactly.  So including an id in the path (e.g. https://my.application.com/path/to/23/lauch) will raise an error of "Couldn't find valid settings for this link".  If you need to provided an id you're stuck with using the query string.

[jpoulos]

 @michael21  your tool configuration, make sure you are setting your domain in the "Additional Settings" section of the developer key. If you fail to do this, Canvas will require an exact match on the url. I _think_  that's why you are getting the error; Canvas will attempt an exact match on the url, and if it can't find it, Canvas falls back on a domain matching routine: Learning Tools Interoperability Advantage Implementation Guide 1.3 IMS Final Release | IMS Global Le... 

If that still doesn't work, let me know.

[michael21]

Deactivated user‌ thanks for the update.  I had a look into the CanvasLMS code when attempting to resolve this issue for my particular needs.  I found it attempts to find the developer key using the ContextExternalTool.find_external_tool class method.  The method attempts to do a find using the full URL then using the full URL less the query params then, finally by the domain.  Although it checks by domain during my practical experimentation I found failed for URLs with an ID is path (e.g. https://my.application.com/path/to/23/lauch).  On further inspection I found that the URL with the full path needed to be in the "Redirect URIs" on the developer key.  So not really practical for that type of URL which means you have to either provide the ID in the "custom" section of the Deep Linking Response for a Resource Link (which I believe is still in development for CanvasLMS) or via a query string.  Hope that helps.

[agarrard]

LTI 1.1 and LTI 1.3 running concurrently. Can we have links to LTI 1.1 and LTI 1.3 tools in the same course? Can we have LTI 1.1 and LTI 1.3 in different courses on the same instance of Canvas? Or is it considered a switch where we can only run LTI 1.1 or LTI 1.3?  Thanks - ALice

[erinhmcmillan]

Hi, Alice,

Right now they are independent, but our team is scoping work to allow for a LTI 1.3 tool to replace the 1.1 tool and associate all the existing links to the 1.3 tool.

Hope that helps!

Erin