Schoolbox Integration

Schoolbox is typically integrated with a direct real-time connection to Synergetic to provide information. Schoolbox can also be integrated to provide access to Community Portal.

Prerequisites

• Schoolbox integration module needs to be purchased
• SAML integration module needs to be purchased if using SAML to integrate with Schoolbox.

Integration information

Application Authentication

Schoolbox integration requires creating a SQL user and assigning permissions to access the Synergetic databases and this task is typically performed by the client. Please refer to the Schoolbox Synergetic Integration KB for further details with sample script and health check option to test the SQL user and permissions. Please check with Schoolbox support for the required information. 

There is a policy setting on this page here to allow user types to change their passwords in Schoolbox.

Sample URL (replace with school's Schoolbox URL): https://schoolboxurlhere.school.com/adminv2/lists/roles

You can flick the setting to allow password change for passwords and that should fix it.   

User Authentication

To use Schoolbox with Community Portal can use Schoolbox in-built SSO to the Synergetic Community Portal accounts. Parents and students will need login accounts and passwords stored within Synergetic as well as Schoolbox and Schoolbox performs SSO and sync of passwords. Windows authentication is not supported in this scenario - please contact Schoolbox for further information in this space and may recommend using SAML authentication as an alternative.

Alternatively SAML authentication can be used and allows the client to use externally stored usernames and passwords (such as Active Directory) and link these with Community Portal IDs. The Synergetic SAML integration module will also need to be purchased in this scenario.

Embedding Community Portal within iFrame

When embedding iframes into Schoolbox you need to first whitelist the source as this protects malicious sites being embedded by students.  To whitelist you go to the Safe Iframe Sources in Admin -> Security and add the domain of the site you are trying to embed. There is also a specific format for the URL required that also performs SSO to the Community Portal with a redirect using the Schoolbox /synRedir.php. Clients should check with Schoolbox documentation and support if assistance is required.

If using the Schoolbox accounts (not SAML) with the Community Portal SSO then sections can be embedded within iFrames but the link must route through the synRedir.php page in order for the authentication step to occur. Below is an example link to the MyDetails page via an iFrame in Schoolbox:

<iframe allowfullscreen="true" class="full-width" src="https://schoolboxurlhere.schooldomain.com/synRedir.php?page=MyDetails" style="height:500px; width:100%"></iframe>

Note there is also a dedicated page that will do this for you if not wanting to embed within an iFrame.  This can be added to a Schoolbox TILE link with sample link as follows: https://schoolboxurlhere.schooldomain.com/synergetic/MyDetails

You can also add /nomenu to this URL to hide the Community Portal menu.

Hide the Community Portal header if required using a Configuration Key.

SchoolBox Website

https://schoolbox.com.au

https://help.schoolbox.com.au

V68 Upgrade 

Contact school sysadmin and advise them to notify Schoolbox about the upgrade. You can also provide the client this link and they can finalize the integration.

https://help.schoolbox.com.au/homepage/495#textbox499

Related articles