Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-44047

Support LTI Advantage Custom Parameter Substitution

    XMLWordPrintable

    Details

    • 20 status:
      Resolved
    • Test Plan:
      Hide

      Go into an LTI tool in admin and add two custom items:

      zippy=$User.id
      zappy=$Context.title

      This tool can be 1.1 or 1.3, direct launch or Content Item / Direct Link.   All combinations should work.  Turn on debug to make it easier to see the launch data.

      Place the tool in Lessons and launch it - and look at launch data.   You should see the custom values but with the "$" expressions unchanged.

      With the fix, you will see the values substituted.  LTI 1.3 puts custom values in a JWT claim and LTI 1.1 puts them in post parameters - just search for zappy or zippy in the debug output.

      Show
      Go into an LTI tool in admin and add two custom items: zippy=$User.id zappy=$Context.title This tool can be 1.1 or 1.3, direct launch or Content Item / Direct Link.   All combinations should work.  Turn on debug to make it easier to see the launch data. Place the tool in Lessons and launch it - and look at launch data.   You should see the custom values but with the "$" expressions unchanged. With the fix, you will see the values substituted.  LTI 1.3 puts custom values in a JWT claim and LTI 1.1 puts them in post parameters - just search for zappy or zippy in the debug output.

      Description

      There are a number of LTI Advantage Custom substitution variables as described in:

      http://www.imsglobal.org/spec/lti/v1p3/#lti-user-variables

      Tools can set custom values with a dollar sign like:

      zippy=$User.id

      And they will be launched with:

      custom_zippy=42

      Or whatever the current primary key for the user happens to be.

      A variation of this was part of the Sakai LTI 2.0 support - but was removed when LTI 2.0 was removed.  This Jira will add some of that code back (refactored for LTI 1.3) and updated to the LTI 1.3 spec above.

        Gliffy Diagrams

          Zeplin

            Attachments

            1. custom_values.gif
              custom_values.gif
              6 kB
            2. SAK-44047-LTI11.png
              SAK-44047-LTI11.png
              63 kB
            3. SAK-44047-LTI13.png
              SAK-44047-LTI13.png
              191 kB
            4. SAK-44047-No-Subst.png
              SAK-44047-No-Subst.png
              42 kB

              Issue Links

                Activity

                  People

                  Assignee:
                  csev Charles Severance
                  Reporter:
                  csev Charles Severance
                  Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                    Dates

                    Created:
                    Updated:
                    Resolved:

                      Git Integration