Students (Texas v4.0)

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.

A Student School Association record must be sent in order to see/access a Student record in the ODS. This is is the security protocol set by Ed-Fi. You cannot see the Student record until they are associated to a School through the SSA record.

The Student Resource is a shared record among all districts. If two districts have the same student in the same year, the last district to trigger data to Ed-Fi is the data stored in Ed-Fi.

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

Action	Trigger
Post	When an enrollment is created and saved for a person and the enrollment overlaps a configured year. Do not send it an enrollment is marked as No Show. Do not send a record if enrollment is in a Calendar marked as State Exclude. Do not send a record if enrollment is in a School marked as State Exclude.
Put	When any student data is edited for the person in the Data Elements fields below. When the person’s identity record is changed in one of the following fields: Birth Date First Name Middle Name Last Name Suffix Crisis Event is added or removed; As-of-status on enrollment is added, changed, or removed. Student census block group changes (added or removed).
Delete	Student records are never deleted because Student records are a shared resource among all districts.

Action

Trigger

Post

When an enrollment is created and saved for a person and the enrollment overlaps a configured year.

Do not send it an enrollment is marked as No Show.
Do not send a record if enrollment is in a Calendar marked as State Exclude.
Do not send a record if enrollment is in a School marked as State Exclude.

Put

When any student data is edited for the person in the Data Elements fields below.

When the person’s identity record is changed in one of the following fields:
- Birth Date
- First Name
- Middle Name
- Last Name
- Suffix
Crisis Event is added or removed; As-of-status on enrollment is added, changed, or removed.
Student census block group changes (added or removed).

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

Action	Business Rule
None	If a resource is toggled to 'OFF' after data has sent, all sent data remains in the ODS but no new data sends.
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

Action	Business Rule
Post	Natural Key change: Ed-Fi ID If an Ed-Fi ID is changed for a student, all data for the previous number is deleted and resent under the new number.
Delete	Cascading Deletes: The following resources will be deleted and resent if the Ed-Fi ID is changed. Student Parent Associations, Student Education Organization Associations, Student School Associations, Student Section Associations, Graduation Plans, Student Program Associations, Student CTE Program Associations, Student Special Education Program Associations, Student Title 1 Part A Program Associations, Student Academic Records, Course Transcripts, Grades, Student Discipline Incident Associations, Discipline Actions, Student Cohort Associations, Student School Attendance Events, Student Section Attendance Events

Action

Business Rule

Post

Natural Key change: Ed-Fi ID

If an Ed-Fi ID is changed for a student, all data for the previous number is deleted and resent under the new number.

Delete

Cascading Deletes: The following resources will be deleted and resent if the Ed-Fi ID is changed.

Student Parent Associations, Student Education Organization Associations, Student School Associations, Student Section Associations, Graduation Plans, Student Program Associations, Student CTE Program Associations, Student Special Education Program Associations, Student Title 1 Part A Program Associations, Student Academic Records, Course Transcripts, Grades, Student Discipline Incident Associations, Discipline Actions, Student Cohort Associations, Student School Attendance Events, Student Section Attendance Events

Scope Year Logic

Logic
A record reports when an enrollment is created and saved that is aligned to a configured year. The enrollment must overlap with the configured year to report. Data only sends for the years that have valid configuration.
When using data in Campus that has a single date, the following logic is applied to determine the scope year(s) in which to report data: Current Year: The record must overlap the current year. Previous Years: The record's date must be on or before the schools year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used. Future Years: The record's date must be on or after the schools year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) in which to report data: Current Year: The record must overlap the current year. Previous Years: The record's start date must be on or before the school year's end date and the record's end date must be after the school year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used. Future Years: The record's start date must be on or before the schools year's start date and the record's end date must be on or after the school year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.

Logic

A record reports when an enrollment is created and saved that is aligned to a configured year.

The enrollment must overlap with the configured year to report.
Data only sends for the years that have valid configuration.

When using data in Campus that has a single date, the following logic is applied to determine the scope year(s) in which to report data:

Current Year: The record must overlap the current year.
Previous Years: The record's date must be on or before the schools year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used.
Future Years: The record's date must be on or after the schools year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.

When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) in which to report data:

