Tool Search: Ed-Fi
This association represents student information that is specific to a student’s relationship with an Education Organization.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Business Rules |
---|---|
Post | When an enrollment is created and saved for a person and the enrollment overlaps a configured year.
|
Put | When any student data is edited for the person in the Data Elements fields below. When the person’s identity record is changed:
When one of the person’s household locations is updated/changed:
When one of the person’s household memberships is added/deleted/changed:
When any data in the address the student is associated with changes:
When a student's IEP is locked or unlocked and/or a student's disability is changed on the IEP, Enrollment or State Special Education tool. When a student's contact information is changed: Email, Other Phone, Work Phone, Cell Phone, Pager, Private. When a student's LEP information is changed:
When a student's Response To Intervention Plan is locked/unlocked or the plan name changes. When any of the Student Characteristics change:
Disadvantaged, Displaced Homemaker, Single Parent: If a student's Special Population is changed. Foster Care: A student has a Foster Care record that overlaps the configured year, Start/End Dates are changed so record no longer overlaps configured year, the record is deleted. Parent in Military: A Military Connections record exists for a Guardian of the student, Start/End Dates are changed so record no longer overlaps configured year, the Guardian checkbox is checked/unchecked, the record is deleted |
Delete | This record deletes when the student no longer has an eligible enrollment in the District. When the Enrollment is marked as a No Show. |
Resource Toggle and Resync Logic
This table describes the Resource Toggle and Trigger logic of this object.
Action | Business Rule |
---|---|
None | When a resource is toggled to off after data has sent, all sent data remains in the ODS but no new data sends. |
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 needs 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 Change: When the District Number/Ed-Fi District Number changes, a delete/post occurs with the cascading deletes from the LEA ID Change triggers. When an Ed-Fi ID changes, this happens with the cascading deletes from the Ed-Fi ID Change trigger. |
Delete | Cascading Deletes: N/A - no dependent resources |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
The record sends to the scope year for the school year the enrollment is associated with.
|
When using data in Campus that has a single date, the following logic is applied to determine the scope year(s) to report the data to.
|
When using data in Campus that have start and end dates, the following logic is applied to determine the scope year(s) to report the data to.
|
Resource Preferences
This table describes the Resource Preferences of this object.
Data Element Label | Mapping Needed |
---|---|
Limited English Proficiency Descriptor | EL Program Status |
Disability Descriptor | Disability |
Language Descriptor | Home Primary Language |
Race Descriptor | Race/Ethnicity |
Student Characteristic Descriptor | Career Tech Special Populations |
Economic Disadvantaged | |
Foster Care | |
Homeless | |
Parent in Military | |
US Entry Type | |
Flags |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Person | personID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
enrollment | Post/Put/Delete Put | The primary table used for sending data for this resource. Reports Disabilities. |
identity | Put | Reports Hispanic or Latino, Gender, Home Primary Language, US Entry Type. |
person | Put | Reports the Ed-FI ID. |
contact | Put | Reports the Telephone and Email information. |
householdlocation | Put | Determines if address is marked as Mailing or Private. |
householdmember | Put | Determines household membership with Start Date, End Date, Private. |
address | Put | PO Box, Number, Prefix, Street, Tag, Direction, Apt, City, State, Zip |
raceethnicity | Put | Reports Races. |
plantype | Put | Reports Indicators. |
plan | Put | Reports Disabilities, Indicators. |
planstate | Put | Reports Disabilities. |
programs | Put | Reports any Characteristic created in Flags. |
programparticipation | Put | Reports any Characteristic created in Flags. |
Title1 | Put | Reports Neglected or Delinquent. |
ImpactAidEmployment | Put | Reports Parent in Military. |
relatedpair | Put | Guardian checkbox for contact information and Parent in Military. |
section504 | Put | Reports Section 504 Handicapped. |
homeless | Put | Reports Homeless, Unaccompanied Youth, Runaway. |
Object Data Elements
This table describes data elements sent within the Student Education Organization Association resource.
Data Element Lable | Description | M, C, or O | Database Location |
---|---|---|---|
id | The unique identifier of the resource. | M | |
educationOrganizationId | The identifier assigned to an education organization. ReportingDistrictCode must match a valid DESE County District Code. | M | District Information > State District Number |
studentReference | A unique alphanumeric code assigned to a student. Reports the fields that are part of the Natural Key for the Students resource where the studentUniqueId is the Student State ID. | M | |
addresses | The set of elements that describes an address, including the street address, city, state, and ZIP code. Reports the most current Primary address that is marked as Mailing. When more than one Primary Address marked as Mailing, reports address with most recent Household Membership Start Date. Otherwise, reports the primary address with most recent Address Start Date. Otherwise, reports the primary address with the highest addressID. Does not report when the Address Location Detail or Household Membership is marked as Private. See the Scope Year Logic section to determine the eligibility of records. See Arrays section below for data logic for each field. | M | Household Addresses > Mailing Household Membership > Start Date Household Addresses > Start Date HouseholdLocation.mailing HouseholdMember.startDate Householdlocation.StartDate |
disabilities | The disability condition(s) that best describes an individual’s impairment, as determined by evaluation(s) conducted by the education organization. Reports the Ed-Fi code associated with the primary disability of the student. When null or a value that is not automapped, sends 00. | M | Enrollments > Special Ed Fields > Primary Disability |
electronicMails | The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. Reports the email address entered for that person. Does not report when Email is marked as Private. When blank, does not report. See Arrays section below for data logic for each field. | M | Demographics > Email contact.email |
hispanicLatinoEthnicity | An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central and South America, and other Spanish cultures, regardless of race. The term, ""Spanish origin,"" can be used in addition to ""Hispanic or Latino."" Reports Is the individual Hispanic/Latino? from the student's current identity. When yes, reports as True. When no, reports as False. | O | Identities > Is the Individual Hispanic or Latino? identity.hispanicEthnicity |
languages | The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-3 language codes. Required when EL is RCV. | M | Demographics > Home Primary Language |
limitedEnglishProficiencyDescriptor | An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient. When at least one LEP record exists for a student, determines which LEP record to use:
| O | Program Participation > LEP |
races | The general racial category which most clearly reflects the individual’s recognition of his or her community or with which the individual most identifies. The data model allows for multiple entries so that each individual can specify all appropriate races. See Arrays section below for data logic for each field. | M | Demographics > Person Information > Race Ethnicity IdentityRaceEthnicity and racethnicity.raceid |
sexDescriptor | A person's gender. First looks to Legal Gender on the Identities > Protected Identity Information area for reporting. When blank, reports from Demographics > Gender. | M | Legal Gender on the Identities > Protected Identity Information area for reporting Demographics > Person Information > Gender |
studentCharacteristics | An unordered collection of studentEducationOrganizationAssociationStudentCharacteristics. Reflects important characteristics of a student. When a student has a characteristic present, that characteristic is considered true or active for that student. When a characteristic is not present, no assumption is made as to the applicability of the characteristic, but local policy may dictate otherwise. See Arrays section below for data logic for each field. | M | |
studentIdentificationCodes | An unordered collection of studentEducationOrganizationAssociationStudentIdentificationCodes. A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student. See Arrays section below for data logic for each field. | M | |
giftedDescriptor | Gifted Status of Student. Returns the code entered in the Gifted/Talented dropdown. | O | Enrollments > State Reporting Fields > Gifted/Talented |
inDistrictLessThanYearIndicator | Indicates when a student has only been in school for less than a school year. Considers all enrollments for the reported year at same district as well as dual-enrolled students UNLESS
Otherwise, reports as N. | O | Enrollments > State Reporting Fields > First Date in District |
perkinsStudentTypeDescriptor | Mark student as an Adult or Post-Secondary Perkins participant. Designation for students in Grades 9-12 who have completed or are currently taking a Career Education course approved by DESE.
| O | Enrollments > State Reporting Fields > Career Ed |
dyslexiaAssessmentDescriptor | Optional, does not report. | O | |
eighthGradeTechLiteracyDescriptor | Optional, does not report. | O | |
followUpStatusDescriptor | Optional, does not report. | O | |
perkinsTechSkillsAttainmentDescriptor | Optional, does not report. | O | |
sealOfBiliteracyLanguageDescriptor | Optional, does not report. | O | |
deviceAccessIndicator | Optional, does not report. | O | |
firstFreshmanYear | Optional, does not report. | O | |
highNeedsIndicator | Optional, does not report. | O | |
icapIndicator | Optional, does not report. | O | |
icapReviewIndicator | Optional, does not report. | O | |
internetAccessInResidenceIndicator | Optional, does not report. | O | |
k8gGraduateDistrictCode | Optional, does not report. | O | |
kindergartenReadinessIndicator | Optional, does not report. | O | |
mapaIndicator | Optional, does not report. | O | |
membershipFTE | Optional, does not report. | O | |
nscComment | Optional, does not report. | O | |
numberOfMonthsInUSA | Optional, does not report. | O | |
onePrior10DayAttendanceIndicator | Optional, does not report. | O | |
onTrackToGraduateIndicator | Optional, does not report. | O | |
perkinsRetentionLeftCode | Optional, does not report. | O | |
perkinsTechPrepStartDate | Optional, does not report. | O | |
pkEligibleStateAidIndicator | Optional, does not report. | O | |
pkReplacementId | Optional, does not report. | O | |
truantIndicator | Optional, does not report. | O | |
voluntaryTransferStudentIndicator | Optional, does not report. | O | |
kgs | Optional, does not report. | O | |
physicalFitnesses | Optional, does not report. | O |
Arrays
Type/Descriptors