Michigan Ed-Fi Data v3.1 - Class Periods

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 will be sent for each Period Schedule/Period Name/Schedule Structure ID combination created. Do not send records if the Calendar Exclude check box is checked. Do not send a record if the School Exclude checkbox is checked.
Put	When any field not part of the Natural Key is changed: Period Start Period End
Delete	When a Period Schedule or Period Name is updated and saved.
Delete/Post	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	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 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 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
Delete/Post	If any of the following changes in the Schools resource: If the School Number/Ed-Fi School Number changes, a delete/post will occur with the cascading deletes from the School ID change triggers.
Delete/Post	If Period Schedule Name or Period Name Changes.
Dependent Resources	There is not a cascading delete option in Class Periods because all dependent data in Campus would need to be removed before a Class Period could be deleted from the Period Schedule. Section, Student Section Associations, Staff Section Associations, Grades, Student Section Attendance Events

Action

Trigger

Delete/Post

If any of the following changes in the Schools resource:

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

Delete/Post

If Period Schedule Name or Period Name Changes.

Dependent Resources

There is not a cascading delete option in Class Periods because all dependent data in Campus would need to be removed before a Class Period could be deleted from the Period Schedule.

Section, Student Section Associations, Staff Section Associations, Grades, Student Section Attendance Events

Scope Year Logic

This table describes scope year logic of this object.

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

Logic

Class Periods 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
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.

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.

Object Data Elements

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

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI	Database Field
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).	Report the Period Schedule Name + Period Name + Schedule Structure ID. Report a space between each value.	M	System Administration> Calendar> Calendar> Periods System Administration> Calendar> Calendar> Schedule Structure	periodschedule.name + period.name + schedulestructure.structureID
schoolReference	A reference to the related School resource.	Reports the fields that are part of the Natural Key for the Schools resource.	M	System Administration> Resources> School> State School Number	school.number
meetingTimes	The meeting time(s) for a class period.	Report if the Period being reported has both a start and end time populated. If blank or one is not populated, do not report. See Array section below for logic.	O
officialAttendance Period	Indicator of whether this class period is used for official daily attendance.	Field is optional, does not report.	O

Arrays

Click here to expand...

Meetings Times

Data Element Label	Business Requirement	Business Rules	M,C or O	Data Source GUI	Database Field
endTime	An indication of the time of day the meeting time ends.	1. Report the end time of the period being reported.	M	System Administration> Calendar> Calendar> Periods	period.endTime
startTime	An indication of the time of day the meeting time begins.	1. Report the start time of the period being reported.	M	System Administration> Calendar> Calendar> Periods	period.startTime