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.
|
| Delete/Post | When a Period Schedule or Period Name is updated and saved. |
| 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 | 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:
|
| 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.
|
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. |
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 | Business Rules | M, C or O | Data Source GUI | Database Field |
|---|---|---|---|---|---|
id | 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 Name. | M | Calendar Information > Periods | period.name |
| schoolReference | A reference to the related School resource. | Reports the fields that are part of the Natural Key for the Schools resource. | M | School Information > State School Number | school.number |
| meetingTimes | The meeting time(s) for a class period. | Note: Arizona does not use this field. Core logic was not overridden, therefore this field is populated as stated below:
| O | ||
| officialAttendance Period | Indicator of whether this class period is used for official daily attendance. | This field is optional and does not report. | O |
Arrays
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. | Report the end time of the period being reported. | M | Period Setup > End Time | period.endTime |
| startTime | An indication of the time of day the meeting time begins. | Report the start time of the period being reported. | M | Period Setup > Start Time | period.startTime |
