RIO Ready V4: Student Ledger Setup
Table of Contents
Overview
To quickly setup the Student Ledger Functionality, please follow the following steps:
Note that the package includes only the Lightning Web Component and Apex classes. For full implementation, you will need to configure the Community Site by creating a page where this Lightning Web Component can be placed, allowing users with contact IDs to access the functionality. The component can also be placed on an internal Lightning record page.
Prerequisite
- 00 Generic Metadata for RIO Ready V4 is selected together with the Student Ledger component during installation, or has been installed beforehand. It contains shared metadata required by the RIO Ready V4 components.
Permission (Objects/Fields/Apex Classes/User permission)
Grant the necessary permissions to users. Ensure these are assigned to the relevant profiles or permission sets.
| User Type | Type of Permission | Component Name | Access Type |
| Student | Apex Class | redu_StudentLedgerSummary_LCTRL | Enable |
No permission set is included in the package, so the access above must be granted manually to the student users (and to any internal users viewing the ledger on a record page).
Digital Experience Page
Adding the Component to a Digital Experience Page
- Navigate to the builder of the Digital Experience.
- Go to the page where you'd like to place the Student Ledger. Ensure that the page is only visible to student users.
- In the components panel, drag and drop the "REDU - Student Ledger" component into the desired section of the page.
- The component has 5 configurable attributes that are required to ensure proper functionality. The attributes are as follows (the examples are the default values):
| Name | Description | Example |
| (1) Contact Fields API | Configurable contact field API names, separated by semicolons | reduivy__Student_ID__c;reduivy__Total_Outstanding_Amount__c;reduivy__Balance_Amount__c |
| (2) Transaction Line Item Fields API | Configurable Transaction Line Item field API names should be separated by semicolons. The component supports a maximum of two-level relationships, for example: reduivy__Transaction_Order__r.Name. | reduivy__Transaction_Order__r.reduivy__Transaction_Date__c;reduivy__Transaction_Order__r.Name;reduivy__Item_Name__c;reduivy__Debit__c;reduivy__Credit__c; |
| (3) Txn Line Item Column Header Label | List of field labels to display as column headers for transaction line items, separated by semicolons. Each label corresponds to the field in the same order as the Transaction Line Item Fields API are defined. | Transaction Date;Transaction Order Name;Item Name;Debit;Credit; |
| (4) Roll-Up Fields API Name | API names of number fields to display a summary row, separated by semicolons. Only enter number fields from the transaction line item object. | reduivy__Credit__c;reduivy__Debit__c |
| (5) Roll-Up Fields Label | List of field labels to display as label for roll up fields, separated by semicolons. Each label corresponds to the field in the same order as the Roll-Up Fields API Name are defined. | Total Credit;Total Debit |
Lightning Record Page (Optional)
The "REDU - Student Ledger" component can also be added to an internal Lightning record page using the Lightning App Builder. It uses the same 5 attributes described above, plus the following:
- Contact record page: the component uses the current Contact record directly. No additional configuration is needed.
- Other object record pages: set the contactFieldApiName attribute to the API name of the field on that object that references the Contact (for example, reduivy__Contact__c). The component reads the Contact from this field to display the ledger.