Engage SIS Integration

Katrease Sinclair
Katrease Sinclair
  • Updated

Configuration

Setting up Engage Integration

Engage Integration is an additional paid module and can be found via Settings > Integrations. Please contact sales@openapply.com, if you would like to learn more about pricing and functionality of this module.
46568b0e-1632-48b5-b01c-f8ddd34ed5a2.png
You can select which of your Open Apply statuses you would like to be able to sync to Engage.

Navigate to Settings > Integrations > Engage:

Screenshot_2023-01-24_at_3.55.55_PM.png
The integration requires your school’s Engage API URL and the credentials of a user with valid permissions.

Your can also sync students to different Engage School IDs, according to the programme, or add rules to sync to different Engage School IDs based on other fields, such as campus.
3ba259db-1f01-4449-a8e8-c66d8ec1c32c.png

Supported Fields

The following fields are mapped automatically as part of the OpenApply to Engage Integration:
    1. Pupil (Student)

      1. `forename`

      2. `surname`

      3. `middleName`

      4. `genderid`

      5. `dob`

      6. `address`

      7. `postCode`

      8. `entryYearGroup`
    2. Contact (Parent)

      1. `titleid`

      2. `firstname'

      3. `lastname`

      4. `genderid`

      5. `home_phone`

      6. `mobile_phone`
      7. `email`
There is also the option of mapping your OpenApply fields to the following additional Engage core fields, via Settings > Integrations > Engage > Student Core Fields Mappings, in order to sync data to these fields:
  1. medical_info / nhsNumber

  2. medical_info / comments

  3. medical_info / isMedicalInformationPresent

  4. medical_info / MedicareCardPosition

  5. religion_info / ReligiousAffiliationCode

  6. religion_info / ReligiousEducationIndicator

  7. religion_info / CollectiveWorshipIndicator

  8. religion_info / notes

  9. nationality_info / nationalityId

  10. nationality_info / isRefugee

  11. nationality_info / isImmigrant

  12. nationality_info / countryOfBirth

  13. nationality_info / notes

  14. transport_info / isFreeSchoolTransportEligible

  15. transport_info / travelType

  16. transport_info / travelFrom

  17. transport_info / pickupLocation

  18. transport_info / isLEAProvidedTransport

  19. transport_info / travelRoute

  20. transport_info / travelRouteType

  21. transport_info / travelRouteNotes

  22. visa_info / placeOfBirth

  23. visa_info / passportCountry

  24. visa_info / passportNumber

  25. visa_info / passportValidFrom

  26. visa_info / passportExpiryDate

  27. visa_info / residenceVisaNumber

  28. visa_info / residenceVisaValidFrom

  29. visa_info / residenceVisaExpiryDate

  30. visa_info / healthCardNumber

  31. visa_info / healthCardValidFrom

  32. visa_info / healthCardExpiryDate

  33. visa_info / visaInformationNotes

  34. ethnic_info / ethnicCode

  35. ethnic_info / sourceOfEthnicCode

  36. ethnic_info / gypseyCode

  37. ethnic_info / sourceOfTravellerIndicator

  38. ethnic_info / notes

  39. ethnic_info / aboriginalOrigin

The OpenApply field values need to match exactly to Engage field values or the data will not sync.
4c40bb28-e29f-4e48-a951-f1128dc99178__2_.png

How to sync a student to Engage

It is necessary to manually push students to Engage, so that schools have complete control over when and which students sync. Students can only be pushed if they have one of the statuses selected in the Engage integration settings.

Adding a new student to Engage

If an OpenApply student is pushed to Engage, and there is no Engage student already within the system, it will create the student and provision an Engage ID, and the students will be linked by the Engage ID.

To sync a student, select them on the Students roster and click Export > Push to Engage

Screenshot_2023-01-24_at_3.30.50_PM.png

Alternatively, access the Engage sync page via the right panel of the individual student profile

Screenshot_2023-01-24_at_3.32.22_PM.png

Then click to Sync to Engage

Screenshot_2023-01-24_at_3.33.39_PM.png

Adding an student to an existing Engage account

For an OpenApply student to be linked to an existing Engage student account, Input the student's Engage ID into OpenApply, This will link the student to Engage.  

Through the Engage IDs, it will recognise siblings and their parents to not create any duplicates in Engage. 

Screenshot_2023-01-24_at_3.35.59_PM.png
Share

Was this article helpful?

1 out of 3 found this helpful