In this guide we will look at how to roster and onboard your district using Classlink.
- Connecting ClassLink
- Roster server set up
- OneClick set up
- Sync & test the integration
- Synchronization
- Manually sync data on-demand
- Beginner's guide to managing ClassLink syncs
- Enabling Google Classroom SSO
- User roles
Connecting ClassLink
The Twig Science platform supports integration with Classlink for both:
- ClassLink OneClick (SSO)
- ClassLink Roster Server / OneRoster API (Rostering)
For information on how to set up Classlink, before adding Twig Science as an application, please go to: Classlink: Getting Started
Before you can connect to Twig Science, please:
- Setup our application in Roster Server (OneRoster API)
- Setup our Classlink OneClick application (i.e. Adding app to Launchpad)
- Sync and test the integration
Roster server set up
- Log in as a Classlink Administrator to https://launchpad.classlink.com/DISTRICTNAME
- Select Classlink Roster Server.
- Log in to ClassLink Roster Server.
- Select Apps from the left-hand navigation bar.
- From the Applications screen, select Add a new app in top right hand corner.
- Search for Twig Science and click Add.
- Setup your data sharing rule. You should only share students who require access to Twig Science.
- We will then be notified you wish to connect to us. It may take us a day or so to accept your invitation.
- On connection, we will run an initial sync (unless you request otherwise) and will let you know when this is completed. Once we've ran the initial sync, data will be synced on a nightly basis.
Note
We do not require access to Unenrolled Users or Demographics. See this help article Applications: Adding Applications & Modifying Permissions from Classlink for more information. Sharing all district data may push you over your license limit.
OneClick SSO set up
Recommendation
Please sync data with Twig Science and test a student and teacher login before making the OneClick app available to all users.
- Log in as a ClassLink Administrator to LaunchPad and navigate to: ClassLink Management Console.
- Go to Applications - Add & Assign Apps - App Library.
- Search for Twig Science and click Add.
- The app will now appear in the Add & Assign Applications screen.
- Search for Twig Science again.
- Use the Assign button to make the app available to the relevant teachers/students/classes who should have access to Twig Science. This Classlink help video explains this step in more detail.
Sync & test the integration
Once you connect your Roster Server app with us, we’ll run an initial sync. If your data changes significantly between the rostering setup and implementing the Launchpad App, we recommend you run an on-demand sync beforehand to ensure the rostering data is fresh.
When setting up your OneClick Launchpad App, we recommend that you use the Impersonate user function for a selection of teachers and students who should have access to Twig Science to confirm they can log in successfully.
Synchronization
There are two different ways to sync data with Twig Science:
- Automated Nightly Sync: Once connected, Twig Science will sync with Roster Server every night at approximately 01:00 AM PT. Any new records that are not found in Twig Science will be added. Missing records will be deactivated in Twig Science.
- On-Demand Sync: The District Account Owner can trigger an on-demand sync if an update is needed sooner than the automatic nightly sync.
Manually sync data on-demand
You can manually sync data at any time using your district admin credentials.
-
Log in to Twig Science using the following:
- District ID
- Username (typically your email)
- Password (contact Support@twigeducation.com if you need assistance logging in)
- Go the the left hand menu and select Manage then Integrations.
- Now click Sync now.
- The sync will start to run, please note it may take up to 30 minutes.
A Beginner's Guide to Managing and Triggering Syncs
If your district is rostered via Classlink, you can manage and trigger syncs from your district admin dashboard. Discover how to trigger a sync with our interactive step by step guide below.
Step by step guide to syncing with Classlink.
Enabling Google Classroom Single Sign On
You can allow users to log in using Google credentials simply by using Google email addresses in your users.csv file. In the users.csv file simply add google email addresses to the "email" column.
This will allow users to log in here.
Note
Google Workspace for Education
If your district uses Google Workspace for Education, you will need approve the Twig Science app on your Google Console first. Please read Google's guide: Control which third-party & internal apps access Google Workspace data
User roles
Twig Science has the following user roles, but only certain ones are supported for rostering and OneClick integration: