Rostering Integrations

About OneRoster

OneRoster Format Overview

Please note that each data table is a .csv file. 

Click here to view a breakdown of each file.

CSV File	Description
manifest.csv	Contains the list of files that are supplied in your upload.
academicSessions.csv	Describes the quarters, semesters, or terms during which classes will be taught.
classes.csv	Lists the classes taught for each course.
enrollments.csv	Assigns users to their various classes
users.csv	Describes the various users of the organization.
orgs.csv *	Describes the organizations to be included in the roster information.
courses.csv *	Establishes the course to which multiple classes may belong.
demographics.csv **	Describes the demographic information of each user.

If your district intends to set up Auto-Registration, you will need to send additional .csv files. Please refer to our Auto-Registration documentation for specific instructions regarding your roster data. 

CSV File	Description
resources.csv	Contains resource information that will be used to link a teacher to a Quaver license via a class or course.
classResources.csv	Links a resource from resources.csv to a class
courseResources.csv	Links a resource from resources.csv to a course

Delivering OneRoster Files

Step 1: Provide IP address, and connect via sFTP

Please email the Quaver Integrations team at integration@quavered.com to request SFTP credentials. Please provide the public IP address that will be delivering your files. 

You may establish a connection using any capable sFTP client. Quaver operates on the default sFTP Port 22. A successful connection will open to your district’s root directory automatically.

Step 2: Deliver roster files

Locate your OneRoster files in your local file system, and upload the OneRoster files to your root directory ‘/’ on the Quaver server. 

Please ensure that all files are named exactly as specified prior to transfer, including the .csv suffix. Be sure to verify that the transfer of each file completed successfully.

Step 3: User testing

After your first file set is delivered to production, we will need to test with a Quaver teacher in the district to ensure that their rosters are built correctly when they go through the typical workflow. You should identify a teacher who currently uses Quaver and is willing to participate. The more responsive this teacher can be, the faster testing can proceed.

Remember that an automated rostering integration with QuaverEd also requires users to be able to log in via a Single Sign-On (SSO) integration.

Testing involves two steps:

1. The teacher will log into Quaver using your district’s SSO method.
   • If this is the user’s first time signing in via SSO, they will see our account provisioning page. 
   • When prompted, the teacher should select “Link existing QuaverEd Account” and enter their Quaver account credentials.

2. The testing teacher will need to check their Classes and Student Accounts in the Student Admin section of the Teacher Dashboard. If the test is successful, the teacher should see their rosters automatically populate.

Step 4: Scheduling regular file delivery

You can submit updated file sets to the production server as frequently as every day. We process files on a nightly basis. Sending updated files regularly ensures that teachers have accurate rosters in Quaver.

Step 5: Release

Once we have confirmed that the rostering integration is working properly, we will launch the functionality district-wide. 

About Auto-Registration

An Auto-Registration integration automatically provisions the appropriate access levels and creates accounts for your teachers using your OneRoster data. In doing so, this integration removes the need for teachers to register their Teacher Access Code to gain access to Quaver. To do this we use the teacher’s name and email along with their associated schools to determine their access and create their account. A simple integration can be achieved by supplying the following data with an SSO and rostering integration:

• First name, last name, email, role (i.e. teacher, student, etc)
• OneRoster orgs data with NCES ID in the “identifier” field.

Note: If the OneRoster orgs data is not supplied, teachers can be given the option to select which schools they are associated with.

A more granular integration can be achieved by using the resources dataset of the OneRoster format. An integration using the OneRoster resources service can be set up via OneRoster.CSVs sent via SFTP, or with ClassLink OneRoster API (other APIs don’t currently support the resources service). This service is mainly useful if you want to control which teachers are granted access or have multiple QuaverEd products. Here are the pieces of information we need to provide this service:

• An SSO or rostering integration that supplies the following data for teacher users: first name, last name, email.
• OneRoster orgs data with NCES ID in the “identifier” field.
• OneRoster resources data with appropriate “vendorResourceIds” (QuaverEd will provide these)
• OneRoster classResources and courseResources to associate QuaverEd resources with a teacher’s enrolled class.
• Teachers in OneRoster users are associated with an org that has a valid QuaverEd license and enrolled as teacher in a class with the appropriate resource.

It is important to note that a rostering integration with Quaver requires that we also integrate via Single Sign On (SSO) for your district. To set up an Auto-Registration integration, reach out to the integration department at integration@Quavered.com.