RIO Ed - My Program (Aura)

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.

Supported configuration

Hide Course and Session Enroll Button

Admin can enable these options (TRUE) to hide the 'Enroll' button for Courses and Sessions.

This will prevent students from being able to enroll to Courses and Sessions in the Student Community.

• Internal users can then enroll the students on their behalf, provided that the RIO Ed - My Pathway (Aura) component on the Program Enrollment lightning page in the internal console has these 2 attributes as FALSE.

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

(v3.10)

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

(v3.10)

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

(v3.10)

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

(v3.10)

If checked, the my Results table will allow users to click the 'View Details' button, which shows the Term Grade information and breakdown.

(See also: RIO Ed - Course Connection Grade Breakdown (Aura)‍ and RIO Ed - Term Grade Details (Aura)‍)

Use Custom Field Set For Result

Course Connection Result Field Set API Name

(v3.10)

These configurations allow user to customize the My Results table under My Program.

1. Configure the "MyProgram Result Table" Field Set in the Course Connection object with the desired fields.
   
   
   
   
   
   
2. 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

(v3.10.1)

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.

Show Credits

(v3.11)

When checked, this attribute adds an extra column to the Course table in the Enrollment Wizard called 'Credits', that displays the value of the Credits field from the related Plan Requirement.

This allows admin to control whether to display the Credit Hours.

Configurable PE Discipline Fields

(v3.11)

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:

1. PE Discipline Section Title Field Name.
2. PE Discipline Field Set API Name.
3. PE Discipline Field Column Number.
4. PE Discipline Requirement Group Section Title Field Name.
5. PE Discipline Requirement Group Field Set API Name.
6. PE Discipline Requirement Group Column Number.
7. PE Discipline Requirement Course Table Field Set API Name.

Hide Irrelevant Multi Groups Course

(v3.11)

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:

1. Completed = checked and Credits Earned more than zero.
2. Primary = checked.
3. Requirement = Mandatory.
4. Status = Enrolled and the total estimated credits earned based on the above is less than the group's Credits Required.

See also: Identifying which PE Discipline Requirement (Group) will a Course contribute to‍ 

Enable Edit for PEDR Course

(v3.11)

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

(v3.11)

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

(v3.11)

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

(v3.11.4)

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.

showPaymentButton

(v3.12)

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

(v3.12)

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

(v3.12)

ignoreSelfEnrollment - Allows internal user to enroll students to Sessions on their behalf, when the “Self Enrollment Disabled” at the Session level is checked.

ignorePeEligibility - Shows the enrollment button regardless of the PE's ‘Eligibility to Enroll’ checkbox and Course Offering status.

Hide Course Fee Amount

(v3.12)

User can control to show/hide the 'Course Fee Amount' field on the Course Info popup (on the enrollment wizard).

Course Info Field Set

(v3.12)

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

(v3.14)

A segment of fields for the enrollment wizard table are now configurable, based on a field set from the Plan Requirement and Course Offering objects.

• 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.

Custom Filters

(v3.14)

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:
  • Checkbox.
  • Picklist.
  • Date.
  • Datetime.
  • Time.
  • 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

(v3.14)

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.

View All Course Toggle Default

(v3.14.2)

The "View All Courses" toggle allows students to view all courses including those outside of the pathway, when using the enrollment wizard on the Student Portal.

If this attribute is set as true, this will set "View All Courses" as default, so that users would not need to manually toggle it when viewing the enrollment wizard. 

Developer section