SIS Integrations

EnrolHQ to Compass

Powerful Integration Between EnrolHQ and Compass

The EnrolHQ-Compass integration leverages Compass’ new Enrolments Import API and was officially released into production in December 2024. Designed for seamless data transfer, this integration simplifies the process of moving key student and parent information from EnrolHQ to Compass.

Key Points Regarding the Integration:

One-Way Data Push

  • This integration currently supports a one-way push of data from EnrolHQ to Compass.
  • Documents cannot be transferred from EnrolHQ to Compass in the current version.
  • Student and parent records cannot be transferred from Compass back to EnrolHQ. Schools will need to export the data from Compass into a CSV and import into EnrolHQ.

Optimal Timing for Data Transfer

The integration is best suited for transferring student data close to the end of the calendar year before they commence school.

Data Destination in Compass

EnrolHQ students are imported directly into the “People Management” section of Compass.

A detailed log of all imports is available in Compass under “Administration Tools > Import Management”.

ImportJobs-Compass

Future Student Tagging

Imported students are marked as “future students” in Compass because their commencement date is set to a future date.

Parent-Student Relationships

Parents are also imported, and the integration establishes relationships between the imported students and their parents.

Imported Data

Student Data

The following student details are imported from EnrolHQ into Compass:

  1. Name: First, Middle, and Last Name
  2. Date of Birth
  3. Gender
  4. Residential Address and “Living Amount”
  5. Year Level and Commencement Date
  6. Demographic Data including Country of Birth, Nationality and ATSI status
  7. Religion data is imported
  8. Medical Data is imported

Parent Data

The following parent details are imported:

  1. Name: First, Middle, and Last Name
  2. Gender
  3. Address and Contact Details (mobile and email)
  4. Demographic Details:
  5. Country of Birth
  6. Nationality
  7. Privacy Settings including Email/SMS Preferences and Communication Preferences
  8. Occupation Details

Duplicate Management in Compass

To ensure that duplicate records are not created, Compass uses a sophisticated points-based system to manage duplicate detection during the import process.

Student Matching Criteria

A total of 15 points is required for a student match.

Points Breakdown:

  1. First Name: +3 points, -3 points if not matching
  2. Preferred Name: +3 points
  3. Middle Name: +3 points
  4. Last Name: +3 points, -1 point if not matching
  5. Date of Birth: +4 points
  6. Gender: +2 points, -2 points if not matching
  7. Govt Code1: +6 points, -1 point if not matching
  8. Mobile Phone: +6 points

Parent Matching Criteria

A total of 16 points is required for a parent match.

Points Breakdown:

  1. First Name: +3 points, -3 points if not matching
  2. Preferred Name: +3 points
  3. Middle Name: +3 points
  4. Last Name: +3 points, -3 points if not matching
  5. Date of Birth: +3 points
  6. Gender: +2 points, -3 points if not matching
  7. Mobile Phone: +2 points
  8. Home Phone: +2 points
  9. Email Address: +6 points

By utilising this comprehensive matching algorithm, Compass ensures accurate and clean data imports, avoiding duplicate entries during the one-time push from EnrolHQ.

Summary

The EnrolHQ-Compass integration streamlines the enrolment data transfer process by efficiently importing detailed student and parent information into Compass. Although currently limited to a one-way data flow, this integration provides a reliable solution for managing future students and their associated records, ensuring accuracy through Compass’ duplicate management system.

EnrolHQ to Compass Field Mapping

This document outlines the field mapping between EnrolHQ and Compass student information systems based on the provided code repository and sample data.

Student Information

EnrolHQ Field Compass Field Notes
first_name firstName Student's first name
middle_name middleName Student's middle name (if available)
last_name lastName Student's last name
preferred_name preferredFirstName Student's preferred first name
dob dateOfBirth Date of birth in format YYYY-MM-DD
enrolhq_id govtCode1 Student's EnrolHQ unique identifier
external_id (generated if not provided) externalCode External code for student (generated if not provided)
entry_grade yearLevelCode Mapped through YearLevelLookup to Compass-specific codes
gender (numerical code) gender 1 for Male, 2 for Female, 0 for Not Specified
aboriginal_statuses indigenousType Aboriginal/Torres Strait Islander status
born_country (object) birthCountry Country of birth (name field from object)
visa_expiry_date visaExpiryDate Date visa expires (if applicable)
is_speak_other_language + home_language personLanguages Languages spoken by student
is_speak_other_language languageBackgroundOtherThanEnglish Boolean indicating non-English language background
special_needs from abilities section disability Boolean indicating if student has disabilities
religion religion Student's religion
visa_subclass visaSubclass Visa subclass number (if applicable)
residency_status residentialStatus 1: Permanent, 2: Temporary, 3: Citizen
mobile_phone phoneMobile Student's mobile phone number
home_phone phoneHome Student's home phone number
nationalities (array of objects) nationality First nationality from the array (name field)
house groupC House assignment, maps to Compass groupC field
medical_data.is_ambulance_fund_subscription ambulanceSubscriber Boolean indicating ambulance subscription
is_assistance_with_english_literacy_required requiresEslAssistance English as Second Language assistance required
attendance_type studentDetailsBoarderTypeString Day Student: "None", Boarder: "Full Time"
current_school (object) schoolHistory Previous school information
campus campusStatuses Assigned campus with time allocation
visa_arrival_date arrivedInCountryTimestamp Date of arrival in the country
medical_data.doctor personDoctors Student's doctor information
emergency_contacts emergencyContacts List of emergency contacts with priority order
medical_data.medical_conditions_v2 userMedicals Medical conditions and medications
siblings siblingHints Information about student's siblings

