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.
Do not send a record if the Calendar Exclude checkbox is checked.
Do not send a record if the School Exclude checkbox is checked.
Do not send a record if the Calendar is mapped via the Ed-Fi Calendar Override Mapping tool to a different calendar.
Put
When fields that are not part of the natural key are changed.
Calendar Events - A put will be completed if there is one or events on a day and at least one 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.
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.
Future Years data will be suppressed until the Active Year is changed:
This allows the Schedule Wizard to be used and reducing the number of records sent until the final schedule is completed.
A resync must be done after the Active Year is changed to send data.
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 Requirement
Business Rules
M, C or O
Location
id
The unique identifier of the resource.
M
SchoolReference
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.
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.
See Type/ Descriptor section below for information on new 2022-2023 codes and the process for mapping.
O
System Administration > Calendar > Calendar > Days > Day Events
eventMinutes
Number of minutes the event goes on for.
Reports the minutes of the instructional section of the day.
If Instructional Minutes is populated, report the number of minutes populated.
If Instructional Minutes is NOT populated, generate an error.
Note: Instructional Minutes are required for Day Events that shorten a day.
M
System Administration > Calendar > Calendar > Day > Event Type > Instructional Minutes
eventDuration
The percent of time the event goes for.
If this data field is populated, report the percentage of the value entered.
Example: If 100 is entered into the Duration field, report that as 1. If 50 is entered into the Duration field, report that as .5.
If Duration is NULL, report as 1.
M
System Administration > Calendar > Calendar > Day > Event Type > Duration
dayEvent.duration
Arrays
Calendar Event Descriptor
Data Element Label
Business Requirement
Business Rules
M, C or O
Location
CalendarEventDescriptor
This descriptor holds the types of scheduled or unscheduled event for the day.
Reports the Ed-Fi Code mapped to 'Instructional Day' if Instruction check box is checked on a day.
Otherwise, report the Ed-Fi Code from the 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
Type/Descriptor
Day Event Descriptors
Codes deprecated as of the 2022-2023 school year:
COVID-19 E-Learning
E-Learning
E-Learning in Lieu of Cancellation
E-Learning PD
New Codes for 2022-2023:
Virtual Planned - Asynchronous
Virtual Planned - Synchronous
Virtual Unplanned - Asynchronous
Virtual Unplanned - Synchronous
Virtual Covid - Asynchronous
Virtual Covid - Synchronous
Recommended Process to Update Codes
1. Add new codes to the Attribute / Dictionary
System Administration > Custom > Attribute/Dictionary > Day > Type
2. Uncheck the 'Active' checkbox for the deprecated E-Learning Codes noted above. This will keep them in the database, but will prevent them from displaying as an option for users.
3. Map new codes to the new codes in the Ed-Fi Configuration Mapping Tool.
