One recommended method of rostering students in Summit K12 is to use an SFTP nightly upload.
Setting Up Single Sign-on (SSO) Access
Troubleshooting SFTP Rostering
Schedule a Tech Call with Summit K12
What is SFTP?
Summit K12 rosters can be uploaded as CSV files via Secure File Transfer Protocol (SFTP). SFTP is a secure process to transmit data securely from one platform to another. These files can be set up either manually or through automation using data exported from your Student Information System (SIS). We recommend that the files are sent around 7 pm nightly to upload the most current data to Summit K12.
Upload Process
Summit K12 utilizes nightly uploads of OneRoster standard User and Orgs files for a nightly sync process that can often be initiated through your Student Information System (SIS). During onboarding, Summit K12 will provide the district technology team with SFTP credentials for your district or school. Summit K12's SFTP server address is sftp://sftp.summitk12.com (Port 22). To receive your district or school's SFTP credentials, please email support@summitk12.com or submit a support request here.
We ask that you upload your files to the directory path "/files". You may also upload files in a single ZIP file (please omit underscores or other special characters from the file name).
File Formats
The Secure File Transfer Protocol (SFTP) nightly upload uses .csv files. Two files are required to be shared with us, the orgs.csv file and the users.csv file. These are based on OneRoster v1.1. The formatting, order, capitalization, etc. are all a part of the OneRoster standard and cannot be changed. Please make sure the files are labeled "orgs" and "users" and saved in the CSV format.
To create your CSV files or refer to the templates, please see the files attached at the bottom of this article.
orgs.csv File
The orgs.csv file contains information about schools that are shared with Summit K12. All Field Headers are required and spelling must match exactly. There may be empty columns and that is okay.
Field Header | Description | Required |
sourcedId | The NCES ID# for each school, or what is used in your SIS | Yes |
status |
Can be left blank, set as "active" or "A" | No |
dateLastModified | Can be left blank | No |
name | The school name | Yes |
type | Schools should be labeled with the type: "school" | Yes |
identifier | NCES ID# (National Center for Education Statistics) for the school | 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.
If you need assistance locating a school's NCES ID#, please contact support@summitk12.com or submit a support request here.
users.csv File
The users.csv file contains information about Users that are shared with Summit K12. All Field Headers are required and spelling must match exactly. There will be empty columns and that is okay.
Field Header | Description | Required |
sourcedId |
ID# for each User, each number must be unique | Yes* |
status | Can be left blank or set as "active" | No |
dateLastModified | Can be left blank | 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 exactly. | Yes |
role | Designates the role of a user, for example: "student" | Yes |
username | This field can contain a school district-issued email address | Yes |
userIds | Can be left blank | 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 | No* |
This field should contain a school district-issued email address | Yes | |
sms | Can be left blank | No |
phone | Can be left blank | No |
agentSourcedIds | Can be left blank | No |
grades | Student grade | Yes |
password | ID# for each User can be the same number as the sourcedId | No* |
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.
*Account usernames will be set up using the school district-issued email addresses. Please inform Summit K12 of the field that will be used for student passwords. We recommend using the column that contains the students' ID#s. Our team can map to either the sourcedId, identifier, or password column on the users.csv file. This value will become the students' default password for manually logging on to Summit K12 at https://lms.summitk12.com.
Setting Up Single Sign-on (SSO) Access
Single Sign-on (SSO) can be set up for Clever, ClassLink, or RapidIdentity. Please see our Clever Single Sign-on (SSO) article or ClassLink article for additional information.
Filtering
Depending on the product purchased, the Summit K12 Support team will sometimes ask for the users.csv file to be filtered before it is shared with us. This is especially true for Summit K12's TELPAS Connect-to-Literacy program which is designed for emergent bilingual (EB) students who aren't always as easily identified in bulk exports.
Note: All Users shared in the users.csv will have accounts created and will be available for teachers to enroll in their courses, thereby consuming licenses.
Troubleshooting SFTP Rostering
Need help with Secure File Transfer Protocol (SFTP)? Review our Troubleshooting SFTP Rostering article which discusses several solutions for common SFTP rostering issues.
Schedule a Tech Call with Summit K12
We are happy to meet with you to provide guidance on rostering and integrations:
Additional information is available in the following help articles:
- Clever SSO Set Up Overview
- iPad User Guide
- Allow List for URLs and Websites
- Student Manual Rostering Set Up Overview
If you have any other questions, please do not hesitate to contact us:
- Submit a support request,
- Email at support@summitk12.com,
- Or call Summit K12 Support at (844) 331-4737