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

RIO Ed - Attendance - Session List (Aura)

rio_ed:sessionList

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.

  • RIO Certification
    RIO Certification Program RIO Academy RIO Challenge RIO Recipe Training
  • Releases
    Release Notes
  • Help & Support
    Install RIO Education RIO Insights RIO Recipe Support
  • About Us
    Who is RIO Education? Start Your RIO Journey Housekeeping
  • Experience RIO in action
+ More


RIO Ed - Attendance - Session List (Aura)


Component Name RIO Ed - Attendance - Session List (Aura)
API Name rio_ed:sessionList
Type Standalone
Recommended Pages Any page in digital experience


This component is used for marking students' attendances. It displays the Sessions that a faculty teaches (and thus will need to take the attendance), and allows the faculty to mark the students who are enrolled to said Session.





Supported configuration

The following are the options that you could configure:


Session list view

  1. Icon for Session.

  2. Use Mini Layout = View in mobile mode.

  3. Contact Id = Contact record id (default is current user contact).

  4. Past X Days.

  5. Next X Days.

  6. Session Name Field Expression = Session Name field Expr e.g. `Name` - `SessionRelationalFieldName1`.

  7. Session Description Field Expression List = Session Name field Expr e.g. `SessionRelationalFieldName1` - `SessionRelationalFieldName2`, `SessionField3`, `SESSION_LOCATION`, `SESSION_DURATION`. The support system variables are:
    • SESSION_LOCATION.
    • SESSION_DURATION.

  8. Session Datetime Format = Session Datetime format for "SESSION_DURATION" system variable.

  9. No. of Sessions Today Text.

  10. No. of Upcoming Sessions Text.

  11. No. of Sessions This Month Text.

  12. Current Sessions Text.

  13. Future Sessions Text.

  14. Past Sessions Text.

  15. Show Sessions According To Allocation = Show sessions according to faculty Session allocation. If uncheck, it will show sessions based on faculty  Session Connections.

  16. Session Sorting Order.



Show Sessions According to Allocation

This configuration, when checked, will categorize and list the Sessions according to current, future, and past (as seen in the image above).

  • Current Sessions - If the Session has attendances with:
    • Past and future dates.
    • Past and current dates.
    • Future and current dates.
    • Current dates.

  • Future Sessions - If the Session only has attendances with future date.

  • Past Sessions - If the Session only has attendances with past date.


Attendance view

  1. Attendance View Title.

  2. Session Connection Name Field Expression.

  3. Session Connection Description Field Expression List.

  4. Total Number of Students Text.

  5. Total Number of Present Students Text.

  6. Total Number of Absent Students Text.

  7. Total Number of Unmarked Students Text.

  8. Total Number of Late Students Text.

  9. Total Number of Excused Students Text.

  10. Add New Checkpoint Text.

  11. Student Session Connection Status.

  12. Student Tile Action.

  13. Student Info Component Name.

  14. Student Info Overlay Modal Header Text.

  15. Student Info Overlay Modal CSS Class.




Show no attendance warning

(v3.5)

Checkbox to enable the highlight of Sessions without attendance taken. 

If there are any past or current Sessions that do not have attendances taken, there will be a warning icon next to the "Attendance" button.

Note: The icon will be automatically removed, when at least one student's attendance is marked as "Attended", "Absent", "Late" or "Excused".


No attendance warning text

(v3.5)

Warning text for the warning icon's tooltip, i.e. "No attendance taken". 


No attendance warning icon

(v3.5)

Warning icon that appears on any past or current Sessions that do not have their attendances taken/marked. 


No attendance warning variant

(v3.5)

Warning variant e.g., info, warning and error. 


Profile Picture Source Object = Picklist (Account, Contact)

Admin can decide the object to retrieve the profile picture (where the profile picture is saved). For person account, please select Account.


Profile Picture File Description

Description of File of Contact to get profile picture from. Defaults to: Profile Picture. This will run a check against a list of Files uploaded under a single Contact/Account to identify which file to be used as the Profile Picture. If multiple Files with the same description are uploaded, it will determine which to use based on the latest LastModifiedDate.


