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 Pathway (Aura)

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

Table of Contents

RIO Ed - My Pathway (Aura) Supported configuration Show Add New PE Pathway Button Show All Sessions Show Additional PE Pathway Fields Additional PE Pathway Field Set Name Additional PE Pathway Field Column Number Hide View All Courses Toggle Hide View All Campuses Toggle Show Program Enrollment Related Campuses Only View Discipline Courses Toggle Default Show Grade Breakdown Details Show Credits Show Course Offering Campus Student Calendar configuration Enrollment Retry Max Attempt and Incremental Time Developer section

RIO Ed - My Pathway (Aura)

Component Name RIO Ed - My Pathway (Aura)
API Name rio_ed:termMap
Type Standalone
Recommended Pages Program Enrollment‍ object page in Digital Experience and Salesforce internal
Supported In Digital Experience and Salesforce Internal

 


As of v3.5, the RIO Ed - My Pathway (Aura) component is exposed for internal users. The component can be added to the Program Enrollment‍ object record page for both internal and digital experience. Internal users can use the component to view and enroll Courses / Sessions for each Term on behalf of student. 


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



Supported configuration

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


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)‍)


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.


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.


Student Calendar configuration

(v3.11)

The student calendar (my Sessions) is now available in Session enrollment (within the Enrollment Wizard) to allow user to view the Sessions that he/she has enrolled, in order to avoid overlapping enrollment. 

The following configurable attributes are add to allow admin to configure the student calendar:

  • Show my Sessions = show/hide the my Sessions button.
  • my Sessions Label = button label.
  • my Session Icon = button icon.
  • Calendar - Show Navigation Header = show/hide the calendar navigation header.
  • Calendar - Column Header Format = format of the calendar column header.
  • Calendar - First Day = the first day for the calendar e.g., 0 = Sunday, 1 = Monday.
  • Calendar - Hide Today Highlight = show/hide the today highlight.
  • Calendar - Min Time = the first hour of the calendar.
  • Calendar - Max Time = the last hour of the calendar.




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
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 my Majors showMyMajors Show the my Majors button.
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.
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.
Show All Sessions showAllSessions Show all sessions regardless of the published and self enrollment disabled flag.
Show Add New PE Pathway Button showAddPathwayButton Show add new PE Pathway button.
Show Back Button showBackButton Show back button.
Show Program Enrollment Related Campuses Only showPeRelatedCampusesOnly (v3.10)
Show campuses related to the Program Enrollment for selection only.
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.
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.
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.
Show Course Offering Campus showCourseOfferingCampus (v3.11)
Show/hide Course Offering campus.
Show my Sessions showMySessions (v3.11)
Show the my Sessions button in session enrollment wizard.
my Sessions Label mySessionBtnLabel  (v3.11)
my Sessions Label.
my Session Icon mySessionBtnIcon (v3.11)
my Session Icon.
Calendar - Show Navigation Header calendarShowHeader (v3.11)
Show the header buttons to navigate and change calendar format.
Calendar - Column Header Format calendarColumnHeaderFormat (v3.11)
Determines the text that will be displayed on the column headings. eg. ddd=Mon, ddd M/D=Mon 3/18, dddd=Monday.
Calendar - First Day calendarFirstDay (v3.11)
First day of week in calendar. Sunday=0, Monday=1.
Calendar - Hide Today Highlight calendarHideTodayHighlight (v3.11)
Hides the Today highlight.
Calendar - Min Time calendarMinTime (v3.11)
Calendar min time to show. Must be in 24 hour time in HH:mm:ss format eg. 07:00:00.
Calendar - Max Time calendarMaxTime (v3.11)
Calendar max time to show. Must be in 24 hour time in HH:mm:ss format eg. 23:00:00.
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.



Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • RIO Ed - Program Completion (Aura)
  • RIO Ed - Display Student Connections (Aura)
  • RIO Ed - My Majors (Aura)
  • RIO Ed - Session Calendar (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