Configuration options for OneRoster REST

You will work with your Brightspace Implementation Consultant to set up your OneRoster REST source system. Brightspace automatically defaults to your most common settings. However, these settings can be edited at any time with the appropriate permissions.

Before the source system can be configured, make sure you have the following items completed:

General Requirements

Contact your OneRoster representative to obtain your API information. You will need:

  • Endpoint URL
  • Authentication Endpoint
  • Client Id
  • Client Secret

Configuration

After the initial set up, you can update the configuration of your OneRoster REST source system:

  1. From the Admin Tools menu, select IPSIS Administration, select the Configuration tab
  2. Credentials provided during initial set up will appear first, these credentials can be edited if required.
  3. Source System fields:
    • SIS Name: The SIS Name field is editable and is recommended to be kept up to date.
    • Scheduled Updates: The time that Brightspace will automatically sync with the SIS. It is recommended that this process is completed overnight.
    • Overwriting Brightspace: Granular choices to identify which fields in Brightspace your SIS can overwrite.
  1. People
    • SIS Role Mappings: This section contains the OneRoster specific role to map SIS role names to Brightspace role names. Teacher and Student roles are included by default, but they can be deleted. The following are the roles available in OneRoster:
    • Administrator
    • Aide
    • Guardian
    • Parent
    • Proctor
    • Relative
    • Student
    • Teacher
  2. To add additional SIS specific role names to map to Brightspace Learning Environment roles, click + Add Role.

    Note: If the SIS sends a role that is not configured, it results in an error and the user cannot be created.

    • Map SIS Entries to Existing Users: Provides the option to map SIS entries based on username or OrgDefinedId to existing users that were created outside of the SIS (manually, bulk operations, API, etc.). If mappings are off, duplicates may be created.

  1. Courses and Sections
    • Courses and Sections - Mappings: This section contains the OneRoster specific org unit types to map SIS orgs to Brightspace org names.
    • Click + Add Org Unit Type to add additional SIS specific org unit names. The following Org Unit Types are required for Synergy:
      • SIS Orgs
        • District
        • School
        • Local, National, State, and Department are optional
      • Academic Session Type
        • Semester
        • Term
        • SchoolYear
        • GradingPeriod
      • SIS Group
        • Course Offering
        • Course Section
        • Course Template
        • Section Association
    • Deletion: Provides two options on how a tobedeleted status affects an org unit in Brightspace Learning Environment.
      • Do Nothing – the org unit mapping will be deleted from IPSIS mappings, but the org unit will remain unchanged in Brightspace
      • Inactivate course offering – the org unit mapping will be deleted from IPSIS mappings, the course offering will be marked inactive in Brightspace, section and enrollments will remain
    • 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 of the SIS (manually, bulk operations, API, etc.). It is not recommended to turn these on for any org units created by your SIS unless you confirmed the codes are unique across schools and school years.
    •  Course Content: Provides the ability to copy course content from a master course or a course template to the newly created course. Select Yes and choose one of the following:
      • If Find an Org Unit to automatically copy from based on specified criteria? is not selected, content is 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
      • If Find an Org Unit to automatically copy from based on specified criteria? is selected, you can choose from two options:
        • Parent course template of the new course
          • Content is copied from the parent Course Template to the new child Course Offering
          • Sibling course where the Org Unit Code matches the parent template. Content is copied from the source course offering to the new child Course Offering based on the source course being manually added to Brightspace with the same org unit code as the parent template.
  1. Grades Export
    • Provides the option to allow grade syncs of all modified grade items at the time of the Scheduled Update, and/or, to allow Teacher initiated grade export from the course offering.
  1. Departments, Semesters and Other
    Map SIS entries to existing org units: Provides the option to map SIS entries based on org unit code to existing org units that were created outside of the SIS (manually, bulk operations, API, etc.). It is not recommended to turn these on for any org units created by your SIS unless you confirmed the codes are unique across schools and school years.
  2. Once complete, select Save Configuration.

 

Troubleshooting

The Dashboard provides the processing status of the latest batch. Both the Dashboard and Batches pages show a final indicator if the batch completed successfully or with errors. Each batch has a quick link to the Audit Log and if completed with errors to Error Messages.

Review all logs to verify all records processed as expected. If error messages were logged, expand the error to review the metadata captured to identify the error, correct the data in your SIS and either wait until the next day for the Scheduled Update or request an update from the Dashboard. The goal is to have the runs completed without error.

How to sync Grades

Grades can be sent nightly with the daily roster update, on demand via the grades interface, or both. These options are set up in IPSIS Administration > Configuration > Export Grades.

To send grades, a category, grade item, and grade are required. See the Grades Export section for overall rules to send a grade.

Category

Categories are automatically created by Synergy. These categories are noted in the Manage Grades UI with an SIS icon.

Create a Grade Item

  1. In the Manage Grades area, click New and select Item.
  2. Set the desired preferences and options for the category.
  3. Choose an Academic Session from the dropdown menu.
  4. Select the End of Course checkbox if the assignment should be sent as an End of Course assignment.
  5. Map the grade item to the Category synced with the SIS.
  6. Click Save and Close.

Export to SIS

To manually sync grades to the SIS:

  1. From the course home page, navigate to Grades> Enter Grades > Export to SIS
  2. On the Export Grades UI, you are presented with a summary page that includes:
  • Section: a dropdown menu that allows you to choose between different sections in the course (if multiple sections are present)
  • Academic Session: a dropdown menu that allows you to choose between different School Years associated with the course (if multiple academic sessions are used)
  • Overview: Lists the number of Categories and the number of grades within the categories that meet the criteria selected in Section and Academic Session above and can be exported
  • Scheduled Export: only visible if configured in SIS Integration configuration and can be edited in the Configuration tab in IPSIS Administration
  1. Click Export. The page refreshes and takes you to the View All Exports page. This UI provides an overview of who sent the grades and when.
    • Once the export has completed, click on the Export Name to view details that include: Course name, Export start and end dates, and User who initiated the export

Note: If grades are sent via the nightly sync the IPSIS Service user is displayed

  1. Successful and failed export details for Categories, Grade Items and Results:
  • You can navigate back to historical exports, using Grades > Enter Grades > Export to SIS and click View Export History at the top right.