Set Up
- On the IPSIS Administration page, select the Configuration tab.
- Configure your integration:
- Review and edit settings and complete mappings.
- People
- Instructor and Learner are defaulted, but can be deleted.
- Click + Add Role to add additional SIS specific role names to map to Brightspace role. The following are the roles available in OneRoster:
- Administrator
- Aide
- Guardian
- Parent
- Proctor
- Relative
- Student
- Courses and Sections
- The following are the org types available in OneRoster:
- National
- State
- Local
- District
- School
- Once complete, select Create Source System.
- Once the source system is created, administrators can select from OAuth1a or OAuth2 as the preferred authentication method.
- Generate SFTP credentials:
- Click Create SFTP Site.
- Click Generate Password.
- Save Address, Username and Password
- SFTP credentials are used to upload files.
- Password is hidden and is not recoverable once the page has been saved. Password can be regenerated, SFTP credentials will need to be updated when transferring zip to the SFTP.
Note: Passwordless authentication with an SSH Public key is not currently configurable.
- Select Done.
You will be directed to the OneRoster CSV dashboard. The dashboard is the landing page of the IPSIS Administration Interface. To see more details, click here to access Brightspace Community.
Use academic session information for course start and end dates
On the IPSIS administration page the Use course offering dates checkbox allows you to use academic session information for course offering start and end dates. This checkbox is set to off by default. This option allows you to choose if academic session (semester, term, school year, or grading period) dates are associated to the course offering (this option defaults to term). The start date and end date of a course can also be offset by a specified number of days. If multiple academic sessions are set for a single course offering, the first Academic Session received from the SIS will be used for the start and end dates.
Processing CSV Files
Any CSV file must be zipped. ZIP folders be uploaded to Brightspace two ways:
- Manually by dragging a ZIP archive from your computer to the drag and drop UI found in IPSIS Administration - Dashboard
- Programmatically by uploading a ZIP archive containing the CSV file(s) to the SFTP site provisioned during your initial set up. Brightspace monitors the SFTP site on ten minute intervals for new ZIP folders.
Copy Course Content to New Course
Brightspace offers the ability to copy content from an existing Org Unit when creating a new course.
- From IPSIS Administration – Configuration, scroll down to Courses and Sections.
- From When creating a new course, copy content from an existing Org Unit?, select Yes.
- Parent course template of the new course
- Content will be copied from the parent Course Template to the new child Course Offering.
- Sibling course where the Org Unit Code matches the parent template
Content will be copied from a Master Course Offering to the sibling Course Offering when the Master Course Offering and Course Template share the same Org Unit Code.
Files are not duplicated when copying a course.
Troubleshooting
The Dashboard provides the processing status of the latest batch. Both the Dashboard and Batches pages will show a final indicator if the batch completed successfully or with errors. Each batch has a quick link to Audit Log and if completed with errors to Error Messages.
Review all logs to verify all files processed as expected. If error messages were logged, expand the error to review the meta data captured to identify the error, correct the data in your SIS and export a new ZIP folder with a CSV file that only contains the necessary changes to correct the errors. The goal is to have the batches completed without errors.
Common Errors
- ArgumentException Exception while processing message.
- Exception Message: Invalid Request TypeName provided. No Mapping found for Type:district in Source System:27. Parameter name: TypeName
- Exception Type: System.ArgumentException
- Typically occurs when the source system is missing Org Unit Type mappings in the Configuration UI and a request of that type is sent.
- CourseCreationException Exception while processing message.
- Exception Message: Invalid code
- Exception Type: D2L.LP.OrgUnits.Courses.CourseCreationException
- Typically occurs when the Class Request has Invalid characters in the classCode field. If classCode was not provided then the Invalid characters are in the title field.
Invalid characters: \ : * ? “ ” < > | ‘ # , % &
- RoleMappingNotFoundException Exception while processing message.
- Exception Message: No role mapping found for source system: OneRoster - Drag and Drop identifier: guardian
- Exception Type: D2L.IM.Platform.Exceptions.RoleMappingNotFoundException
- Typically occurs when the source system is missing role mappings in the Configuration UI and a request of that type is sent.
- DataNotFoundException Exception while processing message.
- Exception Message: RoleMapping not found for guardian
- Exception Type: D2L.Data.DataNotFoundException
- Typically occurs when the source system is missing role mappings in the Configuration UI and a request of that type is sent.
- DataNotFoundException Exception while processing message.
- Exception Message: ReplaceEnrollmentReadIMHandler.Process - IMExternalOrgUnitInfo is null.
- Exception Type: D2L.Data.DataNotFoundException
- RecordType: Enrollment
- Typically occurs when either an incorrect code for the class or user is sent to the LMS.
- JsonReaderException Exception while processing message.
- Exception Message: Could not convert string to DateTime: 4/30/2016T00:00:00.000Z. Path 'StartDateUtc', line 1, position 183.
- Exception Type: Newtonsoft.Json.JsonReaderException
- Typically occurs when the date format of one of the Date or DateTime fields not following the correct formatting.
- Supported format: yyyy-mm-ddThh:mm:ssZ
- OrgUnitMappingNotFoundException Exception while processing message.
- Exception Message: No org unit mapping found for source system: 27 identifier: SOMETHING
- Exception Type: D2L.IM.Platform.Exceptions.OrgUnitMappingNotFoundException
- Typically occurs when the request has an org unit type that does not have a mapping configured in the source system. Example: Request to create a District is received by the source system has not mapped District to anything.