This document provides an overview of how Edlink's direct CSV upload functionality works, including data processing, file requirements, and key considerations for successful implementation.
How the Integration Works
Edlink's direct CSV upload integration enables administrators to upload flat files directly through the Edlink dashboard. The files are processed to generate roster data, including users, classes, and enrollments. Unlike API-based or SFTP integrations, CSV uploads are manually managed through the interface, providing flexibility and simplicity for schools and organizations.
File Processing Workflow
- File Upload: Administrators log in to the Edlink dashboard and upload individual CSV files or a zipped archive containing multiple files.
- Files can be mapped during this process if need be.
- File Syncing: Edlink syncs the files at a regular cadence to your integration.
File Requirements
To ensure successful integration, uploaded files must meet the following requirements:
Supported File Formats
- CSV Files: Files must be in CSV format, with consistent delimiters (e.g., commas).
- Zipped Archives: When uploading multiple files, they must be zipped together into a single archive. Each file within the archive should follow a consistent format.
File Contents
- Required Fields:
- 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 email and password fields enables Single Sign-On (SSO) functionality through Edlink.
Naming Conventions
- Use descriptive and consistent names for uploaded files (e.g.,
users.csv,classes.csv). - Ensure that related entities (e.g., students and classes) refer to each other using the same unique identifiers.
Recommendations for Common Issues
Here are some actionable tips for resolving frequent issues during setup and ongoing maintenance.
File Format Errors
- Verify that files use the correct CSV format and consistent delimiters.
- Ensure that zipped archives contain valid CSV files.
Missing Data
- Check that all required fields (users, classes, enrollments) are included.
- If enabling SSO, ensure email and password fields are present.
Duplicate or Invalid Entries
- Use unique identifiers for all users and classes to avoid duplication.
- Remove unnecessary blank rows or duplicate records before uploading.
For assistance with file preparation, validation, or troubleshooting, please contact Edlink support or your Customer Success Manager.