CPM Teacher Tutorials

Automated Roster Sync / Licensing

Updated on

Who is this for?

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


CPM supports automated rostering and licensing of digital curriculum via the OneRoster API and OneRoster CSV.  Using CPM's 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 and OneRoster CSV through SFTP uploads.

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.

For OneRoster CSV, SFTP server information is provided.

Step 3: Use CPM's  Integration Settings Checklist

The integration settings checklist can be completed by non-technical staff provided you you have the credentials from step 2.  You must be an administrators with escalated privileges, which you can request by emailing [email protected]

Access Integration Services through the link at my.cpm.org.

Step by step instructions


The dashboard is where you can access all integration services starting with the Integration Settings Checklist. Steps for completing each checklist item are provided in the sections below.

Entering Credentials

The Integration Services link is located at my.cpm.org.  To gain access CPM administrators can contact CPM at support.cpm.org.

Once you have selected your student information system from the Roster Platform dropdown menu, you will need three key data points:

  1. The URL of your OneRoster API server.
  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 return to the dashboard for the next step.

If using CSV instead of API, select OneRoster CSV from the Roster Platform dropdown menu and the SFTP Server information will be displayed.

Specifying Schools to be Processed
  1. To include a school, click on the + sign.
  2. To remove a school, click on the X icon.
  3. Once finished go back to the dashboard.
Specifying Courses to be Processed
  1. To include a course, click on the + sign.
  2. To remove a course, click on the X icon.
  3. Once finished go back to the dashboard.
Assigning Licenses to Courses
  1. Use the arrow below each course to view and select the appropriate license.
  2. To add more than one license to a course, select enable.
    1. Select the add icon and then add the next license for the course.
  3. Once finished go back to the dashboard.

Review Your Staged Data

If your term has not started you will need to add an override date.  See Advancing and Extending Terms.

  1. Select View on the Last Roster Import tile.
  2. Select Manual Import to import the data from your student information system.
  3. Once the import has completed staged data will be available for your review.
  4. To see each classes roster, select the ClassId.

Once you have reviewed your staged data, return to the dashboard.

To see the completed import, you may need to refresh your browser.

Selecting License Pool

Set your license pool to rostered.  If you have more than one license pool, contact CPM at support.cpm.org.

CPM Certification

Schedule an integration appointment to review your license pools and existing data in CPM's eBook Licensing System (ELS).  CPM will also provide support to ensure that existing accounts in ELS meet the requirements for automated rostering and verify imported results through reviewing the staged data.

CPM integration support specialist are available for a 30 minute checklist review meeting prior to turning on rostering.   During this meeting the integration specialist will walk through with you the configuration settings and answer any questions you may have.   To schedule a meeting email [email protected].

The most common final checklist item is to ensure that the existing data is "clean".    Automated roster syncing requires that the format of the incoming records matches the format of the existing accounts, otherwise duplicates or conflicts can occur.   CPM can typically perform most cleanup in bulk for you during this meeting.

Set Your Schedule

Once your district is ready to go live with automated rostering, your schedule can be switched to live. This automates the rostering to run between 12:00 AM and 2:00 AM Pacific and the automated rostering process will replace any existing license assignments you currently have with the incoming data from your SIS.

  1. Set your integration schedule to live.
Previous Article LTI v.1.3: Deep Linking
Next Article Sticky Licenses