OneRoster is the standard IMS Global specification designed to allow secure sharing of class rosters and related data between a Student Information System (SIS) and any other system.
Brightspace’s OneRoster implementation supports spreadsheet (CSV) import, as well as direct system exchanges using REST APIs.
The Brightspace implementation of the OneRoster v1.1 specification lets administrators schedule data to be pulled from their SIS to populate the required roster related data such as schools, classes, users, or enrollments in Brightspace.
The IPSIS OneRoster REST user interface includes a schedule to allow administrators to configure the time of day when the data pull occurs. For an SIS supporting grades passback, administrators can set the grades to be returned with the daily data sync and / or allow a faculty member to initiate a manual sync.
Before you configure your OneRoster integration in the IPSIS Administration area, review the following setup instructions.
Set up roles for OneRoster
You must first review roles configured in your SIS, and ensure that there are appropriate corresponding roles in Brightspace.
To review roles for OneRoster
- Review the roles that are configured in your SIS. The following roles are available in OneRoster:
- Administrator
- Aide
- Guardian
- Parent
- Proctor
- Relative
- Student
- Teacher
-
For any of the above roles you want to send into Brightspace, if there aren’t already appropriate roles in Brightspace, create them from Roles and Permissions before you configure your SIS Integration. For more information, refer to Managing Roles and Permissions.
Set up org unit types
You must also review the org unit types that are set up in your SIS and ensure corresponding types are set up in Brightspace.
To review org unit types
-
Review the org unit types that are configured in your SIS. The following org types are available in OneRoster:
-
National
-
State
-
Local
-
District
-
School (mandatory)
-
Department
- For any of the above org unit types that you want to send into Brightspace, if there aren’t already appropriate org unit types in Brightspace, create them from the Org Unit Editor before you configure your SIS integration. You will be required to set up mappings between org unit types in the SIS and in the Brightspace when you create the SIS Integration. For more information, refer to Create and delete org unit types.
Understand the mapping of data types between OneRoster and Brightspace
OneRoster object types do not map exactly with object types in Brightspace. The following table shows the mapping relationship between OneRoster and Brightspace object types.
|
Note: Org Unit types are typically custom org unit types that you can map during the configuration process.
|
| OneRoster data type |
D2L Brightspace data type |
|---|
| Academic sessions |
Org Units |
| Org |
Org Units |
| School |
Org Units |
| Course |
Course Template |
| Class |
Course Offering and Course Section |
| User |
User |
| Enrollment |
Enrollment |
| Line item categories |
Grade categories |
| Line items |
Grade items |
| Results |
Grades / Scores |
Responsibilities for parent/guardian relationships
|
Note: This information is for K-12 clients who want to use Brightspace Parent & Guardian. |
Your institution is responsible for maintaining the accuracy of user relationships in your Student Information System (SIS). Consult with your advisers to ensure you adhere to your institution’s privacy and security policies, and applicable laws. For example, your institution or jurisdiction might have a policy or law that specifies when a child turns 18, the parent/legal guardian should no longer have access to their child's content, unless the child consents to granting access; this case needs to be handled while generating and sending parent/guardian-child relationships to Brightspace.
Basic configuration of a OneRoster REST integration
The following steps describe the high-level sequence to aid in understanding. Basic configuration of OneRoster REST requires the following general steps:
- In your organization’s SIS, generate a OneRoster Consumer for Brightspace with which to call into your SIS. The process for this varies depending on your SIS. Consult your SIS representative for more information.
- Record the OAuth Credentials from your SIS.
- Record the URL of your SIS’s OneRoster endpoint. For example, https://www.sis.com/school/api.
Important: Do not include ims/oneroster/v1p1 on the end of the URL. D2L does this within the IPSIS Service.
- Complete the configuration in the new IPSIS Administration area. If you have existing records you want to match with the OneRoster data, ensure that for the questions pertaining to linking Brightspace data with their SIS equivalents, you select the appropriate options.
- In the Scheduled Updates field, select the time each day that you want your REST integration to sync automatically with your SIS.
- When you save your integration, it will begin to process when the time of the next scheduled update occurs. If you want to run your integration immediately, on the Batches page, click Run Update Now and select Resync all SIS records.
Basic configuration of OneRoster CSV integration
The following steps describe the high-level sequence to aid in understanding. Basic configuration of OneRoster CSV requires the following general steps:
- Create a CSV file with your roster related data.
- Complete the configuration in the IPSIS Administration area. If you have existing records you want to match with the OneRoster data, ensure that you select the appropriate options for the questions pertaining to linking Brightspace data with their SIS equivalents.
- On the Batches page, drag and drop or browse and select a ZIP file containing the CSV file with your roster-related data.
Your integration begins to process automatically.
Verify a OneRoster integration
Administrators can verify a OneRoster integration using the following methods.
To verify a OneRoster integration
- To determine if a REST integration is complete, navigate to IPSIS Administration > Audit Log. Refresh the page to verify if all the expected record types (such as user, org unit, and so on) have run.
- To determine if a CSV integration is complete, do one of the following
Batches Page: After uploading a CSV ZIP file, the processing indicator appears on the Batches page in the source system. Refresh the page to confirm the indicator shows Completed.
Audit Log: Refresh the Audit Log to verify all expected record types have been processed.
- To determine if either type is complete, do the following:
- Org Units: Use the Org Unit Editor to review all org units that were created and make updates if necessary.
- Users: Use the Users tool to review the users that were created and make updates if necessary.