Automated Roster Sync / eBook Licensing

Who is this for?

School or District personnel responsible for administrating the creation of CPM user accounts and provisioning of eBook licenses.

Overview

CPM supports automated rostering and licensing of eBooks via the OneRoster API.  Using CPM's wizard interface, automated roster sync can be set up in as little as 15 minutes.


Step 1: Check that your SIS supports OneRoster

OneRoster 1.1 API is the industry standard for secure sharing of enrollment information with authorized educational service providers.  Aeries, Infinite Campus, PowerSchool Unified, Skyward, and Synergy are examples of SIS systems that support using the API integration method.  CPM also supports PowerSchool's native API.

Some districts SIS systems may not support OneRoster 1.1 API.  Many have adopted ClassLink, which adds OneRoster support to virtually every SIS system.  


Step 2: Get OneRosterSync credentials and set sharing settings

Each SIS system has a different process for enabling access, but in the end they all will provide a OneRoster Base URL, Consumer Key, and Consumer Secret.  On some systems you may also need to individually select which data sections you wish to share.   CPM will need access to the organizations, academic schedules, courses, teachers and students.   Typically this needs to be completed by the district tech admin.


Step 3: Use CPM's  wizard interface to configure automated roster and license sync

The configuration wizard can be completed by non-technical staff provided you you have the credentials from step 2.  You must be an eBook administrators with escalated privileges, which you can request by emailing support@cpm.org

Integration wizard is located at: https://rosterfeed.cpm.org

Video walk through

Watch the quick 3 minute Walkthrough Video 

Step by step instructions

Entering Credentials

The integration wizard for API based rostering is located at rosterfeed.cpm.org.  To gain access CPM administrators can contact CPM at support.cpm.org.

To get started you will need three key data points:

  1. The full URL of your OneRoster API server. This includes:
    a. The https protocol.
    b. The domain name.
    c. Attributes in the route specifying which version of API standard.
  2. The client ID, also know as the public key.
  3. The client secret.

If you do not have this information, please request it from your district administrator.

Once ready click save.

A green notification indicates your credentials have been validated and you are ready to click on the next button.

Specifying Schools to be Processed
  1. To include a school, click on the + sign.
  2. To remove a school, click on the delete icon.
  3. Once finished click next.
Specifying Courses to be Processed
  1. To include a course, click on the + sign.
  2. To remove a course, click on the delete icon.
  3. Once finished click next.
Assigning eBooks to Courses
  1. Use the arrow below each course to view and select the appropriate eBook.
  2. Once finished click finish.
Enabling Automated Rostering

Only enable when you are ready to go live. Once enabled the automated rostering process will replace any existing eBook license assignments you currently have with the incoming data from your OneRoster API server.

  1. To remain in setup mode select no, or
  2. to enable automated rostering select yes.
Dashboard

You can go live or change any other setting from the dashboard.