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 Behavior
  • Non-core Columns
  • Example file

Was this helpful?

Export as PDF
  1. CSV_Files

orgs.csv

The orgs.csv file expresses hierarchy in an organizational structure. Each row represents a unique organization, where the type column indicates the kind of organization the record is referring to.

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

name

yes

no

Required by OneRoster

5

type

yes

no

Required by OneRoster

6

identifier

yes

yes

Optional in OneRoster and MB

7

parentSourcedId

yes

yes

Required by MB for rows of type -> ext:program. The value must be a sourcedId of the org of type -> school.

Relational Columns

There are two columns in orgs.csv that represents how the specified organizations are related to each other:

Column Name
Description
On Import

sourcedId

Uniquely identify the row

Used referentially

type

The kind of organization

Informs validations

parentSourcedId

Refers to the parent organization

Informs validations

Together, the type column and parentSourcedId translates the information contained in this file into a hierarchy. There are three Organizations that ManageBac understands: district, school, and the custom type ext:program:

Organization Type
Description
On Import

district

A collection of ManageBac instances

Ignored

school

A specific instance of ManageBac / subdomain / school

Used referentially only

ext:program

A ManageBac Program, for example "IB Diploma"

Used referentially only

Import Validations

  • There can only be one row of type -> district, or no such row

  • There must be only one row of type -> school

  • Only rows whose type -> district or type -> school can have a blank parentSourcedId

  • A row with non-blank parentSourcedId value must resolve to a row with matching sourcedId

  • A row with type -> ext:program must have its parentSourceId resolve to a school that the the given program enabled

Export behavior

  • A single row of type -> school is exported, with blank parentSourcedId

  • A row for each enabled Program is exported, with type -> ext:program

  • Each Program rows will have populated parentSourcedId values that points to the school row.

Core Columns

The org.csv file includes some core columns that represent the individual organization:

Column Name
Description
On Import

name

Name of the organization

No modification occurs

identifier

The human-readable code for the org, if available

Ignored

Import Validations

  • Name cannot be blank

Export Behavior

  • The School and all enabled Programs are exported.

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
name
type
identifier
parentSourcedId

6a9d...2d8f

MYS checking

school

6a9d...2d8f_diploma

IB Diploma

ext:program

IB DP

6a9d...2d8f

6a9d...2d8f_myp

IB Middle Years

ext:program

IB MYP

6a9d...2d8f

Previousmanifest.csvNextroles.csv

Last updated 2 months ago

Was this helpful?