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.
When viewing or editing CSVs, it is NOT recommended to use Microsoft Excel. It is recommended to use a text editor like NotePad++ instead. https://notepad-plus-plus.org/
If you want to use Excel to view or edit CSVs, follow the steps on Using Excel to edit/view CSVs
OneRoster 1.1 CSV Download
Download the base OneRoster 1.1 CSV files here.
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
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.
Describes the set of files that is being transmitted.
Describes different time periods that are referenced in other files.
Describes “organizations” that are referenced in other files. Generally, there will be a “District” org and an org for each building within the district.
Describes course offerings. These are sometimes referred to as “class templates” and are not assigned to teachers or students.
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.
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).
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.
Describes the demographics of users. This file is important for end of year reporting and for several administrative tasks that certain vendors may require.
If resources are included, all three files must be included as well.
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.
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.
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.