RIO Ed - My Program (Aura)
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.
Table of Contents
RIO Ed - My Program (Aura)
|Component Name||RIO Ed - My Program (Aura)|
|Recommended Pages||My Program page in digital experience|
This component is exposed on the Student Community (on the 'My Programs' page).
It allows students to view the details of their Program.
As seen in the image above, the 'Bachelor of Business Information Systems' is currently being viewed. Below it is another 'Bachelor of Music Performance' (that can be expanded to display its details as well)
- Only the Program Enrollment records that have 'Current' or 'Completed' PE status will be displayed. In other words, the students can only see their current or completed Programs that they enrolled to.
This component allows students to use the enrollment wizard to enroll to Course Offerings and Sessions (when they click on the 'Pathway' button).
The 'Sessions' button will display a calendar / timetable of the student's class Sessions.
The 'Results' button will display their results for the Program being viewed.
The 'Major' button will display a page where students can select their Major of choice, and view their progress there.
Hide Course and Session Enroll Button
Admin can enable these options (checkboxes) to hide the 'Enroll' button for Courses and Sessions. This will prevent students from being able to enroll to Courses and Sessions in the My Majors page in the Student Community.
This can be found via Setup > Digital Experiences > All Sites > RIO Education Community > Builder > My Program.
Show Add New PE Pathway Button
Admin can enable this option to allow students/internal users to add a new PE Pathway tile. A new PE Pathway record will be created:
- My Term = the last term count + 1.
- Notes = Program Pathway's Notes.
- Number of Terms = Program Pathway's Number of Terms.
- Study Mode = Program Pathway's Study Mode.
- Program Pathway = Program Enrollment's Program Pathway.
- Recommended Credits = Program Pathway's Recommended Credits per Term.
- Max Credits = Program Pathway's Max Credits per Term.
- Automatically Enroll in Courses = checked if Program Pathway's enrollment method is "All Terms".
Show All Sessions
Admin can enable this option to allow students/internal users to view and enroll to Sessions regardless of the Published and "Self Enrollment Disabled" checkbox on Sessions.
Show Additional PE Pathway Fields
Additional PE Pathway Field Set Name
Additional PE Pathway Field Column Number
These (as of v3.6) are to allow admin to show more fields from PE Pathway on the Term tile and Course selection screen. The PE Pathway Field Set Name allows you to add descriptions such as the ones in the image below (Recommended Credits, Max Credits, etc.).
The Additional PE Pathway Field Column Number allows you to set the number of columns (3 columns in this image below).
The existing PE Pathway rollup trigger is also updated to rollup the following fields:
- Credits Enrolled.
- Completed Courses.
The Credits Enrolled will include all Course Connections with enrollment status Enrolled, Completed and Withdrawn Requested.
The Completed Courses will include all Course Connections with enrollment status Completed.
myMajors Allow Discipline Selection
Added in v3.6 to prevent students from selecting/deselecting disciplines. Admin to enable or disable the option to hide or show the "Select" button for the discipline selection.
Hide View All Courses Toggle
Hide View All Campuses Toggle
If checked, these will hide the ‘View All Courses’ and ‘View All Campuses’ button from students' view, to prevent them from selecting Courses that are not relevant to their pathway.
Show Program Enrollment Related Campuses Only
When this configuration is checked, clicking on 'View All Campuses' will now only show campuses from the educational institution that is related to the student's Program Enrollment. This is to prevent potential confusion from being able to select any campus from different educational institutions.
View Discipline Courses Toggle Default
Check this to make the 'View Discipline Courses' button available by default. This filters the Courses in the enrollment wizard to show all the Courses related to a Discipline, instead of just the Pathway.
Students can take multiple Disciplines (Majors/Minors) within the same Academic Program, with the ability to easily filter and choose the right Courses for the right Disciplines. This allows educational institutions to offer a flexible Program with multiple Major/Minor combinations.
Show Grade Breakdown Details
If checked, the my Results table will allow users to click the 'View Details' button, which shows the Term Grade information and breakdown.
Use Custom Field Set For Result
Course Connection Result Field Set API Name
These configurations allow user to customize the My Results table under My Program.
- Configure the "MyProgram Result Table" Field Set in the Course Connection object with the desired fields.
- Modify the RIO Ed - My Program (Aura) configuration in the Experience Builder by checking the "Use Custom Field Set For Result" checkbox, and ensuring the "Course Connection Result Field Set API" field has the same name for the Field Set configured in step #1.
Hide Non Credited Completed Courses
This allows admin to hide any of the completed PE Discipline Requirements with Credits Earned = 0 from the Course list.
If checked, the My Major 'Overview' page will only show Courses under the Discipline Requirements (Group) which are assigned with the credits from said Courses
If a Course is also in another Group, but the credits are not assigned to that Group, the Course details will not show up under that Group in the My Major 'Overview' page.
This allows admin to control whether to display the Credit Hours.
Configurable PE Discipline Fields
The following configurable options are added, to allow admin to configure and customize the fields in the 'Overview' page for PE Disciplines and PE Discipline Requirement Groups:
- PE Discipline Section Title Field Name.
- PE Discipline Field Set API Name.
- PE Discipline Field Column Number.
- PE Discipline Requirement Group Section Title Field Name.
- PE Discipline Requirement Group Field Set API Name.
- PE Discipline Requirement Group Column Number.
- PE Discipline Requirement Course Table Field Set API Name.
Hide Irrelevant Multi Groups Course
If a Course is listed in multiple groups, this will hide the display of the Course in all the groups, except the one group where the Course will be contributing to.
This will help to identify which group the Course will contribute to.
This is according to the priority below:
- Completed = checked and Credits Earned more than zero.
- Primary = checked.
- Requirement = Mandatory.
- Status = Enrolled and the total estimated credits earned based on the above is less than the group's Credits Required.
Enable Edit for PEDR Course
This to show the "Edit" dropdown menu item next to each PE Discipline Requirement (Course) record in the table to allow the user to edit the record instantly.
Note: The editable fields are the same as the fields visible on the PE Discipline Requirement (Course) table.
Show Course Offering Campus
Allows admin to show/hide the Campus column in the Course enrollment table of the Enrollment Wizard.
Course Offerings are linked to Campus record (that needs to be created). For example, if a Course Offering is conducted online, it might have a Campus named Online.
Admin can hide the Campus column in the Enrollment Wizard to prevent potential confusion for users, who might wonder why there is a Campus named online.
Course Connection and Session Connection Unenrolled Status
This allows admin to define whether a Course Connection and Session Connection will get 'Withdrawn' or 'Dropped' for their enrollment status, when students withdraw from them.
See also: Withdrawing or unenrolling from Courses.
Enrollment Retry Max Attempt and Incremental Time
If there are multiple students enrolling to the same Course Offering at the same time (high volume of requests), the admin can configure the enrollment wizard to automatically continue to retry and enroll them:
- Enrollment Retry Max Attempt - The number of retry for Course Enrollment.
- Enrollment Retry Incremental Time (Sec) - The time in seconds to be incremented for each retry. For example, if the incremental time is set to 5 secs, the retry timing for each attempt would be:
- Attempt 1 = 5 sec.
- Attempt 2 = 10 sec.
When the enrollment wizard encounters the possible error messages for retry, a warning message "This may take a little bit longer due to high volume of requests" will be prompted.
The wizard will retry the request until it reaches the maximum attempts configured. If the request failed, the error message "Unfortunately, there are too many requests at the moment. Please try again later." will be prompted.
Allows user to show/hide the 'Pay Now' shopping cart button on the 'My Payments' tab in Student Community, for institutes that do not require students to do payments via portal payment gateways.
The button is visible by default (true / checked).
Show Missed/Failed Courses
Allows students to re-enroll a Course in the next Term, if they failed the Course / missed enrollment.
When "All" is selected, the student will be able to view mandatory Courses from previous Terms in the Enrollment Wizard, under the following conditions:
- The student either failed or did not enroll to the Course in a previous Term.
- A valid Course Offering exists for the Course in the current Term the student is enrolling in.
- The Pathway Unit specifically lists the Plan Requirement (Course) for the missed Courses.
When "None" is selected, the behaviour of the Enrollment Wizard remains unchanged.
Ignore Self Enrollment and PE Eligibility
ignorePeEligibility - Shows the enrollment button regardless of the PE's ‘Eligibility to Enroll’ checkbox and Course Offering status.
Hide Course Fee Amount
User can control to show/hide the 'Course Fee Amount' field on the Course Info popup (on the enrollment wizard).
Course Info Field Set
The Course Description on the enrollment wizard can use a field set, to determine which fields appear in the Course info popup on the Enrollment Wizard, using field sets from the Course, Plan Requirement, and Course Offering objects.
Enrollment Table (Course Offering / Plan Requirement) Columns Fieldset
- Enrollment Table Plan Requirement Columns Fieldset:
- Default value = rio_ed__MyProgram_CourseEnrollmentTable (a new field set on the Plan Requirement object).
- E.g. the Credits field.
- Enrollment Table Course Offering Columns Fieldset:
- Default value = rio_ed__MyProgram_CourseEnrollmentTable (field set on the Course Offering object).
- E.g. the Campus and Start/End Date fields.
Note: The following existing attributes are now considered obsolete, since these fields are now a part of the rio_ed__MyProgram_CourseEnrollmentTable fieldset on the Course Offering / Plan Requirement.
- Show Course Offering Campus.
- Show Course Offering Start/End Date.
- Show Credits.
However, these can also be removed from the fieldset, if unwanted.
If the 'Custom Filter (1 and/or 2) - Show Filter' button is enabled, custom filters will be displayed on the enrollment wizard.
This allows further fine tuning of the search results for specific Course Offerings.
When students view the Courses available for enrollment, the field value for the Custom Filter 1 and Custom Filter 2 will be retrieved from the related Program Enrollment and will be matched against target fields on the Course Offering.
The admin will need to configure the 'Custom Filter (1 and/or 2) - Field Mapping' such as [Program Enrollment Field Api Name = Course Offering Field Api Name].
- The following field types are supported for the custom filter:
- Text (email, text formula, telephone, any text fields).
- Number (currency, number formula, percent, any decimal fields).
- Make sure that both the admin and student have read/edit permission for the fields used in the filter.
Completed Enrollment Statuses
Allows admin to define which types of Course Connection "Enrollment Status" will be displayed on the My Results table on the Student Community.
Previously, only 'Completed' Course Connections were displayed, but other Course Connections with different statuses can now be displayed.
Make sure to input the Enrollment Statuses in semi-colon separated values (e.g. Completed;Withdrawn).
- Will default to Completed if left blank.
|Attribute Name||API Name||Description|
|Show Program Status||showProgramStatus||Shows the Program Status field.|
|Program Status Label||programStatusLabel||Program Status Label.|
|Show Program Status Visual Indicator||showProgramStatusVisual||Shows the Program Status Visual Indicator.|
|Show Credits Earned||showCreditsEarned||Shows the Credits Earned field.|
|Credits Earned Label||creditsEarnedLabel||Credits Earned Label.|
|Show GPA||showGPA||Shows the GPA field.|
|GPA Label||GPALabel||GPA Label.|
|Show my Pathway||showMyProgramPathway||Shows the my Program Pathway button.|
|my Pathway Label||myProgramPathwayBtnLabel||My Program Pathway Label.|
|my Program Pathway Description||myProgramPathwayBtnDescription||My Program Pathway Description.|
|my Program Pathway Icon||myProgramPathwayBtnIcon||My Program Pathway Icon.|
|Show my Sessions||showMySessions||Shows the my Sessions button.|
|my Sessions Label||mySessionBtnLabel||My Sessions Label.|
|my Session Description||mySessionBtnDescription||My Session Description.|
|my Session Icon||mySessionBtnIcon||My Session Icon.|
|Show my Results||showMyResults||Shows the my Results button.|
|my Results Label||myResultBtnLabel||My Results Label.|
|my Result Description||myResultBtnDescription||My Result Description.|
|my Result Icon||myResultBtnIcon||My Result Icon.|
|Show my Majors||showMyMajors||Shows the my Majors button.|
|my Majors Label||myMajorsBtnLabel||My Majors Label.|
|my Majors Description||myMajorsBtnDescription||My Majors Description.|
|my Majors Icon||myMajorsBtnIcon||My Majors Icon.|
|Show my Payments||showMyPayments||Shows the my Payments button.|
|my Payments Label||myPaymentsBtnLabel||My Payments Label.|
|my Payments Description||myPaymentsBtnDescription||My Payments Description.|
|my Payments Icon||myPaymentsBtnIcon||My Payments Icon.|
|Term Icon||tileIcon||Tile icon for Term.|
|Size of Icon||tileIconSize||Size of Icon: xx-small, x-small, small, medium, or large.|
|Show Term Title||showTitle||Shows the Term title (the Pathway number).|
|Show Courses Tab||showCoursesTab||Shows the Courses Tab in my Pathway.|
|Show Sessions Tab||showSessionsTab||Shows the Sessions Tab in my Pathway.|
|Show Payment Tab||showPaymentTab||Shows the Payment Tab in my Pathway.|
|Show Fee Line Edit Button||showFeeLineEditButton||Shows edit button next to fee line.|
|Show Fee Line Gross Amount Field||showFeeLineGrossAmountField||Shows gross amount field for fee line.|
|Show Fee Line Funding Assistance Field||showFeeLineFundingAssistanceField||Shows funding assistance field for fee line.|
|Show Fee Line Discount Field||showFeeLineDiscountField||Shows discount field for fee line.|
|Show Fee Line Upfront Payment Amount Field||showFeeLineUpfrontPaymentAmountField||Shows upfront payment amount field for fee line.|
|Show Fee Line Payment Method Field||showFeeLinePaymentMethodField||Shows payment method field for fee line.|
|Show Fee Line Total Amount Field||showFeeLineTotalAmountField||Shows total amount field for fee line.|
|Session Select Requested Colour||requestedColour||Event colour for Enrollment Requested session connections (e.g. #FFFFFF).|
|Session Select Waitlisted Colour||waitlistedColour||Event colour for Waitlisted Session Connections (e.g. #FFFFFF).|
|Show courses enrolled in the selected term only||showCoursesEnrolledInTermOnly||Show Courses enrolled in the selected Term only.|
|Show courses available for enrollment in the selected term only||showCoursesAvailableForEnrollOnly||Show Courses available for enrollment in the selected Term only.|
|View all terms||viewAllTerms||View all terms including internal only Terms.|
|Show Course Offering Start/End Date||showCourseOfferingDates||Show Course Offering start and end dates.|
|Show Session Start/End Date||showSessionDates||Show Session start and end dates.|
|my Majors Optional Course Listing Mode||optionalCourseListing||Choose either to show all or enrolled and completed optional Courses when viewing my Majors.
Supported options are: All, Enrolled and Completed Only.
Datasource = All,Enrolled and Completed Only.
|Hide Course Enroll Buttons||hideCourseEnrollButtons||Can be used to hide all Course enroll and unenroll buttons in this component.|
|Hide Session Enroll Buttons||hideSessionEnrollButtons||Can be used to hide all Session enroll and unenroll buttons in this component.|
|Hide View All Courses Toggle||hideViewAllCoursesToggle||(v3.10)
Hide view all courses toggle.
|Hide View All Campuses Toggle||hideViewAllCampusesToggle||(v3.10)
Hide view all campuses toggle.
|Hide View Discipline Courses Toggle||hideViewDisciplineCoursesToggle||(v3.10)
Hide view discipline related courses only toggle.
|View Discipline Courses Toggle Default||viewDisciplineCoursesToggleDefault||(v3.10)
Default value for the view discipline related courses only toggle.
|Show Program Enrollment Related Campuses Only||showPeRelatedCampusesOnly||(v3.10)
Show campuses related to the Program Enrollment for selection only.
|Use Custom Program Enrollment Banner Fields||useCustomPeBannerField||(v3.10)
Use custom Program Enrollment banner fields.
|Program Enrollment Banner Field Set API Name||peBannerFieldSetName||(v3.10)
Program Enrollment field set API name.
|Program Enrollment Field Column Number||peBannerColumnNo||(v3.10)
Program Enrollment field display column number.
|Use Custom Field Set For Result||useCustomFieldSet||(v3.10)
Use custom field set for displaying result for completed courses.
|Course Connection Result Field Set API Name||customFieldSetName||(v3.10)
Course Connection field set API name for completed courses.
|Show Grade Breakdown Details||courseShowGradeBreakdownDetails||(v3.10)
Show the grade details from term grade and related child grades.
|Grade Breakdown Header||courseTermGradeDetailsHeader||(v3.10)
Grade breakdown header.
|Term Grade Section Title Field Name||courseTermGradeSectionTitleFieldName||(v3.10)
The field API name for Term Grade section title.
|Term Grade Field Set API Name||courseTermGradeFieldSetName||(v3.10)
Term grade field set API name for grade breakdown details.
|Term Grade Field Column Number||courseTermGradeFieldColumnNo||(v3.10)
Term grade field display column number for grade breakdown details.
|Term Grade Form Density||courseTermGradeFormDensity||(v3.10)
Term grade form density for grade breakdown details.
|Term Grade Criteria||courseTermGradeAdditionalCriteria||(v3.10)
Term grade record additional criteria for grade breakdown details.
|Grade Field Set API Name||courseGradeFieldSetName||(v3.10)
Grade field set API name for grade breakdown details.
Grade record additional criteria for grade breakdown details.
|Show Parent Grade||courseShowParentGradeCriteria||(v3.10)
Show parent grade records for grade breakdown details.
|Hide Non Credited Completed Courses||hideNonCreditedCompletedCourses||(v3.10.1)
Hide all completed Courses that do not have credits earned.
If the credits of a completed Course are not assigned to a Group, it will not appear there in the My Major 'Overview' page.
Adds an extra column 'Credits' to the Course table in the Enrollment Wizard, that displays the value of the Credits field from the related Plan Requirement.
This allows admin to control whether to display the Credit Hours.
|PE Discipline Section Title Field Name||peDiscSectionTitleFieldName||(v3.11)
The field API name for PE Discipline section title.
|PE Discipline Field Set API Name||peDiscFieldSetName||(v3.11)
The PE Discipline info highlight field set API name.
Custom field set for displaying info under PE Discipline (i.e. Credits Required, Credits Earned).
|PE Discipline Field Column Number||peDiscFieldColumnNo||(v3.11)
The PE Discipline field display column number.
Defines the number of columns for the PE Discipline Field Set.
|PE Discipline Requirement Group Section Title Field Name||peDiscReqGroupSectionTitleFieldName||(v3.11)
The field API name for the PE Discipline Requirement Group section title.
|PE Discipline Requirement Group Field Set API Name||peDiscReqGroupFieldSetName||(v3.11)
The PE Discipline Requirement Group info highlight field set API name.
Custom field set for displaying info under PE Discipline Requirement Group (i.e. Sequence, Credits Required, Credits Earned).
|PE Discipline Requirement Group Column Number||peDiscReqGroupFieldColumnNo||(v3.11)
The PE Discipline Requirement Group field display column number.
Defines the number of columns for the PE Discipline Requirement Group Field Set.
|PE Discipline Requirement Course Table Field Set API Name||peDiscReqCourseFieldSetName||(v3.11)
The PE Discipline Requirement Course table field set API name.
Custom field set for displaying fields in the Course table under PE Discipline Requirement Group.
|my Majors - Hide Irrelevant Multi Groups Course||myMajorHideIrrelevantMultiGroupsCourse||(v3.11)
Allow users to hide or show Courses that are listed in multiple groups depending on the credits earned or primary checkbox.
See also: Identifying which PE Discipline Requirement (Group) will a Course contribute to
|my Majors - Enable Edit For PEDR Course||myMajorEnabledPedrCourseEdit||(v3.11)
Allow users to edit the PE Discipline Requirement course record.
|Show Course Offering Campus||showCourseOfferingCampus||(v3.11)
Show/hide Course Offering campus.
|Course Connection Unenrolled Status||ccUnenrolledStatus||(v3.11)
Status for unenrolled Course Connections.
Expected statuses: Withdrawn, Dropped.
Default is Withdrawn.
|Session Connection Unenrolled Status||scUnenrolledStatus||(v3.11)
Status for unenrolled Session Connections.
Expected statuses: Withdrawn, Dropped.
Default is Withdrawn.
|Allow Course Connection Unenrollment After Census Date||ccAllowUnenrollmentAfterCensusDate||(v3.11.1)
Allows students to unenroll from a Course after the census date has passed.
|Enrollment Retry Max Attempt||enrollAttemptMax||(v3.11.4)
The maximum retry attempt for Course enrollment via the enrollment wizard.
Default value = 3.
|Enrollment Retry Incremental Time (Sec)||enrollAttemptWaitingTime||(v3.11.4)
The incremental time for each retry attempt (in seconds) to enroll to a Course Offering via the enrollment wizard.
Default value = 5.
|Show Payment Button||showPaymentButton||(v3.12)
Show/hide the payment button.
Default value is true (checked).
|Payment Button Icon||paymentButtonIcon||The payment button icon.
Default is utility:cart (required).
|Student Fee Button Icon||studentFeeButtonIcon||The student fee info button icon.
Default is utilify:info (required).
|Show Missed/Failed Courses||showMissedFailedCourses||(v3.12)
|Ignore PE Eligibility||ignorePeEligibility||(v3.12)
Show the enrollment button regardless of the PE's Eligibility to Enroll checkbox.
Default = "false".
|Ignore Self Enrollment||ignoreSelfEnrollment||(v3.12)
Show the Sessions regardless of the Session's 'Self Enrollment Disable' checkbox.
Default = "false".
|Hide Course Fee Amount||hideCourseFeeAmount||(v3.12)
Hides the Course Fee Amount field in Course Info (on the enrollment wizard).
|Course Info Field Set||courseInfoFieldset||(v3.12)
Course field set for Course Info.
|Plan Requirement Info Field Set||planReqInfoFieldset||(v3.12)
Plan Requirement field set for Course Info.
|Course Offering Info Field Set||courseOfferingInfoFieldset||(v3.12)
Course Offering field set for Course Info.
|Session Info Field Set||sessionInfoFieldSet||(v3.12)
Session fields to display.
Default = rio_ed__Timeline_CalendarInfoPopup
|Session Time Info Field Set||sessionTimeInfoFieldSet||(v3.12)
Session time fields to display.
Default = rio_ed__Timeline_CalendarInfoPopup
|Session Booking Info Field Set||sessionBookingInfoFieldSet||(v3.12)
Session booking fields to display.
Default = rio_ed__Timeline_CalendarInfoPopup_Session
|Appointment Booking Info Field Set||appointmentBookingInfoFieldSet||(v3.12)
Appointment booking fields to display.
Default = rio_ed__Timeline_CalendarInfoPopup_Appointment
|Enrollment Table Course Offering Columns Fieldset||coFieldSet||(v3.14)
Course Offering fields to display on the table.
Default = rio_ed__MyProgram_CourseEnrollmentTable (from the Course Offering object).
|Enrollment Table Plan Requirement Columns Fieldset||prFieldSet||(v3.14)
Plan Requirement fields to display on the table.
Default = rio_ed__MyProgram_CourseEnrollmentTable (from the Plan Requirement object).
|Custom Filter 1 - Active||customFilter1Active||(v3.14)
Make the custom filter active.
|Custom Filter 2 - Active||customFilter2Active|
|Custom Filter 1 - Label||customFilter1Label||(v3.14)
Label for the custom filter.
|Custom Filter 2 - Label||customFilter2Label|
|Custom Filter 1 - Field Mapping||customFilter1FieldMapping||(v3.14)
The custom filter mapping, e.g. rio_ed__PE_Field__c=hed__CO_Field__c.
Supported field types are: Number, currency, percent, picklist, text, checkbox, date, datetime, time.
|Custom Filter 2 - Field Mapping||customFilter1FieldMapping|
|Custom Filter 1 - Show Filter||customFilter1Show||(v3.14)
Show the filter on the enrollment wizard to allow user to update the filter.
|Custom Filter 2 - Show Filter||customFilter2Show|
|Completed Enrollment Statuses
Displays Course Connections with the defined Enrollment Statuses on the My Results table.
Input the statuses in semi-colon separated values, e.g, Completed;Withdrawn.
Will default to Completed if left blank.