Tool Search: Ed-Fi
This entity represents an offering of a course by school during a session, representing the course catalog of available courses.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When a section with Section Placement is created and saved.
|
Delete/Post | When the Course Number is changed. |
Delete/Post | When the Term Descriptor changes either via section placement or mapping override and a course offering already exists with non-matching Term Descriptors. |
Put | When Course information is changed and saved.
|
Delete | When a section is deleted. |
Delete | When a section schedule placement is removed and saved. |
Delete/Post | When there are two Sections with the same natural key and 1 is deleted, the other record posts with the remaining records data. |
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 sends. |
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 is needed 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 Course Number changes. When the Session Name changes to which the Course Offering is aligned. When the natural key changes all dependent resources are deleted/posted. |
Dependent Resources | Sections Staff Section Associations Student Section Associations |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
Course Offerings report to the configured year to which they are aligned. |
Data only sends for years that have valid configuration. |
Identity Mapping Object Key
campusObjectType | Object Key Data Source |
---|---|
Section | sectionID-termID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
course | Post/Put/Delete | The primary table used for sending data for this resource. |
sectionplacement | Post/Put/Delete | The primary table used for sending data for this resource. |
Object Data Elements
This table describes data elements sent within the Course Offerings resource. Data Element Labels in bold are part of the Natural Key and are required data elements for Data to send to Ed-Fi.
Data Element Label | Business Requirements and Rules | Mandatory, Conditional or Ooptional | Location |
---|---|---|---|
id | The unique identifier of the resource | M | |
localCourseCode | The local code assigned by the he school or district to identify an individual course. Reports the Course Number value. | M | Scheduling & Courses > Courses > Course Information > Course Number Course.number |
courseReference | A reference to the related Course resource. See Array section below for Reference Array. | M | |
schoolReference | A reference to the related School resource. Reports the fields that are part of the Natural Key for the School resource.
| M | |
sessionReference | A reference to the related Session resource. Reports the fields that are part of the Natural Key for the Session resource.
| M | |
courseLevelCharacteristics | Course level value for the course. Reports the mapped Ed-Fi Course value of the Course Level selected. When blank, does not report. | M | Scheduling & Courses > Course Information > Custom Data Elements > Course Level Course.courseLevel |
curriculumUsed | An unordered collection of courseOfferingCurriculumUseds. This entity represents an offering of a course by school during a session, representing the course catalog of available courses. This is optional, does not report. | O | |
instructionalTimePlanned | The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined Course. This is optional, does not report. | O | |
localCourseTitle | The descriptive name given to a course of study offered in the school, when different from the Course Title. Reports the Course Name. | O | Course Information > Name Course.name |
offeredGradeLevels | The grade levels in which the course is offered. For each Course State Code, reports the Ed-Fi Grade Level Descriptor associated with the selected Grade Level. | O | Course Information > Grade Level Course.grade |
courseCredits | Reports the credits value for the Course. Reports the sum of the credit value for all Grading Tasks marked as state-reported, rounded to the nearest hundredth decimal position. | O | Scheduling & Courses > Courses > Course Grading Tasks > Credit GradingTaskCredit.credit |
courseSequence | Reports the course sequence from the location indicated. | O | Scheduling & Courses > Courses > Course Information > Custom Data Elements > Sequence Sequence.course |
totalCourseSequence | Reports the total course sequence from the location indicated. | O | Scheduling & Courses > Courses > Course Information > Custom Data Elements > Sequence Total Course.sequenceTotal |
courseDeliveryTypeDescriptor | Reports the mapped Ed-Fi code value of the Delevery Type selected. When blank, does not report. | O | Scheduling & Courses > Courses > Course Information > Custom Data Elements > Delivery Type Course.deliveryType |
courseProgramTypeDescriptor | Reports the mapped Ed-Fi code value of the Targeted Program selected. When blank, does not report. | O | Scheduling & Courses > Courses > Course Information > Custom Data Elements > Targeted Program Course.targetedProgram |
Arrays
Type Descriptors