OneRoster CSV
OneRoster CSV integration accepts your data in a set of Comma Separated Values (CSV) files, uploaded via a zip archive of CSV files.
The file formats you will be working with are and will be processed in the following order:
- manifest.csv
- academicsessions.csv
- orgs.csv
- courses.csv
- classes.csv
- users.csv
- enrollments.csv
Mapping Values
The below mapping table explains how the OneRoster object types relate to the D2L Brightspace environment.
OneRoster
|
D2L Brightspace
|
| Academic Sessions |
Org Units*
|
| Orgs |
Org Units* |
| Courses |
Course Templates |
| Classes |
Course Offering and Course Section |
| Users |
User |
| Enrollments |
Enrollment |
*The org unit type each object is mapped to is dependent on the D2L SIS Integration configuration setup in the IPSIS Administration UI mapping section.
The OneRoster CSV integration is capable of creating, updating at the levels listed above. Anything outside this list should be managed outside this integration.
The Org Unit naming conventions (Name/Code) should follow that described in your SIS. Brightspace can accept as many Org Units as needed, Org Unit names and codes can be fed as-is through the CSV files as long as names or codes respect Brightspace illegal character requirements.
- Manifest
- The manifest must be included with each package. The manifest contains the version and the list of files that are being sent to Brightspace. It also specifies Delta versus Bulk.
- Academic Sessions, Orgs, Schools, Courses, Classes
These must be sent at least once to instruct IPSIS on which Org Unit it is able to control.
You should only resend Org Unit files when they need to be added or updated in the org structure in the learning environment.
OneRoster CSV can:
- Create a new Org Unit if it doesn’t exist
- Map to an existing Org Unit if it was created by a different source to OneRoster
- Update the name or code of an Org Unit that it controls
- Course Template: assign and update parent Schools based on the School code
- Course Offering: assign and update parent Schools based on the School code
- Course Offering: assign and update parent Course Template and Semester based on the parent code
- Course Offering: Update all course details including course offering name
- Update Org Unit codes
- Copy Course Content to New Course
- Delete an Org Unit if the delta file is sent with Status tobedelete and the Org Unit has no enrollments
OneRoster CSV will not:
- Delete manually created Org Units unless they been mapped with OneRoster CSV
- Delete an Org Unit if it has children linked to it (children must be deleted first)
- Maintain start or end dates for any org unit type
- Users
Processing the user type creates, updates or inactivates users in Brighspace. Users must be sent at least once to instruct IPSIS on which User profiles it is able to create, update and manage enrollments of. Users are automatically enrolled into the school.
OneRoster CSV can:
- Create new user if it doesn’t already exist
- If a user exists with same ‘OrgDefinedID’ then it can be mapped to the existing user
OR
- If a user exists with same ‘Username’ then it can be mapped to the existing user
- Update First Name, Last Name, Password and Email
- Password is not required
- Update the Org level role
- Activate, or Inactivate a user
- Update the OrgDefinedId or Username
OneRoster CSV will not:
Enrollments
Processing the enrollment type enrolls or unenrolls users in Brightspace at the course section level. Enrollments should be sent when changes are made in the information system to accurately reflect those changes in Brightspace. An unenrollment should only be sent once. Resending the same unenrollment will cause warnings in your IPSIS log.
OneRoster CSV can:
- Enroll users in Course Offerings and sections
- Un-enroll users from Course Offerings and sections
OneRoster CSV cannot:
- Enroll users at other org levels
Limitations and Assumptions
Limitations
- Unenrollments at Upper Org Units
- Enrollments via the User’s Org property cannot be unenrolled via the OneRoster integration at this time.
- Unsupported characters
- There are several characters that we do not currently support being entered for the Org Unit Code
Unsupported Characters: \ : - * ? “ ” < > | ‘ # , % &
- Comes from
- Academic Sessions Title
- Course Title or Course Code
- Class Title or Class Code
- Org Name or Org Identifier
Truncations
- Org Unit Code – Length 50
- Academic Sessions Title
- Course Title or Course Code
- Class Title or Class Code
- Org Name or Org Identifier