Calendar Dates (Indiana v3.6)

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. When there is more than 1 calendar/schedule structure, any day that has a day event reports. All events report if the same day in multiple calendars has events that are not the same. Only 1 record reports if the same day in different calendar/schedule structures has the same event. 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 any field that is not part of the natural key but impacts reporting elements changes. When any of the following elements change on Day: dayID Date Duration End Time Instruction Instructional Minutes Lunch Minutes Period Minutes Period Schedule Start Time Type
Delete	When the Instruction check box is unchecked or a Day Event is deleted and saved. To delete this resource, all Day Events must be deleted and the Instructional check box needs to be unchecked. When removing a day event there must only be 1 day event reported to send a delete. If there is more than 1 it will update the day, not delete.

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.
When there is more than 1 calendar/schedule structure, any day that has a day event reports.
All events report if the same day in multiple calendars has events that are not the same.
Only 1 record reports if the same day in different calendar/schedule structures has the same event.
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 any field that is not part of the natural key but impacts reporting elements changes.

When any of the following elements change on Day:

dayID
Date
Duration
End Time
Instruction
Instructional Minutes
Lunch Minutes
Period Minutes
Period Schedule
Start Time
Type

Delete

When the Instruction check box is unchecked or a Day Event is deleted and saved.

To delete this resource, all Day Events must be deleted and the Instructional check box needs to be unchecked.
When removing a day event there must only be 1 day event reported to send a delete. If there is more than 1 it will update the day, not delete.

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.

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 Rules	M, C, or O	Location
id	The unique identifier of the resource.	M
calendarEvents	The type of scheduled or unscheduled event for the day. See arrays section below.	O
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
calendarReference	References the calendar Code from the Calendar resource, schoolID, and schoolYear in which the calendar day takes place. See reference section below.	M
eventDuration	Percent of time the event took. Note: Duration is entered as a percentage to match the ODS values (e.g. Value of 50 entered = .5 in ODS) If multiple day events are present, report the duration value of the day event with the lowest number of instructional minutes on the Day Event editor. Report as '1' if any of the following are true: Duration is blank for all events. An event is added and no duration is provided. No event is added to day detail. Examples If value = 50, send as .5 If value = 25, send as .25	M	System Administration > Calendar > Calendar > Day Event > Duration Calculated
eventMinutes	Number of instructional minutes for the event. Report the number of Instructional Minutes for the day. If no day events are present, report total instructional minutes for the period schedule assigned on that date. If one or more events are present, report value of the lowest number of Inst. Minutes on the Day Event editor. If one or more Events are present and there is no value in Instructional Minutes in the Day Event Editor for any event, report total instructional minutes for the period schedule assigned on that date.	M	System Administration > Calendar > Calendar > Student Day (Inst. Minutes) System Administration > Calendar > Calendar > Days > Day Event > Inst. Minutes Calculated
calendarEventDescriptor	The type of scheduled or unscheduled event for the day. Reports as Student Calendar (hard-coded) if the day has Instructional checked and there are no day events listed. For this logic to work, there MUST be a day event code of I: Instructional Day that is mapped to the Student Calendar Ed-Fi Code. If the I: Instructional Day code does not exist or is not mapped to the Student Calendar Ed-Fi Code, then this special reporting logic will not work. Reports the Ed-Fi Code mapped to the day events selected if the day has day events listed.	M	System Administration > Calendar > Calendar > Instructional + Day Events

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).	Report 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

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

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

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

System Administration > Calendar > Calendar > Day Event

day.instruction

dayevent.type

References

Reference Business Rule Example Location

calendarReference

calendarCode

Report School ID + Calendar ID separated by -'s.
- Example: 1234-56

schoolID

Report the school as: 10+District#+School#
- Example: 1010009999

schoolYear

Report the End Year of School Year.
- Example: SY 22-23, report 2023

"calendarReference": {
      "calendarCode": "string",
      "schoolId": 0,
      "schoolYear": 0,
      "link": {
        "rel": "string",
        "href": "string"

calendarCode:

Index > System Administration > Resources > School > School ID

Index > System Administration > Calendar > Calendar > Calendar ID

School.stateSchoolNumber
Calendar.calendarID

schoolID:

Index > System Administration > Resources > District Info > State District Number

+
Index > System Administration > Resources > School > State School Number

district.stateDistrictNumber
school.stateSchoolNumber

schoolYear:

Index > System Administration > Calendar > School Years > School Year Editor > End Year

SchoolYear.endYear

Type/Descriptor