The information in this article applies if you have selected to use a Secure File Transfer Protocol (SFTP) nightly upload for rostering your purchased Summit K12 subscription(s).
Unsure which rostering option below is the best fit? We are happy to meet with you over a scheduled Onboarding and Integrations Tech Call to provide guidance on rostering and integrations.
| What is SFTP? | Data Sharing Considerations |
| Upload Process | Single Sign-On (SSO) Options |
| Rostering Options with SFTP | Using SFTP with LMS Integrations |
| File Formats | Troubleshooting SFTP Rostering |
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 sending files before 10 pm CST nightly to upload the most current data to Summit K12.
Upload Process
Summit K12 utilizes nightly uploads of OneRoster standard CSV files 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, submit a request with Summit K12 Support.
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).
Rostering Options with SFTP
It is essential to choose the SFTP rostering option more suitable for your SIS data and purchased Summit K12 subscription(s). Partners interested in utilizing SFTP as a rostering method can choose between two options: Roster Account Provisioning or Full Roster Integration.
| Roster Account Provisioning | Full Roster Integration | ||
| SIS data | Students and teachers using the purchased subscription(s) are NOT clearly defined in scheduled classes | Students and teachers using the purchased subscription(s) are clearly defined in scheduled classes | |
|
Create student accounts? |
✅ | ✅ | |
| Create teacher accounts? |
Include users with the role of "teacher" in your Users data |
✅ | |
| Create classes? | By including teachers in your Users data, they can use our self-managed class creation tool which will allow teachers to create their classes as needed | ✅ | |
| Enroll students? | Teachers would manually enroll students using in-product tools | ✅ | |
Using an LMS integration alongside your SFTP nightly sync? Check out Using SFTP with LMS Integrations further down in this article.
File Formats
The SFTP nightly upload uses .csv files. Depending on your preferred rostering option, either two or five CSV files are required to be shared with us. 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 correctly and saved in the CSV format.
For required data fields and instructions for your selected rostering option, please view the OneRoster Integration Admin Guide.
| Roster Account Provisioning | Full Roster Integration | |
| Users | ✅ | ✅ |
| Orgs | ✅ | ✅ |
| Courses | ❌ | ✅ |
| Classes | ❌ | ✅ |
| Enrollments | ❌ | ✅ |
Data Sharing Considerations
Data shared with Summit K12 through SFTP should be limited to the students, teachers, and/or classes a purchased subscription is intended for.
All users shared in the Users file will have accounts created and will be available for teachers to enroll in their classes. Once a student is enrolled in a class, a license will be consumed. Otherwise, a Full Roster Integration or an LMS integration will automatically handle student enrollment.
Single Sign-On (SSO) Options
Single sign-on (SSO) is offered for Clever, ClassLink, or Google.
Ensure the users' district-issued emails match between the users.csv and the third-party SSO application you are using. If they fail to match, users will not be able to access Summit K12 through the SSO until the necessary corrections are made.
Using SFTP with LMS Integrations
Partners interested in using a Schoology, Canvas, or Google Classroom LMS integration (help articles coming soon!) with Summit K12 must have classes with teachers and students in the chosen LMS.
For Summit K12 content deployment and grade passback to properly function with your LMS integration, users are required to be enrolled in a class associated with the purchased subscription(s) on Summit K12. Therefore, partners must determine how classes and enrollment in Summit K12 will be handled.
Class creation and enrollment in Summit K12 can be handled through a Full Roster Integration or an LMS integration.
- A Full Roster Integration will handle class creation and user enrollment using the classes, courses, and enrollment CSV files. This may be preferred for users in scheduled classes in your SIS data.
- An LMS Integration can take care of class creation and student enrollment after students click on deployment links. This may be preferred for users in unscheduled classes in your SIS data.
A rostering method must be selected in conjunction with an LMS integration.
Troubleshooting SFTP Rostering
Need help with SFTP? Review our Troubleshooting SFTP Rostering article which discusses several solutions for common SFTP rostering issues. If you are unsure how to set up your export, reach out to your SIS provider.
Additional onboarding 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.
Tags:sftp, clever, rostering, integration, roster