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 | Trigger |
---|---|
Post | When an enrollment is created and saved for a person and the enrollment overlaps a configured year.
|
Post | If the School Override field is populated on a student's enrollment, report the record with the associated Ed-Fi School Number. |
Post | When a student's FRAM record is ended. |
Put | When the Immigrant indicator on the enrollment driving the Student Education Organization Association record is updated and saved. |
Put | When the Resident District field on the enrollment driving the Student Education Organization Association record is updated and saved. |
Put | When a Migrant record is created that has dates falling within the enrollment dates driving the Student Education Organization Association record. |
Delete | This record will delete if the student no longer has an eligible enrollment in the District. |
Delete | When the State Exclude, WISE Exclude, or No Show check boxes are checked. |
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. |
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 Change: If the District Number/Ed-Fi District Number changes, a delete/post will occur with the cascading deletes from the LEA ID Change triggers. If an Ed-Fi ID changes, this will happen 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 will send 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 will be 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 will be applied to determine the scope year(s) to report the data to.
|
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Person | personID - schoolID |
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. |
raceethnicity | Put | Reports Races. |
plantype | Put | Reports Indicators. |
plan | Put | Reports Disabilities, Indicators. |
planstate | Put | Reports Disabilities. |
programs | Put | Reports any Characteristic created in Programs. |
programparticipation | Put | Reports any Characteristic created in Programs. |
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 Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | |||
education OrganizationId | The identifier assigned to an education organization. |
| M | ||
studentReference | A unique alphanumeric code assigned to a student. |
| M | ||
addresses | The set of elements that describes an address, including the street address, city, state, and ZIP code. |
| O | ||
cohortYears | The type and year of a cohort (e.g., 9th grade) the student belongs to as determined by the year that student entered a specific grade. |
| O | ||
disabilities | The disability condition(s) that best describes an individual’s impairment, as determined by evaluation(s) conducted by the education organization. |
| O | ||
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. |
| O | Census> People> Demographics> Email | contact.email |
hispanicLatino Ethnicity | 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." |
| O | Census>People>Identities> Is the Individual Hispanic or Latino? | identity.hispanic Ethnicity |
international Addresses | The set of elements that describes an international address. |
| O | ||
languages | The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-3 language codes. |
| C | Census > People > Identity > Native Language | Identity.language Alt |
limitedEnglish Proficiency Descriptor | An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient. |
| O | Student Information> Program Participation> English Learners (EL) | lep.programStatus lep.identifieddate lep.exitDate lep.parent Declined |
loginId | The login ID for the user; used for security access control interface. |
| O | app.username | |
oldEthnicity Descriptor | Previous definition of Ethnicity combining Hispanic/latino and race 1 - American Indian or Alaskan Native 2 - Asian or Pacific Islander 3 - Black, not of Hispanic origin 4 - Hispanic 5 - White, not of Hispanic origin. |
| O | N/A | N/A |
profileThumbnail | File name for the ProfileThumbnail photograph. |
| O | N/A | N/A |
program Participations | Key programs the student is participating in or receives services from. |
| O | ||
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. |
| O | Census > People > Identities > Race/Ethnicity | IdentityRace Ethnicity and racethnicity.raceid |
sexDescriptor | A person's gender. |
| M | Census>People>Identities> Legal Gender OR Census>People>Identities> Gender | identity.Legal Gender or identity.gender |
characteristics | Reflects important characteristics of the student’s home situation: Displaced Homemaker, Immigrant, Migratory, Military Parent, Pregnant Teen, Single Parent, and Unaccompanied Youth. |
| O | ||
identificationCodes | A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student. |
| O | ||
indicators | Indicator(s) or metric(s) computed for the student (e.g., at risk) to influence more effective education or direct specific interventions. |
| O | ||
telephones | The 10-digit telephone number, including the area code, for the person. |
| O | ||
languages | An unordered |
| C | Census > People > Identity > Native Language | Identity.language Alt |
tribalAffiliations | An American Indian tribe with which the student is affiliated. |
| O | ||
_etag | A unique system-generated value that identifies the version of the resource. | O |