RIO Education Plans
The RIO Education installer is a tool that is used to quickly install the RIO Education managed package and deploy any metadata used for configuring the instance.
Along with the main install plan, 3 additional plans are included. These additional plans deploy additional metadata and also a sample dataset.
Detailed descriptions for all plans can be found below.
- For the steps on installing RIO Education, see this article here instead.
RIO Education Plan
This plan is the primary plan of the RIO Education product. It is used to install the RIO Education managed package as well as deploy some metadata that is used to quickly configure the instance where RIO Education is being installed.
Please note that before installing this plan, you must have installed the EDA package in your org and enabled Digital Experiences.
This plan must be installed before attempting to deploy any additional plans. All additional plans depend on the RIO Education package. A description of all steps in this plan can be found below.
Note: From v3.12 onwards, ensure that 'Lightning Web Security' is enabled on the Session Settings before upgrading your instance.
RIO Education - Check Transfer Credit Course ID
This step checks if there are Transfer Credit records in the org that have not had the values of the obsolete Approved Course field copied to the new Approved Course ID (s) field. If there are, the user is prompted to install RIO Education v3.9 and run the "Transfer Credit Course ID" task from the v3.9 upgrade plan before proceeding to avoid losing data.
DeleteRIO Education - Salesforce Feature Enablement
This step enables the following org settings:
- Chatter in Chatter Settings.
- "Allow site guest users to upload files" in Feature Settings.
- Path in Path Settings.
RIO Education - HEDA Object Tracking
This step sets up field history tracking for the following EDA object fields:
-
Course Connection.
- Course Connection ID.
RIO Education - HEDA Object Activity
This step enables Activities, Bulk API, Feeds, History, Reports, Search, Sharing and Streaming API on the Application object.
DeleteInstall RIO Education
This step installs the most recent version of the RIO Education managed package.
DeleteRIO Education - REDU - Admin Permission Set
This step assigns the running user the REDU - Admin permission set.
DeleteRIO Education - Public Groups
This step deploys the REDU - All and REDU - Admin public groups.
DeleteRIO Education - Standard Objects UI
This step deploys Lightning pages and configurations for the following standard objects:
- Account.
- Case.
- Contact.
RIO Education - EDA Objects UI
This step deploys Lightning pages and configurations for the following EDA objects:
- Address.
- Affiliation.
- Application.
- Course.
- Course Connection.
- Course Offering.
- Plan Requirement.
- Program Enrollment.
- Program Plan.
- Relationship.
- Term.
- Trigger Handler.
RIO Education - Standard Objects Security Setup
This step sets standard object field permissions on the Admin and REDU - Admin profiles, and deploys sharing rules for the Account and Contact objects.
DeleteRIO Education - EDA Security Setup
This step sets EDA object field permissions on the Admin and REDU - Admin profiles and deploys sharing rules for the Course Connection object.
DeleteRIO Education - REDU Security Setup
This step sets RIO Education object field permissions on the Admin and REDU - Admin profiles and deploys sharing rules for the Session object. It also deploys the following apps:
- RIO Admin Console.
- RIO Admissions.
- RIO Programs.
- RIO Students.
RIO Education - Standard Object Tracking
This step sets up field history tracking for the following standard object fields:
- Contact.
- Birthdate.
- Name.
- Deceased.
- Faculty Member?
- Student ID.
RIO Education - HEDA Object Tracking
This step enables field history tracking for the following EDA object fields:
-
Course Connection.
- Course Offering.
- Credits Attempted.
- Enrollment Status.
- Fee Amount.
- Fee Type Option.
- Fee Type.
- Grade.
- Release Grades.
- Requirement Met.
- Status.
- Upfront Payment.
-
Course Offering.
- End Date.
- Faculty.
- Fee.
- Fee Label.
- Release Grades.
- Start Date.
-
Program Enrollment.
- Credits Earned.
- End Date.
- Enrollment Status.
- Fee Type.
- Fee Type Option.
- GPA.
- Grade Points.
- Program Status.
- Start Date.
RIO Education - REDU Object Tracking
This step enables field history tracking for the following RIO Education object fields:
-
Attendance.
- Check In.
- Check Out.
- Session Date.
- PE Group.
- Completion Percentage.
- Credits Earned.
- Grade Points.
- Group Status.
-
PE Pathway.
- Automatically Enroll in courses.
- Credits Earned.
- Deferred.
- GPA.
- Grade Points.
-
Program Application.
- Applicant.
- Fee Type.
- Fee Type Option.
- Opportunity.
- Program.
- Program Application ID.
- Start Month.
- Start Year.
- Status.
- Status Date.
- RIO Order
- Discount Amount
- Discount Code
- Status
- Total Paid Amount
- RIO Order Line
- Amount
- Quantity
- Study Credit
- Study Offering
- Unit Price
-
Session.
- Attendance % for completion.
- Booked Places.
- Mandatory Attendance.
- Primary Faculty.
- Status.
-
Session Connection.
- Faculty Confirmed.
- Status.
- Study Offering
- Booked Places
- Listing Status
- Waitlisted Places
- Study Registration
- Enrollment Date
- Status
- Waitlist Date
- Withdrawn Date
RIO Education - Appointment Scheduler Automation
This step deploys the following automations related to the Appointment Scheduler:
- Email templates.
- RIO Education Appointment new appointment.
- RIO Education Appointment status updated.
- Flows.
- Appointment Status email flow.
- New Contact Attendance flow.
- Workflow email alerts.
- Send Email to Contact Attendances.
- Send Email to new Contact Attendances.
RIO Education - EDA Object Picklist
This step deploys the following picklist values for the following objects and fields:
-
Facility.
- Facility Type.
- Building.
- Cafeteria/Food Hall.
- Classroom.
- Computer Lab.
- Gymnasium.
- Health Center.
- Laboratory.
- Lecture Hall.
- Library.
- Non-room.
- Facility Type.
RIO Education - Update Group Members
This step assigns the REDU - Admin, REDU - Faculty, REDU - Guest and REDU - Student public groups as members of the REDU - All public group, provided they are not already members of the group.
DeleteOrg-Wide Default Sharing Plan
This plan contains only one step that sets the Org-Wide Default Sharing Settings for Standard, EDA and RIO Education objects. The exact configurations can be found in this article. If you are using the RIO Education Community, you should install this plan and the Community Security Setup plan. If not, it is not necessary to install these plans.
DeleteCommunity Security Setup Plan
This plan contains sharing configurations that give users access to the RIO Education Community. There are two different options for deploying Community Security Setup metadata for RIO Education that depend on what kind of Community the specific instance will be using. The plan also contains three separate steps for each of the three profiles REDU - Student, REDU - Faculty and REDU - Platform Faculty. Regardless of which option you choose, you may deploy any combination of these three profiles.
Option 1: If the Salesforce instance uses two different Communities for Faculty and Student members respectively, users should select only the "RIO Education - Student Community Security Setup" and "RIO Education - Faculty Community Security Setup" metadata instead.
Option 2: If the Salesforce instance only has a single Community that will be used by both Faculty and Student members, users should select only the "RIO Education - Combined Community Security Setup" metadata.
If you are using the RIO Education Community, you should install this plan and the Org-Wide Default Sharing plan. If not, it is not necessary to install these plans.
RIO Education - Enable ExperienceBundle Metadata API
This step enables the ExperienceBundle Metadata API in Experience Management Settings.
DeleteRIO Education - REDU - Platform Faculty Profile
This step deploys the REDU - Platform Faculty profile.
DeleteRIO Education - Student Community Security Setup
This step deploys the following components.
- Groups.
- REDU - Guest.
- REDU - Student.
- Sharing Sets.
- REDU - Student.
If this instance uses two separate Communities for students and faculty, this step should be checked as well as the RIO Education - Faculty Community Security Setup.
DeleteRIO Education - Faculty Community Security Setup
This step deploys the following components.
- Groups.
- REDU - All.
- REDU - Faculty.
- Sharing Sets.
- REDU - Faculty.
It also contains sharing rules to share records of the following objects with the REDU - Faculty group:
- Account.
- Application.
- Contact.
- Course Connection.
- PE Discipline.
- Program Enrollment.
- Requirement.
- Requirement Set.
- Session.
- Term Grade.
If this instance uses two separate Communities for Students and Faculty, this step should be checked as well as the RIO Education - Student Community Security Setup.
DeleteRIO Education - Combined Community Security Setup
This step deploys the following components.
- Groups.
- REDU - All.
- REDU - Faculty.
- REDU - Guest.
- REDU - Student.
- Sharing Sets.
- REDU - Faculty.
- REDU - Student.
It also contains sharing rules to share records of the following objects with the REDU - Faculty group:
- Account.
- Application.
- Contact.
- Course Connection.
- PE Discipline.
- Program Enrollment.
- Requirement.
- Requirement Set.
- Session.
- Term Grade.
If this instance uses two separate Communities for students and faculty, this step should be checked as well as the RIO Education - Student Community Security Setup.
If this instance uses a combined Community for both students and faculty, this step should be checked instead of the previous two steps.
DeleteRIO Education - Update Group Members
This step assigns the REDU - Admin, REDU - Faculty, REDU - Guest and REDU - Student public groups as members of the REDU - All public group, provided they are not already members of the group.
DeleteRIO Ready Plan
RIO Ready is a collection of metadata built on top of RIO Education. It is intended to deploy a set of pre-built components to give users a head start and reduce their implementation time when setting up their RIO Education functionality. Full documentation of RIO Ready and all its components can be found here. Each step in this plan will deploy a separate RIO Ready component.
All components are optional, however it should be noted that the RIO Ready - Login and Register (Pre-Deploy) component must be deployed before the RIO Ready - Login and Register component and the RIO Ready - Custom Fees (Pre-Deploy) component must be deployed before the RIO Ready - Custom Fees component.
The Community Transcript and Payments2Us components depend on the S-Docs and Payments2Us AppExchange apps, respectively. Attempting to deploy these components without first installing the appropriate apps will cause errors. Links to install these apps can be found in the documentation for these steps below. Similarly, the Housing Fee Generation component is intended as an add-on to the RIO Ed Housing Extension package and will cause an error if it is deployed without that package being installed first. A link to the package installer is provided in the documentation for this step.
RIO Ready - Community Transcript
NOTE: You must install the S-Docs app from the AppExchange before deploying this component.
RIO Ready: Community Transcript Generation
DeleteRIO Ready - Login and Register (Pre-Deploy)
NOTE: You must deploy this component before deploying the RIO Ready - Login and Register component.
RIO Ready: Login/Self-Registration
DeleteRIO Ready - Login and Register
NOTE: You must deploy RIO Ready - Login and Register (Pre-Deploy) component before deploying this component.
RIO Ready: Login/Self-Registration
DeleteRIO Ready - Payments2Us
NOTE: You must install the Payments2Us app from the AppExchange before deploying this component.
RIO Ready - Custom Fees (Pre-Deploy)
NOTE: You must deploy this component before deploying the RIO Ready - Custom Fees component.
This step deploys the following custom fields. These fields are needed for the automation deployed by RIO Ready - Custom Fees.
- Program Enrollment.
- Last Annual Fee Term.
- Last Annual Fee Year.
- Program Plan.
- Annual Fee Group.
- Program Completion Fee Group.
- Term-wise Fee Group.
- Term.
- Academic Year.
RIO Ready - Custom Fees
This step deploys an automation that performs Annual Fee functionality. Whenever a new Student Fee is created each term, it checks if the Academic Year is different and, if it is, finds and applies the Annual Fee.
DeleteRIO Ready - Housing Fee Generation
NOTE: You must install the RIO Ed Housing Extension package before deploying this component. A link to this package installer can be found here.
RIO Ready: House Fee Generation
DeleteRIO Ready - Housing Application Form
NOTE: You must install the RIO Ed Housing Extension package before deploying this component. A link to this package installer can be found here.
RIO Ready: Housing Application Form
DeleteSample Data
This plan loads a set of sample data to allow users to test out the functionality of RIO Education. A description of each step can be found below.
NOTE: Any steps in between the Disable Trigger Handlers and Restore Trigger Handlers steps will not throw exceptions if there is an error. They will instead log the error and then continue. This is to ensure that Trigger Handlers are always restored even on error. Because of this, you should expand the logs for these steps to check for errors, even if the installer reports the job as successful.
Disable Trigger Handlers
This step disables all TDTM Trigger Handlers in the targeted instance to ensure that no unexpected behaviour occurs when deleting and loading sample data.
DeleteRIO Education - Deactivate Community Users
This optional step finds any active Community Users that are related to Contacts from the sample dataset and deactivates them.
DeleteRIO Education - Delete Sample Data
This optional step deletes any existing sample data in the targeted instance in order to avoid duplicate errors in the loading step. Sample data is identified by the either the External Id or RIO P1 fields containing the string "ISD" (Installer Sample Data).
NOTE: The previous step (RIO Education - Deactivate Community Users) should always be selected if this step is selected. If there are existing Community Users that aren't deactivated, then their related Contacts will not be able to be deleted, causing an error in this step.
DeleteRIO Education - Load Sample Data
This step loads the sample dataset into the targeted instance. It is important to note that if there are any errors with this step, an error message will not appear and the installer will still report it as a success. This is to ensure that the following Restore Trigger Handlers task is run even in the event of an error. When running this plan, make sure you expand the logs for this task to check for errors, even if the installer reports the job as successful.
The sample dataset includes records of the following objects:
- Account.
- Affiliation.
- Appointment Availability.
- Appointment Time.
- Appointment Type.
- Assigned Location.
- Attendance.
- Availability Time.
- Booking.
- Contact.
- Contact Attendance.
- Course.
- Course Connection.
- Course Connection Requirement.
- Course Offering.
- Discipline Requirement.
- Facility.
- Fee.
- Fee Line.
- Fee Schedule.
- Fee Schedule Term.
- Funding.
- Grade.
- Grade Criteria.
- Grade Setting.
- Pathway Unit.
- PE Group.
- PE Pathway.
- Plan.
- Plan Line.
- Plan Requirement.
- Program Application.
- Program Course Requirement.
- Program Discipline.
- Program Enrollment.
- Program Pathway.
- Program Plan.
- Qualified Faculty.
- Resource.
- Resource Type.
- Session.
- Session Connection.
- Session Time.
- Student Fee.
- Term.
- Term Grade.
- Time Block.
RIO Education - Plan Line Session IDs
Because all Trigger Handlers are disabled while this plan runs, the usual trigger that populates the Session Id field on Plan Line records does not run.
This task replaces that trigger. It automatically populates the Session Id field on any Plan Lines in the sample dataset with the Id from the related Session.
DeleteRIO Education - Booking Session Time IDs
This step automatically populates the Session Time Id field on any Bookings in the sample dataset with the Id from the related Session Time.
DeleteRIO Education - Provision Community Users
This step selects a small subset of Students and Faculty Contacts, and creates Community Users associated with those contacts. The subset of Contacts used is fixed and is the same each time this is run.
DeleteRestore Trigger Handlers
This step restores all TDTM Trigger Handlers to the state they were in before this plan was run.
DeleteRIO Education - Approve Fee Schedules
There is a validation rule in RIO Education, which means a Fee Schedule's Status cannot be set to 'Approved' unless it has one or more related Fee Schedule Terms.
Because Fee Schedules are inserted before Fee Schedule Terms in the dataset, their Status is initially set to 'Draft'. This step runs a script that sets all the inserted Fee Schedules' Statuses to 'Approved'.
Delete