Data and parameters transfer via LTI
Whenever external learning content is integrated into a course via the LTI tool course element, the learning platform transfers information to the external tool when the LTI link is used. This data transfer enables the tool to clearly identify the course, the participant and the respective situation of use.
This page explains the available data groups, shows typical application examples, and provides basic information. For step-by-step examples on how to configure the course editor, please refer to the page Parameters (LTI).
The following data groups can be distinguished for transmission:
Anonymous context information
This data is necessary in order for the tool to know how to display content and interpret access rights correctly. It is always transferred and enables the external tool to place the request in the correct context - without any personal data of the participants.
Examples of anonymous context information
Course context:
- Information about the course and the course element from which the tool was accessed.
- This means that a combination of the course ID, course module ID, and course title is transferred.
- More about the course context in LTI can be found at https://www.imsglobal.org/spec/lti/v1p3#contexts-and-resources
User context:
- Information about the user who accessed the tool.
- This means that an anonymous user ID and the user role are transferred. The user ID allows for the clear allocation of assessment data that is returned by the tool to the learning platform.
- Learn more on user context and user roles in LTI at https://www.imsglobal.org/spec/lti/v1p3#users-and-roles
Optional user information
Apart from anonymous context data, personal information can also be transferred to the external tool. These options can be activated in the course editor. They are needed, for example, when the external tool stores personal learning progress or provides feedback by name.
- First name
- Last name
- Email address
Fixed key values
Fixed key-value pairs are user-independent parameters that can be set manually in the course editor. They are sent each time the tool is used and are always the same, regardless which person opens the link.
Typical use cases:
- Transfer of a content ID or task ID so that the external tool can display the correct content
- Transfer of an access code for special content
- Definition of a mode (e.g. “Exercise” or “Exam”)
These values are useful as a way to control the tool's behaviour for a specific section of a course.
User-dependent key values
These values can be defined in the course editor as well. However, they differ in that they are person-dependent. They enable individual course data to be transferred to the tool – for example, to transfer personal user attributes, assessment of other elements, or current progress information.
Examples of user-dependent values:
- User attributes, such as the study programme
- User settings, such as the system language setting
- Membership of a specific learning group
- Score or assessment in a previous course section
- Learning progress or processing status
Specific examples on how to configure the course editor can be found on the page Parameters.
Summary
| Data group | Personal data | Configuration | Consent required | Example |
|---|---|---|---|---|
| Anonymous context information | no | automatically | no | Course- and user context, Role |
| Optional user information | yes | Course editor | yes | First and last name, Email address |
| Fixed key values | no | Course editor | no | Content ID, language |
| User-dependent key values | yes | Course editor | yes | User attribute, progress, assessment |
Using an IMS test tool is a good way to check the technical aspects of transferred data. Further information on creation and configuration can be found at https://lti-ri.imsglobal.org/lti/tools.