This document provides an overview of how Edlink's SFTP integration works, including data processing, file requirements, and key considerations for successful implementation.
How the Integration Works
Edlink's SFTP integration processes flat files uploaded to a secure SFTP server. The files are used to generate roster data, including people, classes, and enrollments. Unlike API-based integrations, SFTP integrations work with static data and do not support features like coursework or grade synchronization.
File Processing Workflow
- SFTP Server Setup: You or Edlink creates an SFTP server.
- Connection to Edlink: The SFTP server is connected to Edlink as a source.
- File Upload: You upload flat files (e.g., CSV or TSV) to the SFTP server.
- File Syncing: Edlink syncs the files at a regular cadence from the SFTP server.
- Files can be mapped during this process if need be.
File Requirements
To ensure successful integration, roster files must meet the following requirements:
Supported File Formats
- OneRoster-compliant files: Edlink supports standard OneRoster CSV files for exchanging roster data.
- Custom Formats: Edlink can process files in other formats (e.g., CSV, TSV) tailored to your system. Please coordinate with your Customer Success Manager for custom format setup.
Whichever file format you choose, it must remain consistent across uploads. Switching formats mid-integration can cause errors or missing/mismatched data.
File Contents
- Required Fields: Files must include some basic information to successfully sync:
- Unique identifiers for entities (e.g. UUID, SIS ID, etc).
- Related entities (e.g., students, classes, enrollments) must refer to each other using the same unique IDs to reliably form connections, such as students being enrolled in the correct courses.
- Optional Fields: Including emails and passwords to enable Single Sign-On (SSO)
Key Considerations
- Static Data: Data in SFTP integrations is static and will only reflect the most recent file upload. Changes to roster data require uploading a new file.
- No Real-Time Updates: Unlike API-based integrations, SFTP data does not sync in real time. Schedule regular uploads to ensure accuracy.
- File Validation: Edlink performs basic validation on uploaded files to ensure required fields are present. Missing or improperly formatted data can cause errors during processing.
Recommendations for Common Issues
Here are some actionable tips for resolving frequent issues during setup and ongoing maintenance.
File Format Errors
- Verify that your files adhere to the agreed-upon format (OneRoster or custom).
- Ensure consistent delimiters (e.g., commas for CSV files, tabs for TSV files).
- Double check the number of columns against the number of headers to avoid misalignment.
- Make sure you didn't change name of a previously uploaded and mapped file.
Missing Data
- Check that all required fields (people, classes, enrollments) are included.
- If enabling SSO, ensure emails and passwords are present in the file and that Password login is enabled in the source settings.
Duplicate or Invalid Entries
- Ensure unique identifiers for entities to avoid duplication errors.
For assistance with file setup, validation, or troubleshooting, please contact Edlink support or your Customer Success Manager.