Refer to LTI: Single Sign-On for an overview of the LTI Consumer integration.

This guide assumes that a functioning LTI sign-on has been set up via Institution Settings > Integrations >> Manage Single Sign-on (SSO) connections settings.

The steps to set it up can be found in the LTI Overview section here.

Context IDs

Upon a successful LTI launch, OpenLearning uses the LTI context_id field to determine which OpenLearning course and class to navigate the user to. This will also enrol the user into this class and assign any required class roles.

This provides a mechanism for another application to provision the OpenLearning application with:

• user roles and enrolments for existing classes,
• a new class in an existing course, linked to the consumer application's own context
• a new course, with a new class, linked to the consumer application's own context

Note: The mappings between OpenLearning classes and LTI context_ids can be viewed and modified in the “Single Sign On Mapping” section under Integrations.

Provisioning a new Class (or Course)

In order for an LTI launch to provision a class or course, some criteria must be satisfied:

1. The LTI launch must send through the "Instructor" or "Administrator" LIS roles
2. An existing user must be linked to this launch
3. The user linked to the launch must have the OpenLearning Institution Staff role assigned

The consumer application will need to generate a launch link for this user to follow, which will specify a new context_id that is not yet linked to an OpenLearning class.

If the user following the launch link does not meet the above criteria, access will not be granted and an error will be shown to signal that the class has not yet been set up.

If the user does match the above criteria, the following user interface will be provided to the user:

This allows the user to assign the consumer application's context_id to a class, which may be:

• An existing class in an existing course
  • No provisioning will occur, this will only create a link from the context_id of the consumer application to an existing class.
  • This requires the user to be an Administrator of a Course under this institution.
• A new class in an existing course 
  • A new class will be provisioned, and the new class will be linked to the context_id of the consumer application.
  • This requires the user to be an Administrator of a Course under this institution.
• A new class in a new course
  • This will provision both a new course, and a class within it which will link to the context_id of the consumer application.
  • This requires the consumer application to pass through the "Administrator" LTI (LIS) role.

Once the new class has been created and/or linked to the consumer application's context_id, subsequent launches using this context_id will enrol learners into, and navigate to the linked class.

Using LTI Class Provisioning as an Administration Tool

This pathway can also be used by the consumer application as part of a course provisioning workflow for courses which have other offerings (e.g. public courses).

An administration tool can assign a context_id to each class delivery that is required on OpenLearning, and then be used as a staff tool to launch course creators into OpenLearning to create the required courses and classes as is required.

Once these courses are set up in OpenLearning, classes can be configured to use any kind of offering.

Launching learners into OpenLearning via LTI without specifying any context_id will sign the user into OpenLearning and then navigate to the institution's course catalogue homepage.