Parents (Wisconsin v3.6)

Tool Search: Ed-Fi

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

If the 'Does your LEA want to 'opt-in' to send records for both Parents and Student Parent Association Resources for all students?' checkbox is marked on the Parents resource preferences, then Parents records for all students will report based on existing reporting/trigger log.

If the checkbox is not marked, then Parents records for students with an active FRAM Eligibility record with Type = Meal or SES for the current/reporting school year and eligibility is = Free or Reduced will report.

A record is considered active when the FRAM end date is greater than or equal to the last instructional date on the calendar
Follow all other reporting logic.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

Action	Trigger
Post	When the Guardian check box is checked AND 1 person is a student and 1 person is not a student. The 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. A record will not send if the student they are associated with has an enrollment marked as a no show, state exclude or enrollment is in a calendar or school marked as Exclude.
Put	A record will be updated when any of the following are changed and saved: When the person’s identity record is changed. When one of the person’s household locations is changed. When one of the person’s household memberships is changed. When one of the person’s relationships that is marked Guardian is changed. When the contact information has 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 will no longer have authorization to see the parent record.

Action

Trigger

Post

When the Guardian check box is checked AND 1 person is a student and 1 person is not a student.

The 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.
A record will not send if the student they are associated with has an enrollment marked as a no show, state exclude or enrollment is in a calendar or school marked as Exclude.

Put

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

When the person’s identity record is changed.
When one of the person’s household locations is changed.
When one of the person’s household memberships is changed.
When one of the person’s relationships that is marked Guardian is changed.
When the contact information has 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 will no longer have authorization to see the parent record.

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	Trigger
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.
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 will be deleted from the ODS.
Resync	If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes.

Natural Key Changes, Cascading Updates, and Deletes Logic

This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.

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

Scope Year Logic

This table describes scope year logic of this object.

Business Rules
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.

Business Rules

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

This table describes the Identity Mapping Object Key of this object.

campusObjectType	Object Key Data Source
Person	personID

Event Queue Detail

This table describes the Event Queue Detail of this object.

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

This table describes data elements sent within the Parents 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
parentUniqueId	A unique alpha-numeric code assigned to a parent.	Report the Ed-Fi LEA ID + '-'+personID.	M		person.edfiid
addresses	Report the person's address(s).	Report the Primary addresses that are marked as "Mailing" or "Physical". If more than 1 Primary Address marked as Mailing, report address with most recent Household Membership Start Date. Else, report the address with most recent Address Start Date. Do not report if the Address Location Detail or Household Membership is marked as "Private" or "Secondary". If multiple primary addresses exist and 1 is marked Physical, report a second address with an addressTypeDescriptor of "Home". Note: Only 1 of each address type may be reported. If only 1 address exists and only Mailing or Physical are checked, report 2 records - 1 with an addressType = Home and the 2nd record with same address with addressType = Mailing . If "Secondary" is checked, do not report address. See Array section for data logic for each field.	M	Household Addresses> Mailing	HouseholdLocation. mailing
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
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
generationCode Suffix	An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).	Report the Suffix from the person's current identity record.	C	Census>People> Identities> Suffix	identity.suffix
international Addresses	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.	See Array section for data logic for each field.	M	Census > People > Identities > Native Language	Identity.languageAlt
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
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.	Report 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
personalidentification Documents	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.	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
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. do not report Phone Number is 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
_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

Any leading and trailing white spaces are removed when reporting this information

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI Path	Database Field
addressTypeDescriptor	Key for Address	All addresses will report as 'Home' or 'Mailing'.	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, do not report.	O
doNotPublishIndicator	An indication that the address should not be published.	Reports 'True' if the Private checkbox is checked on the address being reported. Else, report 'False'.	O
latitude	The geographic latitude of the physical address.	This is optional, do not report.	O
longitude	The geographic longitude of the physical address.	This is optional, do not report.	O
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
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 address Type Descriptor = 'Home', do not report if PO Box is checked If PO Box is not checked, send address If addressType Descriptor = 'Mailing', send PO Box If both Mailing and Physical are checked for the Address Location Detail: Only send PO Box for 'Mailing' Do not send PO Box for 'Physical'	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, do 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, do not report.	O

Languages

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI Path	Database Field
languageDescriptor	A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.	Report the Language from the Native Language saved on the parent's current identity record. Look for a mapping saved to the Language 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 language Code matches an Ed-Fi code, if yes report that value. Else, report NULL.	M	Census > People > Identities > Native Language	Identity.languageAlt

Parent Electronic Mail

Data Element Label	Business Requirement	Business Rules	M, C or O	Data Source GUI Path	Database Field
electronicMailTypeDescriptor	Key for ElectronicMail.	The Primary Email address will report as "Home/Personal". The Secondary Email address will report as "Work".	M
doNotPublishIndicator	An indication that the electronic email address should not be published.	This is optional, do 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, do not report.	O

Parent Telephone

Data Element Label

Business Requirement

Business Rules

M,C or O

Data Source GUI Path

Database Field

telephoneNumberTypeDescriptor

Key for Telephone Number.

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

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.

Reports 'True' if the Private checkbox is checked on the address being reported
Else, report 'False'.

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