For REST integrations, IPSIS allows you to schedule data to be pulled from your organization's SIS to populate the required roster related data (including schools, classes, users, enrollments, and others) in the Brightspace platform. The new IPSIS 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 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.
- 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
To administer IPSIS in Brightspace, you must set up a user role and assign permissions first.
Tip: You can adjust these permissions for specific roles. For example, you can set a certain role to be able to do everything except manage IPSIS admin configuration options. A Super Administrator may have all permissions, but an Administrator may have only the following permissions: Access IPSIS Administration Console, Manage IPSIS Bulk Operations, and Subscribe to Batch Job Notifications.
- 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:
- Access IPSIS Administration console - This sets whether a user can see IPSIS Administration in their Admin Tools menu under the SIS Integration section
- Manage IPSIS Bulk Operations - This allows users to upload files for processing, and review log and troubleshooting details of past runs
- View IPSIS Configuration Options - This allows users to access the Configuration tab within the IPSIS Admin page
- Manage IPSIS Configuration Options - This allows users to edit the settings within the Configuration tab, this includes IPSISSFTP account management
- Subscribe to Batch Job Notifications - This allows users 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 the following:
- 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.