Overview
Enquiry Tracker integrates with Compass via the API, which requires the enrolments module enabled in Compass for data to be able to transfer successfully. Compass does not support transfer of any documents, just the data listed in the table below.
Please contact Enquiry Tracker support if you are interested in setting up integration for Compass
Mandatory fields in Compass
Compass requires data to be set in the following fields, not all of which exist in Enquiry Tracker. This explains how these values are set- username is mandatory for student and parent. Enquiry Tracker will set it to initials of the records first name + ID number, where is number is the ET Student ID by default
-
govtCode1 is mandatory in Compass and is a Government provided identifier. Must be
unique within the school. Enquiry Tracker sets this value as “UNK-” followed by ET Student ID - title for student is a mandatory field . Enquiry Tracker sets ‘master’ for male student and ‘miss’ for female student
- Student Address is mandatory. The address used by Enquiry Tracker, is based on whom the student lives with
- Living Amount this value is set on whom the student lives with
Fields Transferred to Compass
Note the following:
- Area: This is the area the field is located in Enquiry Tracker. Note that unless listed as Apply Only, all fields are in Pipeline
- Field Type: if the type contains Configurable, it means it can be turned on and off under ADMIN> EDIT school. If any of these are off, they cannot be transferred. If the field is Conditional it means it will be displayed based on the answer to another question such as Alumni
- If field is Apply Only, it will only be included in the transfer when transferred from Applications> Applications and they will not be included if a transfer is initiated from the Student List section
| ET Field | Area | Field Type | Compass Fields | Status | Compass Notes |
|---|---|---|---|---|---|
| Student First Name | Student | Required | firstName | ✅ | |
| Student Middle Name | Apply Only Student | Optional | middleName | ✅ | |
| Student Last Name | Student | Required | lastName | ✅ | |
| Student Preferred Name | Student | Optional | preferredFirstName | ✅ | Also set preferredLastName to the same value |
| Student Date of Birth | Student | Optional | dateOfBirth | ✅ | |
| Student Gender | Student | Optional SIS CODE | gender | ✅ | |
| Student Religion | Student | Optional Configurable SIS CODE | religion | ✅ | |
| Sibling first name | Apply Only Student | Optional Conditional | Name | ✅ | Concatenate Sibling First and Last name |
| Sibling last name | Apply Only Student | Optional Conditional | Name | ✅ | Concatenate Sibling First and Last name |
| Sibling Year level of entry | Apply Only Student | Optional Conditional SIS CODE | YearLevel | ✅ | |
| Has Additional Needs | Student | Optional Conditional | disability | ✅ | Boolean field in Compass, if any value in Enquiry Tracker for Additional Needs is TRUE, then this field will be set to TRUE |
| Current School | Student | Optional SIS CODE | schoolName | ✅ | |
| Campus | Student | Optional SIS CODE | campusCode | ✅ | For multi-campus schools, Enquiry Tracker will use the relevant lookup table in Compass, otherwise it is set to 1 |
| Year Level of entry | Student | Optional SIS CODE | yearLevelCode | ✅ | This is a mandatory field in Compass. |
| Starting Year | Student | Optional | Starting Year | ✅ | Enquiry Tracker sets the commencementDate in Compass based on starting year and month if there is no start date |
| Student Type | Student | Optional Configurable SIS CODE | studentDetailsBoarderType | ✅ | Pass the string value from the Boarder/Homestay list in Enquiry Tracker |
| Other Interests | Student | Optional SIS CODE | interests | ✅ | Pass a comma delimited concatenated string of Other Interests into a single Compass field |
| Enrol Date | Student | commencementDate | ✅ | ||
| Salutation | Contact | Optional SIS CODE | title | ✅ | Mandatory field in Compass |
| First Name | Contact | Required | firstName | ✅ | |
| Last Name | Contact | Required | lastName | ✅ | Enquiry tracker will also set preferredLastName using the Last name |
| Gender | Contact | Optional SIS CODE | gender | ✅ | |
| Contact | Required | emailAddress | ✅ | ||
| Mobile Phone | Contact | Optional | phoneMobile | ✅ | |
| SMSFLAG | Contact | compassSmsAllowed | ✅ | ||
| Home Phone | Contact | Optional | phoneHome | ✅ | |
| Relationship to Student | Contact | Required SIS CODE | adultToStudentRelationship | ✅ | |
| Religion | Apply Only Contact | Optional SIS CODE | religion | ✅ | Enquiry Tracker will pass string value to compass |
| Occupation | Apply Only Contact | Optional | occupation | ✅ | |
| Occupational Group | Apply Only Contact | Optional SIS CODE | parentDetailsOccupationalStatus | ✅ | |
| Employer/Company | Apply Only Contact | Optional SIS CODE | employer | ✅ | |
| School Level Education | Apply Only Contact | Optional SIS CODE | parentDetailsSchoolEducationBackground | ✅ | |
| University/Further Education | Apply Only Contact | Optional SIS CODE | parentDetailsNonSchoolEducationBackground | ✅ | |
| Country of Birth | Apply Only Contact | Optional SIS CODE | birthCountry | ✅ | |
| Residency Status | Apply Only Contact | Optional SIS CODE | residentialStatus | ✅ | |
| Country | Contact Address | Optional SIS CODE | country | ✅ | |
| Address | Contact Address | Optional | addressLine1 | ✅ | |
| Suburb | Contact Address | Optional | suburb | ✅ | |
| State | Contact Address | Optional SIS CODE | state | ✅ | |
| Postcode | Contact Address | Optional | postcode | ✅ | |
| Postal Country | Apply Only Contact Address | Optional SIS CODE | country | ✅ | If this is a different address then residential, set to true. If both address same, set it to true. |
| Postal Address | Apply Only Contact Address | Optional | addressLine1 | ✅ | |
| Postal Sublocality | Apply Only Contact Address | Optional | suburb | ✅ | |
| Postal State | Apply Only Contact Address | Optional SIS CODE | state | ✅ | |
| Postal Postcode | Apply Only Contact Address | Optional | postcode | ✅ | |
| Student Lives With | Apply Only Student | Optional SIS CODE | studentDetailsLivingArrangements | ✅ | |
| Country of birth | Apply Only Student | Optional SIS CODE | birthCountry | ✅ | ET pass the string value for country |
| Country of nationality | Apply Only Student | Optional SIS CODE | nationality | ✅ | ET pass the string value for country |
| Visa sub class | Apply Only Student | Optional Conditional | visaSubclass | ✅ | Compass expects a code form the matching lookup table. ET will attempt to match, based on the entered description and shall transfer if there is a matching code for the entered value else we will not. |
| Date of arrival | Apply Only Student | Optional Conditional | arrivedInCountryTimestamp | ✅ | |
| Visa Expiry | Apply Only Student | Optional Conditional | visaExpiryDate | ✅ | |
| Main language spoken at home | Apply Only Student | Optional SIS CODE | Language | ✅ | Enquiry Tracker will also set home and Primary language fields in Compass if it is teh primary language spoken at home |
| Church/Parish | Apply Only Student | Optional | Parish | ❌ | While the field exists in Compass, there is no available endpoint |
| Medical Conditions | Apply Only Student | Optional SIS CODE | title | ✅ | Medical conditionls i. ET are added as separate line items, however if the student has Anaphylaxis then we set the field anaphylaxis to tru |
| Doctor's Name | Apply Only Student | Optional | Name | ✅ | |
| Doctor's Phone Number | Apply Only Student | Optional | Phone | ✅ | |
| Ambulance Cover | Apply Only Student | Optional | ambulanceSubscriber | ✅ | |
| Emergency First Name | Apply Only Contact | Optional | name | ✅ | Currently set priority, contactOrder field in Compass, as #3 after contacts. Concatenate Emergency First and Last name and pass to Compass |
| Emergency Last Name | Apply Only Contact | Optional | name | ✅ | |
| Emergency Relationship to Student | Apply Only Contact | Optional SIS CODE | relation | ✅ | Pass string value from Contact Relationship in Enquiry Tracker |
| Emergency Mobile Phone | Apply Only Contact | Optional | contactNotes | ✅ | |
| Emergency Email | Apply Only Contact | Optional | contactNotes | ✅ | If emergency mobile is not entered in ET, then map emergency email to contactNotes in Compass |