Current Year: The record must overlap the current year.
Previous Years: The record's start date must be on or before the school year's end date and the record's end date must be after the school year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used.
Future Years: The record's start date must be on or before the schools year's start date and the record's end date must be on or after the school year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.

Resource Preferences

Data Element Label	Mapping Needed	Database Field
birthCountryDescriptor	Birth Country Override	identity.birthcountry
birthStateDescriptor	Birth State Override	identity.birthstate

Identity Mapping Object Key

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 is 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 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 if all enrollments that were sent to Ed-Fi are deleted.

Event Queue Detail

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

Click here to expand...

Data Element Label	Business Requirement	Logic	Mandatory (M) or Optional (O)	Location
id	The unique identifier of the resource.		M
studentUniqueId	A unique number assigned to a student by the Texas Education Agency.	Reports the Ed-Fi ID.	M	Census > People > Demographics > Ed-Fi ID person.edfiid
birthCity	The city where the student was born.	Reports the Birth City if populated on the Demographics tab.	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. Look for a mapping saved to the Birth Country Descriptor Override .section in preferences. If there is a mapped value, report that mapping. If an override is not there, look to see if the Code matches an Ed-Fi code, if yes report that value. Reports default value if saved on the Attribute and the code matches an Ed-Fi code. Otherwise, reports NULL.	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
birthInternationalProvince	For students born outside of the U.S., the Province or jurisdiction in which an individual was 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. If null, reports the student's Gender from the current Identity record. Reports the following based on the value selected in the drop list. Female reports 'Female'. Male reports 'Male'. Blank reports 'Not Selected'.	O	Census > People > Identities > Legal Gender OR Census > People > Identities > Gender identity.LegalGender or identity.gender
birthStateAbbreviation Descriptor	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. Look for a mapping saved to the Birth State Abbreviation Type Override section in preferences. If there is a mapped value, report that mapping. If an override is not there, look to see if the Code matches an Ed-Fi code, if yes report that value. Report default value if 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.	Report the Date Entered US if date is entered. Do 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, reports legal first name. If Legal First and Last name fields are blank, reports first Name.	M	Census > People > Identities > Legal First Name OR Census > People > 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).	This is optional, does not report.	O	Census > People > Identities > Legal Suffix OR Census > People > Identities > Suffix identity.legalSuffix OR identity.suffix
identificationDocuments	Describe 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: Reports first from the legal name fields, reports Last Name. If Legal First and Last name fields are blank, reports Last Name.	M	Census > People > Identities > Legal Last Name OR Census > People > Identities > Last Name identity.legalLastName OR 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.	Reports from the current identity record: Reports first from the legal name fields, reports legal middle name. If Legal First Name and Legal Last Name are populated and Middle Name is blank, reports blank. If all legal name fields are blank, reports from middle name. Otherwise, reports blank.	O	Census > People > Identities > Legal Middle Name OR Census > People > Identities > Middle Name identity.legalMiddleName OR identity.middleName
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
LocalStudentID	The student's local identification number as assigned by the district.	Reports Local Student Number.	M	Census > People > Demographics
StudentID	The student's Social Security number or a state-approved alternative identification number.	Reports the Previous State ID. If Previous State ID = NULL, reports Social Security Number.	O	Census > People > Demographics
GenerationCodeDescriptor	Identifies the generation suffix, if any, which the person attaches to his name (e.g., Jr., Sr., III)	Reports mapped Ed-Fi Code of Suffix.	O	Census > People > Demographics
AsOfStatusLastFridayOctoberDescriptor	Indicates the student’s status in the district on the last Friday in October in the current school year.	Reports As-Of-Status from primary enrollment that overlaps last Friday in October.	O	Census > People > Demographics
AsOfStatusLastDayEnrollmentDescriptor	Indicates the student’s status in the district on the last day of school or last date of enrollment in the current school year.	Reports As-Of-Status from most recent primary enrollment.	O	Census > People > Demographics
StudentDoNotReportTSDS	Indicates the student should not be reported for TSDS state or federal data collections.
censusBlockGroupSets		See array for field specific logic.
crisisEventSets		See array for field specific logic.
_etag	A unique system-generated value that identifies the version of the resource.		O

Array Data Elements

Click here to expand...

Student Other Name

