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 will be created for each Calendar/Grade/Schedule Structure combination.
|
| Put | When fields that are not part of the natural key 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 will 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 |
|---|---|
| Calendar Type Descriptor | Calendar Type |
| Kindergarten Schedule Descriptor | Grade Level Kindergarten Schedule |
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 | Business Rules | M, C or O | Location |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | ||
| Calendar Code | The identifier for the Calendar. |
Report a dash between concatenated values. Example: "calendarCode": "1027-1364-11" | M | alendar.calendarID + schedulestructure.structureID + gradelevel.name |
| School Reference | A reference to the related School resource. | Reports the fields that are part of the Natural Key for the Schools resource. | M | |
| SchoolYear Type Reference | A reference to the related School Year resource. | Reports the End Year the calendar is associated. | M | |
| calendarType Descriptor | Indicates the type of Calendar. | Reports the Ed-Fi Code the Calendar Type is mapped to in Calendar Resource Preferences.
| M | Scheduling & Courses > Calendar Setup > Calendar Information > Type calendar.type |
| gradeLevels | Indicates the Grade Level associated with the Calendar. |
| C | Scheduling & Courses > Calendar Setup > Grade Level Setup gradelevel.name |
| kindergarten Schedule Descriptor | Indicates the Kindergarten schedule. |
| O | Scheduling & Courses > Calendar Setup > Grade Level Setup > Kindergarten Schedule GradeLevel.kindergartenCode |
| instructional Days | The total number of Instructional days during the current school year. | Report the total number of days marked as Instructional in the associated calendar.
| O | Scheduling & Courses > Calendar Setup > Day Setup OR Scheduling & Courses > Calendar Setup > Grade Level Setup > Instructional Days Override |
| lengthOfDay | Indicates the length of day. |
| O | Scheduling & Courses > Calendar Setup > Calendar Information > Student Day (instructional minutes) OR Scheduling & Courses > Calendar Setup > Grade Level Setup > Standard Day Calendar.studentDay GradeLevel.standardDay |
Resource Preferences Continued
The Ed-Fi Configuration tool is used to establish Ed-Fi data resources.
The following describes how to set the resource preferences for the Calendars resource. If the Configure or Edit buttons do not display, then the resource does not need to be mapped and the toggle button can be used to turn the resource on or off.
Note: Records are not sent if the Calendar Grade Level "Exclude from State Reporting" checkbox is selected for the grade level that the student's enrollment is tied to:
- If one calendar is mapped to another calendar in the Calendars Override Mapping , and any grade levels are shared between the two calendars, the "mapped-to" calendar governs the "Exclude from State Reporting" status.
Select the appropriate Ed-Fi Code for the Calendar Types.
Calendar Types Attribute Dictionary System Settings > Custom Data and Links > Core Attribute Dictionary > Calendar > Type UI Location Scheduling & Courses > Calendar Setup > Calendar Information 
- Select the appropriate Ed-Fi Code for the Kindergarten Schedule Descriptors.
| Grade Level Kindergarten Schedule | |
|---|---|
| Attribute Dictionary | System Settings > Custom Data and Links > Core Attribute Dictionary > Grade Level > Kindergarten Schedule |
| UI Location | Scheduling & Courses > Calendar Setup > Calendar Information > Grade Level Setup > Kindergarten Schedule |
3. The Calendars Override Mapping tool allows districts to identify specific Calendar/Schedules that they want an Infinite Campus Calendar to report as. Selecting an override value in any of the droplists only sends an Ed-Fi Calendars record generated from the Infinite Campus calendar selected in the droplist. Any Student School Association records for students enrolled in the selected Infinite Campus calendar will be tied to that same Ed-Fi Calendars record. Only map a calendar to another calendar if they are both tied to the same school.
| Field | Description |
|---|---|
| School | Used to filter by school. |
| Calendars | Used to filter by calendar. |
| Schedule Structures | Used to filter by schedule structure. |
| Override to report as: | Indicates the Infinite Campus calendar that will be used as the override. |
| Fill | Inserts the Infinite Campus calendar selected in the Override to report as: field into all schools. |
4. Click Save.
