Tool Search: Ed-Fi
This entity represents a set of dates associated with an organization.
Object Triggering Logic
| Action | Trigger |
|---|---|
| Post | When a Day is created with the Instruction checkbox marked or a Day Event that is mapped to an Ed-Fi Code is added to a day. If more than one day event is found, reports from the most recent event only.
|
| Put | When fields that are not part of the natural key are changed.
|
| Delete | To delete this resource, all Day Events must be deleted and the Instructional checkbox needs to be unmarked. |
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 will remain in the ODS but no new data will send. |
| Delete | If a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data will remain in the ODS until a resync is done. |
| Resync | If a Calendar Event 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 Event 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
| 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.
|
| Delete | Cascading Deletes: This resource will delete if a calendar is marked as exclude after dependent data has been sent or a 2nd Schedule Structure is added after 1st Calendar is sent. |
Scope Year Logic
| Logic |
|---|
Calendar Dates only send for the school year to which they are aligned.
|
Resource Preferences
| Data Element Label | Mapping Needed |
|---|---|
| Calendar Event Descriptors | Day Detail / Event Type |
Identity Mapping Object Key
| campusObjectType | Object Key Data Source |
|---|---|
| Day | dayID |
Event Queue Detail
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| day / dayevent | Post/Put/Delete | The primary table used for sending data for this resource. |
Object Data Elements
This table describes data elements sent within the Calendar Dates resource. Required data elements are listed in bold.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Location |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | ||
| calendarReference | A reference to the related School resource. | Reports the fields that are part of the Natural Key for the Calendars resource. | M | |
| date | Month, day, and year of the date being reported. | Reports the Date being reported. | M | System Administration > Calendar > Calendar > Days > Date day.date |
| calendarEvents | The type of scheduled or unscheduled event for the day. | See Array section below for data logic for each field. | M | System Administration > Calendar > Calendar > Days > Day Detail > Day Events AND Instructional |
| CalendarWaiverEventType Descriptor | The type of state approved waiver. | Reports mapped Ed-Fi Code of day event. | O | |
| SchoolDayOperationalMinutes | The minutes that a campus operated on a particular school day for the purpose of student instruction. | If the calendar has an Instructional Program Type with mapped Ed-Fi Code = 01, 02, or 14 and day has a day event mapped to an Ed-Fi Code, report event Duration.
| O | System Administration > Calendar > Calendar > Days > Day Events > Duration OR System Administration > Calendar > Periods > Period Schedule /Periods Editor > Period Schedule Info > School Day (calculated field) |
| SchoolDayInstructionalMinutes | The portion of the school day during which instruction takes place along with certain other exceptions and are considered a subset of operational minutes. | If the calendar has an Instructional Program Type with mapped Ed-Fi Code = 04, 05, 06, 07, 08, 09, 10, 11, or 12, and day has a day event mapped to an Ed-Fi Code, report event Instructional Minutes.
| O | System Administration > Calendar > Calendar > Days > Day Events > Instructional Minutes OR System Administration > Calendar > Periods > Period Schedule / Periods Editor > Period Schedule Info > Instructional Minutes (calculated field) |
| SchoolDayWaiverMinutes | The waiver minutes for the campus and calendar date. | If day has a day event mapped to an Ed-Fi Code, report event Instructional Minutes
| O | System Administration > Calendar > Calendar > Days > Day Events > Instructional Minutes |
Array
