OneRoster 1.1 classes 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 classes file contains all the classes or courses/section numbers that must be identified for Ed, The HMH Learning Platform; ThinkCentral; and/or Holt McDougal Online.

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

 

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

 

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

OneRoster 1.1 classes File Details Dictionary (PDF 365 Kb)

Note: When populating the classes.csv import template file, required fields must be populated and columns must appear in the proper order. Fields that are not required may remain empty, but even empty fields must be retained using commas. Do not use a space for an empty field. The header row must always be included exactly as it appears in the downloaded template; the header row field names are case sensitive. HMH strongly recommends that you use quoted identifiers.

Details for each of the classes 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 class ID.

 

Note:

      It is critical that this value be unique across all classes in the district.

      Examples of possible formulas are as follows:

      primary key of a class table

      course ID + section number

      school year + course + section number

      composite key of course number + section number

255,

but HMH recommends 40

 

Ed supports 255, but
HMO supports only 40.

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

*See Supported Symbols for complete list.

G801AtoL

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

title

Y

Enter a name for the class.

 

TIP: For best results, we recommend reviewing the Class Name Tips for OneRoster provided below this table.

 

Note:

      For TC and HMO, each class name must be unique within each teacher account. (In other words, a teacher cannot have more than one class with the same name.)
If a class name is not unique for TC or HMO:

 

      HMH recommends a class name using the formula SY+sourcedId+title. Some HMH platforms are limited to 40 characters, so it is important that the first portion of the title be unique. Otherwise, those platforms may not capture unique class names.

255,

but HMH recommends 75

 

Ed supports 255, but
TC and HMO support only 75.

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

*See Supported Symbols for complete list.

2016-12345 Algebra 1 Sec 1 Sem 2

E

grades

Optional

If you leave this blank, the median grade of the students in the class is used. However, if the class has no students assigned, then an error occurs and the class is not added.

If you choose to populate this field, enter the grade associated with the class.

Note:

      Only one grade can be entered for each class. If multiple grades are entered for Ed, TC, or HMO, only the first grade in the list will be imported; for example if you enter "6, 7, 8" or "6–9", only "6" is sent. If class consists of multiple grades, enter the grade that best represents the class such as the median grade of the students in the class.

      Grade level is used to auto-assign products to the classes in some platforms.

      For TC, if you change the grade level of an existing class, the products available to the class will include the products of the new grade level and the products of the previously assigned grade level(s). To limit the available products, return to the ThinkCentral platform and manually deselect any unneeded products for the class.

255

Ed supports lists of multiple grades, so it allows up to 255 characters.

 

TC and HMO support only one grade, so they allow 2 characters.

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

F

courseSourcedId

Y

Enter the SourcedId of this course.

255

   

G

classCode

N

 

255

   

H

classType

Y

Enter the class type for this class.

255

homeroom

scheduled

homeroom

I

location

N

 

255

 

 

J

schoolSourcedId

Y

Enter the unique ID for the school.

255

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

*See Supported Symbols for complete list.

12345678

K

termSourcedIds

Y

Enter the sourcedIds from the academicSession file this class reports to.

255

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

*See Supported Symbols for complete list.

6F9619FF-8B86-D011-B42D-00C04FC964FF

L

subjects

N

 

255

 

 

M

subjectCodes

N

Enter the subject codes associated with the class.

255

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

*See Supported Symbols for complete list.

 

N

periods

N

Enter the class period associated with the class.

255

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

*See Supported Symbols for complete list.

 

 

*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.

 

Class Name Tips for OneRoster

Note: HMH automatically appends the Classes.sourcedId value to the beginning of the title (class name) entry, up to 50 characters to help make it unique.

For best results in managing classes, use class names that are unique and easy to identify. The HMH recommendation is provided here.

Note:

      For many reasons (moves, marriage, divorce), the inclusion of the teacher name or teacher ID as part of the class name can be problematic and is not recommended.

      HMH highly recommends the inclusion of the SchoolID (or local building ID) as part of the class name to ensure that situations such as, class moves between schools, are accounted for and do not cause data errors.

 

school year + course ID + course name + section number + semester number

For example, if you have two ninth-grade Algebra classes, one taught by Sarah Masterson and the other taught by Lupina Baez, you may simply name them “2016-123-Algebra 1 Sec1 S1” and “2016-123-Algebra 1 Sec2 S1”. This method requires less long-term maintenance because you will not have to enter new classes when teachers change roles or leave the school system.

Additional options may include any of the following:

school year + class name + section number + semester number

school year + course ID + course name + class number + semester number

school year + course ID + course name + semester number