Skip to content

LTI - Deep Linking

OpenOlat supports deep linking according to the LTI 1.3 Deep Linking Protocol.

Functional description

Deep linking is an LTI 1.3 service that enables authors to guide course participants directly to a specific point in external content that is integrated via LTI.

Example:
Instead of providing a link to a book in the course element and letting learners search for a recommended chapter themselves (scrolling), a specific chapter can be displayed directly.

System administrators can activate the deep linking function so that the OpenOlat authors can enable the deep links to the external tool in the course elements without having to enter the login and the parameters again each time. This simplifies the work of the authors when configuring an LTI course element.

Available features

Various information about the course and course participants can be exchanged between OpenOlat and the integrated tool. In OpenOlat this includes:

  • Content Types
    • ResourceLink
    • Link
    • Image
    • File
    • HTML
  • Properties
    • type
    • url
    • title
    • text
    • thumbnail
    • window
    • iframe

Configuration

Global configuration

When system administrators set up an LTI tool at a global level, they can also activate an option for deep links. Activation means that all settings of the tool (use without logging in again separately) also apply to deep links that course authors specify in the LTI course element.

You find the toggle button "Activate Deep-Linking" in the system administration under:
Administration > External tools > LTI > Tab "External tools" > Button "Edit"

Toggle Activate Deep-Linking set to ON

Configuration in courses

If deep linking has been permitted for authors, they can select preconfigured links under "LTI Version" when configuring the LTI course element:
Course > Course editor > Course element "LTI page" > Tab "Page content"

If you select one of the preconfigured links, OpenOlat enters the required URL itself.

Selection list LTI Version with the value LTI 1.3

Opened selection list LTI Version with both LTI versions and the preconfigured tools below them

With the parameters Client ID and Deployment ID generated in the process, you then complete the configuration in the integrated tool.

Tip

In order for the Deployment ID to be generated, a change in the tab "Page content" must first be saved. This applies in particular when a preconfigured link has been selected under "LTI Version".

The button "Select content" appears with "LTI 1.3" and with a preconfigured tool for which "Activate Deep-Linking" is switched on. It becomes usable as soon as the Client ID and the Deployment ID are available. It opens the content selection of the external tool. The content selected there then appears in the field "Resources".

Page view

If the course element "LTI page" is to start the external content immediately, select the option "Skip launch page" in the tab "Page content" in the course editor. Otherwise, a button appears with which the learners start the integrated page themselves.

Checkbox Skip launch page, above it a preconfigured tool with the completed fields URL and Deployment ID

Further information

Mentioned on this page
LTI 1.3 Deep Linking Protocol (IMS Global Learning Consortium) >

Further reading
Learning Tools Interoperability Core Specification (IMS Global Learning Consortium) >
LTI 1.3 Integrations >
LTI - External tools >
LTI - External Platforms >
LTI - Role mapping >
Configure LTI access to a course >
Course Element "LTI Page" >
Configure LTI access to a group >

To the top of the page ^