Adding SchooLinks App in Roster Server & Sharing Permissions

Below are instructions for connecting the SchooLinks application to ClassLink Roster Server. The process involves adding the SchooLinks app through ClassLink Roster Server and assigning permissions to the app. After successfully, adding the SchooLinks app, assigning permissions, and enabling the connection: SchooLinks can then connect to ClassLink to pull the rostering data used to provision SchooLinks accounts.

Included are links to ClassLink's documentation for adding applications and modifying permissions.

  1. To add the SchooLinks application through ClassLink Roster Server, please refer to ClassLink's documentation on Adding Applications. When following the steps to Connect an application, search for the SchooLinks application
  2. Then please review and assign permissions to the SchooLinks app in Roster Server by Following ClassLink’s documentation on **Permissions.** You can assign SchooLinks Full Permission, or setup Rule Based Permissions to filter our certain data by criteria.

<aside> 💡 Keep in mind that the application is not enabled by default after sharing data and must be explicitly toggled to "Enabled" to allow access to data.

image.png

</aside>

  1. After ClassLink has been connected to SchooLinks, notify your Customer Success Manager to let them know that you have successfully connected
  2. Ensure that Demographic Records are shared with the SchooLinks APP

    1. Click Apps > All Applications

    2. Click the Gear Icon next to the SchooLinks app

      image.png

    3. Select Shared Fields, then select the Demographics tab and check Enable Demographics, then click Save

      image.png

SchooLinks API Configuration

After the connection has been made, SchooLinks will configure your district’s Rostering sync to run nightly internally within SchooLinks. Our Data Integration team member’s will have access to all of the API credential information needed after you are connected with the SchooLinks app.

SchooLinks utilizes proxy-based API authentication through ClassLink, ensuring seamless integration without the need for frequent configuration updates. This approach allows us to securely access ClassLink's services without directly exposing credentials or requiring adjustments when API credentials or hostnames change. If ClassLink informs you that your hostname or API credentials for ClassLink are changing, there will be no need for configuration changes within SchooLinks.

Sharing Metadata with SchooLinks

If you have student/staff identifiers, Staff Roles, or additional staff fields that you want to share with SchooLinks, you first need to ensure that the fields exist in ClassLink and then share the fields with SchooLinks following these steps:

  1. Login to Roster Server and go to your Applications

  2. Click the ⚙️ Gear icon next to the SchooLinks app

  3. Click on DataGuard

  4. Click on the Users entity

    image.png

  5. Click the Toggle next to Metadata Fields and make sure the specific fields are checked to be shared with SchooLinks