This document describes details of the OneRoster CSV configuration, requirements, and recommendations for implementing integration with your Student Information System (SIS).
Brightspace synchronizes with the SIS when using OneRoster CSV in Bulk mode. Enrollments that are no longer included in the OneRoster CSV file, when using Bulk mode, are treated as unenrollments in Brightspace.
This approach only applies to sections that are included in the OneRoster CSV file. Enrollments that are no longer included for sections that are also excluded from the OneRoster CSV file are ignored, as these are typically for sections from previous terms.
For CSV integrations, support for the OneRoster v1.1 specification allows administrators to upload a OneRoster 1.1 compliant package that contains the required roster related data (schools, classes, users, enrollments, etc.) and see the imported results in the Brightspace platform. The new IPSIS user interface allows administrators to upload a package using the drag-and-drop method.
Important: This document is specific to OneRoster CSV requirements. The CSV files that are required for the OneRoster are text files saved in a Comma Separated Values (CSV) format. CSV files are only expected to be UTF-8 encoded. Generating content for the files will require some sort of data access from your SIS system. Some SIS systems provide you with data export mechanisms which should be used as per your vendor instructions.
We recommend that you contact your source system provider and seek guidance on best practices for extracting the required data into the needed CSV file format.
Supported OneRoster CSV files
The following files are supported by OneRoster CSV:
When you use OneRoster CSV in Bulk mode, it provides the Student Information System (SIS) the ability to automatically unenroll users from courses and sections when they are no longer included in the OneRoster CSV bulk file. It also provides the ability to keep Brightspace in sync with the SIS when using OneRoster CSV in Bulk mode as unenrollments are not explicitly sent in the OneRoster files.