Indiana Ed-Fi Data v2.4/3.1 - Calendars

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 new Calendar is created. Do not send a record if the Calendar Exclude checkbox is checked. Do not send a record if the School Exclude checkbox is checked. When a new Schedule Structure in an existing Calendar is created and saved.
Put	When calendar data are changed or updated: When the Start Date is changed. When the End Date is changed. When the Calendar Name is changed.
Delete	When a calendar and/or schedule structure is deleted. Delete if a 2nd Schedule Structure is added after 1st Calendar is sent.

Action

Trigger

Post

When a new Calendar is created.

Do not send a record if the Calendar Exclude checkbox is checked.
Do not send a record if the School Exclude checkbox is checked.

When a new Schedule Structure in an existing Calendar is created and saved.

Put

When calendar data are changed or updated:

When the Start Date is changed.
When the End Date is changed.
When the Calendar Name is changed.

Delete

When a calendar and/or schedule structure is deleted.

Delete if a 2nd Schedule Structure is added after 1st Calendar is sent.

Days report by school not calendar in Ed-Fi, so when working with multiple calendars / schedule structures it is possible a day could report even if it is not connected to the calendar in which you are working.

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	No data will send if the School or Calendar is marked as Exclude.
Delete	If the Calendar is marked as exclude after the Calendar or any dependent data is sent, the calendar and all dependent data will delete upon a resync even if the resource is toggled 'OFF'.
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.
Resync	If a Calendar 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 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.

Scope Year Logic

This table describes scope year logic of this object.

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

Logic

Calendars 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
ScheduleStructure	structureID

Object Data Elements

This table describes data elements sent within the Calendars resource. Data Element Labels in bold are part of the Natural Key and are required data elements for information to send to Ed-Fi.

Data Element Label	Business Requirement	Business Rules	M, C or O	Location
id	The unique identifier of the resource.		M
calendarCode	The identifier for the Calendar.	If there is only 1 schedule structure associated with the calendar, only report the Calendar ID. If there is more than one schedule structure associated with calendar, report the Calendar ID + Schedule Structure ID. Report the Calendar ID-Structure ID. Report a dash between the two numbers.	M	System Administration > Calendar > Calendar + System Administration > Calendar > Calendar > Schedule Structure calendar. calendarID + schedulestructure. structureID
SchoolReference	A reference to the related School resource.	Report the fields that are part of the Natural Key for the Schools resource.	M
SchoolYearTypeReference	A reference to the related School Year resource.	Report the End Year the calendar is associated.	M
calendarTypeDescriptor	Indicates the type of Calendar.	Report the Ed-Fi Code the Calendar Type is mapped to in Calendar Resource Preferences. If the Type is not selected on the Calendar or not mapped, an error will occur.	M	System Administration > Calendar > Calendar > Type calendar.type
gradeLevels	Indicates the Grade Level associated with the Calendar.	See Array logic below.	O	System Administration > Calendar > Calendar > Grade Levels gradelevel.name
beginTime	The start of the school day.	Report the start of the school day from the calendar in Military time.	M	System Administration > Calendar > Periods > First Period Start
endTime	The end of the school day.	Report the end of the school day from the calendar in Military time.	M	System Administration > Calendar > Periods > Last Period End
Non-InstructionalMinutes	Time on the calendar not marked as Instructional. *Indiana only wants Lunch and Recess time to report for this data element.	Calculate the total "Lunch Time" for each Period Schedule associated to the calendar. Report the lowest total "Lunch Time" as Non-Instructional Minutes	M	Calculated System Administration > Calendar > Periods > Lunch Time
InstructionalTimeInMinutes Indicator	This element is hard-coded.	Report 'False'.	M
Total Waiver Days	This element is hard-coded.	Report 0.	M

Arrays

Click here to expand...

Calendar Event Descriptor

Data Element Label	Business Requirement	Business Rules	M, C or O	Location
calendarDate EventDescriptor	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 'Instructional Day' if Instruction check box is checked on a day. Otherwise, report the Ed-Fi Code if from data dictionary of the Day Event that is selected and saved. 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 OR System Administration > Calendar > Calendar > Student Day day.duration OR calendar.studentDay

Data Element Label

Business Requirement

Business Rules

M, C or O

Location

calendarDate EventDescriptor

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 'Instructional Day' if Instruction check box is checked on a day.
Otherwise, report the Ed-Fi Code if from data dictionary of the Day Event that is selected and saved.
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

System Administration > Calendar > Calendar > Student Day

day.duration

calendar.studentDay

Type/Descriptor