Data Element Label	Business Requirement	Logic	M, C or O	Location
otherNameTypeDescriptor	The unique identifier of the resource.	Reports "Previous Legal Name". **Not reporting any other name types. See link to Other Name Types below for other name types.	M
firstName	A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. NEDM First Name.	Reports the first name from the student's current identity record.	M	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 the suffix from the student's current identity record. If blank, does not report.	C	Census > People > Identities >Suffix identity.suffix
lastSurname	The name borne in common by members of a family. NEDM Last Name/Surname.	Reports the last name from the student's current identity record.	M	Census > People >I dentities > Last Name identity.lastName
middleName	A secondary name given to an individual at birth, baptism, or during another naming ceremony. NEDM Middle Name	Reports the middle name from the student's current identity record. If blank, does not report.	C	Census > People > Identities > Middle Name identity.middleName
personalTitlePrefix	A prefix used to denote the title, degree, position or seniority of the person.	This is optional, does not report.	C	N/A

Census Block Group

Data Element Label	Business Requirement	Logic	M, C, or O	Location
beginDate		Reports the household address begin date.	M
endDate		Reports the household address end date.	O
StudentCensusBlock Group	Indicates the census block in which the student resides.	If ANY of the following are TRUE, then does not report. Otherwise, reports value. TX-Economic Disadvantaged equals 00 TX-ADAEligibility equals 0, 4, 5, or 8 TX-Attribution equals 21 or 23 (Student Information > General > Enrollments > Attribution Code) TX-HomelessStatus equals any value other than 0 Reports Block from the most recent primary household tied to the student AND the most recent primary address within that household.	M	TX-EconomicDisadvantaged: Student Information > General> Enrollment> State Reporting Fields> Code 99 OR System Administration > FRAM > Eligibility > State Code TX-ADAEligibility: System Administration > Student Information > Program Participation> State Programs > ADA > ADA Eligibility TX-Attribution: Student Information > General> Enrollment> State Reporting Fields> Attribution Code TX-HomelessStatus: Student Information > Program Participation > Homeless > Homeless Nighttime Residence

Crisis Event

Data Element Label	Business Requirement	Logic	M, C, or O	Location
beginDate		Reports start date of crisis event record.	M	Student Information > State Programs > Crisis Event
endDate		Reports end date of crisis event record.	O	Student Information > State Programs > Crisis Event
crisisEventDescriptor	Indicates a state health or weather-related event that impacts a group of students, and may require additional funding, educational, or social services. The event may or may not cause the student to leave the district or campus of residence. A crisis event is designated by the Commissioner of Education.	Reports mapped Ed-Fi Code from Crisis Code.	M	Student Information > State Programs > Crisis Event

Type/Descriptor

Click here to expand...

AsOfStatusLastFridayOctober Descriptor

Code	Description	Short Description
A	Student Was Enrolled In The District During The Prior School Year But Has Never Enrolled In The District During The Current Year	Enrolled In District Prior School Year Not Enrolled District Current Year
B	Student Was Enrolled In The District Within The School-Start Window And Was Enrolled In The District On The Fall As Of Date	Enrolled In District In School-Start Window And Enrolled On Fall As Of Date
C	Student Was Enrolled In The District Within The School-Start Window And Was Not Enrolled In The District On The Fall As Of Date	Enrolled In District In School-Start Window Not Enrolled On Fall As Of Date
D	Student Was Enrolled In The District In The Prior School Year, Was Not Enrolled In The District Within The School-Start Window In The Current School Year And Was Enrolled In The District On The Fall As Of Date In The Current School Year	Enrolled PY Not Enrolled School-Start Window And Enrolled Fall As Of Date
E	Student Was Enrolled In The District In The Prior School Year, Was Enrolled In The District In The Current Year But Not Within The School-Start Window And Not On The Fall As Of Date	Enrolled PY And CY Not Enrolled SchoolStart Window Or Fall As Of Date
F	Student Was Not Enrolled In The District In The Prior School Year, Was Not Enrolled In The District Within The School-Start Window In The Current School Year And Was Enrolled In The District On The Fall As Of Date In The Current School Year	Not Enrolled PY Not Enrolled School Start Was Enrolled On Fall As Of Date
G	Student Was Not Enrolled In The District In The Prior School Year, Was Enrolled In The District In The Current Year But Not Within The School-Start Window And Not On The Fall As Of Date	Not Enrolled PY Enrolled CY Not Enrolled School Start Or Fall As Of Date
X	For All Students In Grades EE-06 And First-Time 7th Graders Enrolled In The District On The Fall As Of Date	For All Students in Grades EE-06 And First Time 7th Graders

