Classic View: System Administration > Ed-Fi
Search Terms: Ed-Fi
This resource represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency, or other institution or program. A student is a person who has been enrolled in a school or other educational institution.
For example, if one district put in a first name of "Robert" and the second district put in a first name of "Rob", the last district to update the student record is what will appear in Ed-Fi and on both District's reports. This is true for all field logic in the Student Resource.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | Do NOT post a student record if one or more of the following conditions exist:
|
Post | When a new enrollment is saved for a student and student has an Ed-Fi ID that is not null. A record reports for each distinct School a student is enrolled.
|
Post | When the start date for an enrollment is changed.
|
Put | When an enrollment is updated for a student.
|
Delete | When an enrollment is deleted.
|
Delete | When the start date of an enrollment is changed. |
Delete | When the No Show check box is checked. |
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 | 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 an Ed-Fi Code mapping is changed to a new code or made NULL, a resync must be performed for the data to be updated in the ODS. |
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 | Natural Key change: Ed-Fi ID
|
Delete | Cascading Deletes: The following resources will be deleted and resent if the Ed-Fi ID is changed.
|
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
A record will report when an enrollment is created and saved that is aligned to a configured year.
|
When using data in Campus that has a single date, the following logic will be applied to determine the scope year(s) in which to report data:
|
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) iin which to report data:
|
Resource Preferences
This table describes the Resource Preferences of this object.
Data Element Label | Mapping Needed | Database field |
---|---|---|
birthCountryDescriptor | Birth Country Override | identity.birthcountry |
birthStateDescriptor | Birth State Override | identity.birthstate |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Person | personID |
If a Student and Student School Association record has been sent for a student, a Student and Student School Association record will be logged in the Ed-Fi Identity Mapping table. If the student's enrollment is deleted or their Ed-Fi ID is changed while the Student and/or Student School Association Resource Preference is turned off, the old record and resource id will remain in the table until the resource is turned back on and a resync is performed on either Students or Student School Associations.
The Students and Student School Associations records will be deleted from the identity mapping table if all enrollments that were sent to Ed-Fi are deleted.
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. |
identity | Put | birthCity, birthCountryDescriptor, birthDate, birthSexDescriptor, birthStateAbbreviationDescriptor, dateEnteredUS, firstName, lastSurname, generationCodeSuffix, middleName, otherNames |
person | Post/Delete | studentUniqueID |
Object Data Elements
This table describes data elements sent within the Student resource.
Data Element Label | Business Requirement | Business Rules | Mandatory (M) or Optional (O) | Data Source GUI Path | Database Field |
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | |||
studentUniqueId | A unique alpha-numeric code assigned to a student. Reports the Ed-Fi ID. | Report Ed-Fi ID. | M | Census>People>Demographics> Ed-Fi ID | person.edfiid |
birthCity | The city the student was born in. | Report the Birth City if populated on the Demographics tab. | O | Census> People> Demographics> Birth City | identity.birthcity |
birthCountry Descriptor | The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes. |
| O | Census>People>Identities>Birth Country | identity. birthcountry |
birthDate | The month, day, and year on which an individual was born. | Report the Birth Date from the student's current identity record. | M | Census>People>Identities>Birth Date | identity.birthdate |
birthInternational Province | For students born outside of the U.S., the Province or jurisdiction in which an individual is born. | This is optional, does not report. | O | ||
birthSexDescriptor | A person''s gender at birth. |
| M | Census>People>Demographics | identity.Legal Gender or identity.gender |
birthState Abbreviation Descriptor | The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born. |
| O | Census > People > Demographics > Birth State | identity.birthstate |
citizenshipStatus Descriptor | An indicator of whether or not the person is a U.S. citizen. | This is optional, does not report. | O | ||
dateEnteredUS | For students born outside of the US, the date the student entered the US. |
| O | Census > People > Identities > Date Entered US | identity.date EnteredUS |
firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. | Report from the current identity record,
| M | Census > People > Identities > Legal First Name OR Census > People > Identities > First Name | identity.legal FirstName OR identity.firstName |
generationCode Suffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). |
| O | Census > People > Identities > Legal Suffix OR Census > People > Identities > Suffix | identity.legalSuffix OR identity.suffix |
identification Documents | Describe the documentation of citizenship. | This is optional, does not report. | O | ||
lastSurname | The name borne in common by members of a family. | Report from the current identity record,
| M | Census > People > Identities > Legal Last Name OR Census > People > Identities > Last Name | identity.legal LastName OR identity.lastName |
maidenName | The person''s maiden name. | This is optional, does not report. | O | N/A | N/A |
middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony. |
| O | Census > People > Identities > Legal Middle Name OR Census > People > Identities > Middle Name | identity.legal MiddleName OR identity. middleName |
multipleBirth Status | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.). | This is optional, does not report. | O | N/A | N/A |
otherNames | Other names (e.g., alias, nickname, previous legal name) associated with a person. |
| O | Census > People > Identities | |
personalIdentification Documents | The documents presented as evident to verify one’s personal identity; for example: drivers license, passport, birth certificate, etc. | This is optional, does not report. | O | ||
personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. | This is optional, does not report. | O | N/A | N/A |
visas | An indicator of a non-US citizen’s Visa type. | This is optional, does not report. | O | ||
birthInternational Province | Student’s State of Birth Code | If Birth Country is not US or NULL, report Birth State. | O | Census > People > Demographics > Birth State | |
mothersMaiden Name | Mother's Maiden Name | Reprot Mother's Maiden Name. | O | Census > People > Demographics > Mother's Maiden Name | |
firstUSSchool EnrollmentDate | Date First Enrolled in US School - Report the year the immigrant student first enrolled in a US school | Report the Date Entered US School | O | Census > People > Demographics > Date Entered US School | identity. dateEnteredUS School |
previousBirthDate | Previous birth date. | Report the Previous Birth Date. | O | Census > People > Demographics > Previous Birth Date | |
previousSex Descriptor | Previous gender. | Report the Previous Gender. | O | Census > People > Demographics >Previous Gender | |
syblingOfMultiple Birth | Indicates a sibling of multiple birth. | If Multiple Birth is selected, report true. | O | Census > People > Demographics > Multiple Birth | |
birthCounty Descriptor | Students County of Birth Code. | Populate the Birth County code and Birth State code of the student's current identity. | O | Census > People > Identities > Current Identity > Birth County | Identity. birthCounty |
submittedForSchool YearTypeReference .schoolYear | Key for School Year | Report the School Year tied to the configured year to identify the End Year. | M | schoolYear. endYear | |
submittedBy Education Organization Reference .education OrganizationID | The identifier assigned to an education organization | Populate the State District Number + State School Number. | M | System Administration > Resources > District Information System Administration > Resources > School | district.number school.number |
_etag | A unique system-generated value that identifies the version of the resource. | O |
Array Data Elements
Type/Descriptor