Skip to main content

Compass Setup Guide

This guide walks you through connecting your school's Compass Student Information System to Junipa.

Prerequisites​

Before you begin, ensure you have:

  • Compass admin access -- You need to be a Compass administrator to configure API settings.
  • Junipa admin access -- You need to be a Junipa administrator to enter integration credentials.

Step 1: Configure Compass API Access​

  1. Log into your school's Compass instance as an administrator.
  2. Navigate to the Administration or Technical Settings section.
  3. Locate the API or Third-Party Integrations settings.
  4. Enable API access for external applications.
  5. Generate or note down the following credentials:
    • API Key or Client ID
    • API Secret or Client Secret
    • School ID (your Compass school identifier)
  6. Save the settings in Compass.
note

The exact location of API settings may vary depending on your Compass version. If you cannot locate them, contact your Compass administrator or Compass support.

Step 2: Enter Credentials in Junipa​

  1. Log into Junipa as an administrator.
  2. Navigate to Administration > Integrations.
  3. Select Compass from the list of available integrations.
  4. Enter the credentials from Step 1:
    • API Key / Client ID
    • API Secret / Client Secret
    • School ID
  5. Click Test Connection to verify that Junipa can reach your Compass instance.
  6. If the test is successful, click Save.

Step 3: Run the Initial Sync​

After saving the credentials:

  1. Click Sync Now to trigger the initial data import.
  2. Junipa will pull student records from Compass. Depending on the number of students, this may take a few minutes.
  3. Once complete, navigate to Administration > Students to verify that student records have been imported.

Step 4: Verify the Data​

After the initial sync, check the following:

  • Student names are correct and complete.
  • Year levels are assigned correctly.
  • Class assignments match your timetable.
  • The number of imported students matches your expectations.

If anything looks incorrect, check the Compass data first -- Junipa imports what Compass provides.

Ongoing Sync​

After the initial setup, Junipa will sync with Compass automatically:

  • Sync frequency -- Data is pulled from Compass on a scheduled basis (typically once per day).
  • New students -- Students added in Compass will appear in Junipa after the next sync.
  • Updated records -- Changes to student details in Compass (name, year level, enrolment status) will be reflected in Junipa after the next sync.
  • Departed students -- Students marked as departed in Compass will be updated accordingly in Junipa.

Disconnecting the Integration​

If you need to disconnect the Compass integration:

  1. Navigate to Administration > Integrations.
  2. Select Compass.
  3. Click Disconnect.
  4. Confirm the action.

Disconnecting the integration stops future syncs. Existing student data in Junipa is retained.