Skip to main content

Integration with LTI

info

The LTI integration is demonstrated using the example of UZH OLAT and might look different for other learning management systems.

KlickerUZH can be integrated with LMSs (Learning Management Systems) through the LTI 1.3 standard. When connected correctly, KlickerUZH can use the LMS's authentication mechanism to automatically authenticate students (or create an account for them) and grant them access to the corresponding KlickerUZH content.

How should I structure my KlickerUZH elements?​

When integrating KlickerUZH into an online course (e.g., on UZH OLAT), several components can be included. We suggest the following structure to effectively set up your course.

Create a KlickerUZH structure with the following LTI pages:

LTI OLAT Integration - OLAT Structure

  1. Course overview and documentation: As part of your KlickerUZH course configuration, you can add a description containing an overview of how KlickerUZH will be used in your course, including the timing and purpose of its features. This section can also include information on the initial login and account setup. The information given in this text box can then be integrated into your OLAT course, providing your students with an overview and guidance.

  2. Live Quiz and Q&A: Make sure to integrate a page where your students can access active live quizzes and Q&A quizzes (if you are using them) directly from OLAT.

  3. Leaderboard: If your course includes gamification elements and/or groups and group activities, it makes sense to dedicate a page to the leaderboard (where students can also manage their groups). Motivate students from time to time by presenting the leaderboard, which tracks individual and group points.

  4. Manage Account (required): This page allows students to create or update their profile and manage their KlickerUZH account. This is the first page students should visit if they have not used KlickerUZH before and want to participate with an account. After creating an account here, they will be automatically logged in on all other KlickerUZH pages within OLAT. If students have already signed up for KlickerUZH outside of OLAT with their university e-mail address, they should also visit this page to ensure that their account is linked correctly.

  5. Self-Learning Area: In the self-learning area of your OLAT course, we recommend embedding the combined Practice Pool & Practice Quizzes overview as the primary entry point. It gives students access to spaced-repetition practice and to individual Practice Quizzes from one course page. You can additionally embed selected Practice Quizzes as separate OLAT elements when direct access is useful.

How can I set the language for KlickerUZH activities embedded in OLAT?​

KlickerUZH allows you to set a course language during creation or in the course settings. This language will be used as the default for all access links you copy from the corresponding course overview page (both direct access and LTI integration links), as well as QR codes.

While this means that all activities integrated into OLAT using the provided LTI access links will be displayed in the course language, students may still change the language to their preferred language using the corresponding functionality in the avatar dropdown. Students accessing your course activities directly through the KlickerUZH app will see the activities in their preferred language, which they can set in the app settings.

How can I configure Moodle with a system-wide LTI tool?​

