Tool Search: 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 | 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.
|
Delete | Student records are never deleted because Student records are a shared resource among all districts. |
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 | When a resource is toggled to OFF after data has sent, all sent data remains in the ODS but no new data is sent. |
Resync | When 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 are deleted and resent when the Ed-Fi ID is changed.
|
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
A record reports 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 |
When 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. When 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 remains 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 are deleted from the identity mapping table when 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 Rules and Requirements | Mandatory (M) or Optional (O) | Location |
---|---|---|---|
id | The unique identifier of the resource. | M | |
studentUniqueId | A unique alpha-numeric code assigned to a student. Reports the Student State ID. | M | Census > People > Demographics > Person Identifiers > Student State ID Person.stateID |
birthCity | The city the student was born in. Reports the Birth City when populated on the Demographics record. | O | Census > People > Demographics > Birth City Identity.birthcity |
birthCountryDescriptor | The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes. Reports the Country from the Birth Country saved on the student's current identity record.
| O | Census > People > Identities > Birth Country Identity.birthcountry |
birthDate | The month, day, and year on which an individual was born. Reports the Birth Date from the student's current identity record. | M | Census > People > Identities > Birth Date Identity.birthdate |
birthInternationalProvince | 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. Reports the Legal Gender from the student's current identity record.
| O | Census > People > Identities > Protected Identity Information > Legal Gender Identity.legalGender Census > People > Identities > Gender Identity.gender |
birthStateAbbreviationDescriptor | The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born. Reports the State from the Birth State saved on the student's current identity record.
Reports the default value when saved on the Attribute and the code matches an Ed-Fi code. Otherwise, reports NULL. | O | Census > People > Demographics > Birth State Identity.birthstate |
citizenshipStatusDescriptor | 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. Reports the Date Entered US if date is entered. Does not report if date is blank. | O | Census > People > Identities > Date Entered US Identity.dateEnteredUS |
firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. Reports from the current identity record, Reports first from the legal name fields, report legal first name. When Legal First and Last name fields are blank, report first Name. | M | Census > People > Identities > Protected Identity Information > Legal First Name Identity.legalFirstName Census > People > Identities > First Name Identity.firstName |
generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). Reports from the current identity record.
| O | Census > People > Identities > Protected Identity Information > Legal Suffix Identity.legalSuffix Census > People > Identities > Suffix Identity.suffix |
identificationDocuments | Describes the documentation of citizenship. This is optional, does not report. | O | |
lastSurname | The name borne in common by members of a family. Reports from the current identity record,
| M | Census > People > Identities > Protected Identity Information > Legal Last Name identity.legalLastName Census > People > Identities > Last Name Identity.lastName |
maidenName | The person''s maiden name. This is optional, does not report. | O | N/A |
middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony.
| O | Census > People > Identities > Protected Identity Information > Legal Middle Name Identity.legalMiddleName Census > People > Identities > Middle Name |
multipleBirthStatus | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.). This is optional, does not report. | O | N/A |
otherNames | Other names (e.g., alias, nickname, previous legal name) associated with a person. Reports the data from the previous Identity for a student. Must have more than 1 Identity for this to report. See Array section below for data logic for each field. | O | Census > People > Identities |
personalIdentificationDocuments | 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 |
visas | An indicator of a non-US citizen’s Visa type. This is optional, does not report. | O | |
_etag | A unique system-generated value that identifies the version of the resource. | O |
Array Data Elements
Type/Descriptor