Classic - OneRoster and Enriching Students

Enriching Students supports the OneRoster standard for pushing data from your Student Information System to Enriching Students.

This document describes which files are needed and which fields in those files are required to have data. We'll list all the files that are expected as part of the OneRoster standard and describe which of the files we use in Enriching Students. For each file, we'll describe what the standard required for the header. You can include additional fields, but the header must start with the fields as described in the standard.

As per the OneRoster standard, your files can be uploaded to your school's SFTP location as individual files, or as a single ZIP file.

Also, as per the OneRoster standard, you may provide multiple schools via a single set of OneRoster files.

The order of the fields matters, but the header fields are not case-sensitive.

Classes.csv

Is File Required: Yes.  This file is used to determine the Departments (subjects in OneRoster) to create in Enriching Students.  This means the subject field has to be populated.

This file is also used to create Student Groups in Enriching Students.  We use the Source Id field in the Classes.csv file to look-up and determine the students that are enrolled in that class.

Header Must Start With: sourcedId,status,dateLastModified,title,grades,courseSourcedId,classCode,classType,location,schoolSourcedId,termSourcedIds,subjects,subjectCodes,periods

Required Fields for Enriching Students: the Source Id, Title, SchoolSourceId, Subjects fields must all have data.

How It's Used: Please see Enrollment.csv, How It's Used.

Enrollments.csv

Is File Required: Yes.  This file is used to determine how students relate to staffers.  See the Classes.csv description.

Header Must Start With: sourcedId,status,dateLastModified,classSourcedId,schoolSourcedId,userSourcedId,role,primary,beginDate,endDate

Required Fields for Enriching Students: the ClassSourceId, SchoolSourceId, UserSourceId, Role fields must all have data. 

If the BeginDate and EndDate fields have valid dates, we'll use these to determine if the enrollment should be created in Enriching Students. The enrollment is created when the date the import is being run on is between the BeginDate and EndDate. The Student Group will also be created if the BeginDate and EndDate fields are blank.

How It's Used: The classes.csv file and enrollments.csv file are used together.

In Enriching Students, we have the concept of "rosters".  For us, a roster is nothing more than a group of students.  We use the TITLE field as the name of a roster.

Then, the SourcedId field is read and we look up all the matches in the enrollments.csv file.  We find the record where the role is administrator or teacher and we create the roster for the staffer.  If the role is student, then we add the student to the staffer's roster.

Orgs.csv

Is File Required: Yes.  This file is used to determine which of the school data in the other files should be pulled into Enriching Students.

Header Must Start With: sourcedId,status,dateLastModified,name,type,identifier,parentSourcedId

Required Fields for Enriching Students: SourceId, Name

How It's Used: strictly speaking, we need this file only when new schools are added to Enriching Students.  It details the Source Id to the School.

Users.csv

Is File Required: Yes.  This file is used to add/edit the staff and students within Enriching Students.

Header Must Start With: sourcedId,status,dateLastModified,enabledUser,orgSourcedIds,role,username,userIds,givenName,familyName,middleName,identifier,email,sms,phone,agentSourcedIds,grades,password

Required Fields for Enriching Students: SourceId, orgSourceIds, role, UserIds, GivenName, FamilyName, Identifier, Email, Grades

How It's Used: there are two basic types of users in Enriching Students, staff and student.  If the role in the record equals "administrator", the user will be set up as an Enriching Students Admin.  If the role equals "teacher" the user is set up as a non-admin staffer.  Otherwise, the record is saved as a student.

---

AcademicSessions.csv

Is File Required: No, Enriching Students does not use any of the data in this file.

Courses.csv

Is File Required: No, Enriching Students does not use any of the data in this file.

Demographics.csv

Is File Required: No, Enriching Students does not use any of the data in this file.

Manifest.csv

Is File Required: No, Enriching Students does not use any of the data in this file