The OneRoster Enrollment feature will work with ClassLink and SFTP customers to create teachers’ Summit K12 classes and accounts. It will also enroll students into their corresponding class and update those enrollments with nightly syncs.
Users will then be able to SSO via an integration, such as Clever or ClassLink, or log in directly to Summit K12 using the login credentials provided by Summit K12 Customer support.
Note: We do not currently support Clever integration. Classes and accounts cannot be created through Clever. Instead, we recommend rostering through SFTP and using Clever only for SSO.
The first step will be to connect with Summit K12 to share data either through SFTP or ClassLink. For instructions regarding setting up that initial connection please see:
In addition to the Users and Orgs tables referenced in the above articles, customers will need to share details on the classes the users are enrolled into in their SIS. Summit K12 will sync nightly with either ClassLink or through SFTP to automatically create new classes and accounts and to process roster changes to update enrollments in Summit K12 classes.
Required OneRoster Files
Enrollment will be based on five csv files:
- Courses (Download courses.csv template)
- Classes (Download classes.csv.template)
- Users (Download users.csv template)
- Enrollments (Download enrollments.csv template)
- Orgs (Download orgs.csv template)
For detailed instructions on how to complete each file, see below. Instructions for setting up the nightly sync are found lower in the guide.
Note: Any updates to the orgs file and/or courses file should be reported to Summit K12 support. Please email support@summitk12.com.
Courses
Different subjects offered by your district, not tied to a particular teacher/time period like classes.
Field Header | Description | Required |
sourcedId | Unique ID for course | Yes |
status | No | |
dateLastModified | No | |
schoolYearSourcedId | No | |
title | Course name | Yes |
courseCode | No | |
grades | Grade level associated | Yes |
orgSourcedId | Set to district's orgID or NCES ID; must exist in orgs.csv file | Yes |
subjects | No | |
subjectCodes | No |
Classes
The specific instance taught by a teacher during a set time period. Also referred to as sections or periods.
Field Header | Description | Required |
sourcedId | Unique class ID | Yes |
status | No | |
dateLastModified | No | |
title | Class name that will become part of the Summit K12 class name | Yes |
grades | Summit K12 requires that each class is given a single grade | Yes |
courseSourcedId | Course sourcedId from courses.csv file | Yes |
classCode | No | |
classType | Can be set to “scheduled” | Yes |
location | No | |
schoolSourcedId | Org sourcedId from orgs.csv file | Yes |
termSourcedId | No | |
subjects | No | |
subjectCodes | No | |
periods | Time of day the class is given. If present, the period will become part of the Summit K12 class name | Optional |
Users
Refers to all teachers, administrators, and students who will be rostered. We recommend only sharing data for the users who will use Summit K12.
Field Header | Description | Required |
sourcedId | ID# for each User, each number must be unique | Yes* |
status | No | |
dateLastModified | No | |
enabledUser | Can be "true", "yes", "y", or "1" | Yes |
orgSourcedIds | SourcedID that connects to the organization a User belongs to. These numbers must match the org sourcedId exactly. | Yes |
role | Designates the role of a user, for example: "student" | Yes |
username | School district-issued email address or other identifier | Yes |
userIds | No | |
givenName | User's first name | Yes |
familyName | User's surname | Yes |
middleName | User's middle name | No |
identifier | ID# for each User can be the same number as the sourcedId. May be used as User password if not using SSO | Optional* |
School district-issued email address | Yes | |
sms | No | |
phone | No | |
agentSourcedIds | No | |
grades | Student grade | Yes |
password | ID# for each User can be the same number as the sourcedId. May be used as User password if not using SSO | Optional* |
*If you plan to use a Single Sign-on (SSO) such as Clever, ClassLink, or RapidIdentity please make sure that the students' district-issued emails match between the users.csv and the third-party Single Sign-on (SSO) application you are using. If they fail to match, students will not be able to access Summit K12 through the Single Sign-on (SSO) until the necessary corrections are made.
Enrollments
Connects users to classes.
Download enrollments.csv template
Field Header | Description | Required |
sourcedId | Unique identifier of enrollment | Yes |
status | No | |
dateLastModified | No | |
classSourcedId | Class sourcedId from classes.csv file | Yes |
schoolSourcedId | Orgs sourcedId from orgs.csv file | Yes |
userSourcedId | User sourcedId from users.csv file | Yes |
role | Can be teacher, student | Yes |
primary | At least one primary teacher is required for each class | Yes |
beginDate | No | |
endDate | No |
Orgs File
Field Header | Description | Required |
sourcedId | The NCES ID# (National Center for Education Statistics) for each school or what is used in your SIS | Yes |
status | No | |
dateLastModified | No | |
name | The school name | Yes |
type | Schools should be labeled with the type: "school" | Yes |
identifier | NCES ID#for the school, if not in the sourcedId column | Yes* |
parentSourcedId | Typically the district NCES ID# that identifies the parent organization. | Yes |
*identifier is not required to be filled out if the NCES ID#s are placed in the sourcedID column.
Setting Up a Nightly Sync
After csv files have been created and shared either through SFTP or ClassLink, please contact Summit K12 support in one of the following ways:
- Submit a support request,
- Email at support@summitk12.com,
- Or call Summit K12 Support at (844) 331-4737
Summit CSR will process 20-30 students to test the sync. The remainder will be processed during the first overnight sync.