US English (US)
ES Spanish

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Log in
English (US)
US English (US)
ES Spanish
  • Home
  • Help & Support
  • Support
  • Deep Dive
  • RIO Education Modules
  • Module - Schedule / Delivery
  • V3 Feature: Schedule / Delivery

Student Scheduling - Delay changes until a future date

Available from v3.20

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • RIO Certification
    RIO Certification Program RIO Academy RIO Challenge RIO Recipe Training
  • Releases
    Release Notes
  • Help & Support
    Install RIO Education RIO Insights RIO Recipe Support
  • About Us
    Who is RIO Education? Start Your RIO Journey Housekeeping
  • Experience RIO in action
+ More

Table of Contents

Setup Student Scheduler Apex Scheduled Job Feature Information Student Scheduler Features Warning regarding future Available Places Technical Information Session Connection fields SECN_ScheduledEnrollment_SCHED - Scheduled Apex details

A new setting called Allow Future Scheduling has been added to the Student Scheduler. This setting adds extra features to the Student Scheduler, allowing you to delay any student enrollment/unenrollment updates so changes don't appear on records or calendars until a specified date.

Please note, we only support Future Scheduling for Session Connections at this time.

Setup

Student Scheduler

You will need to enable Allow Future Scheduling on the Student Scheduler.

How to enable:

  1. Go to the Student Scheduler page
  2. Click Edit Page
  3. Click the Student Scheduler component on the page
  4. Scroll through the list of variables on the right, and enable Allow Future Scheduling
  5. Save the page, and Activate if necessary

Apex Scheduled Job

This new feature relies on an Apex Scheduled Job to find any future scheduled changes, and update the records. This job needs to be manually scheduled by an administrator.

How to schedule:

  1. Go to Setup > Custom Code > Apex Classes
  2. Click the Schedule Apex button
  3. Input the following information:
    1. Job Name: REDU Future Student Scheduling
    2. Apex Class: SECN_ScheduledEnrollment_SCHED
    3. Schedule using: Schedule Builder
    4. Frequency: Weekly (every day)
    5. Start: [Today]
    6. End: [100 years] - We can't tell a job to run infinitely using this method. If you still need to run the job 100 years later, you can come back and update the end date even later.
    7. Preferred Start Time: 12:00AM
  4. Save

 

Feature Information

Student Scheduler Features

With Allow Future Scheduling enabled, you will see some new features available in the Student Scheduler.

When assigning or removing students from Sessions, you will see a new radio-select option to Schedule the change for the future. This will allow you to choose the date for the change to take place, and specify the Enrollment status, if necessary.

Warning regarding future Available Places

Because the change is taking place in the future, we cannot guarantee there will be enough available places to enroll when the date arrives. Whatever status is set in the confirmation window will be applied, even if this causes the Session to become overbooked. It is up to the user to ensure there are enough available places, or to set the status to Waitlisted if necessary.

Also for this reason, it is NOT recommended to use this feature while also allowing students to enroll into Sessions themselves with the community's enrollment wizard.

 

 

A new button has also been added to the button menu, allowing users to view all Scheduled Enrollments for a Session, and update them if needed.

If a student has a scheduled enrollment date AND a scheduled unenrollment date, they will appear as two separate lines in this view. Deleting the scheduled enrollment in this case will also automatically remove the scheduled unenrollment.

 

Technical Information

Session Connection fields

The following fields have been added to the Session Connection object to store future scheduling information. These will automatically be populated by the Student Scheduler, and the scheduled job. The scheduled job will read the information from these fields to determine if a record needs to be updated, and will then input the appropriate dates and enrollment status on the main Session Connection fields.

These 3 fields store the information for adding a student to a Session:

  • Scheduled Start Job Status
  • Scheduled Start Date
  • Scheduled Start Enrollment Status

These 3 fields store the information for removing a student from a Session:

  • Scheduled End Job Status
  • Scheduled End Date
  • Scheduled End Enrollment Status

This field stores information about the completion of either of the scheduled jobs:

  • Scheduled Job Notes

SECN_ScheduledEnrollment_SCHED - Scheduled Apex details

Every time the SECN_ScheduledEnrollment_SCHED class runs, it will perform the following actions:

  1. It will find every Session Connection that matches the following criteria:
    1. Scheduled Start Job Status = “Scheduled”, and Scheduled Start Date ≤ Today's date
    2. OR
    3. Scheduled End Job Status = “Scheduled”, and Scheduled End Date ≤ Today's date
  2. For each Scheduled Start Job Status match, it will update the Session Connection with the following information:
    1. Start Date = [Scheduled Start Date]
    2. Enrollment Status = [Scheduled Start Enrollment Status]
    3. Scheduled Start Job Status = “Completed”
    4. Scheduled Job Notes will be appended with the current time, and a message saying the Enrollment automation completed.
  3. For each Scheduled End Job Status match, it will update the Session Connection with the following information:
    1. End Date = [Scheduled End Date]
    2. Enrollment Status = [Scheduled End Enrollment Status]
    3. Scheduled End Job Status = “Completed”
    4. Scheduled Job Notes will be appended with the current time, and a message saying the Enrollment withdrawal completed.
  4. If any of these Session Connections fail to update, we will instead try to update the Session Connection with the following error information:
    1. Scheduled Start/End Job Status = “Error”
    2. Scheduled Job Notes will be appended with the current time and the error
  5. If AGAIN these Session Connections fail to update, we will create a new hed__Error__c record for error logging each failed record:
    1. Context Type = “SECN_ScheduledEnrollment_BATCH Record Error”
    2. Object Type = “rio_ed__Session_Connection__c”
    3. Datetime = [Current time]
    4. Record Id = [Session Connection Id]
    5. Full Message = [Error message]

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Session Waitlist
  • Scheduling for Online Classes
  • Appointment Scheduler - Student Availability
  • Appointment Scheduler with Room Approval Validation
  • Sharing a combined class Session
RIO Education

RIO Education, a WDCi Company. This information is proprietary, confidential and protected by copyright ©2024.

CONTACT

Get in touch

  • Privacy
  • Terms of service

Knowledge Base Software powered by Helpjuice

Definition by Author

0
0
Expand