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

New default needed for tool_consumer_instance_name in sakai.properties

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: RESOLVED
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 19.0, 19.1, 19.2, 19.3, 19.4, 19.5, 20.0, 20.1, 20.2 [Tentative], 21.0 [Tentative]
    • Fix Version/s: 20.2 [Tentative], 21.0 [Tentative]
    • Component/s: BasicLTI
    • Labels:
    • 20 status:
      Resolved
    • Test Plan:
      Hide
      1. Add and configure a new External Tool (LTI) in a site that requires the tool_consumer_instance_name parameter, such as Ruben Education LTI. Be sure to select the "Debug Launch" option. 
      2. Click on the tool and select "Show Launch Data." 
      3. Look for "tool_consumer_instance_name=" in the launch data parameter list. This parameter should be present and should have some value listed.
      4. Select "Press to Continue to External Tool" and the tool should launch successfully.

      We can verify the change worked in general - but the original submitter needs to verify it "the tool that failed" now works.

      Show
      Add and configure a new External Tool (LTI) in a site that requires the tool_consumer_instance_name parameter, such as Ruben Education LTI. Be sure to select the "Debug Launch" option.  Click on the tool and select "Show Launch Data."  Look for "tool_consumer_instance_name=" in the launch data parameter list. This parameter should be present and should have some value listed. Select "Press to Continue to External Tool" and the tool should launch successfully. We can verify the change worked in general - but the original submitter needs to verify it "the tool that failed" now works.

      Description

      When testing an LTI tool on the nightly experimental server, the tool failed to launch and the following error appeared: "A required parameter (tool_consumer_instance_name) was missing."

      Apparently, there is a basiclti.consumer_instance_name = value that can be set in sakai.properties. However, the default is "none." While most LTI tools don't use this parameter, some of them (like the one being tested recently) do require it. We would like to have a new default value added to sakai.properties, so that the consumer name is automatically populated with something appropriate (e.g. server url or similar).  

      There are three values and here is how Sakai computes a default if they are not explicitly listed in sakai.properties:

      tool_consumer_instance_name - properties serverName or properties serverUrl or "localhost.sakailms"

      tool_consumer_instance_guid - a Sha256 of the name

      tool_consumer_instance_description - The same as the name

       

        Gliffy Diagrams

          Zeplin

            Attachments

              Activity

                People

                Assignee:
                csev Charles Severance
                Reporter:
                wilma@longsight.com Wilma Hodges
                Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    Git Integration