search

openedx / platform-roadmap

Tracking the maintenance, enhancement, and advancement of the Open edX project.
11 stars 1 forks source link

LTI 1.3 custom parameters #233

Closed scottrish closed 6 months ago

scottrish commented 1 year ago

Abstract

The LTI spec allows custom parameters to be passed by the LTI platform in the launch. In the 1.1 implementation these parameters were statically defined in the the LTI component configuration. There is an extension that allows dynamic variable substitution. These capabilities are not currently implemented in the 1.3 platform. This initiative will port the capability from 1.1 to 1.3.

Context & Background

The LTI spec allows for arbitrary name/value pairs to be passed as custom parameters, with the name prefixed with '_custom'. In 1.1 this is often used to provide the ID of the content to be launched, thereby avoiding the need for the tool provider to explicitly expose multiple launch URLs. With deep linking in 1.3 this particular use of custom parameters is reduced and with the current LTI 1.3 platform there is no support for custom parameters. Custom parameters can be used for any purpose however, including passing additional user attributes that the tool provider requests. In the 1.1 implementation there is an extension to custom parameters that allows templatized variables to be included in the LTI component configuration allowing the value to be dynamically retrieved from the course or user context. This initiative will port support for custom parameters, both statically and dynamically defined, from the 1.1 platform to the 1.3 platform. Earlier PR for dynamic custom parameters in 1.1 - https://github.com/openedx/xblock-lti-consumer/pull/215

Scope & Approach

TBD

Value & Impact

This will restore the capability that is currently available in 1.1 and allow Open edX courses to use the 1.3 platform with tools that are expecting certain attributes to be passed via custom parameters.

Milestones and/or Epics

TBD

Named Release

Q?

Timeline

1H2023

Proposed By

Pearson

Additional Info

No response

github-actions[bot] commented 1 year ago

Thanks for your submission, @openedx/open-edx-project-managers will review shortly.

jmakowski1123 commented 6 months ago

closing as there are more current boards to track LTI 1.3 implementations