RIO Ed - Attendance - Session List (Aura)
rio_ed:sessionList
Table of Contents
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 |
| Supported In | Salesforce Internal |
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
- Icon for Session.
- Use Mini Layout = View in mobile mode.
- Contact Id = Contact record id (default is current user contact).
- Past X Days.
- Next X Days.
- Session Name Field Expression = Session Name field Expr e.g. `Name` - `SessionRelationalFieldName1`.
- 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.
- Session Datetime Format = Session Datetime format for "SESSION_DURATION" system variable.
- No. of Sessions Today Text.
- No. of Upcoming Sessions Text.
- No. of Sessions This Month Text.
- Current Sessions Text.
- Future Sessions Text.
- Past Sessions Text.
- Show Sessions According To Allocation = Show sessions according to faculty Session allocation. If uncheck, it will show sessions based on faculty Session Connections.
- 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
- Attendance View Title.
-
Session Connection Name Field Expression.
- Session Connection Description Field Expression List.
- Total Number of Students Text.
- Total Number of Present Students Text.
- Total Number of Absent Students Text.
- Total Number of Unmarked Students Text.
- Total Number of Late Students Text.
- Total Number of Excused Students Text.
- Add New Checkpoint Text.
- Student Session Connection Status.
- Student Tile Action.
- Student Info Component Name.
- Student Info Overlay Modal Header Text.
- 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.
.jpg)
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.
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:
|
| 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. |
| 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. |