Indiana Ed-Fi Data v2.4/3.1 - Calendar Dates
Last Modified on 08/13/2024 9:01 am CDT
You are viewing a previous version of this article. Indiana is currently on Ed-Fi v3.6. See Indiana Ed-Fi Resources v3.6 for the most current information.
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. |
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. |
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.
|
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
Click here to expand...
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. (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.
- 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
Click here to expand...
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.
- System Administration > Ed-Fi > Ed-Fi Configuration > Resource Preferences > Calendar Dates > Edit
Code Value | Name Space |
---|
Canceled - Weather | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Christmas | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
COVID-19 Closure | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Delay/Early Dismissal - Other | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Delay/Early Dismissal - Weather | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Fall Break | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Good Friday | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Instructional Half Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Labor Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Martin Luther King Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Memorial Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Presidents Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Sat/Sun School | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Semester Break | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Spring Break | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Student Calendar | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Thanksgiving | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Tornado Drill | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Vacation - Other | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Veterans Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Waiver Day | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Canceled - Other | http://doe.in.gov/Descriptor/CalendarEventDescriptor.xml |
Student Specific Elementary | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Student Specific Non-Compulsory | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Student Specific Secondary | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Planned - Asynchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Planned - Synchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Unplanned - Asynchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Unplanned - Synchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Covid - Asynchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |
Virtual Covid - Synchronous | http://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml |