To set-up your Compass integration we require the following:

​

-- Instructions for Compass Administrator at SCHOOL NAME --

Please setup an API user in Compass and send me through the creds using Bitwarden or similar. The 4 things we'll need are:

URL: xxxxxxx-state.compass.education (please correct if wrong (must end in "/API"))
Username: EHQAPI
Password: XXXXXXXX
API Secret: API key (is a UUID)

After we receive we'll do a proof of connection to make sure we can connect and then organise up a meeting with you to show you how to sync from EnrolHQ to Compass.

Our standard mapping list is down the bottom of this page: https://www.enrolhq.com.au/product/sis-integrations/compass/

The API documentation (for the fields we can push into Compass) is included here.

Core Campus Lookup - not required for single Campus School

• If they have multiple campuses then contact the School IT and ask for a data dump of their campuses in Compass, it should include name and campus code.
• Match the EnrolHQ and Compass campuses by name and fill in the fields as follows:
  • School: the school
  • Provider: Compass
  • Campus code from provider: Compass campus code
  • Description: campus name (if there is variation between EnrolHQ and Compass than use the EnrolHQ name)
  • Corresponding value in EnrolHQ: EnrolHQ campus ID

Core Year Level Lookup

• Ask the School IT for a data dump of their year levels in Compass, it should include name and year level code.
• Match the EnrolHQ and Compass year levels by name and fill in the fields as follows:
  • School: the school
  • Provider: Compass
  • Year level code from provider: Compass year level code
  • Description: year level name (if there is variation between EnrolHQ and Compass than use the EnrolHQ name)
  • Value: EnrolHQ year level code ID