RIO Education Upgrade Plans
Table of Contents
This article contains a detailed description of all plans in the RIO Education - Upgrades product of the RIO Education installer.
Note
There are several plans in this product that include only two steps - a step to install the respective version of the RIO Education package and the Check Transfer Credit Course ID that is required for all upgrade plans after v3.9. These plans have not been included in this article.
Important info
When upgrading your RIO Education version and deploying metadata, you might encounter this message:
" WARNING: If you are installing into an existing Salesforce org - STOP and contact us for assistance to avoid overwriting any existing metadata. It is important to compare the metadata before applying because it would overwrite any existing configuration. "
To find out what will and will not be affected, check out this guide here.
It is important for anyone that performs the upgrade to review the upgraded metadata before performing any action, as we do not support rollback. Please also take note that you should upgrade and test in a sandbox first before upgrading the production org.
Note
If you have your own custom metadata (custom fields, etc.), and are unsure what changes are present in new version metadata, you should do the following:
- Get the metadata from the latest version (which will contain all the latest unique changes): https://github.com/wdci-dev/RIO-Education-Metadata-Upgrade/tree/master/unpackaged/post
- Extract the metadata from your own instance.
- Compare the two to identify the differences.
RIO Education - Upgrade to v3.0
This plan contains metadata to be deployed after upgrading to RIO Education v3.0.
RIO Education v3.0 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Appointment Availability
- RIOEducation Appointment Availability Layout
- Fee Line
- RIOEducation Fee Line Layout
-
PE Group
- RIOEducation PE Group Layout
- Plan Requirement
- RIOEducation Plan Requirement (Course) Layout
- RIOEducation Plan Requirement (Group) Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Appointment Availability
RIO Education - Upgrade to v3.1
This plan contains metadata to be deployed after upgrading to RIO Education v3.1.
RIO Education v3.1 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Course Connection
- RIOEducation Course Enrollment Layout
- Program Application
- RIOEducation Program Application Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Course Connection
RIO Education v3.1 - Custom Picklist
This step deploys / updates the following metadata:
- Global value sets
- Fee Type Option
- Object configurations
RIO Education v3.1 - Student Community Security Setup
This step deploys / updates the following metadata related to the Student Community. This step should only be selected if you are using separate Communities for students and faculty.
- Sharing sets
- REDU - Student
RIO Education - Upgrade to v3.2
This plan contains metadata to be deployed after upgrading to RIO Education v3.2.
RIO Education v3.2 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Appointment Time
- RIOEducation Appointment Time Layout
- Appointment Type
- RIOEducation Appointment Type Layout
- Appointment Time
RIO Education v3.2 - Student Community Security Setup
This step deploys / updates the following metadata related to the Student Community. This step should only be selected if you are using separate Communities for students and faculty.
- Profiles
- REDU - Student
RIO Education - Upgrade to v3.3
This plan contains metadata to be deployed after upgrading to RIO Education v3.3.
RIO Education v3.3 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Auto Credit Transfer Configuration (Custom Metadata Type)
- RIOEducation Auto Credit Transfer Configuration Layout
- Course Connection
- RIOEducation Student Course Enrollment Layout
- Grade Setting
- RIOEducation Grade Setting Layout
- Plan Requirement
- RIOEducation Plan Requirement (Course) Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Program Enrollment Status (Custom Metadata Type)
- RIOEducation Program Enrollment Status Layout
- Program Plan
- RIOEducation Program Plan Layout
- Session
- RIOEducation Session Layout
- Session Connection
- RIOEducation Session Connection Layout
- Trigger Handler
- RIOEducation Trigger Handler Layout
- Auto Credit Transfer Configuration (Custom Metadata Type)
RIO Education - Upgrade to v3.4
This plan contains metadata to be deployed after upgrading to RIO Education v3.4.
RIO Education v3.4 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Course
- RIOEducation Course Layout
- Course Offering
- RIOEducation Course Offering Layout
- Funding
- RIOEducation Funding Layout
- Course
RIO Education - Upgrade to v3.5
This plan contains metadata to be deployed after upgrading to RIO Education v3.5.
RIO Education v3.5 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Account
- RIOEducation Program Layout
- Program Enrollment Status (Custom Metadata Type)
- RIOEducation Program Enrollment Status Layout
- Program Plan
- RIOEducation Program Plan Layout
- Funding
- RIOEducation Funding Layout
- Student Fee
- RIOEducation Student Fee Layout
- Student Fee Type (Custom Metadata Type)
- RIOEducation Student Fee Type Layout
- Account
RIO Education v3.5 - Custom Picklists
This step deploys / updates the following metadata:
- Object configurations
RIO Education - Upgrade to v3.6
This plan contains metadata to be deployed after upgrading to RIO Education v3.6.
RIO Education v3.6 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Course
- RIOEducation Course Layout
- Discipline Requirement
- RIOEducation Discipline Requirement (Course) Layout
- PE Pathway
- RIOEducation PE Pathway Layout
- Program Discipline
- RIOEducation Program Discipline Layout
- Program Enrollment Status (Custom Metadata Type)
- RIOEducation Program Enrollment Status Layout
- Course
RIO Education - Upgrade to v3.7
This plan contains metadata to be deployed after upgrading to RIO Education v3.7.
RIO Education v3.7 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Agreement Course
- RIOEducation Agreement Course Layout
- Course
- RIOEducation Course Layout
- Transfer Credit
- RIOEducation Transfer Credit Layout
- Agreement Course
RIO Education - Upgrade to v3.8
This plan contains metadata to be deployed after upgrading to RIO Education v3.8.
RIO Education v3.8 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Activity
- RIOEducation Activity Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Session Time
- RIOEducation Session Time Checkpoint Layout
- Activity
RIO Education - Upgrade to v3.9
This plan is used for upgrading to RIO Education v3.10 and deploying any post-upgrade metadata.
Install RIO Education 3.9
This step upgrades the RIO Education package to v3.9.
RIO Education v3.9 - Disable Transfer Credit TDTM
This step deactivates the rio_ed.TC_LinkCourseConnection_TDTM trigger handler. This is used to disable RIO Education's standard Transfer Credit trigger handler.
This is something that should be checked on a case-by-case basis for each customer, as they might have made other changes to their custom wizard/trigger and want to continue using their version instead. If the customer wishes to continue using their existing wizard, this step should be selected.
RIO Education v3.9 - Copy Loan Fee to Fee Schedules
This step copies the value of the Loan Fee % field in any Fee records to the Loan Fee field on their related Fee Schedule records.
RIO Education v3.9 - Transfer Credit Course ID
This step copies the value of the obsolete Approved Course field on Transfer Credit records to the new Approved Course ID (s) field. Note that it populates the new field with the Course's Course ID field, not its record ID.
RIO Education v3.9 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Agreement
- RIOEducation Agreement Layout
- Agreement Course
- RIOEducation Agreement Course Layout
- Auto Credit Transfer Configuration (Custom Metadata Type)
- RIOEducation Auto Credit Transfer Configuration Layout
- Course Connection
- RIOEducation Student Course Enrollment Layout
- Educational Qualification
- RIOEducation Community Educational Qualification Layout
- RIOEducation Educational Qualification Layout
- Funding Allocation
- RIOEducation Funding Allocation Layout
- Grade
- RIOEducation Grade Layout
- RIOEducation SubGrade Layout
- Program Enrollment
- RIOEducation Program Enrollment Community Layout
- RIOEducation Program Enrollment Layout
- Session Connection
- RIOEducation Session Connection Layout
- Term
- RIOEducation Term Layout
- Term Grade
- RIOEducation Term Grade Layout
- Transfer Agreement
- RIOEducation Transfer Agreement Layout
- Transfer Credit
- RIOEducation Transfer Credit Layout
- Agreement
RIO Education v3.9 - REDU Custom Metadata
This step deploys / updates the following metadata:
- Custom metadata
- Auto Credit Transfer Configuration
- Credit Transfer
- Pass
- RPL
- Auto Credit Transfer Configuration
RIO Education v3.9 - Profiles
This step deploys / updates the following metadata:
- Profiles
- Admin
- REDU - Admin
RIO Education v3.9 - Student Community Security Setup
This step deploys / updates the following metadata related to the Student Community. This step should only be selected if you are using separate Communities for students and faculty.
- Profiles
- REDU - Student
- Sharing sets
- REDU_Student
RIO Education v3.9 - Combined Community Security Setup
This step deploys / updates the following metadata related to the Combined Community. This step should only be selected if you are using a combined Community for both students and faculty.
- Profiles
- REDU - Faculty
- REDU - Platform Faculty
- REDU - Student
- Sharing sets
- REDU_Student
RIO Education - Upgrade to v3.10
This plan is used for upgrading to RIO Education v3.10 and deploying any post-upgrade metadata.
RIO Education v3.10 - 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.
Install RIO Education 3.10
This step upgrades the RIO Education package to v3.10.
RIO Education v3.10 - Allow Students to Select Venue
Two new fields - Allow Students To Select Venue and Allow Faculties to Book have been added to the Appointment Type object in 3.10. This step runs a script that sets the Allow Students To Select Venue field on any existing Appointment Types to true.
RIO Education v3.10 - Allow Faculties to Book
Two new fields - Allow Students To Select Venue and Allow Faculties to Book have been added to the Appointment Type object in 3.10. This step runs a script that sets the Allow Faculties to Book field on any existing Appointment Types to true.
RIO Education v3.10 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Appointment Type
- RIOEducation Appointment Type Layout
- Course Connection
- RIO Education Student Course Enrollment Layout
- PE Pathway
- RIOEducation PE Pathway Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Appointment Type
RIO Education v3.10 - Validation Rule
This step activates the Max_Credits_Per_Term validation rule on the PE Pathway object.
RIO Education v3.10 - Org-Wide Default Sharing
This step updates sharing for the Term Grade object.
RIO Education v3.10 - Student Community Security Setup
This step deploys / updates the following metadata related to the Student Community. This step should only be selected if you are using separate Communities for students and faculty.
- Sharing sets
- REDU_Student
RIO Education v3.10 - Faculty Community Security Setup
This step deploys / updates the following metadata related to the Faculty Community. This step should only be selected if you are using separate Communities for students and faculty.
- Sharing rules
- Term Grade
- REDU-Faculty-ReadEdit
- Term Grade
RIO Education v3.10 - Combined Community Security Setup
This step deploys / updates the following metadata related to the Combined Community. This step should only be selected if you are using a combined Community for both students and faculty.
- Sharing rules
- Term Grade
- REDU-Faculty-ReadEdit
- Term Grade
- Sharing sets
- REDU_Student
RIO Education - Upgrade to v3.11
This plan is used for upgrading to RIO Education v3.11 and deploying any post-upgrade metadata.
RIO Education v3.11 - 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.
Install RIO Education 3.11
This step upgrades the RIO Education package to v3.11.
RIO Education v3.11 - Layouts
This step deploys / updates the following metadata:
- Layouts
- Course
- RIOEducation Course Layout
- Discipline Requirement
- RIOEducation Discipline Requirement (Course) Layout
- Funding Allocation
- RIOEducation Funding Allocation
- Grading Period Setting
- RIOEducation Grading Period Setting
- Payment
- RIOEducation Fee Payment Layout
- PE Discipline
- RIOEducation PE Discipline Layout
- PE Discipline Requirement
- RIOEducation PE Discipline Requirement (Course) Layout
- RIOEducation PE Discipline Requirement (Group) Layout
- Program Enrollment
- RIOEducation Program Enrollment Layout
- Program Plan
- RIOEducation Program Plan Layout
- Student Fee
- RIOEducation Student Fee Layout
- Term
- RIOEducation Term Layout
- Term Grade
- RIOEducation Term Grade Layout
- Transfer Credit
- RIOEducation Transfer Credit Layout
- Course
RIO Education v3.11 - Validation Rule
This step deactivates the Required_Default_Program_Pathway validation rule on PE Pathway as it is now obsolete.
RIO Education v3.11 - Picklist
This step adds the Waiver value to the Grade Result global value set and the Dropped value to the following picklist fields:
- Course Connection
- Enrollment Status
- Session Connection
- Status
RIO Education v3.11 - Student Community Security Setup
This step deploys / updates the following metadata related to the Student Community. This step should only be selected if you are using separate Communities for students and faculty.
- Sharing sets
- REDU_Student
RIO Education v3.11 - Faculty Community Security Setup
This step deploys / updates the following metadata related to the Faculty Community. This step should only be selected if you are using separate Communities for students and faculty.
- Sharing rules
- Application
- REDU_Faculty_Read
- Requirement
- REDU_Faculty_ReadEdit
- Requirement Set
- REDU_Faculty_ReadEdit
- Application
RIO Education v3.11 - Combined Community Security Setup
This step deploys / updates the following metadata related to the Combined Community. This step should only be selected if you are using a combined Community for both students and faculty.
- Sharing rules
- Application
- REDU_Faculty_Read
- Requirement
- REDU_Faculty_ReadEdit
- Requirement Set
- REDU_Faculty_ReadEdit
- Application
- Sharing sets
- REDU_Student
RIO Education v3.11 - REDU Custom Metadata
This step sets the Funding Disbursement Method field of all Funding Type Disbursement and Order custom metadata records to Fee Line. By default, some of these fields have been set to Disbursement in v3.11. This step is for customers who wish to continue using Fee Line for these records.
RIO Education - Upgrade to v3.12
This plan is used for upgrading to RIO Education v3.12 and deploying any post-upgrade metadata.
RIO Education v3.12 - 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.
Install RIO Education 3.12
This step upgrades the RIO Education package to v3.12.
RIO Education v3.12 - Layouts
This step updates the following layouts:
- Account
- RIOEducation Department Layout
- Removed grade setting related list
- RIOEducation Organization Layout
- Replaced Grade_Setting_Type__c with Grade_Setting_Scope__c on the grade setting related list
- RIOEducation Program Layout
- Removed grade setting related list
- RIOEducation Department Layout
- Agreement
- RIOEducation Agreement Layout
- Added new custom field "Use for Auto Credit Transfer"
- RIOEducation Agreement Layout
- Application
- RIOEducation Application Layout
- Added transfer credit related list
- RIOEducation Application Layout
- Course
- RIOEducation Course Layout
- Removed the Grading Academic Program field from layout
- RIOEducation Course Layout
- Course Offering
- RIOEducation Course Offering Layout
- Added new Grade Setting Type picklist field
- RIOEducation Course Offering Layout
- Grade Setting
- RIOEducation Grade Setting Layout
- Added new "Auto Suggest" field
- RIOEducation Grade Setting Layout
RIO Education v3.12 - Picklist
This step adds the following picklist values:
- Grade Setting Scope (Global Value Set)
- Pass/Fail
- Percentage/Letter
It also makes these new picklist values available to the Student record type of the Course Connection object.
RIO Education v3.12 - Community
This step adds the following short course related objects to the REDU_Student sharing set.
- Order
- Study Credit
- Study Registration
RIO Education - Upgrade to v3.14.1
This plan is used for upgrading to RIO Education v3.14.1 and deploying any post-upgrade metadata.
RIO Education v3.14.1 - 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.
Install RIO Education 3.14.1
This step upgrades the RIO Education package to v3.14.1.
RIO Education v3.14.1 - Field Tracking
This step updates the field history tracking for the following objects.
- RIO Order
- Track Field History enabled
- Field tracking enabled for the following fields
- Discount Amount
- Discount Code
- Status
- Total Paid Amount
- Field tracking disabled for the following fields
- Order Reference
- RIO Order Line
- Track Field History enabled
- Field tracking enabled for the following fields
- Amount
- Quantity
- Study Credit
- Study Offering
- Unit Price
- Field tracking disabled for the following fields
- Order Line #
- RIO Order
- Study Offering
- Track Field History enabled
- Field tracking enabled for the following fields
- Booked Places
- Listing Status
- Waitlisted Places
- Study Registration
- Track Field History enabled
- Field tracking enabled for the following fields
- Enrollment Date
- Status
- Waitlist Date
- Withdrawn Date
- Field tracking disabled for the following fields
- Study Registration #
RIO Education v3.14.1 - Picklist
This step makes the following changes to picklist values.
- Study Credit
- Status (Override) field label changed to Activation Status
- Current, Used and Expired replaced by Draft, Active and Inactive
- Status (Override) field label changed to Activation Status
- Study Registration
- Status
- Added Waitlisted and Withdrawn values
- Status
RIO Education v3.14.1 - Layout
This step updates the following layouts.
- Discipline Requirement
- RIOEducation Discipline Requirement (Group) Layout
- Fields added
- Parent
- Fields added
- RIOEducation Discipline Requirement (Group) Layout
- Grade Setting
- RIOEducation Grade Setting Layout
- Fields added
- Ignore Credits Earned
- Ignore for GPA calculation
- Fields added
- RIOEducation Grade Setting Layout
- PE Discipline Requirement
- RIOEducation PE Discipline Requirement (Group) Layout
- Fields added
- Parent
- Fields added
- RIOEducation PE Discipline Requirement (Group) Layout
- Study Offering
- RIOEducation Study Offering Layout
- Fields added
- Enable Waitlist
- Waitlisted Places
- Fields added
- RIOEducation Study Offering Layout
- Study Registration
- RIOEducation Registration Layout
- Fields set to required
- Contact
- Study Offering
- Sections added
- Date Info
- Fields
- Enrollment Date
- Waitlist Date
- Withdrawn Date
- Fields
- Date Info
- Fields set to required
- RIOEducation Registration Layout
RIO Education v3.14.1 - Faculty Profile Layout Assignment
This step performs the following profile layout assignments.
- REDU - Faculty profile
- Announcement
- RIOEducation Community Announcement Layout
- Announcement
RIO Education v3.14.1 - Platform Faculty Profile Layout Assignment
This step performs the following profile layout assignments.
- REDU - Platform Faculty profile
- Announcement
- RIOEducation Community Announcement Layout
- Announcement
RIO Education v3.14.1 - Student Profile Layout Assignment
This step performs the following profile layout assignments.
- REDU - Student profile
- Announcement
- RIOEducation Community Announcement Layout
- Study Registration
- RIOEducation Community Registration Layout
- Announcement