Rostering via ClassLink

Overview: 

• This article covers the steps to set up rostering and single sign-on for Literably via Classlink. 
• Rostering: districts can share OneRoster CSV files with Literably over SFTP via ClassLink’s roster server and management console. 
  • • Here are Literably's OneRoster formatting requirements/directions.
    • Literably will sync each district's OneRoster files nightly.
• Single Sign-On (SSO):
  • • Literably allows for ClassLink SSO on its web version (literably.com/login) and via iOS (on an iPad)

• If you are moving from a different rostering system (manual CSV uploads, OneRoster without Classlink, or Clever) to ClassLink, please review the information at the end of this Help Center article to ensure that historical student assessment data is preserved.

Rostering best practices: information about Literably emails and data:

• Please only share necessary classes/courses/enrollments with Literably. This is important for a few reasons: 
  • Reduce unnecessary emails: In Literably, all shared teachers associated with a student will receive summary results emails from Literably. As an example, if you share each student's Art, PE, and Math teacher with Literably, those teachers will receive summary results emails from Literably (which might not be necessary for those teachers).
  • Improve accuracy of data exports: In Literably data exports (more info. here and here), we will associate a teacher with a student for every graded assessment that is taken. If a student is only associated with one teacher, then that student will be associated with that teacher in the Literably data export. If a student is associated with multiple teachers, Literably will associate the student with the teacher who has the highest Literably ID number (which is somewhat arbitrary). 

Required steps if you are new to Literably:

1. Email Literably your district's Tenant ID 

2. Connect with Literably: Districts (not vendors) have to initiate connecting with Literably from the ClassLink Launchpad. Below are screenshots that show you how you can initiate this connection in ClassLink from the Roster Server, by searching for Literably in Applications tab.

We recommend setting up rule-based permissions in order to share only the users and sections who need access to Literably:

3. Share your OneRoster files via file exports: Districts typically set up Classlink to import rostering data from their SIS. This data can then be exported to applications like Literably in the form of OneRoster files. This will create the necessary Literably accounts and dashboards at your district.

Go go "File Exports" under the Literably app, and complete the following:

Server Details:

• In the IP address or Hostname field (see screenshot below), enter: sftp.literably.com
  • The port number should be: 22
• In the Path field (see screenshot below), use the phrase: /home/username. Your district's "username" is the SFTP username that was provided to you by Literably. For example, if your SFTP username is "hogwarts," your path should be /home/hogwarts.

Authentication Details:

• These are the SFTP credentials provided to you by Literably after your district's onboarding call.
  

File and Schedule Details:

Fill out the export template, and set your export schedule. Please ensure that your OneRoster files follow the formatting rules/requirements found here. Enable the daily export schedule so that any rostering changes are pushed out to Literably on a regular basis.

4. Set up permission rules: Under App Overview, enable the Literably app and set up permission rules:

Since it is a reading assessment application, Literably is typically used by home room teachers in the elementary grades, and ELA/reading teachers in upper grades. It often works well to set up permission rules by subject/grade, but this depends on the details of your district's Literably subscription. If you have questions about setting up rule-based permissions, please contact [e-mail].

If needed, please share any necessary school and district admins within your OneRoster files.

5. Enable Single Sign-On App:  From the Classlink Management Console, search for Literably in the App Library, then add the app (OAuth2):

From the app list, assign the Literably app to the appropriate users:

6.  Test logging into Literably: After your OneRoster files sync over the Literably (typically the next day), please test out logging into Literably as a student, teacher, and admin via ClassLink SSO, on both a computer and iPad (see step 6 here). If students are using iPads, please make sure that the Literably app is also installed on iPads.

How can we share students/sections outside of the data in our SIS?

One option might be to use Manual Record in ClassLink (details here). This will allow you to set up students and dashboards outside of the data that is synced with your SIS:

You can also reach out to your ClassLink contact or to ClassLink support, to see if they have any additional recommendations.

If you have been using Literably previously and rostered using a different method, please read the following information about how to preserve student data:

If transitioning from manual CSV uploads: If you want your students' Literably assessment data to be preserved when you transition to OneRoster rostering on Classlink, it is required that each user's (students, teachers, admins) sourcedid from your district's OneRoster files (located on your district's users.csv(s)) is identical to their "Student ID" and "Teacher ID" found on your most recent Literably CSV files.

• Information on manual CSV rostering

If transitioning from OneRoster (without ClassLink): if you want your students' Literably assessment data to be preserved when you transition to OneRoster rostering on ClassLink, it is required that each user's (students, teachers, admins) sourcedid from your district's OneRoster files (located on your district's users.csv(s)) is the same sourcedid that was used for them in previous years (when your school/district was using OneRoster but not ClassLink).

• Information on SFTP/OneRoster

If transitioning from Clever: if you want your students' Literably assessment data to be preserved when you transition to OneRoster rostering on ClassLink, it is required that each user's (students, teachers, admins) sourcedid from your district's OneRoster files (located on your district's users.csv(s)) is the same as the SIS_ID that was associated with the user on Clever.

• Information on rostering via Clever

Please contact [e-mail] for further support with transitioning from another rostering method.