OneRoster Specs | Cengage Help

File format

All OneRoster packages must be in a valid.zip file with the.csv files at the root of the zip. Do not compress the folder containing the.csv files.

NGLSync supports OneRoster versions 1.0 and 1.1.

OneRoster CSV File Name	OneRoster Version 1.0 CSV Column	OneRoster Version 1.1 CSV Column	Cengage Description
orgs.csv	`sourcedId`	`sourcedId`	A `sourcedId` is recorded for each entity the first time it is seen to uniquely identify it for current and future processing.
orgs.csv	`status`	`status`	`status` and `dateLastModified` are used to determine the type of upload (bulk or delta). If these values are populated, then the upload is a delta and the status will be used to determine the status (active or inactive) of the entity. If these rows are not populated, then everything in the upload is considered active and anything not found in the upload will be deactivated.
orgs.csv	`dateLastModified`	`dateLastModified`
orgs.csv	`name`	`name`	School name
orgs.csv	`type`	`type`	Not used. Cengage considers any organization with associated enrollments a school.
orgs.csv	`identifier`	`identifier`	Not used
orgs.csv	`metadata.classification`
orgs.csv	`metadata.gender`
orgs.csv	`metadata.boarding`
orgs.csv	`parentSourcedId`	`parentSourcedId`

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column	Cengage Description
users.csv	`sourcedId`	`sourcedId`
users.csv	`status`	`status`
users.csv	`dateLastModified`	`dateLastModified`
users.csv		`enabledUser`	If this is set to false, the user will not be created or will be deactivated.
users.csv	`orgSourcedIds`	`orgSourcedIds`
users.csv	`role`	`role`	The role of the user. Only users with the role teacher or student are processed.
users.csv	`username`	`username`	Username to sign in to the NGLSync portal to access courses.
users.csv	`userId`	`userIds`	Used as the `LMS_Id`.
users.csv	`givenName`	`givenName`	First name
users.csv	`familyName`	`familyName`	Last name
users.csv		`middleName`	Optional
users.csv	`identifier`	`identifier`
users.csv	`email`	`email`	Email address. Only processed for teachers.
users.csv	`sms`	`sms`
users.csv	`phone`	`phone`
users.csv	`agents`	`agentSourcedIds`	Not used
users.csv		`grades`	Not used
users.csv		`password`	Used if populated. Not needed if implemented with SAML.

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column	Cengage Description
courses.csv	`sourcedId`	`sourcedId`
courses.csv	`status`	`status`
courses.csv	`dateLastModified`	`dateLastModified`
courses.csv	`schoolYearId`	`schoolYearIdSourcedId`
courses.csv	`metadata.duration`
courses.csv	`title`	`title`	Used only during the license item association process to facilitate the association of course `sourcedIds` with purchased license items.
courses.csv	`courseCode`	`courseCode`
courses.csv	`grade`	`grades`
courses.csv	`orgSourcedId`	`orgSourcedId`
courses.csv	`subjects`	`subjects`
courses.csv		`subjectCodes`

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column	Cengage Description
classes.csv	`sourcedId`	`sourcedId`
classes.csv	`status`	`status`
classes.csv	`dateLastModified`	`dateLastModified`
classes.csv	`title`	`title`	Course name. A Cengage course is a OneRoster class.
classes.csv	`grade`	`grades`	Course grade
classes.csv	`courseSourcedId`	`courseSourcedId`
classes.csv	`classCode`	`classCode`
classes.csv	`classType`	`classType`
classes.csv	`location`	`location`
classes.csv	`schoolSourcedId`	`schoolSourcedId`
classes.csv	`termSourcedId`	`termSourcedIds`
classes.csv	`subjects`	`subjects`
classes.csv		`subjectCodes`	Not used
classes.csv		`periods`	Not used

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column	Cengage Description
enrollments.csv	`sourcedId`	`sourcedId`
enrollments.csv	`classSourcedId`	`classSourcedId`
enrollments.csv	`schoolSourcedId`	`schoolSourcedId`
enrollments.csv	`userSourcedId`	`userSourcedId`
enrollments.csv	`role`	`role`	The role of the user within the specified course.
enrollments.csv	`status`	`status`
enrollments.csv	`dateLastModified`	`dateLastModified`
enrollments.csv	`primary`	`primary`
enrollments.csv		`beginDate`
enrollments.csv		`endDate`

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column	Cengage Description
academicSessions.csv	`sourcedId`	`sourcedId`
academicSessions.csv	`status`	`status`
academicSessions.csv	`dateLastModified`	`dateLastModified`
academicSessions.csv	`title`	`title`
academicSessions.csv	`type`	`type`
academicSessions.csv	`startDate`	`startDate`	Course start date
academicSessions.csv	`endDate`	`endDate`	Course end date
academicSessions.csv	`parentSourcedId`	`parentSourcedId`
academicSessions.csv		`schoolYear`

The demographics.csv file is not used in NGLSync.

OneRoster CSV File Name	OneRoster 1.0 CSV Column	OneRoster 1.1 CSV Column
demographics.csv	userSourcedId	sourcedId
demographics.csv	status	status
demographics.csv	dateLastModified	dateLastModified
demographics.csv	birthdate	birthdate
demographics.csv	sex	sex
demographics.csv	americanIndianOrAlaskaNative	americanIndianOrAlaskaNative
demographics.csv	asian	asian
demographics.csv	blackOrAfricanAmerican	blackOrAfricanAmerican
demographics.csv	nativeHawaiianOrOtherPacificIslander	nativeHawaiianOrOtherPacificIslander
demographics.csv	white	white
demographics.csv	demographicRaceTwoOrMoreRaces	demographicRaceTwoOrMoreRaces
demographics.csv	hispanicOrLatinoEthnicity	hispanicOrLatinoEthnicity
demographics.csv	countryOfBirthCode	countryOfBirthCode
demographics.csv	stateOfBirthAbbreviation	stateOfBirthAbbreviation
demographics.csv	cityOfBirth	cityOfBirth
demographics.csv	publicSchoolResidenceStatus	publicSchoolResidenceStatus

The version of your OneRoster package is determined by the presence of the manifest.csv file.

If your package does not include manifest.csv, it is treated as a version 1.0 package.
If your package includes manifest.csv, it is treated as a version 1.1 package.

OneRoster CSV File Name	OneRoster 1.1 CSV Column	Cengage Description
manifest.csv	`manifest.version`
manifest.csv	`oneroster.version`	The version of your OneRoster package.
manifest.csv	`file.academicSessions`
manifest.csv	`file.categories`
manifest.csv	`file.classes`
manifest.csv	`file.classResources`
manifest.csv	`file.courses`
manifest.csv	`file.courseResources`
manifest.csv	`file.demographics`
manifest.csv	`file.enrollments`
manifest.csv	`file.lineItems`
manifest.csv	`file.orgs`
manifest.csv	`file.resources`
manifest.csv	`file.results`
manifest.csv	`file.users`
manifest.csv	`source.systemName`
manifest.csv	`source.systemCode`