All Collections
Getting Started
ClassLink Setup (District Administrator and Standalone Single School Administrator)
ClassLink Setup (District Administrator and Standalone Single School Administrator)

How to connect to Typing Agent using ClassLink.

Typing Agent Dev Support avatar
Written by Typing Agent Dev Support
Updated over a week ago

Connecting your district rostering data with Typing Agent through ClassLink allows you to sync all your schools, classes, staff, students and enrollments through the ClassLink rostering service. 

ClassLink is not Available for School Admins within a district to manage - only main account admins may create the link with this rostering system. Understanding how the admin will be managing the account will help you understand how to request changes from your admin.

When you are ready to share your data and connect with Tying Agent, please do the following steps:  

1.  Make sure you have a valid Tying Agent account setup.  If you already have a trial or paid Typing Agent account, you can skip to step 2 below.

If you need to get started with Typing Agent, register as a district here first:  https://app.typingagent.com/register/district

After you have your approved Typing Agent Demo Account set up, you will need to request a Trial account from your Account Rep listed within your district portal. To see who to contact, login to your Typing Agent account and click on the arrow next to your name at the top right then select Account.  Your Account Rep's contact will be shown there. You can also email support@typingagent.com to request your trial.

2. Within the ClassLink portal, search for and approve the Typing Agent application Icon. 

Make sure to use the App Icon that has OAuth as the authentication method. This makes Single Sign on though ClassLink easy. 

Typing Agent will get notification that you have requested this however to ensure you get connected and have the right licensing for your rostering, we strongly advise you to contact your Typing Agent Account Rep. Let them know the schools and grade levels that will be connecting with ClassLink. Again, this information can be found under your Typing Agent District > Account link by clicking on your name in the top right of the portal. 

Once Typing Agent receives the request, we are going to check the following on your account: 

  1. Does your account have existing users? 

  2. Does your account have the right number of licenses allocated?

  3. If you have current users, do the usernames match or are they different? 

  4. Do you have current data in the system and how will that affect your users? 

The best way to guarantee success with ClassLink is to make sure the usernames in ClassLink match the users in Typing Agent, if you have existing data. 

The users in ClassLink will retain their data IF the usernames in both systems are EXACTLY the same. When the data is pulled over from ClassLink, our system will do the following: 

Soft delete all your current Schools, Classes, Staff and Students. 

Roster the Schools and Classes into Typing Agent as you have in ClassLink Data.

Pull in and try to match staff and students' usernames then associate the ClassLink account with those existing users. 

Roster the staff and students as per your enrollments. 

After this is done, Typing Agent will make sure that in your district portal, we have enabled the ClassLink SSO function to work with your OAuth authentication from ClassLink. 

From your District Portal click on School Management > District Portal 

From here, select your District Portal. Then, scroll down to Login Options, where you can enable Single Sign On with Classlink.

Login with ClassLink must be selected to enable OAuth Sign in from ClassLink. 

Option to add School Admins: 

Because Typing Agent does not control nor assign roles within ClassLink, Typing Agent gives account managers the ability to add district and school admins to our program using CSV (Comma Separated Value) files. Then, some teachers are rostered in ClassLink as teachers but they need to have admin capabilities, too. Add these dual-functioning teachers into Typing Agent using a CSV file with the appropriate admin codes put in that Role column.

The main concern is that these new admin usernames do NOT match usernames in ClassLink. If they match, the system will overwrite them when the nightly sync occurs hence making null and void your admin role creation.

ClassLink Sync: 

Typing Agent will run a nightly cron job on our server. This will pull any data into Typing Agent that has been updated in your rostering system. This should take place around Midnight PST each night. 

If you find your data is not in sync, email our support team at:  Support@typingagent.com and we can perform a manual pull which should sync your ClassLink data with Typing Agent immediately.  (Depending on the size of your sync, this could take up to 24 hours to process.)

NOTE 1:  Typing Agent allows alternative SSO for Typing Agent such as MS SSO or Google SSO, however we only match the usernames to these SSO methods and not the email address.  

NOTE 2:  Typing Agent does not pull over students' email addresses with your data sync -  only their usernames.  

Did this answer your question?