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
  • Support
  • Deep Dive
  • Technical Guides
  • RIO Ed Components

RIO Ed - My Program (Aura)

rio_ed:myProgram

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.

  • About Us
    Who is RIO Education? Experience RIO in action Customer go-live events Our Partners Housekeeping
  • RIO Insights
    Careers
  • RIO Recipe
    Project Management & Governance Discovery Design & Prototype Build & Implementation UAT Deployment & Metadata RIO Recipe: Training Certification Process
  • Install RIO Education
    Configuration Integration with RIO Extension Package Installer Products
  • Releases
    Release Notes
  • Support
    Support FAQs Feature Articles Deep Dive RIO Academy Updates for other products
+ More

RIO Ed - My Program (Aura)

Component Name RIO Ed - My Program (Aura)
API Name rio_ed:myProgram
Type Standalone
Recommended Pages Any page in digital experience
Supported In Salesforce Internal

 


This component is for configuring for the Student Community view. Some of these configurations here, are also on the RIO Ed - My Pathway (Aura)‍ component, which is for the admin console view.



Supported configuration


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

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



Developer section

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 Criteria courseGradeAdditionalCriteria (v3.10)
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.
Show Credits showCreditHours (v3.11)
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.




select/deselect disciplines

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • RIO Ed - Display Student Connections (Aura)
  • RIO Ed - Related List - Single (Aura)
  • RIO Ed - Sessions For Grading (Aura)
  • RIO Ed - Data Reminder (Aura)
RIO Education

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

CONTACT

E:  getinfo@wdcigroup.net

  • Privacy
  • Terms of service

Definition by Author

0
0
Expand