Students (Core v3.X)

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

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. 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 City, Birth Country, Birth Date, Gender, Birth State, Date Entered US, First Name, Suffix, Last Name, Middle Name.
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 City, Birth Country, Birth Date, Gender, Birth State, Date Entered US, First Name, Suffix, Last Name, Middle Name.

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	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 If an Ed-Fi ID is changed for a student, all data for the previous number will be 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 Scool 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 will be 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 Scool Attendance Events, Student Section Attendance Events

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. 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 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 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) iin 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 will report 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 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 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) iin 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

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
birthCountryDescriptor	The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.	Report 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. Report default value if saved on the Attribute and the code matches an Ed-Fi code. Else, report 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 is born.	This is optional, does not report.	O
birthSexDescriptor	A person''s gender at birth.	Report the Legal Gender from the student's current identity record. If null, report the student's Gender from the current Identity record. Report the following based on the value selected in the droplist. Female report 'Female'. Male report 'Male'. Blank report 'Not Selected'.	O	Census>People>Identities> Legal Gender OR Census>People>Identities> Gender	identity.LegalGender or 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.	Report 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. Else, report 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.	Report from the current identity record, Report first from the legal name fields, report legal first name. If Legal First and Last name fields are blank, report 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).	Report from the current identity record. Report first from the legal name fields, report Legal Suffix. If Legal First Name and Legal Last Name are populated and Legal .Suffix is blank, report blank. If Legal First and Last name fields are blank, report Suffix (if available). Otherwise, report blank.	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.	Report from the current identity record, Report first from the legal name fields, report Last Name. If Legal First and Last name fields are blank, report 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	N/A
middleName	A secondary name given to an individual at birth, baptism, or during another naming ceremony.	Report from the current identity record, Report first from the legal name fields, report legal middle name. If Legal First Name and Legal Last Name are populated and Middle Name is blank, report blank. If all legal name fields are blank, report from middle name. Otherwise, report 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	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	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

Click here to expand...

This table describes the array data elements for the Student Other Name element:

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI Path	Database Field
otherNameTypeDescriptor	The unique identifier of the resource.	1. Report "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.	Report 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).	Report the suffix from the student's current identity record. If blank, do not report.	C	Census>People>Identities>Suffix	identity.suffix
lastSurname	The name borne in common by members of a family. NEDM Last Name/Surname.	Report the last name from the student's current identity record.	M	Census>People>Identities>Last Name	identity.lastName
middleName	A secondary name given to an individual at birth, baptism, or during another naming ceremony. NEDM Middle Name	Report the middle name from the student's current identity record. If blank, do 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	N/A

Type/Descriptor