Overview

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

Before You Begin – Contact Compass

Before setting up the Compass integration within RollCall, your school will first need to contact Compass to arrange API access.

This step must be completed with Compass before RollCall can establish the integration.

Contact the Compass team at:

api-request@compass.education

When contacting Compass, advise that your school is setting up an API integration between Compass and RollCall and requires the necessary API access to be enabled.

Compass will assist your school with setting up the API on their side and provide the details required to configure the integration within RollCall.

Important: We recommend completing the Compass API setup before beginning the RollCall configuration. Once Compass has provided the required API details, you can proceed with the steps below to configure and test the integration in RollCall.

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

This is the key used to authorize the API requests we send to Compass

• For schools to gain an API key, they need to contact Compass at api-request@compass.education

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