Tool Search: 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 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. Days can be set either manually or by the Day Reset tool. Day Events can be set either manually or by the Multi Day Event Wizard. A record is not sent when the Calendar Exclude checkbox is marked. A record is not sent when the School Exclude checkbox is marked. A record is not sent when the Calendar is mapped via the Ed-Fi Calendar Override Mapping tool to a different calendar. Only one Calendar Event Descriptor reports per day.
Put	When any field that is not part of the natural key changes. For Calendar Events, when a date previously had a record in the array due to the Instructional checkbox being marked, and a subsequent Day Event that is mapped to an Ed-Fi Code is added to a day, the original 'Instructional day' record is removed from the day, leaving only the Day Event(s) records. For Calendar Events, when a Saturday or Sunday previously had a record in the array due to a Day Event, and all Day Events are removed, Weekend Day reports for the calendarEventDescriptor. For Calendar Events, a Put is completed when there is more than one event on a day and one of those events is updated.
Delete	To delete this resource, all Day Events must be deleted and the Instructional checkbox needs to be unchecked. When the calendar that a Calendar Dates record is tied to has been subsequently mapped to a different calendar via the EdFi Calendar Override Mapping tool, the delete of the record(s) occurs on resync.

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.

Days can be set either manually or by the Day Reset tool.
Day Events can be set either manually or by the Multi Day Event Wizard.
A record is not sent when the Calendar Exclude checkbox is marked.
A record is not sent when the School Exclude checkbox is marked.
A record is not sent when the Calendar is mapped via the Ed-Fi Calendar Override Mapping tool to a different calendar.
Only one Calendar Event Descriptor reports per day.

Put

When any field that is not part of the natural key changes.

For Calendar Events, when a date previously had a record in the array due to the Instructional checkbox being marked, and a subsequent Day Event that is mapped to an Ed-Fi Code is added to a day, the original 'Instructional day' record is removed from the day, leaving only the Day Event(s) records.
For Calendar Events, when a Saturday or Sunday previously had a record in the array due to a Day Event, and all Day Events are removed, Weekend Day reports for the calendarEventDescriptor.
For Calendar Events, a Put is completed when there is more than one event on a day and one of those events is updated.

Delete

To delete this resource, all Day Events must be deleted and the Instructional checkbox needs to be unchecked.

When the calendar that a Calendar Dates record is tied to has been subsequently mapped to a different calendar via the EdFi Calendar Override Mapping tool, the delete of the record(s) occurs on resync.

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	When a resource is toggled to OFF after data has sent, all sent data remains in the ODS but no new data is sent.
Delete	When a resource is toggled to OFF after data has sent and an action is performed that would trigger a delete, that data remains in the ODS until a resync is done.
Resync	When a Calendar Event record is in the Ed-Fi Identity Mapping table and not in the ODS, it is deleted from the Ed-Fi Identity Mapping table.
Resync	When 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 is deleted from the ODS.
Resync	When a mapping is changed in Resource Preferences, a resync is needed 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: when a second schedule structure is added after data is sent, the first Calendar record needs to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID. When a calendar or schedule structure is moved via script, all data sent to the ODS remains and the Delete tool removes all sent data. When the Calendar Dates resource is toggled OFF and a natural key change is made to the Calendar, the Calendar Dates record is deleted.
Delete	Cascading Deletes: This resource deletes when a calendar is marked as exclude after dependent data has been sent or a second Schedule Structure is added after the first Calendar is sent.

Action

Trigger

Post/Delete

Natural Key change: when a second schedule structure is added after data is sent, the first Calendar record needs to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID.

When a calendar or schedule structure is moved via script, all data sent to the ODS remains and the Delete tool removes all sent data.
When the Calendar Dates resource is toggled OFF and a natural key change is made to the Calendar, the Calendar Dates record is deleted.

Delete

Cascading Deletes: This resource deletes when a calendar is marked as exclude after dependent data has been sent or a second Schedule Structure is added after the first Calendar is sent.

Scope Year Logic

This table describes scope year logic of this object.

Logic
Calendar Dates only send for the school year to which they are aligned. Data only sends for years that have valid configuration.

Logic

Calendar Dates only send for the school year to which they are aligned.

Data only sends for years that have valid configuration.

Resource Preferences

This table describes the Resource Preferences of this object.

Data Element Label	Mapping Needed
Calendar Event Descriptor	Day Detail/Event Type

Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectType	Object Key Data Source
Day	dayID

Event Queue Detail

This table describes the Event Queue Detail of this object.

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 Calendars resource.

Data Element Label	Description		Mandatory, Conditional or Optional	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	Calendar Information > Days > Date Day.date
calendarEvents	The type of scheduled or unscheduled event for the day. Reports the data from the Day or Day Event for the Date being reported.		O
calendarEvents	Calendar Event Descriptor	This descriptor holds the types of scheduled or unscheduled event for the day (e.g., Instructional day, Teacher-only day, Holiday, Make-up day, Weather day, Student late arrival/early dismissal day). Reports the Ed-Fi Code mapped to Instructional Day when the Instruction checkbox is marked on a day. Otherwise reports the Ed-Fi Code when from mapped Day Event. When Instruction is not marked and there is not a day event mapped to an Ed-Fi Code, a record is not reported.	M	Day Setup > Day Detail > Instruction Day.instruction Calendar Information > Day Event Dayevent.type

Type/Descriptor

This table describes the Ed-Fi Value mapped and reported for Calendar Event Descriptor:

Code Value	Name Space
Emergency day	uri://ed-fi.org/CalendarEventDescriptor
Holiday	uri://ed-fi.org/CalendarEventDescriptor
Instructional day	uri://ed-fi.org/CalendarEventDescriptor
Make-up day	uri://ed-fi.org/CalendarEventDescriptor
Other	uri://ed-fi.org/CalendarEventDescriptor
Student late arrival/early dismissal	uri://ed-fi.org/CalendarEventDescriptor
Weather day	uri://ed-fi.org/CalendarEventDescriptor
Teacher only day	uri://ed-fi.org/CalendarEventDescriptor
Strike	uri://ed-fi.org/CalendarEventDescriptor

Calendar Dates (Arizona v3.6)