Attendance Marking Info Additional Field Set Name

(Introduced in v3.9)

The property allows admin to define the API name for a field set from the Attendance object. You can use the default field set "rio_ed__AttendanceMarkingAdditionalFields" or create any custom field set.

When the field set is defined, the extra fields added in the field set will be displayed in the "Edit Attendance Info" popup.


Hide Attendance Marking Info System Field

(Introduced in v3.10)

The configuration "Hide Attendance Marking Info System Field" will hide default fields in the attendance note screen.

Additional fields will remain, if "Attendance Marking Info Additional Field Set Name" is populated. This allows users to customize the fields shown in the attendance note screen.



Default Student Sort Order

(v3.14.2)

Introduced student name sorting capabilities, when viewing the list of students for taking attendance in the Community.

Admin can set the default order in which students are listed.

  • Student Name A-Z
  • Student Name Z-A
  • Student Last Name A-Z
  • Student Last Name Z-A



Show Booking Fields

(v3.14.4)

Introduced two new attributes, so that Booking fields can be displayed for faculty to view (e.g. date and time of classes).

Create Booking field sets containing your preferred Booking fields, and add them to these attributes:

  • Session List Booking Field Set API Name
  • Attendance Register Booking Field Set API Name



Custom component to display profile images from external data source

(v3.14.4)

If you are storing students' profile images on an external data source, you can create a custom component to display them.

You will need to reference that custom component in the new attribute "Custom Picture Component Name" here.

See here for a generic guide.


Session quick search

(v3.18.1)

The quick search functionality allows you to filter sessions based on configurable search fields. The functionality is the same as the quick search functionality in the Student Scheduler.

You can set the field(s) to search by editing the "Session Quick Search Index" attribute. For example, to filter based on the name of the course the session is for, you can set the following value: 

course={rio_ed__Course_Offering__r.hed__Course__r.Name}

Sessions can now be filtered by course name by typing it into the quick search box.


Copy previous attendance

(v3.18.1)

For recurring sessions with large numbers of students attending, it would be time consuming to mark the attendance for each session one by one. Instead, you can use the Copy Previous Attendance button to copy the attendance from the session before, which can then be modified as necessary. You can enable this button by enabling the "Show Copy Attendance Button" attribute.


Clicking this button will automatically fill out the attendance with the same details from the previous session. It will copy attendances exactly, with the exception that students that were marked Late for the previous session will be marked Attended for this session. Please note that clicking this button will overwrite the current attendance values for the current session. The Copy Previous Attendance button will also not save the attendance values after copying. You will still need to click Save for the changes to persist. You can, of course, continue to make changes to the attendance values after copying the values from the previous session.


Developer section

Attribute Name API Name Description
Session Icon sessionIcon Icon for Session.
Use Session MINI layout useSessionMiniLayout Use MINI layout.
Contact Id to filter sessions, default: current User Contact contactId Specific contact Id to filter sessions, default: current User Contact.
Past X Days pastXDays Only show Sessions with Start date within Past X Days.
Next X Days nextXDays Only show Sessions with Start date within Next X Days.
Session DateTime Format sessionDateTimeFormat Next Session Date/Time format e.g. hh:mm a, dd-MM-yyyy.
Session Name Field Expression sessionNameFieldExpr Session Name Field Expr e.g. 'Name' - 'SessionRelationalFieldName1'.
Session Description Field Expression List sessionDescFieldExprList Session Name Field Expr e.g. 'SessionRelationalFieldName1' - 'SessionRelationalFieldName2', 'SessionField3', 'SESSION_LOCATION', 'SESSION_DURATION'.
No of Sessions Today Text noOfSessionsTodayText No of Sessions Today Text.
No of Upcoming Sessions Text noOfUpcomingSessionsText No of Upcoming Sessions Text.
No of Sessions This Month Text noOfSessionsThisMonthText No of Sessions This Month Text.
Current Sessions Text currentSessionsText Current Sessions Text.
Future Sessions Text futureSessionsText Future Sessions Text.
Past Sessions Text pastSessionsText Past Sessions Text.
Show Sessions According to Allocation showSessionAccordingToAllocation Show Sessions according to allocation.

