Prepare for SFTP file uploads with OneRoster
Gather the credentials, file format, and account access you need before uploading OneRoster CSV files to SchoolDay over SFTP
This article walks you through what you need before you send OneRoster files to SchoolDay over SFTP. You'll activate your admin account, gather your SFTP credentials, and confirm your CSV files match the OneRoster file format. Complete these steps first : skipping them is the most common cause of failed uploads.
Requirements
Account and permissions
- Activate your SchoolDay admin account. Use the activation link sent to your email. The link expires after 24 hours. Contact support@schoolday.com if the link expires.
- Obtain district data-sharing approval. Ensure you have authorization before you upload roster data to vendor applications.
SFTP credentials
Gather the following credentials:
- SFTP server address. Provide the hostname or IP address of the SFTP server.
- Port. Use port 22 (default).
- Username and password.
OneRoster CSV files and format
Format all files in the OneRoster v1.1 CSV format. For more information, see OneRoster File Format.
Follow these file format requirements:
- Include active data only. Include only currently enrolled students and active staff. Do not upload historical or archived records.
- Use UTF-8 encoding. Verify the file encoding before you upload to prevent corrupted special characters.
- Match headers exactly. Ensure column header names match the OneRoster specification exactly. To see the complete field list for each file, check the OneRoster File Format.
- Create unique identifiers. Ensure each sourcedId is unique within its entity type. Match IDs across files to create relationships. For example, a matching userSourcedId in users.csv and enrollments.csv enrolls that user in a class.
- Use CSV format. Separate values with commas. Use double quotes only when field values contain commas.
- Choose an upload format. Upload files individually or compress them into a single .zip archive.
Tools
- FTP client installed on your machine. WinSCP or FileZilla recommended.
How to upload
For step-by-step upload instructions, see Create SFTP File Transfer via WinSCP/FileZilla.
To set up the SFTP Import app in SchoolDay before your first upload, see Configure an SFTP Integration.
Next steps
- OneRoster File Format: full CSV field specification
- Configure an SFTP Integration: set up the SFTP Import/Export app itself
- Automate SFTP File Transfer via Task Scheduler: schedule recurring uploads