MN v3.3 - Class Periods

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.

ActionTrigger
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 checkbox is checked.
  • Do not send a record if the School Exclude checkbox is checked.

  • Do not send a record if there is not a reportable classPeriodTypeDescriptor value based on the logic in the Object Data Elements.

  • Do not send a record if the Period Start Time or End Time are blank.

Put

When any field not part of the Natural Key is changed:

  • Period Start
  • Period End
Delete/PostWhen a Period Schedule or Period Name is updated and saved.
DeleteWhen a Period Schedule or Period is deleted.
  • When a Period's Start Time or End Time are updated to NULL (saves as '1900-01-01 08:00:00' in the db).

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.

ActionTrigger
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
DeleteIf 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.
ResyncIf 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.
ResyncIf 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.
ResyncIf 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.

ActionTrigger
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/PostIf 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.


Identity Mapping Object Key

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

campusObjectTypeObject Key Data Source
PeriodperiodID


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
periodschedulePost/Put/DeleteThe primary tables used for sending data for this resource.
periodPost/Put/DeleteThe 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.


Object Data Elements

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

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI 

Database Field

id  

The unique identifier of the resource.


M


classPeriodNameAn 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
  1. Report the Period Schedule Name + Period Name + Schedule Structure ID.
    • Report a space between each value.
M

Scheduling & Courses > Calendar Setup > Calendar Information > Period Setup


Scheduling & Courses > Calendar Setup > Calendar Information > Schedule Structure Setup

periodschedule.name + period.name + schedulestructure.
structureID
schoolReference A reference to the related School resource.
  1. Reports the fields that are part of the Natural Key for the Schools resource.


MSchool & District Settings > Schools > School Information > State School Number

school.number

meetingTimesThe meeting time(s) for a class period.
  1. Report if the Period being reported has both a start and end time populated.
    • If blank or one is not populated, do not report.
  2. See Array section below for logic.
O

officialAttendance PeriodIndicator of whether this class period is used for official daily attendance.

Field is optional, does not report.

O

classPeriodType
Descriptor
Class period type. E.g., Before School, During School, After School, Evening School
  1. Report 'DURING_SCHOOL_LUNCH' if the Lunch Time field > '0'.
  2. Report 'DURING_SCHOOL' if the Lunch Time field is = '0' or NULL, and the Non-Instructional checkbox is unchecked ('0' in the db).
  3. If neither of the above conditions are met, report the mapped descriptor value tied to the overlapping time period record on the Class Period Type Descriptor mapping tool.
    • If somehow multiple descriptor values are mapped to the same period record, report the one with the highest record ID value
  4. Otherwise, do not report.
C

Scheduling & Courses > Calendar Setup > Calendar Information > Period Setup > period schedule > period record > Lunch Time


Scheduling & Courses > Calendar Setup > Calendar Information > Period Setup >

period schedule > period record > Non-Instructional checkbox


Scheduling & Courses > Calendar Setup > Calendar Information > Period Setup > period schedule > period record > start time/end time

Period.lunchTime


Period.nonInstructional


Period.startTime


Period.endTime


classPeriod
Description
Class period description.

Field is optional, does not report.


OScheduling & Courses > Calendar Setup > Calendar Information > Period Setup > period schedule > period record > NamePeriod.name

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.

Report the end time of the period being reported.

M

Scheduling & Courses > Calendar Setup > Calendar Information > Period Setup
period.endTime
 
startTime

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

Report the start time of the period being reported.MScheduling & Courses > Calendar Setup > Calendar Information > Period Setup
period.startTime

Resource Preferences

The Ed-Fi Configuration tool is used to establish Ed-Fi data resources.

The following describes how to enable the Class Periods resource for Ed-Fi reporting:

  1. Select the appropriate time periods and class period type descriptors for each school. The Filter option at the top of the section can be used to filter by school, calendar, schedule structure, and/or period schedule. The various filter fields determine which information displays. The Fill options can be used to fill the time period and class period type descriptor value fields based on the schools/calendars/schedule structures/period schedules that have been scoped in the Filter area.
Filter
Description
School
Used to filter by school.
Calendars
Used to filter by calendar.
Schedule Structures
Used to filter by schedule structure.
Period Schedules
Used to filter by period schedule.
Reset Filters
Clears the filter fields. Displays once information has been entered in the filter fields.


Fill
Description
Start Time
The start time of the class period type.
End Time
The end time of the class period type.
Class Period Type Descriptor
The class period type. Options are AS: After School, BS: Before School, and ES: Evening School
Fill
The selected values will be populated for the schools/calendars/schedule structures/period schedules that have been scoped in the Filter area.
Clear
The values will be cleared for the schools/calendars/schedule structures/period schedules that have been scoped in the Filter area.


2. Click Save.