The Sessions will be grouped based on the faculty  attendance:
  • Future - If the Session only has attendances with future date.
  • Past - If the Session only has attendances with past date.
  • Current - If the Session has attendances with:
    • Past and future dates.
    • Past and current dates.
    • Future and current dates.
    • Current dates.
Sessions Sorting Order sessionsSorting Sessions Sorting Order.
Hide Sessions Summary hideSummary Hide Sessions Summary.
Hide Attendance Register Summary hideAttendanceRegisterSummary Hide Attendance Register's Summary.
Session Attendance Text sessionAttendanceText Session Attendance Text.
Checkpoints text checkpointsText Checkpoints text.
Attendance Title attendanceTitle Attendance Title.
Session Connection Name Field Expression sessionConNameFieldExpr Session Connection Relational Field Expression.
`rio_ed__Contact_Name__c`
Session Connection Sub Text Field Expression List sessionConSubTextFieldExprList Session Connection Sub Text Field Expression List.
`rio_ed__Course_Connection__r.hed__Contact__r.hed__Gender__c`,`rio_ed__Course_Connection__r.hed__Contact__r.Email`,`rio_ed__Course_Connection__r.hed__Contact__r.MobilePhone`
Total Number of Students Text attReg_totalNumberofStudentsText Total Number of Students Text.
Total Number of Present Students Text attReg_totalNumberofPresentStudentsText Total Number of Students Present Text.
Total Number of Absent Students Text attReg_totalNumberofAbsentStudentsText Total Number of Students Absent Text.
Total Number of Late Students Text attReg_totalNumberofLateStudentsText Total Number of Students Late Text.
Total Number of Unmarked Students Text attReg_totalNumberofUnmarkedStudentsText Total Unmarked Attendance Text.
Total Number of Excused Students Text attReg_totalNumberofExcusedStudentsText Total Excused Students Text.
Show Add new Checkpoint Button attReg_showAddNewCheckPoint Show Add New Checkpoint Button
Add New Checkpoint Text attReg_addNewCheckpointText Add New Checkpoint Text.
Valid Session Connection Status attReg_validSessionConnectionStatus Session connection statuses to be considered. E.g. Current,Completed.
Student Tile Action attReg_studentTileAction Action when user click on the student tile.
overviewCmpName overviewCmpName Lightning Component name to call for when clicking a Student for more details e.g. rio_ed_sched:overviewComponent. Takes contactId and programEnrollmentId as parameters.
overviewHeader overviewHeader Header of overviewCmp popup modal.
overviewModalCssClass overviewModalCssClass Css class for the overviewCmp popup modal e.g. sIds-modal_large.
Group Students by Activity Code attReg_groupStudentsByActivityCode Group students by activity code when marking attendance in checkpoint.
Profile Picture Source Object  profilePicSourceObject  The object of where the profile picture is saved. For person account, please select Account. 
Profile Picture File Description  profilePicFileDesc  Description of File of Contact to get profile picture from. Defaults to: Profile Picture.
Show No Attendance Warning showNoAttendanceWarning  (v3.5)
If enabled, a warning icon will appear on any past or current Sessions that do not have attendances taken.
Note: The icon will be automatically removed, when at least one student's attendance is marked as "Attended", "Absent", "Late" or "Excused".
No Attendance Warning Text noAttendanceWarningText (v3.5)
Warning text for the warning icon's tooltip, i.e. "No attendance taken".
No Attendance Warning Icon noAttendanceWarningIcon (v3.5)
The warning icon that appears on any past or current Sessions that do not have their attendances taken/marked.
No Attendance Warning Variant noAttendanceWarningVariant (v3.5)
Warning variant for Sessions with no attendance marked, e.g., info, warning and error.
No Attendance Session Title Font Color sessionTitleFontColor (v3.19)
Session title font color in hex color format (e.g. #000000) when no attendance marked
Attendance Marking Info Additional Field Set Name  attReg_attendanceMarkingInfoFieldSetName  (v3.9)
The field set API name for listing additional attendance fields on edit info screen. 
Hide Attendance Marking Info System Field hideAttendanceSystemField (v3.10)
Hide attendance system fields from the attendance info edit screen.
Default Student Sort Order defaultStudentSortString (v3.14.2)
The default order in which student names are sorted.
  • Student Name A-Z
  • Student Name Z-A
  • Student Last Name A-Z
  • Student Last Name Z-A
Session List Booking Field Set API Name
sessionListBookingFieldSet
(v3.14.4)
Add a Booking field set containing your preferred Booking fields to be displayed. 
Attendance Register Booking Field Set API Name
attRegisterBookingFieldSet
(v3.14.4)
Add a Booking field set containing your preferred Booking fields to be displayed.
Custom Picture Component Name
customPictureComponentName
(v3.14.4)
Name of a custom component to use in place of the student profile picture.
Requires namespace (e.g. rio_ed:examplePictureCmp).
See here for generic details.
Student List Scrollbar
scrollStudentList
(v3.15)
Adds a scrollbar to the student list.
Session Filter Field Set API Name
sessionCustomFilterFieldset
(v3.15)
Input the API Name of the fieldset containing Session fields that you want to use for filtering.
Booking Filter Field Set API Name
bookingCustomFilterFieldset
(v3.15)
Input the API Name of the fieldset containing Booking fields that you want to use for filtering.
Hide Students Summary Total
hideStudentsSummary
(v3.17)
If enabled (TRUE), this will hide the "Students" total count at the top of the attendance wizard page. 
Hide Present Summary Total
hidePresentSummary
(v3.17)
If enabled (TRUE), this will hide the "Present" total count at the top of the attendance wizard page. 
Hide Absent Summary Total
hideAbsentSummary
(v3.17)
If enabled (TRUE), this will hide the "Absent" total count at the top of the attendance wizard page. 
Hide Unmarked Summary Total
hideUnmarkedSummary
(v3.17)
If enabled (TRUE), this will hide the "Unmarked" total count at the top of the attendance wizard page. 
Hide Late Summary Total
hideLateSummary
(v3.17)
If enabled (TRUE), this will hide the "Late" total count at the top of the attendance wizard page. 
Hide Excused Summary Total
hideExcusedSummary
(v3.17)
If enabled (TRUE), this will hide the "Excused" total count at the top of the attendance wizard page. 
Session Attendance Text
sessionAttendanceText
(v3.17)
Session Attendance text.
Checkpoints text
checkpointsText
(v3.17)
Checkpoints text
Hide All Present Button
hideAllPresentButton
(v3.17)
If enabled (TRUE), this will hide the "All Present" button. Faculty will not be able to mass mark all students as attended.
Hide Late Button
hideLateButton
(v3.17)
If enabled (TRUE), this will hide the "Late" button. Faculty will not be able to mark students as late.
Session Quick Search Index
sessionQuickSearchKeyFields
(v3.18.1)
Merge fields for session quick search e.g, course={rio_ed__Course__r.Name}.
Show Notes Inline
showNotesInline
(v3.18.1)
Shows the Notes field inline for each student.
Show Copy Attendance Button
showCopyAttendanceButton
(v3.18.1)
Show the Copy Previous Attendance button.
Copy Attendance Button Label
copyAttendanceButtonLabel
(v3.18.1)
Label for the Copy Previous Attendance button.
Group by Course groupByCourse (v3.19)
Group Session Bookings by Course.
Open Groups by Default openGroupsByDefault (v3.19)
Have all Course Group sections expanded by default.
Session Details Font Size strFontSize (v3.19)
Session details (the bullet point list underneath each Session name) font size in px

‍


attendance list

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Qualified Faculty
  • Faculty Administration Overview
  • Attendance (object)
RIO Education

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

CONTACT

Get in touch

  • Privacy
  • Terms of service

Knowledge Base Software powered by Helpjuice

Definition by Author

0
0
Expand