Classic View: System Administration > Ed-Fi
Search Terms: Ed-Fi
Provide a summary of what the report/function will cover and the logistics around the data collection or reporting.
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 | 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
|
Delete | Cascading Deletes: The following resources will be deleted and resent if the Ed-Fi ID is changed.
|
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.
|
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 |
visaDescriptor | Visa Type Descriptor | identity.visatype |
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 | M, C, or 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> EdFi 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. |
| 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. | This is optional, does not report. | O | Census > People > Identities > Gender | 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., | Report the State from the Birth State saved on the student's current identity record.
| O | Census > People > Demographics > Birth State | identity. birthstate |
citizenshipStatus Descriptor | 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. |
| O | Census > People > Identities > Date Entered US | identity. dateEntered US |
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,
| 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.
| 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,
| 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. |
| O | Census > People > Identities > Legal Middle Name OR Census > People > Identities > Middle Name | identity. legalMiddle Name OR identity. middleName |
multipleBirthStatus | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.) | Report from the current identity record,
| O | Census > People > Identities | identity. multipleBirth |
otherNames | Other names (e.g., alias, nickname, previous legal name) associated with a person. | This is optional, does not report. | O | Census > People > Identities | |
personalIdentification Documents | 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. Only required when a Student has a 'Visa' Required for foreign exchange students. Pass visaDescriptor(string) in the array. |
| C | Census > People > Identity > Visa Type | identity. visaType |
_etag | A unique system-generated value that identifies the version of the resource. | O |
Array Data Elements
This table describes the array data elements for the Visas element:
Data Element Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
---|---|---|---|---|---|
visaType | Indicates the visa type. | Report the Ed-Fi value for the visa type. | Census > People > Identity | identity.visaType |