Click
to learn the file requirements and naming rules for OneRoster import files.
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 manifest.csv file must be included in your zipped import file. This file indicates that the submitted template is version 1.1 and not an earlier version. Failure to provide a manifest file results in misleading import errors.
Click
to learn the file requirements and naming rules for OneRoster import files.
Note: When populating the manifest.csv import template file, remember that required fields must be populated even if data from this file is not currently being stored. 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 manifest template fields are provided in the table below. (Fields that appear in gray are optional.)
Row |
Property Name |
Required |
Instruction |
Max. Field Length |
Valid Values |
Sample Entries |
1 |
manifest.version |
Y |
HMH does not store this data at this time. |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
1.0 |
2 |
oneroster.version |
Y |
HMH does not store this data at this time. |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
1.1 |
3 |
file.academicSessions |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
4 |
file.categories |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
5 |
file.classes |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
6 |
file.classResources |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
7 |
file.courses |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
8 |
file.courseResources |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
9 |
file.demographics |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
10 |
file.enrollments |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
11 |
file.lineItems |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
12 |
file.orgs |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
13 |
file.resources |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
14 |
file.results |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
absent |
15 |
file.users |
Y |
Enter one of the following, depending on whether this file is included in the accompanying CSV files. ● absent - this CSV file is not supplied ● bulk - this CSV file contains only bulk data ● delta - this CSV file contains only delta data |
6 |
"absent" "bulk" "delta" |
bulk |
16 |
file.systemName |
N |
Leave this field blank. |
|
|
|
17 |
file.systemCode |
N |
Leave this field blank. |
|
|
|
*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.