Product: Roster Server
Audience: ClassLink Administrator
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 Roster Server.
Overview
- OneRoster 1.1 CSV Download
- Mandatory CSVs
- Highly Recommended CSVs
- Optional CSVs
Note: When viewing or editing CSVs, it is NOT recommended to use Microsoft Excel. It is recommended to use a text editor such as NotePad++ instead.
OneRoster 1.1 CSV Download
Download the base OneRoster 1.1 CSV files here: OneRoster 1.1 Blank Template.
The first step in creating the necessary files for the ClassLink Roster Server 2.0 is determining the necessary data.
The server requires a minimum of 7 files, the 8th file (demographics.csv) is strongly recommended.
Note: All filenames and field headers MUST be identical to those listed in the specs. All columns in the templates are required. If a column is marked as not required, that means that values for that column are not required, though the column itself must still be present. For an example of OneRoster 1.1 files, click here: OneRoster 1.1 Template w/ Sandbox Data.
Mandatory CSVs
manifest.csv
Describes the set of files that are being transmitted.
academicSessions.csv
Describes different time periods such as Marking Periods, Semesters, Quarters, etc. 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 or school 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 teachers and students. They MUST be associated with a course and an org that exists in the courses.csv and the orgs.csv. In the ClassLink Roster 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 MUST match the user’s ClassLink 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 CSVs
demographics.csv
Describes the demographics of users. This file is important for the end of year reporting and for several administrative tasks that certain vendors may require.
Optional
If resources are included, all three files must be included as well.
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.
Click here to learn more about manifest.csv
Updated: Dec 2018