Calendar Dates (Core v3.X)

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 check box checked 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. Do not send a record if the Calendar Exclude checkbox is checked. Do not send a record if the School Exclude checkbox is checked.
Put	When fields that are not part of the natural key are changed. Calendar Events - a put will be completed if there is more than 1 event on a day and 1 is being updated.
Delete	To delete this resource, all Day Events must be deleted and the Instructional check box needs to be unchecked.

Action

Trigger

Post

When a Day is created with the Instruction check box checked 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.
Do not send a record if the Calendar Exclude checkbox is checked.
Do not send a record if the School Exclude checkbox is checked.

Put

When fields that are not part of the natural key are changed.

Calendar Events - a put will be completed if there is more than 1 event on a day and 1 is being updated.

Delete

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

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	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

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. If a calendar or schedule structure is moved via script, all data send to the ODS will remain and the Delete tool will need to be used to remove all data sent. If the Calendar Dates resource is toggled 'OFF" and a natural key change is made to the Calendar, the Calendar Dates record will be deleted.
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.

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.

If a calendar or schedule structure is moved via script, all data send to the ODS will remain and the Delete tool will need to be used to remove all data sent.
If the Calendar Dates resource is toggled 'OFF" and a natural key change is made to the Calendar, the Calendar Dates record will be deleted.

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

This table describes scope year logic of this object.

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

Logic

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

Data will only send for years that have valid configuration.

Resource Preferences

This table describes the Resource Preferences of this object.

Data Element Label	Mapping Needed
Calendar Event Descriptors	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	Business Reqiurements	Business Rules	M, C or O	Data Source GUI Path	Database Field
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.	Reports the data from the Day or Day Event for the Date being reported See Array section below for data logic for each field	M

Array Data Elements

Click here to expand...

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI Path	Database Field
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' if Instruction check box is checked on a day Else, reports the Ed-Fi Code if from mapped Day Event. If Instruction is not checked and there is not a day event mapped to an Ed-Fi Code, do not report a record.	M	System Administration> Calendar> Calendar> Days> Day Detail> Instruction OR System Administration> Calendar> Calendar> Day Event	day.instruction OR dayevent.type

Data Element Label

Business Requirement

Business Rules

M, C or O

Data Source GUI Path

Database Field

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' if Instruction check box is checked on a day
Else, reports the Ed-Fi Code if from mapped Day Event.
If Instruction is not checked and there is not a day event mapped to an Ed-Fi Code, do not report a record.

System Administration> Calendar> Calendar> Days> Day Detail> Instruction

System Administration> Calendar> Calendar> Day Event

day.instruction

dayevent.type

Type/Descriptor