ClassLink API + SSO Sync

This article is for advanced users who are both the System Administrator within Wayfinder and a District Administrator in ClassLink.

Overview

ClassLink Rostering provides a quick, easy way for you to update and maintain your teachers, students, and sections in Wayfinder. Use the following instructions to sync with Wayfinder through a ClassLink API sync (compatible with OneRoster CSV files).

You may also roster "administrator" users from ClassLink. See the "Role Mappings" section below for details. If you opt to roster your administrator users manually, you may follow these instructions. 

This article contains the following sections: 

• Step 1: Verify Your Terms and Allowlisting
• Step 2: Adding Wayfinder in ClassLink
• Step 3: Set Up Sharing Rules
• Step 4: Wait for Confirmation
• Step 5: Complete Set Up in Wayfinder

ClassLink API

Step 1: Verify Your Terms and Allowlisting

Please check to make sure your terms are correct before going forward.  If you're unsure where to find and manage your terms, see Managing Terms.

Also, please ensure these Wayfinder domains are allowlisted. 

Step 2: Adding Wayfinder in ClassLink

1. Login to ClassLink and open your Roster Server.
2. Click on "Add new app" and search for "Wayfinder."
3. After you add our app, ensure that you toggle it "on."

Step 3: Set Up Sharing Rules

Please proceed to add sharing rules that reflect the data you plan on sending to Wayfinder. If you are unsure about the data you should be sending over, please connect with the person who is leading Wayfinder at your school, and copy our team at [e-mail]. 

Sharing Administrators

If you will be sharing administrators, you will need to set up user mappings in Wayfinder. See Step 5 below.

Then, please also ensure that: 

• Your administrators are listed in "Users"
• Your administrators have a valid role in "Enrollments"
• Your administrators have a valid school ID

If you are unable to provide these requirements, please email us at [e-mail]. 

Step 4: Wait for Confirmation

When you add the Wayfinder application, we'll be notified by ClassLink. Assuming you are a Wayfinder customer, we'll set up the ClassLink connection on our end within 2 business days.  When we do, two things will happen.

1. ClassLink settings will become available in the Wayfinder Web App (we'll review this below)
2. A representative from Wayfinder will be in touch with you about your account within 24-48 hours to activate your account and push an initial sync through.

Step 5: Complete Set Up in Wayfinder

Once we have confirmed that the set up is complete, you'll be able to configure your rostering settings within Wayfinder: 

1. Log into the Wayfinder application. 
2. Choose "Admin" from the left links panel (System Administrators only).
3. Click on the "Import Settings" tab.
4. Select the "ClassLink" option under Rostering Type.  (The ClassLink option is selectable after completing the steps above. Please contact us if it's grayed out, but you believe it shouldn't be.)

Then, select your settings as described below:

Term

ClassLink roster data will be added to a particular term in Wayfinder.  Here, you can select from either Auto Detect or a specific term. 

Auto Detect

ClassLink allows you to set up Academic Sessions (terms).  If you have sent this data to ClassLink along with start and end dates for your terms, selecting the Auto Detect option will attempt to match that data with what Wayfinder has in the Term Manager. Wayfinder attempts to make the match using term name and academic year. 

For instance, if you have a term named "Semester 1" term in ClassLink, and that term has a start date of January 8, 2023, it would match to a term in Wayfinder of "Semester 1" in the academic year "2023-2024". The start and end dates aren't considered and don't need to match exactly.

Specifying a Term

Alternatively, you can choose a specific term. If you specify a term, all incoming data from ClassLink will be pushed into the specified term in Wayfinder, regardless of the Academic Session names and dates in ClassLink. Specifying a term is useful if you have multiple Academic Sessions in ClassLink, but would like to have only one year-long term in Wayfinder. In this scenario, you will need to remember to switch terms when you have new term data available in ClassLink. To edit your terms in Wayfinder, see this article on Managing Terms.

Sync Time

Next to sync time, you'll be able choose a time between 7pm and 3am local time.  This assures processing is completed overnight when there's the most computing resources available.

Allow % Change

We recommend leaving this at 10%. This is the percentage of changes or deletions allowed by the upload, intended to prevent mass data loss in case of an error in your files. 

Allow Custom Classes

This setting enables staff members to create standalone classes that are not affected by automated rostering. Please note that custom classes must be managed independently and will not be updated with each roster sync. Refer to our How to Enable Custom Classes after Auto-Rostering for details. 

Configure Class Names

By default, the class name that appears in Wayfinder is mapped directly from the class "Title" field in ClassLink. The Configure Class Names setting allows you to customize how class names appear in Wayfinder. These settings apply to all classes, across all schools. 

You can select the following tags to appear in the primary Class Name or secondary Subtitle Tag:

• Class Name
• Teacher 
• Title 
• Period
• Class Code 
• School Year Source ID

Follow these steps to adjust how class names appear: 

1. Use the "Class Name" dropdown to select the fields that will make up the class name
2. Use the "Subtitle Tags" dropdown to select optional fields to display as subtitle tags beneath the class name
3. Finally, review the Preview section to see how your selected settings will appear throughout Wayfinder. on class tiles

Role Mappings (for Administrator rostering)

These settings enable you to configure how your administrators in ClassLink map to Wayfinder. In order to auto-roster your administrators from ClassLink, you'll need to ensure the following: 

• Your administrators are listed in "Users"
• Your administrators have a valid role in "Enrollments"
• Your administrators have a valid school ID

Once you've completed the items above, return to the Role Mappings section and click the Expand button. Choose which Wayfinder role you'd like your administrators to have, and enter "administrator" in the box under that role. For example, enter "administrator" under the School Admin section if you want all Classlink admins to be School Admin in Wayfinder. To read more about our Wayfinder Roles, see Account Types Overview.

Testing and Saving Your Connection

Once you've chosen a term and a sync time, you can click on the "Test Connection" button to try out the sync.  You should see a green button with a "Connected" note.  If not, please recheck your sharing permissions in ClassLink and Step 4 of this help article.  If you still can't connect, please contact us.

Once you're satisfied with your settings, click on the "Save Import Settings" button.

Finally, if your data is ready in ClassLink, you will probably want to choose "Run Import Now" to see how things go!  Once the import is run, you'll see your results and be able to troubleshoot any problems on the Import Logs page.

Reviewing Import Logs

If you are experiencing any roster issues after rostering through ClassLink (ie. missing users or classes), you may want to review the Import Logs to track down any problems that might have occurred during the nightly sync. On the System Administration page, click on the "Import Logs" tab to review the most recent imports. 

For more information on troubleshooting and resolving import errors, see our Import Logs and Roster Troubleshooting guide. 

ClassLink SSO

To see our other login methods, visit How Do I Login? 

1. To set up ClassLink, open your LaunchPad.
2. Search for "Wayfinder."
3. If you rostered using ClassLink, take the rules from your roster server and link it to this app
4. If you have not rostered using ClassLink, set the appropriate rules so all staff, teachers, and students that use ClassLink can login.

If you need a work-around to ClassLink SSO, you may see this guide on how to set up a password locker instead.

Note: If you would like to restrict logins to SSO only, email us at [e-mail] to get the username + password login option disabled. 

ClassLink Roster (SFTP)

To roster with SFTP, see our article on SFTP Data Sync.