1RIO 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.
Permission (Objects/Fields/Apex Classes/User permission)
| User Type | Type of Permission | Component Name | Access Type |
| Student | Apex Class | redu_StudentLedgerSummary_LCTRL | Enable |
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:
| 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.Name;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 Order Name;Transaction Line Item 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 |
Step 3: Assign Permissions
Students/Users using this component must have access to the Apex class redu_StudentLedgerSummary_LCTRL, which is already included in the 'REDU_RIO_Ready_Student' permission set when installing this component.