The OneRoster specification requires that all .csv files and headers are included in the data even if the data is not used. Unused columns must still have the appropriate headers though the column may be empty of data. Incomplete tables can result in the failure to sync data with Echo even if the data is not needed by Echo.
The required .csv files for Echo's SIS Sync are:
- manifest.csv - defines what is included in the upload
- orgs.csv - Defines the district and school domains
- academicSessions.csv - defines the school year and terms in which classes and enrollments exist
- courses.csv - defines the full list of course offerings (whether taught this term or not)
- classes.csv - defines each course section in which teachers and students are enrolled for the year and term
- users.csv - contains all staff, student, and parent user accounts
- enrollments.csv - lists each teacher and student class enrollment
Below is a map of the tables and fields used by Echo's SIS Sync feature. To see the full list of required tables and headers, refer to the IMS Global CSV table documentation.
orgs.csv (Echo Domains)
| Echo Field | OneRoster Field | Description |
|---|---|---|
| External Id | sourcedId | This field is used as an identifier to identify the domain and associate it with other data in the sync |
| Domain Name | name | The district or school name |
| type | Identifies the organization as a district or school | |
| parentSourcedId | The ID of the parent organization (usually the district) used to create the domain hierarchy |
academicSessions.csv
Although the sync makes use of the names and dates of the academic sessions, the data is not imported into Echo's fields.
| Echo Field | OneRoster Field | Description |
|---|---|---|
| -- | sourcedId | This field is used as an identifier to identify the term for classes and enrollments |
| -- | schoolYear |
The school year for which the academic session contributes. |
| -- | title | Name of the academic session |
| -- | type | Identifies the semester, trimester, or other academic term |
| -- | startDate | Defines the first day of the academic session (course and enrollment start dates) |
| -- | endDate | Defines the last day of the academic session (course and enrollment end dates) |
| -- | parentSourcedId | The ID of the parent session (i.e. quarters within a semester) |
courses.csv (Echo Base Courses)
| Echo Field | OneRoster Field | Description |
|---|---|---|
| External Id | sourcedId | This field is used as an identifier (course number) |
| Course Name | title |
Name of the course (i.e. Language Arts 9) |
| Base Id | orgSourcedId | The external Id of the parent (base) course |
classes.csv (Echo Section Courses)
| Echo Field | OneRoster Field | Description |
|---|---|---|
| External Id | sourcedId | This field is used as an identifier (section number) |
| Course Name | title |
Name of the course (i.e. Language Arts 9) |
| Base Id | orgSourcedId | The external Id of the parent (base) course |
users.csv (Echo Users)
| Echo Field | OneRoster Field | Description |
|---|---|---|
| External Id | sourcedId | This field is used as an identifier to connect the user data in Echo with the user in the SIS |
| Status | enabledUser | Identifies the user account as active or inactive |
| Username | username | The username assigned by the SIS for logging into Echo |
| First Name | givenName | User’s first name |
| Last Name | familyName | User’s surname |
| User’s email address | ||
| Password | password | Used by the sync to establish an initial password for the user account |
| Domain Id | orgSourcedId | The home organization (domain) for the user |
| EchoUserType | role | Used by the sync to assign permissions in the domain |
| EchoGradYear | grade | Used to identify the student’s grade level |
| -- | agentSourcedIds |
Used by the sync to connect students and parent (observer) accounts |
enrollments.csv (Echo Course Enrollments)
| Echo Field | OneRoster Field | Description |
|---|---|---|
| External Id | sourcedId | This field is used as an identifier to connect the user data in Echo with the user in the SIS |
| Course Id | classSourcedId | Connects the enrollment to a course |
| User Id | userSourcedId | Connects the enrollment to a user |
| Last Name | familyName | User’s surname |
| Role | role | Defines the users permissions in the course (teacher or student) |
| Start Date | beginDate | Defines the start date of the enrollment |
| End Date | endDate | Defines the end date of the enrollment |
Echo is constantly being improved based on the feedback from users and we strive to keep our documentation up to date. If this document doesn’t match what you are seeing in Echo, please let us know.
Comments
0 comments
Please sign in to leave a comment.