Tool Search: Ed-Fi
The Local Education Agency Calendar resources reports District Calendar information.
Object Triggering
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | A Calendars record will be created for each Calendar where:
|
| When a new Calendar is created and saved via the Calendar Wizard. | |
| Do not send a record if the Calendars resource is toggled 'OFF' in the Calendars Resource Preferences. | |
| Put | When fields that are not part of the natural key are changed:
|
| When the Instruction checkbox is modified the instructionalDays and calendarFundingPeriod need to be recalculated. | |
When the following day event types have been ADDED OR REMOVED from the calendar, instructionalDays must be re-calculated and the calendarFundingPeriod array must be recalculated
| |
| Delete/Post | If any fields part of the natural key are changed:
|
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 | Business Rule |
|---|---|
| Post | Should a calendar that previously excluded become reportable, all Calendar Dates tied to the calendar should also report. See the Calendar Date Resource. |
| Delete | Should a calendar that previously reported become excluded, all Calendar Dates tied to the formerly reported calendar should also be deleted. See the Calendar Dates Resource. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Calendar Dates 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 |
|---|---|
| calendarTypeDescriptor | calendar.type |
Object Data Elements
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 | Data Source GUI Path | Database Field |
|---|---|---|---|---|---|
| Calendar Code | The Instructional Program Number: Reports the number to uniquely identify the instructional program with the school. | If Instructional Program Number equals null or blank, populate “99”. Otherwise, populate Instructional Program Number | M | System Administration > Calendar > Calendar > Instructional Program Number | customCalendar.value |
| schoolReference | Reports the following:
| District Number + School Number | M | System Administration > Resources > District Information > State District Number System Administration > Resources > School > State School Number | District.number School.number |
SchoolYearType Reference | The School Year tied to the configured year. | Populate the End Year of the school year tied to the configured year. | M | System Administration > Ed-Fi > Ed-Fi Configuration > Connection > School Year System Administration > Calendar > School Years > End Year | SchoolYear.endYear |
| calendarType Descriptor | Indicates the type of Instructional Calendar. | Current Calendar Year is defined as the start year of the school year tied to the calendar. Identifies the calendar date of the first occurrence of Day Event Type "AS". If the date is scheduled BEFORE August 1st of the current calendar year, populate "Yearlong". Otherwise, populate "Traditional". | M | N/A | N/A |
| gradeLevels | Indicates the grade level associated with the Calendar | Optional, does not report. | O | N/A | N/A |
| _ext.tdoe.localEducation AgencyCalendar Reference | A reference to the related Local Education Agency Calendar (District Calendar) resource. | Reports the calendar Number. | M | System Administration > Calendar > Number | |
| _ext.tdoe.stockpile ProfessionalDevDays | The number of days a school has designated as stockpile professional days when the LocalEducationAgency calendar does not declare stockpiling. | For the calendar, sum the Day Event duration of all day events of type "SP". If the sum does not equal a number that can be divided evenly by 100, report blank. Otherwise, report the quotient. | M | System Administration > Calendar > Calendar > Days > Type | |
| _ext.tdoe.instructional Days | The number of days for classroom instruction. | Sum of the total amount of Days marked Instruction for a total. Identifies the days with the following day event types and updates the total by 1 if the day is NOT marked instruction:
| M | System Administration > Calendar > Calendar > Days > Instruction System Administration > Calendar > Calendar > Days > Type | |
| _ext.tdoe.student Day | The number of minutes in a standard full time day for a student, including lunch. | For the calendar, populate the value in Student Day. | M | System Administration > Calendar > Calendar > Student Day | Calendar.studentDay |
| _ext.tdoe.teacher Day | The number of minutes in a standard full time day for a teacher, including lunch. | For the calendar, populate the value in Teacher Day. | M | System Administration > Calendar > Calendar > Teacher Day | Calendar.teacherDay |
| _ext.tdoe.usesBlock ScheduleIndicator | Indicates if this school calendar is using block scheduling. | Populate "false". | M | ||
| _ext.tdoe.springBlock BeginDate | If this calendar uses block scheduling, the first date of the spring block. | Optional, does not report | O | ||
| _ext.tdoe.calendar FundingPeriod | The begin and end dates of each funding period associated with this calendar. | See array logic below. | M | System Administration > Calendar > Calendar > Days > Instruction | calculated |
| _ext.tdoe.submittedFor SchoolYearTypeReference .SchoolYear | Key for the School Year. | Using the End Date tied to the calendar, reports the year. | M | System Administration > Calendar > Calendar > End Date | schoolYear.endYear |
| _ext.tdoe.submittedBy EducationOrganization Reference.education OgranizationID | The identifier assigned to an education organization. | State District Number + State School Number | M | System Administration > Resources > School Sys admin > resources > district info | school.number |
Arrays
Type/Descriptor
