OneRoster 1.1 REST integrations enable you to schedule data to be pulled from your organization's SIS to populate required roster related data (including schools, classes, users, enrollments, and others) in Brightspace. The IPSIS Administration user interface includes a schedule to allow you to configure the time of day when the data pulls occur.
REST endpoints used:
|
Type
|
URL
|
|
Orgs
|
ims/oneroster/v1p1/orgs
|
|
Academic Sessions
|
ims/oneroster/v1p1/academicSessions
|
|
Courses
|
ims/oneroster/v1p1/courses
|
|
Classes
|
ims/oneroster/v1p1/classes
|
|
Users
|
ims/oneroster/v1p1/users
|
|
Enrollments
|
ims/oneroster/v1p1/enrollments
|
Before you can use the OneRoster REST 1.1 integration to import information from your SIS to Brightspace, you need to perform the following initial set up and configuration tasks.
Enable IPSIS Administration and IPSIS platform
Before you can assign IPSIS role permissions and access the IPSIS Administration, you must first turn on the IPSIS Administration and IPSIS Platform tools.
To enable required tools
- From the Admin Tools menu, click Organization Tools.
- On the Tool Availability page, enable IPSIS Administration and IPSIS Platform.
Set up a user role and assign permissions for IPSIS Administration
Once you've enabled IPSIS Administration and IPSIS Platform, you must set up your user role (or other roles) and assign permissions to ensure that you can administer IPSIS in Brightspace.
|
Tip: You can adjust permissions for specific roles. For example, you can allow a certain role to do everything except manage IPSIS admin configuration options. For more information about how to create roles, refer to Managing Roles and Permissions. |
To set up user roles for IPSIS Administration
- From the Admin Tools menu, click Roles and Permissions.
- Create or select a role for administering IPSIS.
- From the Edit Permissions page, assign the following IPSIS Administration permissions to the role:
- Access IPSIS Administration console: This ensures a user can see IPSIS Administration in the Admin Tools menu under the SIS Integration section.
- Manage IPSIS Bulk Operations: This allows a user to upload files for processing and review logs to troubleshoot past runs.
- View IPSIS Configuration Options: This allows a user to access the Configuration tab within the IPSIS Administration page.
- Manage IPSIS Configuration Options: This allows a user to edit the settings within the Configuration tab, this includes IPSISSFTP account management.
- Subscribe to Batch Job Notifications: This allows a user to sign up for notifications to be sent to them when a batch job finishes.
- Assign the following additional permissions:
- User Information Privacy > See Usernames
- User Information Privacy > See Org Defined IDs
- Org Unit Type Editor > Can Create and Edit Org Unit Types
- Security > See Roles and Permissions
Set up email notifications for OneRoster REST processing jobs
You can set up an email notification to alert you each time the OneRoster REST integration processes a job from the SIS.
|
Note:
- D2L recommends using email notifications instead of SMS, as the email contains more details about the SIS run (successes, failures, and summary). The SMS message only states that a job ran.
- Emails are delivered from the NotificationEmail setup for your environment. If you are having trouble receiving the email and have verified your email address is correct, D2L recommends contacting D2L Support for assistance verifying that your environment is properly set up for email. You may need to check your junk folder for the email, depending on your mail provider.
|
To set up email notifications
- From the navbar, click your user profile icon, and select Notifications.
- Under Contact Methods > Email Address, ensure your email address is listed.
- Under Instant Notifications > IPSIS Platform - Batch Summary Completion, enable the Email checkbox.
Filter grades export options during OneRoster REST integration configuration
When configuring a OneRoster 1.1 REST integration to include grades in a daily scheduled update, you can:
-
Only export grades from active courses. All courses set to inactive are ignored and changes to grades within inactive courses are excluded.
-
Limit grades export source to courses that have started and not ended. You can include courses in sync outside of their start and end dates. This option enables administrators to start syncing grades before a course starts and continue exporting after a course end date to ensure late changes to grades are included in the export.
To limit grades export source to active courses only
- Click Admin Tools.
- Under SIS Integration, select IPSIS Administration.
- To add a new OneRoster REST integration, click Add SIS.
- Under Select System Type, select OneRoster 1.1 - REST.
- Select an SIS Provider and click Next.
- From the Configure Your Integration page, scroll down to the Grades Export section.
- To limit grades export to active courses only, do the following:
- Select Export all grades to the SIS at scheduled daily update.
- Select Only export grades from active courses.
Figure: Select Only export grades from active courses to limit grades export to SIS.
- To complete your integration configuration, click Create Source System.
|
Note: All courses set to inactive are ignored and changes to grades within inactive courses are excluded.
|
Your One Roster 1.1 - REST integration is set to export grades to the SIS from active courses only.
To limit grades export to courses that have started and not ended
- From the Configure Your Integration page, scroll down to the Grades Export section.
- Select Export all grades to the SIS at scheduled daily update.
- Select Only export grades from courses that have started and not ended and optionally do the following:
- Set the number of days either before or after a course start to begin exporting grades.
- Set the number of days either before or after a course end to begin exporting grades.
Figure: Enter the number of days and select either before or after.
- To complete your integration configuration, click Create Source System.
Your One Roster 1.1 - REST integration is set to export grades only from courses that have started and not ended.