Parents (Texas v4.0)

Tool Search: Ed-Fi

This entity represents a parent or guardian of a student, such as mother, father or caretaker.

Object Triggering Logic

Action	Trigger
Post	When the Guardian checkbox is marked and one person is a student and one person is not a student. Guardian does not have to be a member of the same household as the student to report. Start date must be on or before today's date. End date must be on or after today's date. Person must have an Ed-Fi ID to send. A record does not send if the student with whom they are associated has an enrollment marked as a no show, state exclude, or enrollment is in a calendar or school marked as Exclude.
Put	A record is updated when any of the following are changed and saved: Person’s identity record is changed. One of the person’s household locations is changed. One of the person’s household memberships is changed. One of the person’s relationships that is marked Guardian is changed. Contact information is changed: phone or email.
Delete	N/A - A Parent record is a shared resource among all districts in the state and cannot be deleted. When the Student Parent Association is removed, the district no longer has authorization to see the parent record.

Action

Trigger

Post

When the Guardian checkbox is marked and one person is a student and one person is not a student.

Guardian does not have to be a member of the same household as the student to report.
Start date must be on or before today's date.
End date must be on or after today's date.
Person must have an Ed-Fi ID to send.
A record does not send if the student with whom they are associated has an enrollment marked as a no show, state exclude, or enrollment is in a calendar or school marked as Exclude.

Put

A record is updated when any of the following are changed and saved:

Person’s identity record is changed.
One of the person’s household locations is changed.
One of the person’s household memberships is changed.
One of the person’s relationships that is marked Guardian is changed.
Contact information is changed: phone or email.

Delete

N/A - A Parent record is a shared resource among all districts in the state and cannot be deleted. When the Student Parent Association is removed, the district no longer has authorization to see the parent record.

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

Action	Trigger
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 a record is in the Ed-Fi Identity Mapping table and not in the ODS, it is deleted from the Ed-Fi Identity Mapping table.
Resync	If a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it is deleted from the ODS.
Resync	If a mapping is changed in Resource Preferences, a resync needs to be done to reflect the changes.

Natural Key Changes, Cascading Updates, and Deletes Logic

Action	Trigger
Delete/Post	Cascading Deletes: The logic for an Ed-FI ID change updates all resources impacted by this change.

Scope Year Logic

Business Rules
A parent record reports when they are a guardian to a student with an enrollment aligned to a scoped year. The related pair start date must be null or on/before the scope year end date to report. The related pair end date must be null or on/after the scope year end date to report. Data only sends for the years that have valid configuration. A resync must be completed on the Parents resource when a new scope year is connected in order for this data to send.
When using data in Campus that has an effective date, the following logic is be applied to determine the scope year(s) to which to report the data. Current Year: Records will be compared to today's date to determine if the record is eligible to report. 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) to which to report the data. Current Year: The records start date must be on or before today's date and the records end date must be on or after today's date. 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.

Business Rules

A parent record reports when they are a guardian to a student with an enrollment aligned to a scoped year.

The related pair start date must be null or on/before the scope year end date to report.
The related pair end date must be null or on/after the scope year end date to report.
Data only sends for the years that have valid configuration.
A resync must be completed on the Parents resource when a new scope year is connected in order for this data to send.

When using data in Campus that has an effective date, the following logic is be applied to determine the scope year(s) to which to report the data.

Current Year: Records will be compared to today's date to determine if the record is eligible to report.
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) to which to report the data.

Current Year: The records start date must be on or before today's date and the records end date must be on or after today's date.
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.

Identity Mapping Object Key

campusObjectType	Object Key Data Source
Person	personID

Event Queue Detail

Campus Table	Ed-Fi Action	Fields
relatedPair	Post/Put/Delete	The primary table used for sending data for this resource.
household	Put	Addresses
contact	Put	Email, Telephone
identity	Put	First Name, Last Name, Middle Name Suffix, Gender

Object Data Elements

Click here to expand...

