Tool Search: Ed-Fi
This entity represents the prescribed span of time when an education institution is open, instruction is provided and students are under the direction and guidance of teachers and/or education institution administration. A session may be interrupted by one or more vacations.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new Term is created and saved that is Mapped to a Term Type and a resync of Sessions is completed.
|
| Post | When a Term Descriptor Override is selected on a Course or Section and saved and the course is mapped to a Term Descriptor Override and a resync of Sessions is completed.
|
| Put | When the Grading Period data is changed or the Grading Period record is deleted. |
| Delete | If the Term is deleted or the mapping is removed the Session record and all dependent data will be removed |
** Start and End dates are not part of the natural Key so only 1 record per Term Type can be sent to Ed-Fi. Logic has been implemented to determine the priority of what start and end dates to use for a Term Type.
School Exclude, Calendar Exclude, Resource Toggle and Resync Logic
This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.
| Action | Trigger |
|---|---|
| None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send. |
| Delete | If a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data will remain in the ODS until a resync is done. |
| Resync | If a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table. |
| Resync | If a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it will be deleted from the ODS. |
| Resync | If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes. |
Natural Key Changes, Cascading Updates, and Deletes Logic
This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.
| Action | Trigger |
|---|---|
| Delete/Post | Natural Key change:
|
| Delete/Post | If the Session Name changes. |
| Delete/Post | If the natural key changes all dependent resources will delete/post.
|
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports Sessions for the scope year the to which the calendar is aligned. |
| Data will only send for the years that have valid configuration. |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
*If there are multiple terms, overridden courses, or overridden sections in a school with the same term descriptor, there will be an identity mapping record for each Campus record and they will have the same edFiIdentityID.
| Where Posting From | campusObjectType | Object Key Data Source |
|---|---|---|
| Course override | Course | courseID |
| Section override | Course | courseID-sectionID |
| Term | Term | termID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| Term | Post/Put/Delete | The primary table used for sending data for this resource. |
| Course | Post/Put/Delete | The primary table used for sending data for this resource. |
| Section | Post/Put/Delete | The primary table used for sending data for this resource. |
| sectionPlacement | Put | Start/End Date |
Error Log
This table describes the Error logic of this object.
| Error | Possible Causes/How to Fix |
|---|---|
| Error code return from Ed-Fi. 400: [message:Validation of 'Session' failed. BeginDate is required. BeginDate : '1/1/0001 12:00:00 AM' must be within SQL datetime range ('1/1/1753 12:00:00 AM' to '12/31/9999 11:59:59 PM') EndDate is required. EndDate : '1/1/0001 12:00:00 AM' must be within SQL datetime range ('1/1/1753 12:00:00 AM' to '12/31/9999 11:59:59 PM') ]. | Term start or end dates are missing |
Object Data Elements
This table describes data elements sent within the Sessions resource.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | |||
| SessionName | The identifier for the calendar for the academic session. | Reports the Term Descriptor of the Term(s) being reported. | M | System Administration> Ed-Fi> Configuration> Resources Preferences> Sessions> Ed-Fi Code | edfimapping.edFiValue |
| schoolReference | A reference to the related School resourc.e | Reports the fields that are part of the Natural Key for the School resource. | M | ||
| schoolYearTypeReference | A reference to the related SchoolYearType resource. | Reports the end year from the calendar the term is reported.
| M | ||
| academicWeeks | An unordered collection of sessionAcademicWeeks. | This is optional, do not report. | O | ||
| beginDate | Term start date | Report the start date of the term being reported:
| M | System Administration> Calendar> Calendar> Terms> Start Date | term.startDate |
| endDate | Term end date | Report the end date of the term being reported:
| M | System Administration> Calendar> Calendar> Terms> End Date | term.endDate |
| gradingPeriods | An unordered collection of sessionGradingPeriods | See the Grading Periods in the Array section below for logic. | O | ||
| termDescriptor | This descriptor defines the term of a session during the school year (e.g., Fall Semester). |
| M | System Administration> Ed-Fi> Configuration> Resources Preferences> Sessions> Ed-Fi Code | edfimapping.edFiValue |
| totalInstructionalDays | Total Days in Session | When reporting from Term Schedule, count the total number of instructional days from the Days tab from the calendar and schedule structure the term is associated with:
| M | Calculated |
