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 |
|
Put |
|
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 sends. |
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 |
|
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 |
---|
|
|
|
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 is 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 Requirements and Rules | M or O | Data Source GUI Path Database Location |
---|---|---|---|
id | The unique identifier of the resource. | M | |
studentUniqueId | A unique alpha-numeric code assigned to a student. Reports the Ed-Fi ID. | M | Demographics > Ed-Fi ID person.edfiId |
birthDate | The month, day, and year on which an individual was born. Reports the Birth Date from the student's current identity record. | M | Identities > Birth Date identity.birthDate |
birthSexDescriptor | A person's gender at birth. Reports the Legal Gender from the student's current identity record. When null, reports the student's Gender from the current Identity record. Reports the following based on the value selected in the dropdown:
| O | Identities > Legal Gender OR Identities > Gender identity.LegalGender or identity.gender |
firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. Reports first from the Legal First Name field from the Protected Identity Information area. When blank, reports from the Demographics First Name field. | M | Identities > Protected Identity Information > Legal First Name OR Demographics Identities > First Name identity.legalFirstName OR identity.firstName |
generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). Reports first from the Legal Suffix field from the Protected Identity Information area. When blank, reports from the Demographics Suffix field. Otherwise, reports as blank. | O | Demographics > Identities > Protected Identity Information > Legal Suffix OR Demographics > Identities > Suffix identity.legalSuffix OR identity.suffix |
lastSurname | The name borne in common by members of a family. Reports first from the Legal Last Name field from the Protected Identity Information area. When blank, reports from the Demographics Last Name field. | M | Demographics > Identities > Protected Identity Information > Legal Last Name OR Demographics > Identities > Last Name identity.legalLastName OR identity.lastName |
middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony. Reports first from the Legal Middle Name field from the Protected Identity Information area. When blank, reports from the Demographics Middle Name field. Otherwise, reports as blank. | O | Demographics > Identities > Protected Identity Information > Legal Middle Name OR Demographics > Identities > Middle Name identity.legalMiddleName OR identity.middleName |
Type/Descriptors
Ed-Fi Code | Description | Namespace | Short Description |
---|---|---|---|
Male | Male | uri://ed-fi.org/SexDescriptor | Male |
Female | Female | uri://ed-fi.org/SexDescriptor | Female |