ClassLink Support Docs

ClassLink Support Documentation

Welcome to the ClassLink Support Docs page. You'll find comprehensive guides and documentation to help you start working with ClassLink as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results

OneRoster 1.1 CSVs

ClassLink OneRoster 1.1 CSV Overview

The purpose of this guide is to provide you with the CSV specs for IMS Global OneRoster V1.1 with tips to ensure smooth usage with your ClassLink OneRoster server.

OneRoster 1.1 CSV Download

Download the base OneRoster 1.1 CSV files here.

Note

All filenames and field headers MUST be identical to those listed in the specs. All columns in the templates are required.

CSV Overview

The first step in creating the necessary files for the ClassLink OneRoster 2.0 Server is determining the necessary data.

The server requires a minimum of 7 files, the 8th file (demographics.csv) is strongly recommended.

Mandatory:

Filename
Description

manifest.csv

Describes the set of files that is being transmitted.

academicSessions.csv

Describes different time periods that are referenced in other files.

orgs.csv

Describes “organizations” that are referenced in other files. Generally, there will be a “District” org and an org for each building within the district.

courses.csv

Describes course offerings. These are sometimes referred to as “class templates” and are not assigned to teachers or students.

classes.csv

Describes the classes that are being taught. These are sometimes referred to as “sections” and are assigned to teacher and students. They MUST be associated with a course and an org. In the ClassLink OneRoster server, permissions are generally assigned to classes based on the org and course to which they belong.

users.csv

Describes all users in the system. There will generally be one row for every student, teacher and administrator. For integration with ClassLink OneClick, the “username” column should match the user’s login credentials (Active Directory username or Google username).

enrollments.

Describes the association between users and the classes they teach/take. Each row needs a unique identifier (sourcedId) and it is generally advised that the classSourcedId and the userSourcedId be combined to create a unique combination.

HIGHLY recommended:

Filename
Description

demographics.csv

Describes the demographics of users. This file is important for end of year reporting and for several administrative tasks that certain vendors may require.

Optional:

Filename
Description

resources.csv

Describes resources that can be assigned to classes and course. In general, this will be used for book codes, but can also be leveraged for other purposes in different pieces of software.

courseResources.csv

Describes an association between a resource and a course. This will be useful if the resource should be assigned regardless of which building or teachers use it.

classResources.csv

Describes an association between a resource and a class. This will be useful if the resource should be assigned to classes, but are only used in certain buildings or by specific teachers.

OneRoster 1.1 CSVs