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.
|
Put | When any field not part of the Natural Key is changed:
|
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:
|
Delete/Post | If Period Schedule Name or Period Name Changes. |
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.
|
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 | 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 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 | |
officialAttendancePeriod | Indicator of whether this class period is used for official daily attendance. Field is optional, does not report | O |