Data Element Label	Business Requirement	Logic	M, C or O	Location
id	The unique identifier of the resource.		M
parentUniqueId	A unique alpha-numeric code assigned to a parent.	Reports State District Number + personID	M	System Administration > Resources > District
addresses	Report the person's address(s).	Reports the Primary address that is marked as 'Mailing' If more than 1 Primary Address is marked as Mailing, reports address with most recent Household Membership Start Date. Otherwise, reports the address with most recent Address Start Date. See Scope Year logic to determine the eligibility of records. See Array section for data logic for each field.	O	Household Addresses > Mailing Household Membership > Start Date Household Addresses > Start Date HouseholdLocation.mailing HouseholdMember.startDate Householdlocation.StartDate
electronicMails	The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.	Reports the email address entered for that person Does not report if Email is marked as 'Private'. If blank, does not report. See Array section for data logic for each field.	O	Census > People > Demographics > Email contact.email
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 person'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).	Does not report.	C	Census > People > Identities > First Name identity.suffix
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
internationalAddresses	An unordered collection of parentInternationalAddresses. This entity represents a parent or guardian of a student, such as mother, father or caretaker.	This field is optional. Does not report.	O
languages	The language(s) the individual uses to communicate.	This field is optional. Does not report.
lastSurname	The name borne in common by members of a family. NEDM Last Name/Surname.	Reports the last name from the person's current identity record.	M	Census > People > Identities > Last Name identity.lastName
loginId	The login ID for the user; used for security access control interface.	This field is optional. Does not report.	O
maidenName	The person's maiden name, if applicable.	This field is optional. Does not report.	O
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 person's current identity record.	O	Census > People > Identities > Middle Name identity.middleName
otherNames	An unordered collection of parentOtherNames. This entity represents a parent or guardian of a student, such as mother, father or caretaker.	This field is optional. Does not report.	O
personalidentificationDocuments	An unordered collection of parentIdentificationDocuments. This entity represents a parent or guardian of a student, such as mother, father or caretaker.	This field is optional. Does not report.	O
personalTitlePrefix	A prefix used to denote the title, degree, position or seniority of the person.	This field is optional. Does not report.	O
sexDescriptor	A person's gender.	This field is optional. Does not report.	O	Census > People > Identities > Gender identity.Gender
telephones	An unordered collection of parentTelephones. This entity represents a parent or guardian of a student, such as mother, father or caretaker.	Reports the Phone numbers entered in the Personal Contact Information for that person. Does not report Phone Number if marked as 'Private'. If blank, does not report. See Scope Year logic to determine the eligibility of records. See Array section for data logic for each field.	O	Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager contact.homephone contact. workphone contact.cellphone contact.pager
HighestCompletedLevelOfEducation		Does not report.
_etag	A unique system-generated value that identifies the version of the resource.		O

Array Data Elements

Click here to expand...

Addresses

Data Element Label	Business Requirement	Business Rules	M, C or O	Location
addressTypeDescriptor	Key for Address	All addresses will report as 'Home'.	M
localeDescriptor	A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban).	This is optional, does not report.	O
stateAbbreviationDescriptor	The abbreviation for the state (within the United States) or outlying area in which an address is located.	Reports the State for the address being reported.	M	Households > Address Info > State address.state
apartmentRoomSuiteNumber	The apartment, room, or suite number of an address.	Reports the value entered in Apt field if populated.	O	Households > Address Info > Apt address.apt
buildingSiteNumber	The number of the building on the site, if more than one building shares the same address.	This is optional, does not report.	O
city	The name of the city in which an address is located.	Reports the City for the address being reported.	M	Households > Address Info > City address.city
congressionalDistrict	The congressional district in which an address is located.	This is optional, does not report.	O
countyFIPSCode	5 digit code consisting of the two digit state code followed by the three digit FIPS code for the county.	This is optional, does not report.	O
doNotPublishIndicator	An indication that the address should not be published.	This is optional, does not report.	O	Households > Address Info > Private householdlocation.private
latitude	The geographic latitude of the physical address.	This is optional, does not report.	O
longitude	The geographic longitude of the physical address.	This is optional, does not report.	O
nameOfCounty	The name of the county, parish, borough, or comparable unit (within a state) in which an address is located.	This is optional, does not report.	O	Households > Address Info > County address.county
postalCode	The five or nine digit zip code portion of an address.	Reports the Zip Code for the address being reported.	M	Households > Address Info > Zip Code address.zip
streetNumberName	The street number and street name or post office box number of an address.	Reports Address PO Box + Number + Street + Tag + Prefix + Dir. If the PO Box is checked, add 'PO Box' in front of the Number being reported.	M	Households >Address Info address.postOfficeBox address.number address.street address.tag address.prefix address.dir
beginDate	The first date the address is valid. For physical addresses, the date the person moved to that address.	This is optional, does not report.	O
endDate	The last date the address is valid. For physical addresses, this would be the date the person moved from that address.	This is optional, does not report.	O

Parent Electronic Mail