You can configure Moodle with one fixed KlickerUZH LTI tool URL and route each activity launch through a custom LTI parameter.

  1. In Moodle, create or edit your tool in Site administration -> Plugins -> Activity modules -> External tool -> Manage tools.
  2. Set the tool launch URL to your fixed KlickerUZH LTI URL (e.g., https://lti.klicker.uzh.ch).
  3. In your course, add an External tool activity that uses this configured tool.
  4. In the activity settings, open Show more... and set Custom parameters to: klicker_redirect_to=<absolute KlickerUZH target URL>
  5. If you set multiple parameters, use one key=value pair per line. Then save and test the launch.

Examples of absolute KlickerUZH target URLs (value of klicker_redirect_to):

  • https://pwa.klicker.uzh.ch/en/course/abc123/liveQuizzes/overview
  • https://pwa.klicker.uzh.ch/en/course/abc123/practiceQuizzes/overview
  • https://pwa.klicker.uzh.ch/en/course/abc123/practiceQuizzes/pq789/
  • https://pwa.klicker.uzh.ch/en/course/abc123/microLearnings/ml456/

Links copied from the Manage interface are OLAT-style launch links and must be adapted for Moodle custom parameters.

  • Copied from Manage (OLAT-style): https://lti.klicker.uzh.ch/lti?redirectTo=https://pwa.klicker.uzh.ch/en/course/abc123/practiceQuizzes/overview
  • Moodle custom parameter (adapted): klicker_redirect_to=https://pwa.klicker.uzh.ch/en/course/abc123/practiceQuizzes/overview

Keep the Moodle tool launch URL fixed and pass only the target URL as klicker_redirect_to.

klicker_redirect_to must be an absolute http(s) URL on an allowed KlickerUZH domain.

Launch target resolution uses the following precedence:

  1. token.platformContext.custom.klicker_redirect_to
  2. redirectTo query parameter on the LTI URL

If both are present, the custom claim value wins.

This means existing OLAT links with ?redirectTo=... remain fully supported and can continue to be used unchanged.

If neither klicker_redirect_to nor redirectTo is provided, the launch is rejected as a configuration error.

How can I integrate KlickerUZH pages into my OLAT course?​

To successfully integrate individual KlickerUZH pages into your OLAT course, we outline the required steps for the different components below, showing you how to integrate the course overview and student documentation, activity lists (including Live Quiz and Live Q&A), leaderboard, account management, and individual activity links.

To embed a KlickerUZH element in OLAT, you always start by creating a new course element of the type “LTI Page.” The subsequent steps depend on the type of KlickerUZH element you would like to create (as listed below).

warning

The examples below focus on UZH OLAT. Moodle can also be integrated with a system-wide LTI tool using klicker_redirect_to as described above. If you would like to use another LMS, please have your administrator reach out to us.

Course Overview and Student Documentation​

LTI OLAT Integration - Course Overview and Documentation Integration
  • To integrate the course overview and student documentation, go to “Page content” on your newly added LTI page. Here, you can choose “KlickerUZH” as your LTI version – this way, many settings are configured automatically.
  • Additionally, add the correct URL for your KlickerUZH course. This URL can be found in the top right corner of your KlickerUZH course page under “LTI Links” > “Copy LTI link (Documentation).”
  • Activate “Skip launch page.”

LTI OLAT Integration - LTI Setting Selection

Activity Lists (including Live Quiz and Live Q&A)​

LTI OLAT Integration - Live Quiz List Integration
  • To integrate overview pages of all available activities of a certain type, create another "LTI Page" element in your OLAT course, select KlickerUZH as the LTI version, and add the correct URL for the activity list.
  • The Practice Pool & Practice Quizzes overview remains available when only one Practice Quiz is published, so students can still choose between spaced-repetition practice and the individual quiz.
  • Other activity lists may redirect students automatically when only one activity is available. We recommend including the Live Quiz List using the LTI link shown on the right, so students can quickly access Live Quiz and Live Q&A during the lecture.
  • Activate “Skip launch page”.

Leaderboard​

LTI OLAT Integration - Leaderboard Integration
  • For gamified courses, we recommend integrating the course overview / leaderboard as a separate LTI page.
  • You can find the corresponding URL again under "LTI Links" > "Copy LTI link (Leaderboard)" on your KlickerUZH course page.
  • Activate “Skip launch page”.

Account Management​

LTI OLAT Integration - Account Management
  • To ensure that students can create or update their KlickerUZH account and connect them correctly to their OLAT account through LTI, it is essential to include an account management LTI page.
  • Create another "LTI Page" element in your OLAT course, select KlickerUZH as the LTI version, and add the correct URL from the course overview under “LTI Links” > “Copy LTI link (Account Management).”
  • Activate both “Skip launch page” and “Transmit E-Mail address”. This step is crucial, as we can only ensure the integrity of new accounts if the e-mail is transmitted.
  • This link is the same for all courses in KlickerUZH.

LTI OLAT Integration - Account Management

  • Individual Practice Quizzes and microlearnings can additionally be integrated as separate LTI pages in your OLAT self-learning modules. Create an "LTI Page" element for each activity, select KlickerUZH as the LTI version, and add the correct URL for the activity.
  • You can find the LTI access link for each individual asynchronous activity in the dropdown on the corresponding activity in the course overview or on the activities list, as shown below.
  • Activate “Skip launch page”.
LTI OLAT Integration - Activity Links