Work with your Brightspace Implementation Consultant to set up your OneRoster source system. Brightspace uses default settings, but you can edit them anytime with the necessary permissions.
To update the integration, go to Admin Tools > IPSIS Administration > Configuration tab.
Most settings apply to both OneRoster CSV and REST connections, with differences noted for each connection type.
Credentials
To create SFTP Credentials (OneRoster CSV integrations only):
To import CSV data into Brightspace, set up an SFTP site and upload your data. If you don’t have an SFTP site, click Create SFTP Site. Save the Address, Username, and Password for future uploads. The password is hidden and cannot be recovered after saving, but you can generate a new one anytime.
To create Credentials (OneRoster REST integrations only):
REST endpoints and access credentials are unique to each SIS integration.
During setup, obtain OAuth credentials from your SIS. Coordinate with your SIS before making any changes to these credentials.
The OneRoster REST integration supports OAuth 1.0a and OAuth 2.0. Confirm the supported protocol with your SIS vendor.
Source System
Ensure the following fields are correctly configured:
SIS Name: Administrators can edit this field. Keep it updated.
Scheduled Updates (REST only): Set synchronization between Brightspace and the SIS for off-hours, preferably overnight.
Deletion (REST only): Enable this option to prevent unenrolling teachers and students from previous term courses after a term ends. Ensure an SIS Group mapping of type Term is set up under Courses and Sections.
Overwriting Brightspace: Specify which fields (Users, Courses, Org Units, Enrollments) the SIS can overwrite in Brightspace.
People
Within the People section, you can configure the SIS Role Mappings, Default User Status, and Map SIS Entries to Existing Users settings.
SIS Role Mappings contains the role mapping between OneRoster and Brightspace. Teacher and Student roles are included by default; you can delete these roles or add additional roles to meet the requirements for roles in your environment. The following roles are available in OneRoster:
- Administrator
- Aide
- Guardian
- Parent
- Proctor
- Relative
- Student
- Teacher
|
Note: If the SIS sends a role without a mapping to a Brightspace role, IPSIS reports an error, and the user is not created.
If there are users that cannot be filtered by GG4L and you do not want to create unwanted roles in Brightspace, exclude the mapping for those roles. However, this workflow results in IPSIS errors when creating users or enrolling them in courses.
|
Courses and Sections
Within the Courses and Sections area, there are configuration options for mapping between SIS org types and Brightspace org unit types, options on deletion behavior, mapping SIS entries to courses and sections, copying course content, course offering dates, and unenrollment.
Mapping between SIS org types and Brightspace org unit types contains the OneRoster-specific org types that are supported by your SIS that you can map to Brightspace org unit types, including:
- SIS Orgs to Brightspace Org Unit Types. SIS Orgs options:
- District
- School
- Local, National, State, and Department (optional)
- SIS Academic Sessions to Brightspace Org Unit Types. Academic Session Type options:
- Semester
- Term
- School Year
- Grading Period
- SIS Groups to Brightspace Org Unit Types: SIS Group options:
- Course offering
- Course section
- Course template
- Section association
Deletion provides two options on how to delete requests affect an org unit in Brightspace:
- Do Nothing: The org unit mapping is deleted from IPSIS mappings, and the org unit remains unchanged in Brightspace.
- Inactivate course offering: The org unit mapping is deleted from IPSIS mappings, the course offering is marked inactive in Brightspace, the section is unchanged, and enrollments remain unchanged.
Map SIS entries to courses and sections provides the option to map SIS entries based on org unit code to existing org units that were created outside the SIS, for example, manually, by bulk operations, or using API.
|
Note: Avoid mapping org unit codes for SIS-created org units unless you’ve confirmed the codes are unique across schools and school years. Non-unique codes may cause the SIS to overwrite data from other org units. |
Course Content allows copying content from a master course or course template to a new course. Choose one of these options:
- If you don't select Find an Org Unit to automatically copy from based on specific criteria, content is copied from the master course to the sibling course when they share the same org unit code.
- If you select Find an Org Unit, you have two options:
- Copy content from the parent course template to the new child course.
- Copy content from the sibling course with a matching org unit code, provided the source course is manually added to Brightspace with the same org unit code as the parent template.
Course Offering Dates enables you to use academic session data, such as semester, term (default), school year, or grading period for course start and end dates. By default, the check box is set to Off. The first Academic Session from the SIS determines the dates. Dates can also be offset by a specific number of days.
Unenrollment provides the option to unenroll users from sections based on the SIS enrollment End Date or from SIS Orgs to which they are no longer associated.
Grades Export (OneRoster REST integrations only)
You can export new and updated grades to the SIS. Choose from the following options:
- To allow teachers with the Export Grades permission to export grades directly from the Grades tool, select Users with the Export Grades permission can export grades to the SIS.
- To export all grades during the scheduled daily synchronization, select Export all grades to the SIS at scheduled daily update. You can filter the exported grades as follows:
- Select Only export grades from active courses to ensure grades in previous courses are excluded which can help reduce the time to sync and prevent overwriting grades.
- Select Only export grades from courses that have started and not ended and set the number of days before or after a course starts or ends to begin exporting grades.
Departments, semesters, and other org units
In this section, you can set the Map SIS entries to existing org units option, which enables you to map SIS entries based on org unit code to existing org units that were created outside the SIS, for example, manually, by bulk operations, or using API.
|
Note: Avoid mapping org unit codes for SIS-created org units unless the codes are confirmed to be unique across schools and years. Non-unique codes can cause the SIS to overwrite existing org units. |