RIO Education Object Definition
The following are the object labels and description used in RIO Education.
Object Label |
Object API Name |
Object Description |
Additional Notes |
Address |
hed__Address__c |
Stores address information. To support multiple and seasonal addresses. |
|
Affiliation |
hed__Affiliation__c |
Connection between a Contact and an Account. |
|
Application |
hed__Application__c |
Stores information about a student's application to an Educational Institution or Program. |
Not used in RIO. |
Attendance Event |
hed__Attendance_Event__c |
Stores information about a student's attendance. |
|
Attribute |
hed__Attribute__c |
A characteristic of or a credential held by the associated Contact. For example, an Attribute record with a Credential record type can indicate that a faculty member has a Multiple Subject Teaching Credential. |
|
Behavior Involvement |
hed__Behavior_Involvement__c |
Stores information about the people involved in a Case that represents a behavior event. |
Not used in RIO. |
Behavior Response |
hed__Behavior_Response__c |
Stores information about the response to a behavior event. |
Not used in RIO. |
Contact Language |
hed__Contact_Language__c |
Joins a Language and a Contact to store details about a Contact's language fluency. |
|
hed__Course__c |
Academic Course offered by a Department or School, for example, English 101 or Ancient History. |
||
hed__Course_Enrollment__c |
Represents a connection to a Course Offering. |
||
hed__Course_Offering__c |
Joins Courses and Terms to contain information related to a single occurrence of a Course. |
||
Course Offering Schedule |
hed__Course_Offering_Schedule__c |
Joins Course Offering to Time Block and provides a way to specify the days and location for a Course. |
Not used in RIO. |
Education History |
hed__Education_History__c |
Stores information about a Contact's education history and related data. |
Not used in RIO. |
Error |
hed__Error__c |
Contains errors generated from the EDA package during normal operations. |
|
hed__Facility__c |
A school property asset. For example, a classroom, lecture hall, or laboratory. |
||
Language |
hed__Language__c |
Stores language information. |
|
hed__Plan_Requirement__c |
The various course requirements for completing a Program Plan. |
||
hed__Program_Enrollment__c |
A student Contact's enrollment in an Academic Program offered by a Department or School (the degree-granting Account type for the Educational Institution). |
||
hed__Program_Plan__c |
Links Courses to an Academic Program to create a path for students to follow. An Academic Program can list multiple Courses, and a Course can be associated with multiple Academic Programs. |
||
Relationship |
hed__Relationship__c |
Connection between two Contacts. |
|
hed__Term__c |
Unit of time in which academic activities are taking place. |
||
Term Grade |
hed__Term_Grade__c |
Stores student grades for a specific grading period within a Term. |
|
Test |
hed__Test__c |
An instance of a student taking a test. |
Not used in RIO. |
Test Score |
hed__Test_Score__c |
The score on a section of a specific test or a composite score. |
Not used in RIO. |
hed__Time_Block__c |
Represents a block of time in which classes are held. |
||
Trigger Handler |
hed__Trigger_Handler__c |
Stores which classes to run in response to DML performed on an object. |
|
Activity |
rio_ed__Activity__c |
Only used for attendance checkpoints. |
Not needed for most use cases. |
Agreement |
rio_ed__Agreement__c |
Types of agreement between an educational institution and the partner or external educational institution. |
|
Agreement Course |
rio_ed__Agreement_Course__c |
||
Booking |
rio_ed__Allocation__c |
This is the Booking Object, labelled Booking in the data model and product. It is used to store the actual appointments and classes that will show up in the calendar. should not be manually edited unless for troubleshooting purposes generally. |
|
Allocation Resource Validation | rio_ed__Allocation_Resource_Validation__c |
Booking Resource validation is the label. It is used internally by RIO education to manage double bookings etc. |
|
Appointment Availability |
rio_ed__Appointment_Availability__c |
Used by RIO Education Appointment Scheduler to identify when a faculty member is available for each appointment type. |
|
Appointment Time |
rio_ed__Appointment_Time__c |
Used by RIO Education Appointment Scheduler to identify what time blocks are available for appointments. E.G Student counselling has 25 minute appointment slots, with 5 min break between. |
|
Appointment Type |
rio_ed__Appointment_Type__c |
Used by RIO Education Appointment Scheduler to identify the different appointment types. (Room bookings also) |
|
Assigned Location |
rio_ed__Assigned_Location__c |
A junction object used to link a faculty member to a location (Campus) where they may teach or take appointments. |
|
rio_ed__Attendance__c |
Used to store the student attendance at an learning event (class etc.). E.G if I have a 10 week term, and classes each week on Monday at 10am, one attendance record will get created per student, per week, when the attendance is marked. |
||
Attendance Checkpoint |
rio_ed__Attendance_Checkpoint__c |
If a Session requires attendance to me taken multiple times. E.G full day class has attendance at start, and after lunch, then an attendance checkpoint will be created to record the student attendance at that "checkpoint" time. |
Not needed for most use cases. |
Availability Time |
rio_ed__Availability_Time__c |
A junction object between Faculty (Contact) and Location Times, that specifies the Time(s) that a faculty member is available at each location. |
Used mostly for part time staff who are only available at a particular location certain hours of certain days. |
rio_ed__Break_Time__c |
Linked to a Session, and used to specify break times. This is used when calculating hours attended primarily. If a class runs from 10am - 4 PM with two breaks of 30 mins each, the total class time calculated is 5 hours. If a student leaves early, but after the break, the correct hours they have attended are recorded. |
Not needed for most use cases. |
|
Cohort Enrollment | rio_ed__Cohort_Enrollment__c |
Allows different cohorts of students to enroll at different times. |
|
Course Connection Requirement | rio_ed__Course_Connection_Requirement__c |
Similar to the Program Course Requirement object but linked to a specific Course Connection record, that is a specific student and a specific Course Offering. |
|
Data Reminder Solution | rio_ed__Data_Reminder_Solution__c |
Data Reminder is a neat pop up that in the student community to "remind" students that there is information that they need to fill in. There is a wizard to configure it, and this is the object that the configuration data is stored in. |
|
Discipline Requirement | rio_ed__Discipline_Requirement__c |
Used to define the requirements (link to courses) for a Program Discipline such as a Major in a Program. For example a course Bus 101 may be mandatory or and elective for a particular major. Record types of Group or Course. Group record type is used much the same way as the plan Line group record type to define the "credits" required to complete a group. |
|
Educational Qualification | rio_ed__Educational_Qualification__c |
A child to the rio_ed__Program_Application__c which enable the student to outline their previous and/or existing education as a proof that he/she is qualified for the program applied. |
|
Facility Availability | rio_ed__Facility_Availability__c |
This is used to "Block" a facility when it is unavailable. E.G a classroom is undergoing maintenance. |
|
Fee | rio_ed__Fee__c |
A container to store the school's fee structure (i.e. a tuition, ancillary, admission fee). Fees can be linked to courses, or programs, and have child fee records and Fee Schedules linked. |
|
Fee Line | rio_ed__Fee_Line__c |
The line items that make up the Student Fee record. (i.e. the specific tuition fee, application fee, admission fee, etc. which the student needs to pay) - NOTE the parent for this is the Student Fee record not the Fee record. |
|
Payment | rio_ed__Fee_Payment__c |
Payments that are made against Student Fees. Normally auto populated by Payments2Us or Chargent with Credit Card type payments, or by integrations from accounting systems for direct payments. |
|
Fee Schedule | rio_ed__Fee_Schedule__c |
Keep track of the different version of the rio_ed__Fee__c record. Whether if it is the current, its start and end date and whether it is an "Approved version". This then needs to have a fee schedule term link to identify which Terms this fee applies to. When an enrollment into a course or program is done, the fee is found in this record through the linked fee schedule term. |
|
Fee Schedule Term | rio_ed__Fee_Schedule_Term__c |
A container to indicate which term/semester the rio_ed__Fee__c.rio_ed__Fee_Schedule__c is available for. |
|
Funding | rio_ed__Funding__c |
This is the core object to hold Scholarships, Discounts etc. |
|
Funding Allocation | rio_ed__Funding_Allocation__c |
This is the allocation of a discount or scholarship to a student, and the Program Enrollment they are in that it relates to. |
|
Grade | rio_ed__Grade__c |
Keeps the grades associated to each of the aspects defined in the 'Grade Criteria' object. - The parent object is the Term Grade. |
|
Grade Criteria | rio_ed__Grade_Criteria__c |
Stores the different aspects against which faculty may assess student performance. The criteria can be weighted. E.G Assessments 60% exam 40%. |
|
Grade Settings | rio_ed__Grade_Setting__c |
Defines the grading system to be used at Educational Institution, University Department and also Academic Program level. This is used when we import grades from a LMS. E.G a final grade of 75 from Canvas relates to a Credit, and 5 grade points. |
|
Holiday | rio_ed__Holiday__c |
It is used to define the holiday for the Education Institution and it can be linked to a term (via Term Holiday object). |
|
Leave Request | rio_ed__Leave_Request__c |
Contains faculty requests for time time off work of any type (recreational, medical, personal, etc.) - Parent of this record is the Staff Leave record. |
Approval on these requests can be made mandatory or optional. |
Location Holiday | rio_ed__Location_Holiday__c |
Connects the records in the Holiday object with the Location record types in the Account object (Campus). Used to specify Location based holidays, e.g. California has Labor Day on 9th Jan but Texas does not. |
|
Location Time | rio_ed__Location_Time__c |
This is used to Identify the time(s) that a faculty member is available for appointments, or teaching in a specific location. E.G Fran works Mondays 10-1 in the Sydney Campus, and Tues 9-5 in the Melbourne Campus. |
|
Pathway Unit | rio_ed__Pathway_Unit__c |
For each record in Program Pathway, this object contains a list of Plan Requirements matched with the Terms in which students are recommended to undertake those. |
|
rio_ed__Payment__c |
Obsolete (do not use). |
||
rio_ed__Payment_Line__c |
Obsolete (do not use). |
||
rio_ed__PE_Course_Requirement_Status__c |
Obsolete (do not use). |
||
rio_ed__PE_Course_Status__c |
Obsolete (do not use). |
||
PE Discipline | rio_ed__PE_Discipline__c |
Similar to the Program Discipline object but linked to a specific Program Enrollment record, that is a specific student within the Program. |
If there are Courses that are required for the discipline, but not the Program as a whole, the validations will not run as they assume the Program is the required pieces. If this is the case, should use a different approach. |
PE Discipline Requirement | rio_ed__PE_Discipline_Requirement__c |
Similar to the Discipline Requirement object but linked to a specific Program Enrollment record, that is a specific student within the Program. |
|
PE Group | rio_ed__PE_Group_Status__c |
Program Enrollment (PE) Group object in the data model, used to track the progress and completion of a students enrollment through the Groups configured for the program they are enrolled into. |
|
PE Pathway | rio_ed__PE_Pathway_Status__c |
PE Pathway object is used to hold the students pathway. E.G first term of study is in Fall 2019. |
|
PE Pathway Unit | rio_ed__PE_Pathway_Unit__c |
Similar to the 'Pathway Unit' object but linked to a specific Program Enrollment record, that is a specific student within a Program. Each record in PE Pathway Unit is also related to a Term and a Course Connection. |
Pathway Units are only generated when a student has a "custom" pathway. This is the object we plan to integrate to the SAL (Student Advisor Link) pathway utility. |
PE Reporting |
rio_ed__PE_Reporting__c |
This is used primarily for Australian Govt reporting of dual qualifications. It holds some completion data for reporting on each of the programs that make up a dual qualification such as a double major. |
|
Plan | rio_ed__Plan__c |
A Plan record is used by RIO Education’s session booking functionality. It is basically a container to group Plan Lines (Sessions). |
When a new Course Offering is created, a Plan record will be created automatically and linked to it. Plan records are created automatically by RIO, so no manual setup is needed. |
Plan Resource Validation | rio_ed__Plan_Resource_Validation__c |
An abject used for the resource validation logic (double bookings etc.) should not be manually edited. |
|
Program Application | rio_ed__Program_Application__c |
The application record when a potential or existing student submitted their program of interest. |
|
rio_ed__Program_Course__c |
Obsolete (do not use). |
||
Program Course Requirement | rio_ed__Program_Course_Requirement__c |
For each Academic Program, specifies the requirements (pre-requisites, co-requisites, credit points, etc.) to meet in order to being able to enroll in the Course it is related to. |
|
Program Discipline | rio_ed__Program_Discipline__c |
Represents a Major/Minor within a program. |
|
Program Grade | rio_ed__Program_Grade__c |
Used to link Term Grades to a project - Not used in the current implementation and can be hidden. Could be used to group Term grades into a "year" but that is more of a K-12 use case than higher education. |
|
rio_ed__Program_Group__c |
Obsolete (do not use). |
||
Program Offering | rio_ed__Program_Offering__c |
Represents a specific student intake in an Academic Program. It is mainly used for the Application process. |
|
Program Pathway | rio_ed__Program_Pathway__c |
For each Academic Program, a container for the names of the different timing options that students are offered to complete their studies depending on their type of enrollment. |
|
Qualified Faculty | rio_ed__Qualified_Faculty__c |
Relates a Course with the different Faculty members qualified to teach it. It includes the role each Faculty is qualified to perform (lecturer, assistant, tutor, etc.). |
|
Resource | rio_ed__Resource__c |
Used by the RIO scheduler to identify resources - rooms specifically. A trigger should create one of these when a new Facility record is created. |
|
rio_ed__Resource_Location__c |
Obsolete (do not use). |
||
Resource Type | rio_ed__Resource_Type__c |
The type of Resource - Location is the main one used in RIO. |
|
Resource Validation | rio_ed__Resource_Validation__c |
Used in the double bookings checking. |
|
RIO Education Settings | rio_ed__RIO_Education_Settings__c |
This is the Custom settings container where lots of RIO Education configuration is done. Find it under custom settings not the object manager. |
|
rio_ed__RIO_Plan_Colour_Mapping__c |
(Obsolete)This is also a Custom settings container, but it is no longer used. |
||
Role | rio_ed__Role__c |
Contains the many functions a faculty member can perform in the delivery of a Course (lecturer, assistant, tutor, etc.). |
|
Session | rio_ed__Session__c |
A container for the names of all teaching-learning interactions that happen under a specific Course Offering. |
|
Session Connection | rio_ed__Session_Connection__c |
Relates faculty and students to Sessions. For Faculty, this relationship also involves Session Time. |
|
Session Group | rio_ed__Session_Group__c |
Identifies and groups students in a Session based on attributes from the Program Enrollment. | |
Session Time | rio_ed__Session_Time__c |
Contains the specific date/time on which Sessions are scheduled to be. |
|
Session Time Checkpoint | rio_ed__Session_Time_Checkpoint__c |
Used to setup the checkpoints for attendance on a Session. |
|
Staff Award | rio_ed__Staff_Award__c |
Contains the details about a staff Contract/Award . Leave entitlement, pay rates, minimum hours etc can all be stored there. |
|
Staff Leave | rio_ed__Staff_Leave__c |
A Staff leave record is created for each year to track a staff leave entitlements and requests. Child record is Leave Request. |
|
Student Fee | rio_ed__Student_Fee__c |
A header container that indicates a group of fees (tuition fees) which the student need to pay for a specific Program Enrollment. |
|
Term Holiday |
rio_ed__Term_Holiday__c |
Relates holidays set in the Holiday object with Terms. |
|
Time Log | rio_ed__Time_Log__c |
This time log is not used. Time is tracked on the attendance object instead. |
|
Timesheet | rio_ed__Timesheet__c |
Used for the Timesheet function for faculty. |
|
Timesheet Line | rio_ed__Timesheet_Line__c |
Used for the Timesheet function for faculty. |
|
Transfer Credit |
rio_ed__Transfer_Credit__c |
Used to transfer credits a Student has earned previously. |