Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-78830

LTI Deep Linking REST Service support for GET and UPDATE

XMLWordPrintable

    • MOODLE_402_STABLE
    • deeplinkservice-squashed
    • Hide

      pre-requisite

      1. LTI Advantage requires your site to be reachable from the internet. If not, Install ngrok to expose your moodle setup externally. Refer here for additional guidelines
      2. Have a course with an instructor.

      Test 1: Dynamic Registration enables Deep Link Service

      1. As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools
      2. In the box that says tool url enter: https://robotest.theedtech.dev/register
      3. Click the Add LTI Advantage button
      4. The test tool should open with a trace of the communication with Moodle, all should be green (thumbs up).
      5. Click the close button - the test app UI should disappear and the list of tools refreshing
      6. Verify the Robotest app has been added and is not yet activated
      7. Open the app settings by clicking on the gear icon
      8. Verify in services section there is an LTI Links Service and the option selected is 'Use this service to retrieve tool's links and update them'
      9. Click the Activate button

      Test 2: verify deep linking service can read and update links

      1. Go to the course as instructor and enter edit mode
      2. Add activity -> External tool
      3. Choose Robotest and click Select Content
      4. Choose on of each option, and when back in moodle save and return to course
      5. Click on any of the imported link and verify:
        1. It's a thumbs up
        2. There is a section Deep Linking Service
        3. The number of links (graded and not) reflects the number of links currently in the course

      Test 3: no service if disabled

      1. As the admin, return to the tool configuration and disable the LTI Links Service
      2. Go back as instructor and launch one of the imported links
      3. Verify there is no more a section about deep linking service in the results

       

       

      Show
      pre-requisite LTI Advantage requires your site to be reachable from the internet. If not, Install ngrok to expose your moodle setup externally. Refer here for additional guidelines Have a course with an instructor. Test 1: Dynamic Registration enables Deep Link Service As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools In the box that says tool url enter: https://robotest.theedtech.dev/register Click the Add LTI Advantage button The test tool should open with a trace of the communication with Moodle, all should be green (thumbs up). Click the close button - the test app UI should disappear and the list of tools refreshing Verify the Robotest app has been added and is not yet activated Open the app settings by clicking on the gear icon Verify in services section there is an LTI Links Service and the option selected is 'Use this service to retrieve tool's links and update them' Click the Activate button Test 2: verify deep linking service can read and update links Go to the course as instructor and enter edit mode Add activity -> External tool Choose Robotest and click Select Content Choose on of each option, and when back in moodle save and return to course Click on any of the imported link and verify: It's a thumbs up There is a section Deep Linking Service The number of links (graded and not) reflects the number of links currently in the course Test 3: no service if disabled As the admin, return to the tool configuration and disable the LTI Links Service Go back as instructor and launch one of the imported links Verify there is no more a section about deep linking service in the results    

      The LTI Deep Linking REST Service is a new LTI Service complementing the current LTI Deep Linking Flow by offering an API that allows a tool to:

      • Get the current links in the course
      • Update a link, in particular URL and/or custom parameters, offering a way for customization to be preserved on course archive/restore

      The specification also contains the ADD and DELETE flow, but those are optional and would not be covered inthis story

      For a quick overview of the capabilities this service would offer to External Tools: https://youtu.be/UJXeZ8Hk2dE

      The specification is available (restricted to 1edtech members): https://github.com/1EdTech/LTI-central/blob/main/proposals/deeplinking-service/specification.md

            Unassigned Unassigned
            claudevervoort Claude Vervoort
            Votes:
            6 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:

                Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.