Product: Partner Portal
Audience: Partner Admin, Partner Developer
The Roster Server Tenants tab shows all of the tenants that have added an app with one of your Roster Server Connections. For each tenant, you can view details on authentication, connection, and the roster data being sent from their Roster Server.
Overview
View Roster
Partners can view a tenant's roster data that has been successfully imported to a district’s Roster Server.
To view this table, click on View Roster.
The data in the table is divided into sections that correspond to the Roster Server CSV files. For each section, data can be sorted by property by clicking the desired property. You can also search for data with specific values by typing into the text box below the desired property to search by.
Use the top dropdown to filter through All, Active, or Deleted data.
Clicking on the blue eye in Users will slide in a side menu which shows all of the users' enrollments.
The side menu will contain the user's sourcedId, his/her name, the org that he belongs to, which grade he/she is in, and what enrollment data the user has. You can be able to use this data to quickly check which classes a student is enrolled in, without having to find the student's sourcedId and perform a search using the Find feature.
Clicking on the blue eye in Classes will bring out a side menu with more information about that class.
The side menu contains the sourcedId of the class, the class title, the org that class belongs to, the grade that it's taught at, the teachers of that class, and the students attending. This allows you to quickly check class rosters to see if a particular class does not have either students or teachers.
Note: This expanded view (blue-eye) is only available on the Classes and Users collection.
Sanity Check
The Sanity Check is a debugging tool to see what data an application has access to. It will also show you how many students have no enrollments, how many classes have no students or teachers, among other things.
Running a Sanity Check:
Note: Make sure that your browser allows pop-ups to be displayed.
Click on the clipboard icon on the right side of the page for a specific district’s Roster Server. A new tab will open, and the Sanity Check will run. It may take a few minutes to gather all the data.
Note: Once a sanity check is started, you cannot run any more checks until it finishes, or the server is reset. Make sure to only run one test at a time. Trying to run multiple checks at once will generate an error message.
Please refer to this article for an explanation on how to read Sanity Check results.
Data Summary
On the right side of the table, click the down arrow to view a district’s Data Summary. Data Summary shows the last API call and CSV Export on the left, along with a breakdown of how many of each data collection a Roster Server is sending to the Partner.
Test Sandbox Access
On the top right, click on Test Sandbox Access to view the details to access the Classlink Roster Server Sandbox.
View API Key
On the top right, click on View API Key to conveniently view the keys used to fetch Roster Server Connections and a list of Roster Servers sharing data with you.
These keys are added and further managed by admins in Partner Settings under API Keys.
Updated: June 2020