Data Element Label	Business Requirement	Business Rules	M, C or O	Location
electronicMailTypeDescriptor	Key for ElectronicMail.	The Primary Email address reports as "Home/Personal". The Secondary Email address reports as "Work".	M
doNotPublishIndicator	An indication that the electronic email address should not be published.	This is optional, does not report.	O
electronicMailAddress	The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.	Reports the email address entered for that person.	M	Census > People > Demographics > Email contact.email
primaryEmailAddressIndicator	An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization.	This is optional, does not report.	O

Parent Telephone

Data Element Label

Business Requirement

Business Rules

M,C or O

Location

telephoneNumberTypeDescriptor

Key for Telephone Number.

Reports based on the Phone Number type entered in Campus based on the chart below:

Campus Phone	Ed-Fi Code
Cell Phone	Mobile
Other Phone	Home
Work Phone	Work
Pager	Other

doNotPublishIndicator

An indication that the telephone number should not be published.

This is optional, does not report.

orderOfPriority

The order of priority assigned to telephone numbers to define which number to attempt first, second, etc.

This is optional, does not report.

telephoneNumber

The 10-digit telephone number, including the area code, for the person.

Reports the Phone numbers entered in the Personal Contact Information for that person.
If blank, does not report.

Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager

textMessageCapabilityIndicator

An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages.

This is optional, does not report.

Type/Descriptor

Click here to expand...

Address Type Descriptor

Code Value	Description	Namespace	Short Description
Billing	Billing	uri://ed-fi.org/AddressTypeDescriptor	Billing
Doubled - up (i.e., living with another family)	Doubled - up (i.e., living with another family)	uri://ed-fi.org/AddressTypeDescriptor	Doubled - up (i.e., living with another family)
Father Address	Father Address	uri://ed-fi.org/AddressTypeDescriptor	Father Address
Guardian Address	Guardian Address	uri://ed-fi.org/AddressTypeDescriptor	Guardian Address
Home	Home	uri://ed-fi.org/AddressTypeDescriptor	Home
Hotels/Motels	Hotels/Motels	uri://ed-fi.org/AddressTypeDescriptor	Hotels/Motels
Mailing	Mailing	uri://ed-fi.org/AddressTypeDescriptor	Mailing
Mother Address	Mother Address	uri://ed-fi.org/AddressTypeDescriptor	Mother Address
Other	Other	uri://ed-fi.org/AddressTypeDescriptor	Other
Physical	Physical	uri://ed-fi.org/AddressTypeDescriptor	Physical
Shelter, Transitional housing, Awaiting Foster	Shelters, Transitional housing, Awaiting Foster Care	uri://ed-fi.org/AddressTypeDescriptor	Shelters, Transitional housing, Awaiting Foster Care
Shipping	Shipping	uri://ed-fi.org/AddressTypeDescriptor	Shipping
Temporary	Temporary	uri://ed-fi.org/AddressTypeDescriptor	Temporary
Unsheltered	Unsheltered (e.g. cars, parks, campgrounds, temporary trailers including FEMA trailers, or abandoned buildings)	uri://ed-fi.org/AddressTypeDescriptor	Unsheltered (cars, parks, temporary trailers, or abandoned buildings)
Work	Work	uri://ed-fi.org/AddressTypeDescriptor	Work

Electronic Mail Type Descriptors

Code Value	Description	Namespace	Short Description
Home/Personal	Home/Personal	uri://ed-fi.org/ElectronicMailTypeDescriptor	Home/Personal
Organization	Organization	uri://ed-fi.org/ElectronicMailTypeDescriptor	Organization
Other	Other	uri://ed-fi.org/ElectronicMailTypeDescriptor	Other
Work	Work	uri://ed-fi.org/ElectronicMailTypeDescriptor	Work

Telephone Type Descriptors

Code Value	Description	Namespace	Short Description
Emergency 1	Emergency 1	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Emergency 1
Emergency 2	Emergency 2	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Emergency 2
Fax	Fax	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Fax
Home	Home	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Home
Mobile	Mobile	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Mobile
Other	Other	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Other
Unlisted	Unlisted	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Unlisted
Work	Work	uri://ed-fi.org/TelephoneNumberTypeDescriptor	Work

Object Triggering Logic

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

Natural Key Changes, Cascading Updates, and Deletes Logic

Scope Year Logic

Identity Mapping Object Key

Event Queue Detail

Object Data Elements

Array Data Elements

Addresses

Parent Electronic Mail

Parent Telephone

Type/Descriptor

Address Type Descriptor

Electronic Mail Type Descriptors

Telephone Type Descriptors

Related Articles