Student Parent Associations (New Mexico v3.5)

Tool Search: Ed-Fi

This association relates students to their parents, guardians or caretakers.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

ActionTrigger
Post

When the Guardian check box is checked on the Relationships tab.

  • The guardian does NOT have to be a member of the same household as the student to report.
  • Ed-Fi does not have relationship start or end dates, if a relationship is started anytime within a school year, the record will be added for that year.
    • Start Date must be blank or on or before school year end date defined in the School Years editor.
    • End Date must be blank or within the current school year
  • Report the person from the related pair that does not have an enrollment for the Parent Reference and the person that has an enrollment as the student reference.

  • A record will not send if the student they are associated with has an enrollment in a calendar or school marked as Exclude.
  • A record will not send if the student they are associated with has an enrollment in a calendar or school marked as Summer School.

  • A record will not send if the student they are associated with has an enrollment marked 'No Show'.

  • A record will not send if the student they are associated with has an enrollment in an excluded grade level.

Put

When any field not part of the natural key is change:

  • Relationship
  • Emergency Contact Status
  • If the parent or student is removed from the household
Delete

When the Guardian check box is unchecked, relationship is end dated or deleted.

  • Ed-Fi does not have relationship start or end dates, if a relationship is ended within a school year, the record will be deleted for that year. 
    • End Date must be blank or after school year end date defined in the School Years editor.
Delete

Records will delete when a student has only one Student School Association record for a specific School and Year that record is deleted.

(Note: If a new Student School Association record is created, existing records will not re-post, a resync must be completed to resend the data).

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.

ActionTrigger
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
ResyncIf 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.
ResyncIf 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.
ResyncIf 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.

ActionTrigger
Delete/PostCascading 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: 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.

Resource Preferences

This table describes the Resource Preferences of this object.

Data Element Label

Mapping Needed

Relationship DescriptorRelation Types


Identity Mapping Object Key

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

campusObjectTypeObject Key Data Source
RelatedPairpersonID1-personID2 (personID1 is student, personID2 is parent)


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
relatedPairPost/Put/DeleteThe primary table used for sending data for this resource.


Object Data Elements

This table describes data elements sent within the Student Parent Parent Association resource.

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI Path

Database Field

id

The unique identifier of the resource.

 

M 

 

parentReferenceA reference to the related Parent resource.
  1. Report the reference from the Parent record for the parent being reported
  2. Parent Unique ID
    • Use DistrictID + PersonID
      • EX: 350017754
        1. 35001 = Ed-Fi Reported District ID
        2. 7754 = The personID of the parent.


M  
studentReferenceA reference to the related Student resource.

Report the reference from the Student record for the student being reported.


M  
contactPriorityThe numeric order of the preferred sequence or priority of contact.

Do not report, not collected in Campus.

O  
contactRestrictionsRestrictions for student and/or teacher contact with the individual (e.g., the student may not be picked up by the individual).

Do not report, not collected in Campus.

O  
emergencyContactStatus  Indicator of whether the person is a designated emergency contact for the student.
  1. Report True if there is a number entered in the Emergency Priority field for the parent being reported.
  2. Else, report False.
OCensus> People> Relationships> Emergency Priority relatedpair.seq
livesWithIndicator of whether the student lives with the associated parent.
  1. Report True if student is in the same household of the parent being reported
    • Both Student and Parent Household dates must follow Business Rule S2 in the Scope year logic for this to report.
  2. Else, report False.
OCensus> People> Households 
 primaryContactStatus Indicator of whether the person is a primary parental contact for the student.
  1. Report True if there is only 1 guardian being reported.
    • If more than 1 guardian report the guardian with the earliest start date.
    • If Start dates are the same or NULL on 1 or more guardians, report the person with the lowest personID.
  2. Else, report False.
O
Census> People> Relationships> Guardian relatedpair.guardian
 relationDescriptorThe nature of an individual''s relationship to a student; for example: Father Mother Step Father Step Mother Foster Father Foster Mother Guardia. 
  1. Report the Ed-Fi Code from the Ed-Fi Relation Type field that is mapped.
  2. If no mapping, do not report.
OCensus> People> Relationships> Relationshiprelatedpair.name
etagA unique system-generated value that identifies the version of the resource. O  


Type/Descriptor

Click here to expand...

Relationship Descriptors

