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.

The deep linking function can be activated by the administrator of the OpenOlat instance so that the OpenOlat authors can enable the deep links to the external tool in the course elements without having to repeatedly provide information on registration and parameter transfer. 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

If an LTI tool is set up by administrators at a global level, an option for Deep Links can also be activated. Activation means that all settings made for the tool (enabling use without having to log 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, in the dialogue for an LTI tool under External tools

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 one of the pre-configurations is selected, the required URL is entered immediately and the author no longer has to worry about it.

Selection list LTI Version with the value LTI 1.3, in the tab Page content of the course element LTI page

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

The Client ID and Deployment ID parameters generated in the process can then be used to complete the process on the integrated tool side.

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" only appears if deep linking is activated for the external tool. 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 external content is to be started immediately in the course element "LTI page", the option "Skip launch page" must be selected in the tab "Page content" in the course editor. Otherwise, a button appears with which the learner must explicitly start the integrated page.

Checkbox Skip launch page, above it the completed fields URL, Client ID and Deployment ID

Further information

Mentioned on this page IMS Global Learning Consortium: LTI 1.3 Deep-Linking protocol

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

To the top of the page ^