The information in this article applies if you will be using:
- ClassLink Roster Server or SFTP as a rostering method
- ClassLink Roster Server or SFTP as a rostering method and an LMS integration
The first step will be connecting with Summit K12 to share data through ClassLink or SFTP. For instructions regarding setting up that initial connection please see:
SFTP Upload Process
Adding Summit K12 and Modifying Permissions in ClassLink
OneRoster Files
Summit K12 is OneRoster compliant and the required files needed for your automated rostering method will depend on the selected rostering option: Roster Account Provisioning or Full Roster Integration.
| Roster Account Provisioning | Full Roster Integration | |
| Users | ✅ | ✅ |
| Orgs | ✅ | ✅ |
| Courses | ❌ | ✅ |
| Classes | ❌ | ✅ |
| Enrollments | ❌ | ✅ |
The five files needed (CSV files for SFTP export available for download):
- Users (Download users.csv template)
- Orgs (Download orgs.csv template)
- Courses (Download courses.csv template)
- Classes (Download classes.csv.template)
- Enrollments (Download enrollments.csv template)
For detailed instructions on how to complete each file, see the related sections below. Instructions for setting up the nightly sync are found lower in this guide.
Any updates to the orgs file and/or courses file should be reported to Summit K12 Support by submitting a request.
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. All students included in this file will have accounts created and will be available for teachers to enroll in their classes. Once enrolled in a class, a student license is consumed. Otherwise, a Full Roster Integration or an LMS integration will automatically handle student enrollment
| 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 a sourcedId on the orgs.csv exactly. | Yes |
| role |
Designates the role of a user, for example: "student", "teacher", or "administrator". Note - The integration will not upload any users listed with the role of "guardian", "aide", or "parent". Users listed as "aide" and who need to be set up with an account must be rostered manually. |
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 Note - Only students need their grade level identified on the Users.csv file. Users with the role of "teacher" or "administrator" can have the grades column blank. |
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* |
Summit K12 will map LMS accounts to the field that contains the user’s district-issued email address. If Users have more than one email address attached to their profile, please inform Summit K12 Support which field contains the email address used to log in to the Single Sign-on (SSO).
District-issued emails tied to Summit K12 accounts and the emails used to log in to the SSO must be identical. If they fail to match, users will not be able to access Summit K12 through the Single Sign-on (SSO) until the necessary corrections are made.
Orgs File
Refers to all schools that include users who will use Summit K12.
Summit K12 partners with schools and districts across the nation and keys off the ID #s provided by the National Center for Education Statistics (NCES) database.
School NCES ID#s can be provided upon request.
For partners using ClassLink Roster Server, the school's NCES ID# can be included in a metadata column titled national_id if the sourcedId and identifier columns are unavailable. Contact your ClassLink Representative for additional guidance if needed.
| 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 |
|
No |
*The identifier is not required to be filled out if the NCES ID#s are placed in the sourcedId column.
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 | SourcedId of an org in the orgs.csv file to which this course belongs | 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 of a school 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 |
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 | Org sourcedId of a school from orgs.csv file | Yes |
| userSourcedId | User sourcedId from users.csv file | Yes |
| role | Can be teacher, student | Yes |
| primary | Permitted values are "true" or "false". Applicable only to teachers. Only one teacher should be designated as the primary teacher for each class. | Yes |
| beginDate | No | |
| endDate | No |
Setting Up a Nightly Sync
After the CSV files have been created and shared through ClassLink or SFTP, please notify Summit K12 support in one of the following ways:
- Submit a support request
- Call Summit K12 Support at (844) 331-4737
Summit K12 Support will review the files, test the sync, and inform you of any issues that need to be resolved before data can be processed. A successful test sync will result in data being processed during the first overnight sync.
Summit K12’s nightly sync begins at 10 PM Central. Any changes to data sent after this time will be reflected on the LMS after the following nightly sync.
tags: OneRoster compliant, ims global, csv files, roster integrations