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
  • Import Behaviors
  • Export Behaviors
  • Delta Export Behaviors
  • Non-core Columns
  • Example file

Was this helpful?

Export as PDF
  1. CSV_Files

classes.csv

Classes are ManageBac classes.

Column Order and Optionality

The columns of the classes.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

title

yes

no

Required by OneRoster

5

grades

yes

no

Required for new classes. If row is matched on classCode or sourcedId, is ignored

6

courseSourcedId

yes

no

Required by OneRoster

7

classCode

yes

yes

Optional in both ManageBac and OneRoster

8

classType

yes

no

Required by OneRoster

9

location

yes

yes

MB does not use this field

10

schoolSourcedId

yes

no

Required by OneRoster

11

subjects

yes

yes

MB requires classes to be associated to subjects

12

subjectCodes

yes

yes

Optional in both OneRoster and MB

13

periods

yes

yes

MB does not use this field

14

metadata.managebac.courseSourcedIds

yes

no

Required only for PYP classes

Note: grades is required because classes in ManageBac must have a grade associated with them.

Relational Columns

Column Name
Description
On Import

sourcedId

Uniquely identifies the record

Used referentially

schoolSourcedId

Refers to the school in orgs.csv

Cannot be modified

termSourcedIds

List of applicable academic terms in academicSessions.csv

courseSourcedId

Refers to the subject group in courses.csv. For PYP homeroom classes, refers to the homeroom subject group

Cannot be modified

metadata.managebac.courseSourcedIds

Applicable to PYP classes only: List of subject groups

Can this be modified?

Import Validations

  • Every class must have courseSourcedId value that represents the Subject Group and Program associations

  • Every term listed must be associated to the same Program, and there are no gaps in the duration as given from the first startDate to the last endDate

    • Does this mean you can't skip a date?

  • Every item listed in metadata.managebac.courseSourcedIds (if present) must match a Subject Group title in the IB PYP

  • The course resolved by courseSourcedId must belong to the same Program as the terms resolved in termSourcedIds

  • Each item in termSourcedIds must resolve to a type -> term row in academicSessions.csv

Export Behavior

  • Every non-archived class will be represented on export

Core Columns

Column Name
Description
On Import

classCode

Human-readable ID

Matches on Class ID, created if not present

title

The name of the class

Updated

subjects

The Subject associated to the Class, only one

Cannot be modified

grades

The grade associated to the Class, only one

Cannot be modified

  • Note that for IB PYP classes, Subjects are expressed through the metadata.managebac.courseSourcedIds instead of subjects.

Import Validations

  • The grade must be the same grade for indicated Subject Group, and must be offered for the associated Program

  • Every row must have a Subject and Grade

  • Every given classCode must be unique in the file, no duplicates are allowed

  • classCode may be blank, but on import it will create a new class the first time it is imported

Column and Program combinations not delineated above are not required and can be left blank.

Import Behaviors

  • If the title is blank, then the default naming convention is applied

Export Behaviors

  • All non-archived classes with terms within the current academic year are exported

Delta Export Behaviors

  • All non-archived classes with terms within the current academic year that are associated to an active subject are exported with status of "active"

  • All archived classes with terms within the current academic year that are associated to an active subject are exported with status of "tobedeleted"

  • All non-archived classes with terms within the current academic year that are associated to an inactive subject are exported with status of "tobedeleted"

Non-core Columns

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
title
grades
courseSourcedId
classCode
classType
location
schoolSourcedId
termSourcedIds
subjects
subjectCodes
periods
metadata.managebac.courseSourcedIds

30ff...3bec

Business & Management

11

63f6...3098

BUS-2-2025

scheduled

6a9d...2d8f

3099...ff8c, 3142...4644

Business & Management

c4bb...bfd0

Test

09

b65f...9e9f

scheduled

6a9d...2d8f

3099...ff8c, 3142...4644

English

6940...0a05

Ex Math

06

624d...941d

homeroom

3302...2a4e

b083...9ad7, ad73...0f0b

Homeroom, Mathematics, Personal social and physical education 1, Physical education 3, English, Science

dfe3...77e4

Math PYP 6

06

624d...941d

homeroom

3302...2a4e

a823...efdb

Homeroom, English, Music, Personal social and physical education 1, Physical education 3

, ks check, , ,

624d...941d, 3a46...842d, 9b12...fccc, 73a8...c76e,73a8...c76e

PreviousacademicSessions.csvNextcourses.csv

Last updated 2 months ago

Was this helpful?