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

Reintroduce the option to set custom params at the instance level

XMLWordPrintable

    • MOODLE_403_STABLE
    • MOODLE_404_STABLE
    • MDL-80914-main
    • Hide
      1. Log in as an admin.
      2. Create a course.
      3. Go to 'LTI External tools' in the course using the secondary navigation.
      4. Add a new course tool with the following configuration:
      5. Go back to the course homepage.
      6. Try to add a new instance of the tool in the course using the activity chooser.
      7. On the instance creation page expand the General section by clicking on the 'Show more...' link
        • confirm you can see a 'Custom parameters' configuration option (textarea)
      8. Configure the tool instance (activity) as follows and later save it:
        1. Activity name: Example activity
        2. Custom parameters: 

          param1=test1
          param2=test2
          param3=test3
          

      9. Go to the created tool instance (activity) and go to its settings page.
        • confirm you can see the same configuration from earlier (step 8.2) still stored in the 'Custom parameters' setting.
      Show
      Log in as an admin. Create a course. Go to 'LTI External tools' in the course using the secondary navigation. Add a new course tool with the following configuration: Tool name: Example tool Tool URL: http://example.com Go back to the course homepage. Try to add a new instance of the tool in the course using the activity chooser. On the instance creation page expand the General section by clicking on the 'Show more...' link confirm you can see a 'Custom parameters' configuration option (textarea) Configure the tool instance (activity) as follows and later save it: Activity name: Example activity Custom parameters:  param1=test1 param2=test2 param3=test3 Go to the created tool instance (activity) and go to its settings page. confirm you can see the same configuration from earlier (step 8.2) still stored in the 'Custom parameters' setting.
    • 3
    • Team Alpha - Sprint 2 I1-2024

      In 4.3, we removed the ability to manually configure an External Tool instance. I.e. users cannot add an "External tool" instance from the activity chooser any more. They instead, must configure a site or course tool, and then use that tool to create resource links (using content selection, most likely).

      This workflow is ok, provided the tool supports content item selection (deep linking). Which of course, is not the case for all tools, particularly the old 1.1 tools (in LTI 1.3/LTI Advantage, deep linking is part of the core suite of specs so most tools implement it in order to be certified).

      We're seeing reports of tools which are using URL params to identify resources (e.g. tool.example.com?resource=123 or even the old Moodle provider code). https://moodle.org/mod/forum/discuss.php?d=454439.

      Previously, the URL param would be entered in the instance form (in the tool URL field), and the tool could load that specific resource on launch. Teachers could paste in the URL, including the params, and it would launch that specific resource. This was a means of sharing access to the specific resource without deep linking too.

      Now, since we've nowhere to set that in the instance form, and more specifically no way to indicate a resource id at all (it's all hidden and tied into deep linking workflows), the only way tools like this (those which don't support deep linking) can create links is to create one tool PER RESOURCE, in the course tools page. This, of course, is hugely clunky and not practical at all.

      This issue is not about re-adding the URL param support - we don't want to do that. Instead, it's about considering whether we want to surface the 'custom params' form field again, under an 'advanced fields' section of the form, so that teachers can enter the id of the resource - should the tool support loading the resource via custom params. This won't instantly solve the problem for tools like the above, which use URL params, but it does at least provide a proper avenue to set resource ids and the like, should the tool not support deep linking.

      References:
      MDL-78573 is the 4.3 Epic, but the form was locked for legacy tool instances in MDL-78597.
      https://moodle.org/mod/forum/discuss.php?d=450974#p1813411
      https://moodle.org/mod/forum/discuss.php?d=454439

            Geshoski Mihail Geshoski
            jaked Jake Dallimore
            Jake Dallimore Jake Dallimore
            Mathew May Mathew May
            Ron Carl Alfon Yu Ron Carl Alfon Yu
            Votes:
            6 Vote for this issue
            Watchers:
            15 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 2 hours, 25 minutes
                2h 25m

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