Classic View: System Administration > Ed-Fi
Search Terms: Ed-Fi
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 | When a new Calendar is created.
When a new Schedule Structure in an existing Calendar is created and saved. |
Put | When calendar data are changed or updated:
|
Delete | When a calendar and/or schedule structure is deleted.
|
Days report by school not calendar in Ed-Fi, so when working with multiple calendars / schedule structures it is possible a day could report even if it is not connected to the calendar in which you are working.
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. |
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.
|
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
ScheduleStructure | structureID |
Object Data Elements
This table describes data elements sent within the Calendars resource. Data Element Labels in bold are part of the Natural Key and are required data elements for information 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 | ||
calendarCode | 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. | Report the fields that are part of the Natural Key for the Schools resource. | M | |
SchoolYearTypeReference | A reference to the related School Year resource. | Report the End Year the calendar is associated. | M | |
calendarTypeDescriptor | Indicates the type of Calendar. | Report 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 Grade Level associated with the Calendar. | See Array logic below. | O | System Administration > Calendar > Calendar > Grade Levels gradelevel.name |
beginTime | The start of the school day. | Report the start of the school day from the calendar in Military time. | M | System Administration > Calendar > Periods > First Period Start |
endTime | The end of the school day. | Report the end of the school day from the calendar in Military time. | M | System Administration > Calendar > Periods > Last Period End |
Non-InstructionalMinutes | Time on the calendar not marked as Instructional. | Report the total minutes from recess and lunch. | M | System Administration > Calendar > Periods |
InstructionalTimeInMinutes Indicator | This element is hard-coded. | Report 'False'. | M | |
Total Waiver Days | This element is hard-coded. | Report 0. | M |