Skip to main content

Integration

Learn why you should use integrations and how to begin your integration set-up.

This process requires IT Admin access.

As an Admin user responsible for IT, you will be required to begin the integration process so that the information from your school's SIS is pulled into Clipboard.

Why should I use an integration?

Having an integration running between your SIS and Clipboard means student information is regularly and automatically updated. You can view and manage the incoming integrations and their frequency in your Clipboard account.

There are eight integration options for you to choose from:

  • Compass API

  • Wonde

  • Microsoft SQL Server

  • IBM DB2

  • PostgreSQL

  • Veracross API

  • Toddle

  • TASS

For Microsoft SQL Server, IBM DB2 and PostgreSQL, Clipboard's Database Connector must be installed. For Wonde, you will need to initiate the approval and setup process (see the steps below).

Compass is a SIS that does not integrate with Wonde. We have built native integrations so that you can still pull your data into Clipboard if you use one of them. If you have a different SIS, then they are not relevant to you.

You can use a single source of integration or a combination of different ones to fit your integration needs and compatibility with your SIS.

What does the integration include?

What is included in the integration depends on the integration method and the compatibility of that method with your SIS. The six integration areas are:

  • Students

  • Student Photos

  • Guardian contacts

  • Medical conditions

  • Absences

  • Emergency contacts

Click on the links for more information on what Wonde syncs from a SIS here, SIS/Wonde Coverage, and Wonde's SIS Integration Guides.

Clipboard's Database Integration Schemas can be found here.

If you have any problems with integration, please email s[email protected] for assistance.

To begin the integration with Compass:

Prerequisites

Before setting up the Compass integration, ensure:

  1. You have IT Admin access to your Clipboard account

  2. Compass will need to set up the API user for Clipboard on behalf of your school.

  3. You have obtained the following credentials from Compass:

    • Your school's Compass domain (e.g., yourschool.compass.education)

    • API Key (provided by Compass)

Compass Integration Set up Steps:

  1. Go to Integration in Clipboard

  2. Under Manage Integrations, choose an area of integration and click on the Edit icon for Source.

  3. In the Source dropdown, choose Compass.

  4. In the form, provide your school’s Compass domain and your Compass API key. When configuring the Absences integration, you will also need to provide the School System Type, following this format: aus.[any state acronym (e.g., vic, nsw)].[public | catholic | independent]

    For example: aus.nsw.independent, aus.vic.catholic

  5. Do not forget to turn on the integration by flicking the switch to green in the Manage Integrations page if you want the integration to run.

Please note that the following data can be pulled directly from the Compass API integration:

  • Students

  • Student photos

  • Guardian contacts

  • Medical conditions and Medical Action Plans

  • Absences - Attendance Notes in Compass sync as Pre-Explained Absences in Clipboard, including absences outside school hours (e.g., on weekends) and multiple absences for the same student

  • Emergency Contacts

The Compass integration also supports significant Writeback functionality, with Clipboard able to send data for Teams, Student membership, Attendance and more.

The Compass Person ID maps to an "internal SIS ID" field in Clipboard (NOT "SIS ID") that does not show in the user interface. The Compass "username" field maps to "SIS ID".

To begin the integration with Wonde:

  1. Go to Integration in Clipboard

  2. Under Manage Integrations, your SIS to Clipboard data sync section will default to the Wonde option for integration. Flick the switch to green next to one of the integration options.

  3. A pop-up window will ask you to request Wonde access and ask for your permission to share your name and email address with Wonde as the authorised contact and select Request.

  4. The next step is to wait; a representative from Wonde will contact you to begin the setup with you. We advise schools to grant all required and optional permissions for Clipboard in the Wonde Portal to ensure we receive all the required data.

  5. Next, Wonde will audit your data. This can take a few days. They will notify us that this has been done, and we will turn on your integrations and check your data is coming through correctly. Once confirmed, the integration will occur daily to pull new data from your SIS.

To begin the integration with Veracross:

  1. Go to Integration in Clipboard

  2. Under Manage Integrations, choose an area of integration and click on the Edit icon for Source.

  3. In the Source dropdown, choose Veracross.

  4. In the form, provide your school’s Veracross School Route, Client ID, and Client Secret.

Note: Schools are to manage their own integration credentials. So they can add themselves as the integration partner and then add the credentials to Clipboard via the integrations page.

Please note that the only data that can be pulled directly from the Veracross API integration is the following:

  • Students

  • Guardians

  • Absences

Below is a list of the scopes that need to be enabled in Veracross for each integration:

  • Students

    • List Students

    • List Boarding Dorms

    • List Boarding Dorms Students

    • List Directory: Student

  • Guardians

    • All scopes needed for Students, plus:

    • List Parents

    • List Contacts Info

  • Absences

    • List Master Attendance

To begin the integration with TASS:

  1. Go to Integration in Clipboard

  2. Under Manage Integrations, choose an area of integration and click on the Edit icon for Source.

  3. In the Source dropdown, choose TASS API.

  4. Provide your school’s API Identity Token and Student Details Token, and fill in the remaining fields below sourced from your TASS Platform:

  5. Save your changes.

  6. If you want the integration to run, remember to turn it on by flicking the switch to green in the Manage Integrations page.

Please note that the only data that can be pulled directly from the TASS API integration is the following:

  • Students

  • Medical

You will need to use the Database Connector to set up the remaining integrations for guardians, absences, student photos, and the emergency contact syncs.

To begin the integration with Toddle:

  1. Go to Integration in Clipboard

  2. Under Manage Integrations, click on the Edit icon for Source

  3. In the Source dropdown, choose Toddle

  4. In the form, provide your school's Toddle API credentials and School's Toddle Region.
    ​

  5. Save your changes

  6. If you want the integration to run, turn it on by flicking the switch to green in the Manage Integrations page.

Please set up the following available Toddle integrations:

  • Students - Syncs student information from Toddle to Clipboard

  • Parents/Guardians - Syncs parent and guardian contact details from Toddle to Clipboard

To begin the Database Connector integration with IBM DB2 or Microsoft SQL Server:

After downloading the Database Connector, go here for the steps to setting up the Database Connector and for the configuration steps.

Here are some Example SQL Queries that can be used to sync your SIS to Clipboard if using the Microsoft SQL Server option.

Note: the Database Connector integration method is solely managed by your school.

Check out the video below to see the process in action!

FAQ

How do I pull homeroom from our SIS into students profiles?

If you are using the Database Connector, please check out the documentation; the Student Schema has been updated and now includes homeroom.

If you are using Wonde; It’s pulled from Wonde as a group of type REGISTRATION. See their API docs. You need to update Clipboard’s Wonde permissions in the Wonde portal.

Can we sync Absences in the past for the Attendance Sync?

If you are using the Clipboard Database Connector as an integration method, you can control what period of time you want to sync, so it is possible to sync absences in the past should you wish.

For all other types of integration methods including Wonde, absences are always removed and resynced with the current and future pre-explained absences.

How many times can we schedule Absence syncs during the day?

You can add up to 50 daily sync times to your Absence integration, so incoming absences from your SIS land in Clipboard more often throughout the day.

That means students are flagged for the right Sessions sooner, even when a parent records an absence not long before the Session starts.

IT Admin can set these up for your school by heading to Integrations > Manage Integrations > Incoming, and modifying the Sync Times under your Absence integration.

I want my Wonde Absences sync to run every day - how do I arrange this?

If your Wonde Absences sync is set to weekdays only and you would also like it to sync absences on weekend days, please contact [email protected].

Did this answer your question?