OneRoster 1.1 courses File

Note: HMH is aware of ongoing standards upgrades in the IMS workspace related to LTI and OneRoster. At this time, IMS has not released OneRoster 1.2 openly to the public. Once it is officially released, HMH will look to prioritize development work and certification to be supported in a future build. Communications will be provided when that occurs.

The courses.csv file must be included in your zipped import file. HMH recommends that the courses file be populated with the relevant data per the IMS OneRoster specifications, but HMH does not currently use that data. As such, you may create this file with only the header row populated, but the resulting OneRoster set will not be compliant with the specification and may not work with other vendors.

 Click to learn the file requirements and naming rules for OneRoster import files.

 

An example of the courses.csv template in Microsoft Excel® is shown below.

 

    Open a printable version of the OneRoster 1.1 courses File Details by clicking the link below.

OneRoster 1.1 courses File Details Dictionary (PDF 279 Kb)

Note: When populating the courses.csv import template file, remember that data from this file is not currently being stored, so only the header row must be populated. Be sure to enter it exactly as it appears in the downloaded template; the header row field names are case sensitive.

Details for each of the courses template fields are provided in the table below. (Fields that appear in gray are optional.)

Column

Field Name

Required

Instruction

Max. Field Length

Valid Values

Sample Entries

A

sourcedId

Y

Enter the unique ID for the course.

255

A–Z, a–z, 0–9, spaces, and *symbols acceptable

*See Supported Symbols for complete list.

 

B

status

N

Not required by HMH despite being required on OneRoster spec

Leave this field blank.

HMH supports bulk rostering; delta processing (as required for this field) is not available at this time.

255

   

C

dateLastModified

N

Not required by HMH despite being required on OneRoster spec

Leave this field blank.

HMH supports bulk rostering; delta processing (as required for this field) is not available at this time.

10

   

D

schoolYearSourcedId

N

 

 

A–Z, a–z, 0–9, spaces, and *symbols acceptable

*See Supported Symbols for complete list.

 

E

title

Y

Enter the name for the course.

255

A–Z, a–z, 0–9, spaces, and *symbols acceptable

*See Supported Symbols for complete list.

 

F

courseCode

N

 

75

 

 

G

grades

N

Enter the grade(s) for which the class is attended.

255

IT, PR, PK, TK, KG, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, PS, UG, Other, [null]

View the OneRoster Grade Level Table to see acceptable values by platform. (Click link to open file.)

Ed only: commas (,) acceptable (used for lists of grades, such as 06, 07, 08)

While OR 1.1 supports grade lists, HMH can accept a grade range, such as 01-12.

06

H

orgSourcedId

Y

Enter the SourcedId of the org to which this course belongs.

255

 

 

I

subjects

N

Enter the subject name(s) of the course.

255

 

 

J

subjectCodes

N

Enter the subject codes associated with the class.

255

 

 

 

*Supported Symbols: !#$%&'()*+,-./:;<=>?@[]_` {|}~\¡¢£¤¥¦§¨©ª«¬-®¯°±²³´¶¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþ

Quoted identifiers are strongly recommended for characters such as commas (",").

**While 255 characters are allowed for certain fields, HMH may truncate values if necessary to align with platform size requirements.