Tool Search: Ed-Fi

This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

Action	Trigger
Post	When a Period Schedule is created and saved. A separate record is sent for each unique Period Name. Does not send a record when the Calendar Exclude checkbox is marked. Does not send a record when the School Exclude checkbox is marked.
Put	When any field is not part of the Natural Key is changed. Period Start Period End
Delete/Post	When a Period Schedule or Period Name is updated and saved. Cascading updates allows this change to PUT instead of Delete/Post.
Delete	When a Period Schedule or Period is deleted.

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	When a resource is toggled to 'OFF' after data has sent, all sent data remains in the ODS but no new data is sent.
Delete	When a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data remains in the ODS until a resync is done.
Resync	When a record is in the Ed-Fi Identity Mapping table and not in the ODS, it is deleted from the Ed-Fi Identity Mapping table.
Resync	When a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it is deleted from the ODS.
Resync	When a mapping is changed in Resource Preferences, a resync needs 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
Delete/Post	When any of the following changes in the Schools resource: When the School Number/Ed-Fi School Number changes, a delete/post occurs with the cascading deletes from the School ID change triggers.
Delete/Post	When the Period Schedule Name or Period Name Changes, all resources that reference Class Periods is updated.
Reference Resources	Section Student Section Associations Staff Section Associations Grades Student Section Attendance Events Bell Schedules

Action

Trigger

Delete/Post

When any of the following changes in the Schools resource:

When the School Number/Ed-Fi School Number changes, a delete/post occurs with the cascading deletes from the School ID change triggers.

Delete/Post

When the Period Schedule Name or Period Name Changes, all resources that reference Class Periods is updated.

Reference Resources

Section

Student Section Associations

Staff Section Associations

Grades

Student Section Attendance Events

Bell Schedules

Scope Year Logic

This table describes scope year logic of this object.

Logic
Class Periods only send for the school year to which they are aligned. Data only sends for years that have valid configuration.

Logic

Class Periods only send for the school year to which they are aligned.

Data only sends for years that have valid configuration.

Error Log

Error	Possible Causes/How to Fix
409: Failed to delete classPeriods resource. [message:The resource (or a subordinate entity of the resource) cannot be deleted because it is a dependency of the 'sectionClassPeriod' entity.]	There are dependent resources in the Ed-Fi ODS so the Class Period record cannot be deleted. Use the delete tool to remove any dependent data before the course can be removed.

Error

Possible Causes/How to Fix

409: Failed to delete classPeriods resource.

[message:The resource (or a subordinate entity of the resource) cannot be deleted because it is a dependency of the 'sectionClassPeriod' entity.]

There are dependent resources in the Ed-Fi ODS so the Class Period record cannot be deleted. Use the delete tool to remove any dependent data before the course can be removed.

Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectType	Object Key Data Source
Period	periodID

Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus Table	Ed-Fi Action	Fields
periodschedule	Post/Put/Delete	The primary tables used for sending data for this resource.
period	Post/Put/Delete	The primary tables used for sending data for this resource.

Object Data Elements

This table describes data elements sent within the Class Periods resource.

Data Element Label	Business Requirement and Rules	Mandatory, Conditional or Optional	Location
id	The unique identifier of the resource.	M
classPeriodName	An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules). NEDM: Class Period Reports the Period Schedule Name + Period Name + Schedule Structure ID. A space reports between each value.	M	Scheduling & Courses > Calendar > Period Setup > Name Period.name Scheduling & Courses > Calendar > Schedule Structure Setup > Structure ID
schoolReference	A reference to the related School resource. Reports the fields that are part of the Natural Key for the Schools resource.	M	School & District Settings > School Information > State School Number School.number
meetingTimes	The meeting time(s) for a class period. Reports whether the Period being reported has both a start and end time populated. When blank or one is not populated, does not report. See Array section below for logic.	O	Scheduling & Courses > Calendar > Period Setup > Instructional Period.instructional
officialAttendance Period	Indicator of whether this class period is used for official daily attendance. Reports True when Instructional on the Period is marked. Reports False when Instructional on the Period is not marked.	M

Arrays

Data Element	Business Requirement	Mandatory, Conditional or Optional	Location
startTime	An indication of the time of day the meeting time begins. Reports the start time of the period being reported.	M	Scheduling & Courses > Calendar Setup > Period Setup > Start Time Period.startTime

Data Element

Business Requirement

Mandatory, Conditional or Optional

Location

endTime

An indication of the time of day the meeting time ends.

Report the end time of the period being reported.

Scheduling & Courses > Calendar Setup > Period Setup > End Time

Period.endTime

startTime

An indication of the time of day the meeting time begins.

Reports the start time of the period being reported.

Scheduling & Courses > Calendar Setup > Period Setup > Start Time

Period.startTime

Class Periods (Vermont v3.6)