Code ValueDescriptionNamespaceShort Description
AuntAunturi://ed-fi.org/RelationDescriptorAunt
BrotherBrotheruri://ed-fi.org/RelationDescriptorBrother
BrotherInLawBrotherInLawuri://ed-fi.org/RelationDescriptorBrotherInLaw
CourtAppointedGuardianCourtAppointedGuardianuri://ed-fi.org/RelationDescriptorCourtAppointedGuardian
CousinCousinuri://ed-fi.org/RelationDescriptorCousin
DaughterDaughteruri://ed-fi.org/RelationDescriptorDaughter
DaughterInLawDaughterInLawuri://ed-fi.org/RelationDescriptorDaughterInLaw
EmergencyEmergencyuri://ed-fi.org/RelationDescriptorEmergency
EmployerEmployeruri://ed-fi.org/RelationDescriptorEmployer
FatherFatheruri://ed-fi.org/RelationDescriptorFather
Father, stepFather, stepuri://ed-fi.org/RelationDescriptorFather, step
FatherInLawFatherInLawuri://ed-fi.org/RelationDescriptorFatherInLaw
FathersCivilPartnerFathersCivilPartneruri://ed-fi.org/RelationDescriptorFathersCivilPartner
FathersSignificantOtherFathersSignificantOtheruri://ed-fi.org/RelationDescriptorFathersSignificantOther
FianceFianceuri://ed-fi.org/RelationDescriptorFiance
FianceeFianceeuri://ed-fi.org/RelationDescriptorFiancee
Foster parentFoster parenturi://ed-fi.org/RelationDescriptorFoster parent
FriendFrienduri://ed-fi.org/RelationDescriptorFriend
GodparentGodparenturi://ed-fi.org/RelationDescriptorGodparent
GrandfatherGrandfatheruri://ed-fi.org/RelationDescriptorGrandfather
GrandmotherGrandmotheruri://ed-fi.org/RelationDescriptorGrandmother
GrandparentGrandparenturi://ed-fi.org/RelationDescriptorGrandparent
Great auntGreat aunturi://ed-fi.org/RelationDescriptorGreat aunt
Great GrandparentGreat Grandparenturi://ed-fi.org/RelationDescriptorGreat Grandparent
Great uncleGreat uncleuri://ed-fi.org/RelationDescriptorGreat uncle
GuardianGuardianuri://ed-fi.org/RelationDescriptorGuardian
HusbandHusbanduri://ed-fi.org/RelationDescriptorHusband
MotherMotheruri://ed-fi.org/RelationDescriptorMother
Mother, stepMother, stepuri://ed-fi.org/RelationDescriptorMother, step
MotherInLawMotherInLawuri://ed-fi.org/RelationDescriptorMotherInLaw
MothersCivilPartnerMothersCivilPartneruri://ed-fi.org/RelationDescriptorMothersCivilPartner
MothersSignificantOtherMothersSignificantOtheruri://ed-fi.org/RelationDescriptorMothersSignificantOther
NeighborNeighboruri://ed-fi.org/RelationDescriptorNeighbor
NephewNephewuri://ed-fi.org/RelationDescriptorNephew
NieceNieceuri://ed-fi.org/RelationDescriptorNiece
OtherOtheruri://ed-fi.org/RelationDescriptorOther
ParentParenturi://ed-fi.org/RelationDescriptorParent
Parent, stepParent, stepuri://ed-fi.org/RelationDescriptorParent, step
RelativeRelativeuri://ed-fi.org/RelationDescriptorRelative
SiblingSiblinguri://ed-fi.org/RelationDescriptorSibling
SignificantOtherSignificantOtheruri://ed-fi.org/RelationDescriptorSignificantOther
SisterSisteruri://ed-fi.org/RelationDescriptorSister
SisterInLawSisterInLawuri://ed-fi.org/RelationDescriptorSisterInLaw
SonSonuri://ed-fi.org/RelationDescriptorSon
SonInLawSonInLawuri://ed-fi.org/RelationDescriptorSonInLaw
SpouseSpouseuri://ed-fi.org/RelationDescriptorSpouse
UncleUncleuri://ed-fi.org/RelationDescriptorUncle
UnknownUnknownuri://ed-fi.org/RelationDescriptorUnknown
WardWarduri://ed-fi.org/RelationDescriptorWard
WifeWifeuri://ed-fi.org/RelationDescriptorWife