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
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.
If the same Term Type is selected on multiple Terms, group the Terms together so only 1 record will report per Term Type.
If there are multiple Calendars or Schedule structures in a School with the same Term Types, only 1 record can report to Ed-Fi. Report the earliest Term Start Date and latest Term End Date.
Do not send records if the Calendar Exclude check box is checked.
Do not send if the School is marked as Exclude.
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.
The Session will report the start and end dates based on the mapping of the course section.
If the same Term Type is selected in the Terms tab and the Term Type Override, a record will not send from the override field.
Do not send records if the Calendar Exclude check box is checked or Course is marked as Inactive or Exclude.
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
Action
Trigger
None
If a resource is toggled to 'OFF' after data has sent, all sent data remains in the ODS but no new data sends.
Delete
If a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data remains 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 is deleted from the ODS.
Resync
If a mapping is changed in Resource Preferences, a resync needs to be done to reflect the changes.
Natural Key Changes, Cascading Updates, and Deletes Logic
Action
Trigger
Delete/Post
Natural Key change:
If the School ID changes, all data will remain under the old number and a resync will need to be completed to populate data under the new number. The delete tool would need to be used to remove all data from the old School ID.
Delete/Post
If the Session Name is changed due to the Term Descriptor changing.
Delete/Post
If the natural key changes all dependent resources will delete/post:
Reports Sessions for the scope year to which the calendar is aligned.
Data will only send for the years that have valid configuration.
Resource Preferences
Data Element Label
Mapping Needed
Term Detail
Term Descriptors
Course / Section
Term Descriptor Overrides
Identity Mapping Object Key
Where Posting From
campusObjectType
Object Key Data Source
Course override
Course
courseID
Section override
Course
courseID-sectionID
Term
Term
termID
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'.
Event Queue Detail
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
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 Labels in bold are part of the Natural Key and are required data elements for Data to send to Ed-Fi.
Data Element Label
Business Requirement
Business Rules
M, C or O
Location
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.
When reporting from the Term Schedule, counts the total number of instructional days from the Days tab from the calendar and the schedule structure with which the term is associated.
A day reset must be completed before the days will calculate. Use the resync after day reset is completed to have instructional days calculated and sent.
If more than 1 term schedule has the same Term Type, count the distinct number of instructional days from all terms for that Term Type.
When Term Descriptor Override is populated, report from the Term Descriptor Override.
