Clean up LTI Placements, add Site Navigation Placement (i.e. left nav)

Description

Over the years, in the “External Tool” UI in the Admin Workspace, we have been evolving a set of check boxes that capture the message types a tool can accept and the placements in the Sakai UI that we want the tool to appear. Launch message types and placements are very different concepts and in the old UI there was a bit of mixing. And there was no “Left Nav” placement. With this Jira these will appear as follows:

The privacy message indicator was moved under message type and a new placement (site navigation) was added.

With this change, the administrator can truly place an LTI tool wherever they like. However there is still a problem. Historically, code in Lessons, Site Manage, or whatever often did not strictly require a placement to be checked and instead “guessed” which tools belonged in which placements based on message types and other bits and bobs in the data model.

The worst example of this was how Site Info → Manage Tools worked. Since prior to this Jira there was no ‘site-level’ navigation placement, to construct the list of external tools to show in Site info it would list a tool petty much if the tool could accept a resource link message. This meant instructors saw tools that were not appropriate for the left navigation use case in Site Manage and there was no easy way for administrators to control what appeared there. I am guessing that stealthing was used as a hack at times to hack / work around this limitation.

Immediately after this change, any placement of an LTI tool selector in Sakai will switch from ad hoc “guessing” what tools might support this placement and erring on the side of more tools rather than fewer tools, each placement will only show tools which are marked as showing up in that placement (i.e. err on only including tools explicitly indicated for a placement).

So after this is put into production, some External Tools will disappear from some places in the the Sakai UI. All the administrator has to do is go into the External Tool configuration and explicitly indicate where the tool is to be placed. It will require a bit of manual fixing for the admin to indicate placements explicitly but with this the admin can truly control what tools appear at what points in the Sakai UI.

In effect, the value of this Jira is that the Placement check boxes really work and tools only show up in a placement if the placement is checked. In short, with this update, Sakai will consistently support placements giving administrators a lot of flexibility and control. Of course, with flexibility and control, there comes some responsibility.

This all has evolved slowly, where we introduced a placement type without requiring it to be checked in the name of upwards compatibility. The placement and message types (other than site-nav) have been in the UI for years - so hopefully admins have been checking them to indicate where they want a tool to show up - and likely frankly confused at times when more than the checked tools show up with no way to stop them from showing up. This will rationalize all that going forward.

Another change, now that the external tools appearing in Site Manage is under precise admin control, we won’t hide them under an expando section - they will just appear as a tool in the tool list - in alphabetical order with all the other tools. (like other LMS’s that support course nav placements already do )

Attachments

5

Activity

Show:

Charles R Severance July 4, 2024 at 1:49 PM

Hey and I just added a first cut at a conversion as an attachment - comments welcome.

Jennifer Loudiana July 3, 2024 at 3:05 PM

Is this working? We just updated to 23.2 and our tools are set for left site navigation and open in a new window but we had to manually go into each course and click Edit and update it.

Andrea Schmidt April 9, 2024 at 11:42 PM

Verified on 23x: https://qa23-maria.nightly.sakaiproject.org/, build: 586bbb76

Stealth testing planned for tomorrow and will add comments to

Andrea Schmidt March 24, 2024 at 12:59 PM

With Lessons placement now passing, I retested the site navigation placement. Both are working as expected. I then tested another tool, adding both the navigation and lessons placements, and this is also working.

25x: https://trunk-maria.nightly.sakaiproject.org/, build: b0fa0c57

Andrea Schmidt January 20, 2024 at 4:30 PM

Tested on 24x: https://trunk-maria.nightly.sakaiproject.org/, build: f5902019

I still need to thoroughly test stealthed tools yet, but I found an issue when the instructor creates a site:

Fixed

Details

Priority

23 Status

QA Verification Pass

Components

Assignee

Reporter

Conversion Script Required

Yes

Created December 3, 2023 at 9:17 PM
Updated July 7, 2024 at 5:43 PM
Resolved January 16, 2024 at 4:43 PM