Compass Integration - Compass Setup

Modified on Wed, 13 May at 8:59 AM

Overview

The Compass Integration allows schools to sync student and parent data from Compass into RollCall through the new Integrations Dashboard.

Navigate to:

  • Integrations → LMS → Compass


Existing Integration

If a Compass integration already exists:

  1. Open the Compass Integration screen

  2. Select:

    • Settings

This will open the existing configuration page.


Basic Settings


API Key

Used to authorise API requests sent to Compass.


Base URL

The school’s Compass URL.

Example:

  • https://sample.compass.com

⚠️ Do not include:

  • /api/


Enable Nightly Sync

When enabled:

  • Sync automatically runs every:

    • 2:00 PM UTC

When disabled:

  • Sync must be run manually


Parent Filtering

Filters determine which parents are synced into RollCall.


Filter by Parent Types

Filters parents based on their Compass Parent Type (contactOrder).


Priority Check Mode

Multi

  • Includes all matching Parent Types

Cascade

  • Parents are checked in order

  • Sync stops once the configured parent limit is reached


Parent Type Cascade Order

Only available in:

  • Cascade Mode

Determines the order Parent Types are checked.


Number of Parents

Only available in:

  • Cascade Mode

Limits the maximum number of parents synced per student.


Only Include Parents Who Live With Student

Only syncs parents whose address matches the student’s address.

⚠️ Address matching must be exact after processing.


Only Include Correspondence Contacts

Only syncs parents who have:

  • receiveSmsGeneral=true

  • OR receiveEmailGeneral=true


Important Note

All parent filters operate using:

  • AND logic

Parents must meet all enabled filter conditions to sync.


Other Settings


Include Future Students

Includes:

  • Current students (Status 1)

  • Future students (Status 3)

⚠️ Future students are only included if:

  • Their start date is within 3 months of the sync date


Exclude Fields from Sync

Campus

When excluded:

  • New students:

    • Campus is set to null

  • Existing students:

    • Existing campus value is retained

    • Campus will not update from Compass

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article