Required By Dates v4.2
- Alastair Izzard
A newer version of this document can be found here: Setting up Required By Dates - v4.4
Required By dates were added in v4.2 and allows registrations to have a date indication of when the student must take the course. The use case and business explanation is at the bottom of the page which provides some context. To set up the feature for a customer follow the below instructions:
Due Soon Intervals
Firstly you need to make sure the the default duration intervals for due soon email notifications and labels in the My Courses Widget is applied. Add System.Customer.DueSoonDurationDefault page attribute to the Org page.
This optional org page attribute is a comma separated list of numbers. It defines the default set of intervals at which a registration will have “due soon” email notifications (if they have been enabled) created and also the largest number will be the threshold for which the MCW marks registrations as Due Soon and adds the below labels.
Not all customers may want email notifications but it is likely all will want the Due Soon label in the MCW to be enabled. 7 days seems like a typical duration for this system setting.
For new offerings
Go to the Manage Registrations and create the offering. Add the Expected Duration in number of days. Creating the offering will also create the Due Soon intervals.
Any new registrations added will now automatically get the appropriate Required By Date.
For existing offerings
Go to the offering and add the Expected Duration.
You will also need to run SetDueSoonIntervalsForOffering to create the Due Soon intervals for your existing offering. NOTE - this command only sets the intervals for the due soon labels and notification. It does not set any Required By dates on registrations.
e.g. SetDueSoonIntervalsForOffering /Root/Carnival/CCL/Compliance/HandleComplaints/ HandleComplaints 7
RequiredBy dates are only created automatically when the registration is created. So if the offering contains existing Active Registrations you will also need to manually add the RequiredBy date to these with SetRequiredByDateForRegistration. This requires the Registration ID and a date in the format yyyy-mm-dd e.g.
SetRequiredByDateForRegistration 7fdc6da1-9fbb-11eb-80f2-0cc47a6f32d0 2021-05-22
If you need to do this for lots of registrations in the offering a quick way to do this is to:
Download Registration Report for Active registrations
Construct GetUsersRegistrations command for each user in with an Active registration
Paste the output into Excel, get rid of the extraneous rows that don’t contain IDs
Use “Text to Columns” to separate RegistrationIDs into their own column
Grab the IDs and construct the
SetRequiredByDateForRegistrationfor each ID.
Then run the set of commands to set the dates.
NOTE: in 4.3 a ReEvaluate command is being added so we can always update all RequiredByDates for an existing offering and registrations. https://rippleops.atlassian.net/browse/COREDEV-5010
Business Use Case
It is common that important training needs to be completed within a certain time period of the trainee being registered. Crew may need to complete familiarization training within 7 days of joining a vessel, or maybe new-hires need to complete their orientation within their first month are just some examples.
This feature allows a course offering to be given a “Required By” duration. This means the trainee must complete the course within a certain number of days after they are registered. You can even set multiple offerings with different durations so you can provide precise deadlines to different groups of students.
Your trainees are made aware of the “Required By” duration by seeing a new column under the My Courses tab or Gradebook.
A new set of labels will also appear next to any courses that are getting close to the deadline or are already overdue.
To help ensure courses are completed on time the system can also send email reminders and overdue notices to the trainee or to managers, admins or instructors who may need to chase up and ensure compliance and timely completion.
If you have some courses in mind that this feature would suit, let your Customer Success Manager or our Support team know you are interested and we can discuss your implementation requirements in further detail.