Prior Year Leaver Parent (Texas v4.0)

Last Modified on 11/18/2024 10:41 am CST

Tool Search Term: Ed-Fi

Object Triggering Logic

Action	Trigger
POST	Reports Guardians of students in Grades 07-12 from prior year calendars that have exited the district and do not have an enrollment in the current year. Prior year is determined by the Ed-Fi configuration year. Student's prior year enrollment must have an End Date and End Status = NOT NULL. If more than one prior year enrollment exists use the most recent to determine if student has exited. Do not send records if the Calendar Exclude checkbox is marked in the calendar the student is enrolled. Do not send records if the School Exclude checkbox is marked in the calendar the student is enrolled. Do not send a record if the State Exclude or No Show checkbox is marked on the enrollment.
PUT	When any field not part of the natural key is changed.
DELETE	Prior year enrollment's End Status or End Date is removed. An enrollment is created in the current year for the student.

Resource Toggle/Resync

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 a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table 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 will be deleted from the ODS. If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes.

Natural Key Changes/Cascading Updates, Deletes

Action	Business Rule
DELETE / POST	Cascading Deletes: The logic for an Ed-FI ID change will update all resources impacted by this change.

Scope Year

Logic
A parent record will report 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 will only send 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 will be applied to determine the scope year(s) to report the data to. 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 report the data to. 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.

Logic

A parent record will report 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 will only send 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 will be applied to determine the scope year(s) to report the data to.

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 report the data to.

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

Campus Object Type	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

Data Element Labels in bold are part of the Natural Key and are required elements for data to send to Ed-Fi.

Click here to expand...

DE#	Data Element Label	Business Requirement	Logic	M, C, or O	Location
DE100	id	The unique identifier of the resource.		M
DE200	parentUniqueId	A unique alpha-numeric code assigned to a parent.	Report Parent Unique State ID.	M	Census > People > Demographics > Parent Unique State ID person.additionalID
DE300	addresses	Report the person's address(s).	Reports the Primary address that is marked as "Mailing". If more than one Primary Address is marked as Mailing, report address with most recent Household Membership Start Date Otherwise, report the address with most recent Address Start Date See Business Rule S3 in 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
DE400	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 Do 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
DE500	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 person's current identity record	M	Census > People > Identities > First Name identity.firstName
DE600	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 > Suffix identity.suffix
TX100	generationCode Descriptor	identifies the generation suffix, if any, which the person attaches to his name (e.g., Jr., Sr., III)	Report mapped Ed-Fi Code of Suffix.	O	Census > People > Demographics identity.suffix
DE900	lastSurname	The name borne in common by members of a family. NEDM Last Name/Surname	Report the last name from the person's current identity record	M	Census > People > Identities > Last Name identity.lastName
DE1100	maidenName	The person's maiden name, if applicable.	This field is optional, does not report.	O
DE1200	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 person's current identity record	O	Census > People > Identities > Middle Name identity.middleName
DE1400	personalidentification Documents	An unordered collection of parentIdentification Documents. This entity represents a parent or guardian of a student, such as mother, father or caretaker.	This field is optional, does not report.	O
DE1500	personalTitlePrefix	A prefix used to denote the title, degree, position or seniority of the person.	This field is optional, does not report.	O
DE1600	sexDescriptor	A person's gender.	Report the Gender from the Person's current identity record This is NOT legal gender. Report the following based on the value selected in the droplist Female report 'Female'. Male report 'Male'. If blank or Non-binary, report 'Not Selected'.	O	Census > People > Identities > Gender identity.Gender
DE1700	telephone	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 Business Rule S3 in 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
DE1800	_etag	A unique system-generated value that identifies the version of the resource	This field is optional, does not report.	O

Array Data Elements

Click here to expand...

Addresses

#	Data Element Label	Business Requirement	Business Rules	M, C or O	Location
AE10	addressTypeDescriptor	Key for Address	All addresses will report as 'Home'.	M
AE20	localeDescriptor	A general geographic indicator that categorizes U.S. territory (e.g., City, Suburban)	This is optional, does not report.	O
AE30	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
AE40	apartmentRoomSuite Number	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
AE50	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
AE60	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
AE70	congressionalDistrict	The congressional district in which an address is located.	This is optional, does not report.	O
AE80	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
AE90	doNotPublishIndicator	An indication that the address should not be published.	Reports 'True' if the Private checkbox is checked on the address being reported Otherwise, report 'False'.	O	Households > Address Info > Private householdlocation.private
AE100	latitude	The geographic latitude of the physical address.	This is optional, does not report.	O
AE110	longitude	The geographic longitude of the physical address.	This is optional, does not report.	O
AE120	nameOfCounty	The name of the county, parish, borough, or comparable unit (within a state) in which an address is located.	Reports the County for the addressing being reported.	O	Households > Address Info > County address.county
AE130	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
AE140	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
Periods Array	beginDate	The first date the address is valid. For physical addresses, the date the person moved to that address.	This is optional, do not report.	O
Periods Array	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, do not report.	O

Parent Electronic Mail

DE#	Data Element Label	Business Requirement	Logic		Location
AE150	electronicMailTypeDescriptor	Key for ElectronicMail	The Primary Email address will report as "Home/Personal". The Secondary Email address will report as "Work".	M
AE160	doNotPublishIndicator	An indication that the electronic email address should not be published.	This is optional, do not report.	O
AE170	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
AE180	primaryEmailAddress Indicator	An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization.	This is optional, do not report.	O

Parent Telephone

DE#

Data Element Label

Business Requirement

Logic

M, C, or O

Location

AE190

telephoneNumberType
Descriptor

Key for TelephoneNumber.

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

AE200

doNotPublishIndicator

An indication that the telephone number should

not be published.

This is optional, does not report.

AE210

orderOfPriority

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

This is optional, does not report.

AE220

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

AE230

textMessageCapability
Indicator

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/Descriptors

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

Was this helpful?

Prior Year Leaver Parent (Texas v4.0)

Object Triggering Logic

Resource Toggle/Resync

Natural Key Changes/Cascading Updates, Deletes

Scope Year

Identity Mapping Object Key

Event Queue Detail

Object Data Elements

Array Data Elements

Addresses

Parent Electronic Mail

Parent Telephone

Type/Descriptors

Address Type Descriptor

Related Articles