AsOfStatusLastDayEnrollment Descriptor

Code	Description	Short Description
H	Student Was Enrolled In The District On The Final Day Of The School Year	Student Was Enrolled In The District On The Final Day Of The School Year
I	Student Was Enrolled In The District At Some Time During The Year, But Not On The Final Day Of The School Year	Enrolled At Some Time During Year Not On Final Day Of School Year
X	For All Students In Grades EE-06 Only	For All Students In Grades EE-06

CrisisEvent Descriptor

Other Name Type Descriptors

Code Value	Description	Namespace	Short Description
Alias	Alias	uri://ed-fi.org/OtherNameTypeDescriptor	Alias
Nickname	Nickname	uri://ed-fi.org/OtherNameTypeDescriptor	Nickname
Other Name	Other Name	uri://ed-fi.org/OtherNameTypeDescriptor	Other Name
Previous Legal Name	Previous Legal Name	uri://ed-fi.org/OtherNameTypeDescriptor	Previous Legal Name

Code	Description	Short Description
11	Reserved For Future Health Or Weather Related Crisis (11)	Reserved For Future Health Or Weather Related Crisis (11)
12	Reserved For Future Health Or Weather Related Crisis (12)	Reserved For Future Health Or Weather Related Crisis (12)
13	Reserved For Future Health Or Weather Related Crisis (13)	Reserved For Future Health Or Weather Related Crisis (13)
14	Reserved For Future Health Or Weather Related Crisis (14)	Reserved For Future Health Or Weather Related Crisis (14)
15	Reserved For Future Health Or Weather Related Crisis (15)	Reserved For Future Health Or Weather Related Crisis (15)
16	Reserved For Future Health Or Weather Related Crisis (16)	Reserved For Future Health Or Weather Related Crisis (16)
17	Reserved For Future Health Or Weather Related Crisis (17)	Reserved For Future Health Or Weather Related Crisis (17)
18	Reserved For Future Health Or Weather Related Crisis (18)	Reserved For Future Health Or Weather Related Crisis (18)
19	Reserved For Future Health Or Weather Related Crisis (19)	Reserved For Future Health Or Weather Related Crisis (19)
20	Reserved For Future Health Or Weather Related Crisis (20)	Reserved For Future Health Or Weather Related Crisis (20)
21	Reserved For Future Health Or Weather Related Crisis (21)	Reserved For Future Health Or Weather Related Crisis (21)
22	Reserved For Future Health Or Weather Related Crisis (22)	Reserved For Future Health Or Weather Related Crisis (22)
23	Reserved For Future Health Or Weather Related Crisis (23)	Reserved For Future Health Or Weather Related Crisis (23)
24	Reserved For Future Health Or Weather Related Crisis (24)	Reserved For Future Health Or Weather Related Crisis (24)
25	Reserved For Future Health Or Weather Related Crisis (25)	Reserved For Future Health Or Weather Related Crisis (25)
26	Reserved For Future Health Or Weather Related Crisis (26)	Reserved For Future Health Or Weather Related Crisis (26)
27	Reserved For Future Health Or Weather Related Crisis (27)	Reserved For Future Health Or Weather Related Crisis (27)
28	Reserved For Future Health Or Weather Related Crisis (28)	Reserved For Future Health Or Weather Related Crisis (28)
29	Reserved For Future Health Or Weather Related Crisis (29)	Reserved For Future Health Or Weather Related Crisis (29)
30	Reserved For Future Health Or Weather Related Crisis (30)	Reserved For Future Health Or Weather Related Crisis (30)

Object Triggering Logic

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

Natural Key Changes, Cascading Updates, and Deletes Logic

Scope Year Logic

Resource Preferences

Identity Mapping Object Key

Event Queue Detail

Object Data Elements

Array Data Elements

Type/Descriptor

Related Articles