Add student special needs information and surface additional info in Roster

Description

This feature has been sponsored and contributed by UDL - Universitat de Lleida

It allows surfacing special needs information for users in the Roster, instructors can see this information but students' not. It’s very important for the instructors to know more information about specific students with special needs, instructors may take into consideration some additional instructions in order to grade, or create materials, or communication, for this reason the Roster tool will surface this private information about users'.

From the technical perspective, this information must be inserted into ‘a user property’, it can also be populated via DB, via providers like LDAP, etc

The properties are:

  • specialNeeds

  • candidateID

  • additionalInfo

The data is expected to be encrypted by default, which can be disabled with following properties:

  • encryptInstitutionalNumericID

  • encryptCandidateDetails

See more information here

  1. Add special needs information to CandidateDetailProvider

    • SampleCandidateDetailProvider will provide demo data for special needs, as it does already for additional notes and student numbers

    • Add new property, enabled by default displaySpecialNeeds

  2. Change following properties to be enabled by default

    • displayAdditionalInformation

    • useInstitutionalNumericID

  3. Surface Student Number, and “Additional Information” - special needs and notes in Roster tool

    • Special needs and notes can have multiple values (list), and might be lengthy, that's why an button is added to display the additional information

    • In the print view the information is displayed instead of the button

    • Add new permission roster.viewcandidatedetails

      • Active by default for maintain and Instructor

To enable this feature with sakai.demo=false uncomment <import resource="candidate-details.xml" /> in the file providers/component/src/webapp/WEB-INF/components.xml

Attachments

11

Activity

Show:

Miguel Pellicer October 24, 2023 at 2:34 PM

Anything you need from my team count on it, we are using it in production with very success adoption.

Sam Ottenhoff October 24, 2023 at 2:27 PM

I like the feature and support keeping it in 23.x.

We will work through the bugs and will look out for regressions.

Miguel Pellicer October 24, 2023 at 6:59 AM

Thanks for fixing this guys, I believe Sakai 23 was cut and then we made more commits that were not merged into 23.x, using the same Jira for feature bugfixing has some pros and cons, and this is one big con.

It went in before the freeze date, but UDL is not planning to adopt Sakai 23 so feel free to revert the full feature from 23.x if no institutions are interested on using this in 23.x, I think it’s a great feature and the instructors are using it a lot.

Earle Nietzel October 23, 2023 at 3:44 PM
Edited

As pointed out the following commits were missing from 23.x:

cherry picked them to 23.x

  • 74253288f20 (Mon Oct 23 11:40:33 2023 -0400) SAK-47992 Add setters needed for injection to CDP

  • 897b8268cc5 (Mon Oct 23 11:40:14 2023 -0400) SAK-47992 Move setter annotation to class

  • bdf9a380bbd (Mon Oct 23 11:37:47 2023 -0400) SAK-47992 Control decryption of candidate details...

Sam Ottenhoff October 23, 2023 at 3:10 PM
Edited

Wow, this is a crazy number of commits on one JIRA. But this is broken in 23.x as it’s missing setters.

I believe the following three commits should be merged into 23.x:

077a3a
249bd8
d989bc

I submitted a PR to merge these 3 commits into 23.x

Fixed

Details

Priority

Affects versions

Fix versions

23 Status

QA Verification Pass

Assignee

Reporter

Conversion Script Required

Yes
Created October 26, 2022 at 1:43 PM
Updated March 3, 2025 at 3:54 PM
Resolved November 8, 2022 at 10:41 AM