OneRoster App

Our OneRoster integration allows you to import a list of students into your CENTEGIX apps from your OneRoster-compliant Student Information System. This saves time as you do not have to manage your student list manually—configure the connection once, and your student lists will stay updated as new students enter and existing students leave! To access OneRoster, log in to your District Manager and click the OneRoster link on the left.

Important notice

There are additional fees, and an Enterprise license is required to use this connection. Contact our Customer Success department at 1-800-950-9202 Option 2 for more information!

Table of Contents

Registration

  1. To access the OneRoster app, log into the District Manager and click One Roster App as shown below. We recommend that you complete these steps with CENTEGIX support.

  1. Select Add New to begin the registration process.

  1. Enter the following:
    1. OneRoster API URL
    2. API Version
    3. Client ID
    4. Client Secret (can be obtained from your OneRoster-compliant Student Information System (SIS). You may need to contact them to get this information.)
    5. The Authorization field contains three options. The one highlighted below is the most common, but you will want to check with your SIS to be sure.

Please note: for those running v1.2, you may need to append ims/oneroster/rostering/v1p2 to the end of your API URL in order for the connection to be made successfully.

  1. Once all information is entered, click Save.

Syncing

  1. Before moving on to School Mapping, syncing must be started so that you can test the connection and obtain the schools to use in the school mapping area. To start syncing, click Sync next to your registration on the Registrations page.
  2. Click Start Initialization. If errors occur, please get in touch with our support team for assistance. If no errors occur, you can proceed with mapping your schools.

School Mapping

  1. To map your school accounts from CENTEGIX to the corresponding school in the OneRoster connection, click School Mapping on the Registrations page.

  1. You will see all of your CENTEGIX schools listed with an Edit button next to each. Clicking Edit will allow you to choose the corresponding school to map and enable the importing of students and/or student contacts into your CENTEGIX apps.

  1. Once the mappings have been saved and all schools are active, click Refresh at the top, verify everything is correct, and then click Go Back.

  1. You must stop and then start syncing again to obtain the student and/or student contacts list for each school. To do this, click Sync on the Registrations page, click Stop Syncing, and then click Start Syncing.

  1. As you refresh (F5) the page you should see the student count rise. You can verify the students’ lists that were imported by checking the Students List within the School Manager app.

NOTE: The OneRoster specification (https://www.imsglobal.org/oneroster-v11-final-specification) dictates that only two statuses can be used for determining a student’s enrollment status at the school. These two statuses are:

  • Active – The student is active and should sync to CTGX apps
  • ToBeDeleted – The student has withdrawn from the school and should be deleted from CTGX apps

This means that if you use any other status for the student’s enrollment, we may not be able to sync and update your student lists. Please check with your SIS to determine the statuses you are using.


Sync Schedule

The sync schedule determines how often your students and/or student contact information is updated.

  • Default sync schedule is set to update every day at 10 pm UTC.
  1. To change the schedule, click Sync on the Registrations page.
  2. At the top of the sync page is an option for Cron Job—(how often your sync is scheduled to run)

Using the example above of “0 22 * * *”, the sync will take place each day at 10 pm UTC.

A few other examples you can use are:

  • Every week – 0 0 * * 0
  • Every month – 0 0 1 * *