Tool Search: Ed-Fi
This association represents the school in which a student is enrolled.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When a new enrollment is saved for a student.
|
Delete/Post/Put | A Delete/Post is performed when the natural key of the record is changed. A Put is performed otherwise:
|
Delete |
|
Resource Toggle and Resync Logic
This table describes the Resource Toggle and Trigger logic of this object.
Action | Business Rule |
---|---|
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. |
Put | If the natural key of the Calendar Reference is changed, a put will be done to update the Calendar Reference even if the Student School Association resource is turned 'OFF'. |
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 | Business Rule |
---|---|
Post/Delete | Natural Key changes:
|
Delete | Cascading Deletes: If the Student School Association is deleted, all dependent resources will be deleted.
|
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
The record will send to the scope year for the school year the enrollment is associated with. |
Data will only send for the years that have valid configuration. |
Resource Preferences
This table describes the Resource Preferences of this object.
Data Element Label | Mapping Needed |
---|---|
Entry Type Descriptors | Enrollment Start Status |
Exit Withdraw Type Descriptors | Enrollment End Status |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Enrollment | enrollmentID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
enrollment | Post/Put/Delete | The primary table used for sending data for this resource. |
person | Post/Delete | Student ID in Student Reference |
graduation | Put | Class of School Year Type Reference |
programs | Put | Graduation Plan Reference |
programparticipation | Put | Graduation Plan Reference |
Object Data Elements
This table describes data elements sent within the Student School Association resource.
Data Element Label | Business Requirement and Business Rules | M, C or O | Data Source GUI Path | Database Field | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
entryDate | The month, day, and year on which an individual enters and begins to receive instructional services in a campus. Report the Start Date.
| M | Student Information > General > Enrollment > Start Date | enrollment.startdate | ||||||||||||||
calendarReference | A reference related to the Calendar resource Reports the fields that are part of the Natural Key for the Calendars resource. | M | N/A | N/A | ||||||||||||||
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 > Ed-Fi School ID | School.entityID | ||||||||||||||
schoolYearTypeReference | The school year in which the student is being reported. Reports the End Year of the associated calendar. | MO | N/A | N/A | ||||||||||||||
studentReference | A reference to the related Student resource. Reports the fields that are part of the Natural Key for the Students resource. | M | N/A | N/A | ||||||||||||||
entryGradeLevelDescriptor | The grade level or primary instructional level at which a student enters and receives services in a school or an educational institution during a given academic session. Report the Ed-Fi Code mapped to the value selected for Grade. | M | Student Information > General > Enrollment > Grade | Enrollment.grade | ||||||||||||||
entryTypeDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. Report the Ed-Fi Code mapped to the value selected for Start Status | M | Student Information > General > Enrollment > Start Status | enrollment.startstatus | ||||||||||||||
exitWithdrawDate | The month, day, and year of the first day after the date of an individual''s last attendance at a campus (if known), the day on which an individual graduated, or the date on which it becomes known officially that an individual left school. NEDM: Exit/Withdraw Date. Report the End Date.
| C | Student Information > General > Enrollments > End Date | enrollment.enddate | ||||||||||||||
exitWithdrawTypeDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. Report the Ed-Fi Code mapped to the value selected for End Status. | C | Student Information > General > Enrollments > End Status | enrollment.endstatus | ||||||||||||||
repeatGradeIndicator | An indicator of whether the student is enrolling to repeat a grade level, either by failure or an agreement to hold the student back.
| C | Student Information > General > Enrollments > End Action | enrollment. endAction | ||||||||||||||
residencyStatusDescriptor | An indication of the location of a persons legal residence relative to (within or outside of) the boundaries of the public school attended and its administrative unit. Report the Ed-Fi Code mapped to the selected Resident Status value. | M | Student Information > General > Enrollments > Resident Status | EnrollmentGA.residentStatus | ||||||||||||||
dateEntered9thGrade | Date the student enrolled in the 9th grade for the first time. Required to report for 9th grade and beyond. Report the date entered on Date First Entered the 9th Grade.
| C | Student Information > General > Graduation > Date First Entered the 9th Grade | Graduation.grade9Date | ||||||||||||||
priorTenDays |
| M | Student Information > General > Enrollment > Prior 10 Days Override | EnrollmentGA.priorDaysOverride | ||||||||||||||
summerImmigrantProgramParticipation |
| M | Student Information > General > Enrollment > Immigrant Participation Program | EnrollmentGA.immigrantProgram | ||||||||||||||
summerTitleIIIServed |
| M | Student Information > General > Enrollment > Title III Served | EnrollmentGA.titleIIIServed | ||||||||||||||
fteSegments | Reports an array with 6 distinct records within it (One per segment). The database fields are named the same but distinguished with the segment number as the last character. Logic will remain the same across all 6 distinct records, but they will use their respective database fields.
| M | FTE Heads Up (Custom K-12 tab) Student Information > General > FTE Heads Up | Replace "1" with "2, 3, 4, 5, or 6" to get the respective segment values: EnrollmentGA.fteProgramCode1 EnrollmentGA.fteProgramCalc1 EnrollmentGA.enrollmentLocation1 EnrollmentGA.enrollmentLocCalc1 EnrollmentGA.inclusion1 EnrollmentGA.inclusionCalc1 EnrollmentGA.itinerant EnrollmentGA.supplementalSpeech EnrollmentGA.transported | ||||||||||||||
esolSegments | Reports based on the EL Service Type of ESOL0 - ESOL5 if that service overlaps the dates of the student's enrollment.
| C | English Learners (EL) | N/A |