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.

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. Do not send records if the Calendar Grade Level "Exclude from State Reporting" checkbox is selected for the grade level in which the student is enrolled.
Put	When any student data is edited for the person in the Data Elements fields below: First Name Middle Name Middle Name Suffix Birth City Birth Country Birth Date Gender Birth State Date Entered US
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.
Do not send records if the Calendar Grade Level "Exclude from State Reporting" checkbox is selected for the grade level in which the student is enrolled.

Put

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

First Name
Middle Name
Middle Name
Suffix
Birth City
Birth Country
Birth Date
Gender
Birth State
Date Entered US

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 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 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 School 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

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	birthDate, firstName, lastSurname, generationCodeSuffix, middleName
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)	Location
id	The unique identifier of the resource.		M
birthCity	The city where the student was born.	This is optional, does not report.	O
birthCountry Descriptor	The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.	This is optional, does not report.	O
birthDate	The month, day, and year on which an individual was born.	Report the date of birth from the student's current identity record.	M	Census > People > Identities > Birth Date identity.birthdate
birthSex Descriptor	A person's gender at birth.	Report from the current identity record. Check the to see if the "Report Legal Identities when provided" checkbox is selected. If yes, check to see if Legal Gender is populated. If yes, report the value. If no, report the Gender value. If no, report the Gender value.	M	Census > People > Identities > Legal Gender OR Census > People > Identities > Gender 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.,	Do not report.	O
dateEntered US	For students born outside of the US, the date the student entered the US.	Do not report.	O
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. Check the to see if the "Report Legal Identities when provided" checkbox is selected. If yes, check to see if Legal First Name is populated. If yes, report the value of Legal First Name. If no, report the First Name value. If no, report the First Name value.	M	Census > People > Identities > Legal First Name OR Census > People > Identities > First Name dentity.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).	Report from the current identity record. Check the to see if the "Report Legal Identities when provided" checkbox is selected. If yes, check to see if Legal First Name is populated. If yes, report the value of Legal Suffix. If no, report the Suffix value. If no, report the Suffix value. If Null, do not report.	M	Census > People > Identities > Legal Suffix OR Census > People > Identities > Suffix identity.legalSuffix OR identity.suffix
lastSurname	The name borne in common by members of a family.	Report from the current identity record. Check the to see if the "Report Legal Identities when provided" checkbox is selected. If yes, check to see if Legal First Name is populated. If yes, report the value of Legal Last Name. If no, report the Last Name value. If no, report the Last Name value.	M	Census > People > Identities > Legal Last Name OR Census > People > Identities > Last Name identity.legal LastName OR identity.lastName
middleName	A secondary name given to an individual at birth, baptism, or during another naming ceremony.	Report from the current identity record. Check the to see if the "Report Legal Identities when provided" checkbox is selected. If yes, check to see if Legal First Name is populated. If yes, report the value of Legal Middle Name. If no, report the Middle Name value. If no, report the Middle Name value. If Null, do not report.	M	Census > People > Identities > Legal Middle Name OR Census > People > Identities > Middle Name identity.legal MiddleName OR identity.middle Name
otherNames	Other names (e.g., alias, nickname, previous legal name) associated with a person.	Does not report.
_etag	A unique system-generated value that identifies the version of the resource.

Array Data Elements

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

Data Element Label	Business Requirement	Business Rules	M, C or O	Location
firstName	A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.	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.	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.	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

Resource Preferences Continued

The Ed-Fi Configuration tool is used to establish Ed-Fi data resources.

The following describes how to enable the Students resource for Ed-Fi reporting. If the Configure or Edit buttons do not display, then the resource does not need to be mapped and the toggle button can be used to turn the resource on or off.

1. Indicate if the resource should report Legal Identities.

2. Click Save.

MN v3.3 - Students