Skip to main content
Skip table of contents

SchoolBox Integration Checklist

This checklist can be used as a guide for configuring the Schoolbox Integration. 

For more information on the solution, check out the Meet our Partners page on our website. 

For more information on endpoints Schoolbox is certified for, refer to links in the Version 3 APIs page. 

Step

Item

Details

  • Task

1

Pre-requisites 

Ensure you meet the following pre-requisites: 

  • Minimum Schoolbox Version: 21.0.  

  • TASS License: must include all APIs in this link. Contact TASS Sales if you require an update to your license. 

  •  Complete

2

Pre-launch [Optional]

If your school has a development/testing environment, you may choose to trial the integration prior to launching the solution in production. 

  •  Complete

3

New Security Role 

When you configure your APIs, you'll need to map a TASS Security Role with the appropriate permissions points. This allows tight control of the data that's shared with the 3rd party. 

Go to: System Admin > Users > Security Role Permissions and create a new security role with the required permissions to be used for this integration. 

Schoolbox required permissions.

Student Records > Students > View

Student Records > Students > Subjects Tab > View

Teacher Records > Teachers > View

Teacher Records > Teachers > Subjects Tab > View

Timetable > Print Teacher Timetables > View

Timetable > Print Student Timetables > View

Timetable > Timetable Calendar Setup > View

Medical Records > Student Medical > Medical Conditions tab > View

Administration > LDAP/SAML Maintenance > View

  •  Complete

4

Configure APIs 

Complete Step 3 of the TASS API Setup Checklist to configure the 4 APIs. 

Map the Security Role with these permission points to all APIs in use for the Schoolbox Integration with the exception of 'School Calendar & Daily Notices'. 

  •  Complete

5

API Details Form

Complete Step 4 of the TASS API Setup Checklist. The API Details Form will need to be completed for all 4 APIs. 

  •  Complete

6

Communicate with Schoolbox

Follow the remaining steps outlined in Schoolbox help

The following details will need to be sent to Schoolbox: 

  1. API Details Forms for all APIs 

  2. Address Blocks that are mapped to a 'Person Position' and what that Position is. 

Parent Records > Setup Information > Parent Records Setup: Addresses tab

e.g. Address Block 4 - Position 1, Address Block 5 - Position 2. 

  •  Complete

You're now live with the TASS & Schoolbox integration! 


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.