ManageBac OneRoster 1.2 CSV Custom Specification

Navigation

• Data Exchange User Guide

• Custom Specification for:

Overview

ManageBac's support of OneRoster 1.2 is implemented via a custom specification. ManageBac exports and imports records by adopting OneRoster extensions. The special handling is necessary due to differences in the data model provided by the base OneRoster specification and ManageBac's functional requirements.

Due to this requirement, exports from source systems using the base OneRoster specification will require additional transformations or adjustments to the source data. To request that a source system, such as an MIS or SIS, export in ManageBac's custom specification, please contact the vendor.

This document will describe this custom specification by explaining the additional validations, required columns, and formatting required by ManageBac. This custom OneRoster specification is coined "ManageBac OneRoster Dialect" or "MB OR Dialect" for short.

The formal specification for base OneRoster CSV Binding is .

Import Validations

The custom OneRoster specification validates the contents of the file according to requirements of ManageBac's data model.

File format

ManageBac accepts zip archives that must contain the following file:

• manifest.csv

The following files are not strictly required. If no such records for a given entity are to be included, the file associated with that entity can be optionally marked "absent" in the manifest. Otherwise, when marked "present", the file is required to be present in the archive:

• academicSessions.csv

• orgs.csv

• courses.csv

• classes.csv

The zip archive must have the ".zip" extension and the .csv files contain ordered columns. An empty file must still contain the requisite columns. For the required columns for each entity, see the respective details.

Universal Row-level Validations

ManageBac processes every row and every file with the following commmon validations:

• Every row must have a non-blank sourcedId and is unique across all the files

• In delta mode, dateLastModified is included and non-blank and is a date

• In delta mode, status is included and non-blank, and is either "active" or "tobedeleted"

Additional row-level validations that apply to specific files are enumerated in the respective area under the heading "Import Validations."

Universal Mappings

In OneRoster there are two entities that have grade properties: students and classes.

The OneRoster grade property corresponds to ManageBac's core grade entity, which is found in the frontend in the table Settings > Schools Settings: Grades & Labels (Y axis).

The tables below indicate how this grade information corresponds to each other. Note that the "MB Core grade label" refers to an annotation in the table, and not the string used to represent the student's grade on their profiles.

On Import

On Export