Address Information

EnrolHQ Field Compass Field Notes
residential_address.apartment addresses[].addressLine1 Apartment number (if available)
residential_address.street_address addresses[].addressLine2 Street address (used as addressLine1 if no apartment)
residential_address.suburb addresses[].suburb Suburb name
residential_address.state addresses[].state State code (e.g., NSW)
residential_address.postcode addresses[].postcode Postal code
residential_address.country.name addresses[].country Country name
student_resides_with addresses[].livingAmount Maps to: 0 (Never), 1 (Rarely), 2 (Sometimes), 3 (Always)

Parent Information

EnrolHQ Field Compass Field Notes
user_parent.title parents[].title Parent's title (Mr, Ms, Dr, etc.)
user_parent.first_name parents[].firstName Parent's first name
user_parent.middle_name parents[].middleName Parent's middle name (if available)
user_parent.last_name parents[].lastName Parent's last name
user_parent.external_id parents[].externalCode Generated if not provided
user_parent.dob parents[].dateOfBirth Default: 1971-01-01 if not provided
user_parent.title + relationship_to_student parents[].gender Derived from title and relationship
user_parent.residential_address parents[].addresses Parent's address information
user_parent.email parents[].emailAddress Parent's email address
user_parent.mobile_phone parents[].phoneMobile Parent's mobile phone number
user_parent.home_phone parents[].phoneHome Parent's home phone number
user_parent.occupation parents[].occupation Parent's occupation
user_parent.employer parents[].employer Parent's employer
user_parent.occupational_group parents[].occupationalStatus Numeric code for occupational group
user_parent.highest_school_year parents[].schoolEducationBackground Highest school year completed
user_parent.degree parents[].nonSchoolEducationBackground Highest non-school qualification
user_parent.relationship_to_student parents[].adultToStudentRelationship Mapped relationship (e.g., "Mother", "Father")
user_parent.born_country parents[].birthCountry Parent's country of birth
user_parent.nationality parents[].nationality Parent's nationality (if available)

Medical Information

EnrolHQ Field Compass Field Notes
medical_data.medical_conditions_v2[].option.name userMedicals[].title Name of medical condition
medical_data.medical_conditions_v2[].medication userMedicals[].description Medication information
medical_data.medical_conditions_v2[].symptoms_treatment userMedicals[].symptoms Symptoms and treatment information
medical_data.doctor.name personDoctors[].name Doctor's name
medical_data.doctor.telephone personDoctors[].phone Doctor's phone number
medical_data.doctor.address personDoctors[].address Doctor's address information
medical_data.permission_field_2 userMedicals[].medications[].medicationTitle For St. Scholastica's: Ibuprofen consent
medical_data.permission_field_3 userMedicals[].medications[].medicationTitle For St. Scholastica's: Paracetamol consent

Emergency Contact Information

EnrolHQ Field Compass Field Notes
emergency_contacts[].title + first_name + last_name emergencyContacts[].name Full name with title
emergency_contacts[] index position emergencyContacts[].contactOrder Priority order (1-based index)
emergency_contacts[].relationship_to_student emergencyContacts[].relation Relationship to student
emergency_contacts[].mobile_phone + home_phone + business_phone emergencyContacts[].contactNotes Concatenated contact information

Special Notes

  • External IDs are generated if not provided, using first initial, middle initial (if available), first 3 letters of last name, and a random number.
  • Student email addresses may be automatically generated based on school domain (e.g., for Demo College, it uses: externalCode@democollege.nsw.edu.au).
  • Parent date of birth defaults to 1971-01-01 if not provided in EnrolHQ.
  • Special mapping exists for school-specific medication consents (e.g., Ibuprofen and Paracetamol for Demo College).
  • Address mapping includes special handling for apartment numbers vs. street addresses.
  • Custom logic exists for determining gender based on title and relationship to student.
  • Photos and consent information are handled through custom form submissions in EnrolHQ.
  • Campus and year level codes are mapped through lookup tables specific to each school.