RIO Education 3.18 Release Notes
Enhancements, new features, and bug fixes
Table of Contents
Info
If a specific enhancement or new feature requires configuration, the notes will mention:
- the upgrade notes (steps),
- the components ("RIO Ed - Aura"),
- the attributes (configurable settings), and/or,
- the custom metadata type.
Otherwise, if there is no mention on configuration, attributes, RIO Ed - Aura components, or upgrade notes for a specific enhancement, this means that specific enhancement is automatically available upon installing this new version.
No configuration is needed for a new feature unless stated otherwise.
For more information on installing or upgrading your RIO Education version, head here.
3.18
Release date: 3rd August 2024
3.18 New Install
https://rioed-installer.herokuapp.com/products/RIO_Education/3.18
3.18 Upgrade
https://rioed-installer.herokuapp.com/products/RIO_Education_Upgrades/latest/v3_18
Before you upgrade
-
If you have not already enabled LWS in your instance, make sure to enable it. See here for more details.
- We recommend you to test new versions in a sandbox first (according to your own test cases), before rolling it into production.
- It is important to review the upgrade plans and the metadata to be applied before performing any action, as we do not support rollback.
< Please expand to read this, if you are directly upgrading from pre-3.11/3.12 >
If you are directly upgrading from pre-3.11, make sure to carry out the upgrade task for the following items below:
ISS-001194 Funding Disbursement
A new object called Disbursement is introduced as an alternate object to track the disbursement for student funding. In order to retain the existing behavior of funding disbursement which is tracked as negative fee line, you need to update the “Funding Type Disbursement and Order” custom metadata for “Scholarship” from “Disbursement" to “Fee Line” by following the steps below:
- Go to Setup > Custom Code > Custom Metadata Types
- Click on the “Manage Records” button next to the “Funding Type Disbursement and Order”
- Edit the “Scholarship” record
- Update the “Funding Disbursement Method” to “Fee Line”
If you are directly upgrading from pre-3.12, make sure to carry out upgrade tasks for the following items below:
ISS-001139 Lightning Web Security readiness for LWC and Aura
Due to the enforcement of Lightning Web Security (LWS), all following Javascripts library used in RIO Education have been upgraded to the version that compatible with LWS:
- FullCalendar
- Jquery
- moment.js
- chartJs
Hence, the LWS needs to be enabled in your Salesforce instance in order for the Appointment Scheduler, Session Scheduler, and Calendar to work properly.
If you still have customized Aura components that utilize third party Javascript library that are not compliant with LWS, it is recommend not to upgrade to this version until the Salesforce Summer'23 release which would have LWS for Aura supported as general release. Please refer to Salesforce release schedule for more info.
Please note that it is important to test the upgrade in sandbox first before rolling out to production to avoid any unforeseen issues.
As part of the change, the following settings have been replaced with the new settings from FullCalendar v5:
Setting | Legacy Value | New Value |
Calendar Weekly view | agendaWeek | timeGridWeek |
Resource Timeline Weekly view | timelineWeek | resourceTimelineWeek |
Resource Timeline Daily view | timelineDay | resourceTimelineDay |
Resource Timeline Monthly view | timelineMonth | resourceTimelineMonth |
Today button | cToday | today |
Resource Timeline Daily view | cTimelineDay | resourceTimelineDay |
Resource Timeline Weekly view | cTimelineWeek | resourceTimelineWeek |
Resource Timeline Monthly view | cTimelineMonth | resourceTimelineMonth |
If you have customized the Appointment Scheduler or Session Scheduler app page, please follow the steps to update the settings manually:
-
Appointment Scheduler:
- Default Calendar View: agendaWeek > timeGridWeek
- Default Calendar View: agendaWeek > timeGridWeek
-
Session Scheduler:
- Calendar Header Button (Left):
- timelineWeek > resourceTimelineWeek
- timelineDay > resourceTimelineDay
- timelineMonth > resourceTimelineMonth
- Calendar Header Button (Center):
- timelineWeek > resourceTimelineWeek
- timelineDay > resourceTimelineDay
- timelineMonth > resourceTimelineMonth
- Calendar Header Button (Right):
- timelineWeek > resourceTimelineWeek
- timelineDay > resourceTimelineDay
- timelineMonth > resourceTimelineMonth
- These custom buttons are obsolete:
- cToday
- cTimelineDay
- cTimelineWeek
- cTimelineMonth
- Please replace them with today, resourceTimelineDay, resourceTimlineWeek, and resourceTimelineMonth respectively.
- The "prev" and "next" button cannot be placed next to "title" anymore due to the change of CSS on FullCalendar v5.
- For example, you will need to remove “prev” and “next” from the Calendar Header Button (Center) and leave it with just “title”.
- Then, in the Calendar Header Button (Left), key in “today prev,next”. This will display the button for you to click and view future and previous days/weeks.
-
If you have a customized Session Scheduler page, make sure to check that all attributes (e.g. field sets, info popups) are present after upgrading.
- It is best to keep track of your attributes on the RIO Ed - Session Scheduler component before upgrading, so that you can update them if any are missing after upgrading.
- Calendar Header Button (Left):
ISS-001528 Simplify Grade Management
This is ONLY APPLICABLE if you are using grade settings at the university department and academic program level before v3.12.
Since grade settings are now only at the educational institution from v3.12 onwards, existing grade settings at university department and academic program levels need to be modified.
If you are upgrading from before version 3.12, you will need to do some manual upgrade steps. Please take note that it is recommended to perform this upgrade task before or after the grading and grade release period to avoid any data integrity issues.
The upgrade task involves updating the following fields:
- Grade Setting - Grade Setting Type field (formerly called Grade Setting Scope).
- Course - Grade Setting Type.
Please follow the following upgrade steps:
1. Navigate to the Grade Settings tab.
2. Create a new list view and include the following fields:
- Name
- Grade Setting Type
- Educational Institution
3. Review the Grade Setting records:
- If the “Grade Setting Type” field for all records is “Educational Institution”, complete only step #4a. Please ignore the rest of these steps.
- If some “Grade Setting Type” have “University Department” or “Academic Program”, please complete all steps.
4. Go to Setup > Picklist Value Sets, and find the Grade Setting Scope picklist values.
- Deactivate the University Department and Academic Program options.
- For each unique University Department and Academic Program Grade Setting Type found on step #3b, create a new picklist value.
For example, if you have Grade Setting created under 'Department of Business' and 'Department of IT' university department, create two new picklist options: 'Business' and 'IT'.
- The new picklist options need to be added to the Course Connection Student record type.
There should be a checkbox while adding picklist options that says "Add the new picklist values to all Record Types that use this Global Value Set".
If you are not given the option to add them automatically, you will need to add that manually.
Go to Object Manager > Course Connection > Record Types, select the Student record type, select Grade Setting Type, then add the new picklist options.
5. Go back to the grade setting list view created on step #2
- Replace the “Grade Setting Type” for both “University Department” and “Academic Program” with the appropriate new values from step #4 using the list view inline editor.
- Replace the “Educational Institution” for both “University Department” and “Academic Program” with the Educational Institution record.
This can be found by the account hierarchy, or looking through the records (they should be set up in the order Academic Program > University Department > Educational Institution).
6. Navigate to Course tab.
7. Create a new list view with filter “Grade Setting Type” not equal to “Educational Institution” and include the following fields.
- Name.
- Grade Setting Type.
- Department.
- (Obsolete) Grading Academic Program.
Review the course records, replace the “Grade Setting Type” with the appropriate values from step #4 using the list view inline editor.
Upgrade notes
Please see the following items below that require you to do some setup after installing / upgrading to this version:
-
ISS-002011 Credit notes - Study Credit
- ISS-002035 v3.18 Security Review
Bug Fixes
ISS-002040 Buttons disappeared after removing classes at checkout
Fixed a bug with the Short Course Filter component, where the Search button would previously lose the background colour when returning to the page, after deleting a class from the checkout.
Changed the css, so button background colour shouldn't get overwritten anymore.
See also: RIO Ed - Short Course Filter
Enhancements
ISS-001983 Allow admin to disable self-enrollment at course level
“Ignore Self Enrollment” field on Course Offering is now implemented.
Course Offerings with this field enabled (TRUE) will not be shown in the Enrollment Wizard, thus giving the admin to ability to prevent students from enrolling into a particular Course Offering.
Note that if the “ignoreSelfEnrollment” parameter on the Enrollment Wizard component is enabled (TRUE), the Enrollment Wizard will still show the Course Offering anyway.
See also:
ISS-002011 Credit notes - Study Credit
Institutions now have the ability to create a "Credit Note" for users where a class has been cancelled and a refund is not given.
For example:
- A class is cancelled because the tutor is unavailable, but the class has already been booked. In this scenario, a user should either get a refund or a Study Credit.
- A student withdraws from a class, and rather than a refund, the institution may choose to give them Study Credits.
Added a new “Quantity Type” field to the Study Credit.
If Quantity Type = Currency, we will use the Study Credit's Quantity as extra funds to be credited towards linked Order Lines.
Upgrade note:
Whatever process is used for cancelling RIO Orders, should include a step to update the related RIO Order Lines and remove the linked currency Study Credit.
This will automatically refund the appropriate amount back to the Study Credit.
See also: Study Credits
Other
ISS-002035 v3.18 Security Review
Updated handling of URL parameters. Also included various code security updates.
Upgrade note:
Any URL parameters (E.g. for Appointment Scheduler, Session Scheduler, Student Scheduler) need to be updated from c__ to rio_ed__
For example:
- (Old parameters) c__contactid=xxx
- (New parameters) rio_ed__contactid=xxx