This entity represents a set of dates associated with an organization.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | A Calendars record is created for each Calendar/Schedule Structure combination.
|
| Post/Delete Put | A Post/Delete will occur when the natural key is changed. A Put will occur otherwise. When the following fields on Calendar are changed:
|
| Delete | If a calendar and/or schedule structure is deleted. |
| Delete/Post | Delete if a 2nd Schedule Structure is added after 1st Calendar is sent. |
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 | No data will send if the School or Calendar is marked as Exclude. |
| Delete | If the Calendar is marked as exclude after the Calendar or any dependent data is sent, the calendar and all dependent data will delete upon a resync even if the resource is toggled 'OFF'. |
| 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. |
| Resync | If a Calendar 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 Calendar 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 |
|---|---|
| Post/Delete | Natural Key change: If a 2nd schedule structure is added after data is sent, the first Calendar record will need to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID.
|
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Calendars only send for the school year to which they are aligned.
|
Resource Preferences
This table describes the Resource Preferences of this object.
| Data Element Label | Mapping Needed |
|---|---|
| calendarTypeDescriptor | calendar.type |
| gradeLevelDescriptor | Uses the overall 'Grade Levels' mapping |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
| campusObjectType | Object Key Data Source |
|---|---|
| ScheduleStructure | structureID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| calendar | Post/Put/Delete | The primary table used for sending data for this resource. |
| gradelevel | Put | Will update the Grade Levels field if a grade level is added/removed to the school and a mapping exists for that grade level. |
Error Log
| Error | Possible Causes/How to Fix |
|---|---|
| 403 Forbidden: {"message": "Access to the resource could not be authorized for the requested action 'http://ed-fi.org/odsapi/actions/create'."} | This is usually caused by a security set up error in the ODS. Contact the Ed-Fi Alliance for assistant on correct security setup in the ODS. |
| Error code return from Ed-Fi. 400: [message:Validation of 'Calendar' failed. CalendarTypeDescriptorId is required. ]. | The Type field is not selected on the Calendar that is being sent or the Type selected on the Calendar is not mapped to an Ed-Fi Code in Resource Preferences. |
Object Data Elements
This table describes data elements sent within the Calendars resource.
| Data Element Label | Business Requirement and Business Rules | M, C or O | Data Source GUI Path | Database Field |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | ||
| Calendar Code | The identifier for the Calendar.
| M | System Administration> Calendar> Calendar + System Administration> Calendar> Calendar> Schedule Structure | calendar.calendarID + schedulestructure.structureID |
| SchoolReference | A reference to the related School resource. Reports the fields that are part of the Natural Key for the Schools resource. | M | System Administration> Resources> School | |
| SchoolYearType Reference | A reference to the related School Year resource. Reports the End Year with which the calendar is associated. | M | ||
| calendarTypeDescriptor | Indicates the type of Calendar. Reports the Ed-Fi Code the Calendar Type is mapped to in Calendar Resource Preferences
| M | System Administration> Calendar> Calendar> Type | calendar.type |
| gradeLevels | Indicates the GradeLevel associated with the Calendar. This is optional, do not report. | O |
Type/Descriptor
