Compass Integration - Compass Settings

For Compass, the fields' values are as follows:

• organisation_id*
  • This is an integer field which should contain the ID of the organisation the integration belongs to
• lms_name*
  • This is a string field which should contain the name of the LMS to be used for the syncing
  • For Compass, the value should be COMPASS
• api_key*
  • This is a string field which should contain the API token/key to be used for authentication in the third-party (LMS) APIs
• base_url*
  • This is a string field which should contain the base url to be used for sending requests to the LMS
• settings*
  • This is a JSON field which should contain the LMS-related settings that are specific to each LMS
  • For Compass, no additional settings are needed, so this should be set to an empty JSON or null

For Compass, there are a few things to note regarding the mapping behavior:

• Compass doesn’t have a flag to tell if the parent lives with the student
  • To make up for this, the parent address is compared to the student address
• Compass doesn’t return the date of the last modification (for everything)
  • Because of this, there is no delta sync feature for Compass
• Compass requires a “last modified” datetime to retrieve the relationships
  • This is set to 1970-01-01T00:00:00Z to retrieve even the oldest records

• lives_with_student
  • Compass does not have a field (in the relationship) that we can use to determine if the parent really is living with the student or not
    • As a workaround, we instead use the processed (concatenated) parent address and compare it to the student address
• priority_list
  • There is currently only one value in this last
  • This field is derived from the contactOrder field of the relationship
• is_correspondence
  • This field is derived from both the receiveSmsGeneral and the receiveEmailGeneral fields of the relationship
    • If any are true, then is_correspondence=true