LogoLogo
  • ManageBac OneRoster 1.2 CSV Custom Specification
  • User Guide
  • CSV_Files
    • academicSessions.csv
    • classes.csv
    • courses.csv
    • demographics.csv
    • enrollments.csv
    • manifest.csv
    • orgs.csv
    • roles.csv
    • users.csv
  • Messages
    • Errors
    • Warnings
Powered by GitBook
On this page
  • Column Order and Optionality
  • Relational Columns
  • Import Validations
  • Export Behavior
  • Core Columns
  • Import Validations
  • Export Behaviors
  • Non-core Columns
  • Example file

Was this helpful?

Export as PDF
  1. CSV_Files

enrollments.csv

Enrollments specify memberships in classes.

Column Order and Optionality

The columns of the enrollments.csv file must be in the following order:

Column Name
Required?
Can be blank?
Explanation

1

sourcedId

yes

no

Required by OneRoster

2

status

yes

must be blank for bulk, must be populated for delta

Follows OneRoster convention

3

dateModified

yes

must be blank for bulk, must be populated for delta

Follows OneRoster convention

4

classSourcedId

yes

no

Required by OneRoster

5

schoolSourcedId

yes

no

Required by OneRoster

6

userSourcedId

yes

no

Required by OneRoster

7

role

yes

no

Required by OneRoster

8

primary

yes

yes

MB does not use this field

9

beginDate

yes

yes

MB does not use this field

10

endDate

yes

yes

MB does not use this field

Relational Columns

Column Name
Description
On Import

sourcedId

Uniquely identifies the record

Used referentially

classSourcedId

Refers to the subject group in courses.csv

Matched to classes.csv

schoolSourcedId

Refers to the school in orgs.csv

Matched to orgs.csv

userSourcedId

Refers to the user in users.csv

Matched to users.csv

Import Validations

  • The schoolSourcedId must resolve to a row in org.csv of type -> school

  • The userSourcedId must resolve to a row in roles.csv with and a role of either "systemadministrator", "teacher" or "student"

Export Behavior

  • Every row represents a single enrollment for either a Student, Teacher, or Administrator

Core Columns

Column Name
Description
On Import

role

The role of the user

Validated

Import Validations

  • The role must be either "systemAdministrator" "student" or "teacher"

  • The role must be the same as the role in roles.csv for the user referenced

Export Behaviors

  • Enrollments for ManageBac Administrators, Students, and Teachers are exported. Parents are not directly enrolled into classes; instead they inherit enrollments from associated children.

Non-core Columns

Column Name
Description
On Import

beginDate

When the enrollments started, always the Start Date of the Class

Ignored, defined via terms

endDate

When the enroolment ended, always the End Date of the Class

Ignored, defined via terms

primary

Whether the enrollment is "primary"

Ignored

The following columns values depend on the import or export mode:

Column Name
Bulk
Delta

status

Must be present but emtpy

Must be present and either "active" or "tobedeleted"

dateLastModified

Must be present but empty

Must be present and a date

Example file

sourcedId
status
dateLastModified
classSourcedId
schoolSourcedId
userSourcedId
role
primary
beginDate
endDate

5ce2...3d44

c4bb...bfd0

6a9d...2d8f

4d74...ed70

student

2018-08-01

2019-07-31

Previousdemographics.csvNextmanifest.csv

Last updated 2 months ago

Was this helpful?