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 school 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.
- OneRoster Format vs Custom Format:
- Typically it is easiest to export your roster data from an LMS or SIS that supports OneRoster. Our system knows how to read the OneRoster data format.
- However, we also support the option of configuring custom mappings for your CSVs.
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.