OneRoster
1.1 CSV files are now available! IMS no longer allows for 1.0 certification
and encourages customers and vendors to use the most recent version of
the standard. If you cannot support the most recent version, click
here to learn more about older standards support.
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 users file contains all the students and teachers who will be using 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 users.csv template in Microsoft Excel® is shown below.
Important: HMH requires that you modify your OneRoster users file to include the custom, metadata fields.
➔ Click to open an example of a populated users.csv template file. (CSV 1 Kb)
➔ Open a printable version of the OneRoster 1.0 users File Details by clicking the link below.
OneRoster users File Details Dictionary (PDF 509 Kb)
Note: When populating the users.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.
Details for each of the users 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 user.
Note: ● Must be unique across all users in your organization. ● If your locally assigned student/staff ID (LASID or Identifier) from your SIS is unique across all schools and user types, then you can use that for sourcedId. ● This value will map to the LASID field and will be shown in some platforms, exports, and reports. ● If you operate as an independent school, do not have a SIS, or are a private/Catholic school, consider these recommendations. (Click for details.) |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
12345678 |
||||||||||||||||
B |
status |
N |
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 |
Leave this field blank. HMH supports bulk rostering; delta processing (as required for this field) is not available at this time. |
10 |
|
|||||||||||||||||
D |
orgSourcedIds |
Y |
Enter the user's organization sourcedId. If the user is tied to multiple orgs, do the following: ● Enter all the user's orgids on the same row, separated by commas ("1, 2, 3, 4"). When entries in fields include commas, the use of quoted identifiers to contain the entries is important. ● Place the primary organization ID first in the orgSourcedIds field. ● DO NOT create separate rows for a single user, one for each org, because that is not a supported OneRoster 1.0 design. ● Some platforms automatically invoke account linking to support a user tied to more than one organization. Click here to learn more: Account Linking Using OneRoster. Note: ● This orgsourcedID must exactly match the sourcedId in the orgs file. ● Be aware that "001" is not the same as "1". |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
A_1234567 |
||||||||||||||||
E |
role |
Y |
Enter the role of the user. If multiple roles exist, enter only the primary role.
Note: Multiple roles are not supported at this time. |
255 |
teacher student |
teacher |
||||||||||||||||
F |
username |
N |
Enter the username. HMH does not manage this field at this time. Instead, HMH uses the globally unique username in the metadata.globalusername custom field (column R) detailed below. |
5–255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
John.Doe@DistrictA.ca.usd |
||||||||||||||||
G |
userId |
N |
Enter the user's ID. HMH does not manage this field at this time. |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
John.Doe@DistrictA.ca.usd |
||||||||||||||||
H |
givenName |
Y |
Enter the user's first name. |
255
**See details regarding truncated values. |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
John |
||||||||||||||||
I |
familyName |
Y |
Enter the user's last name. |
255
**See details regarding truncated values. |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
Doe |
||||||||||||||||
J |
identifier |
N |
Enter the user's identifier. HMH does not manage this field at this time. |
255 |
A–Z, a–z, 0–9, spaces, and *symbols acceptable *See Supported Symbols for complete list. |
|||||||||||||||||
K |
Student: Optional, unless you plan to use this field as your students' usernames, in which case it must be populated |
For students, enter the student's email address.. |
255, but HMH recommends 100
Ed supports 255.
TC and HMO support only 100. |
A–Z, a–z, 0–9, apostrophes, hyphens, periods, underscores, and at sign (' - . _ @) acceptable |
|
|||||||||||||||||
Teacher: Y |
For teachers, enter the teacher's email address.
Note: ● Recommended practice is to use official district or school email address. ● Newly added teachers receive an automated email containing their log in usernames, unless the email notification setting is turned off. (Click link for details.) |
jdoe@ccpsmail.com |
||||||||||||||||||||
L |
sms |
N |
HMH does not store this data at this time. |
255 |
|
|
||||||||||||||||
M |
phone |
N |
HMH does not store this data at this time. |
255 |
||||||||||||||||||
N |
agents |
N |
HMH does not store this data at this time. |
255 |
||||||||||||||||||
O |
metadata.orv1p1.grades |
Y |
Enter the grade associated with the user.
● Students can be assigned to only a single grade. – If a grade range is entered for a student, it defaults to first grade listed in the range. – If the field is blank, the student is not rostered and an import file error occurs. ● Teachers can be assigned to a single grade or a grade range, such as 06–08. – Do not use Excel to open a users.csv file containing grade ranges. Excel converts numeric grade ranges to dates. For example, a grade range entry of "01–08" gets converted to "8-Jan". – If teacher grade is not provided, it defaults to PK–12, which gives the teacher access to all available materials for all grade levels. – If teachers need access to grade-level material above or below the grade level(s) that they teach, you can assign a grade range, such as K–02 or 9–12. – The more specific the grade range, the easier it is for teachers to find the materials they need. ● To determine the range of grade levels associated with a user by platform, view this grade table. (Click link to open file.) |
5
Teachers can be assigned ranges, so they can support up to 5 characters.
Students can be assigned only one grade, so they are allowed only 2 characters. |
IT, PR, PK, TK, KG, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, PS, UG, Other, [null], x-y
View this grade table to see acceptable values by platform. (Click link to open file.) |
06–08 (teacher)
06 (student) |
||||||||||||||||
P |
metadata.hmhapplication |
Optional |
You do not need to include this field; however, if you choose not to include this field, you MUST check the appropriate application check boxes on the OneRoster District Details Page. To include this field, enter the code indicating the HMH product(s) available to the user, as follows:
Note: ● ORDER MATTERS: The code must be entered in the order shown in the table above. ● Abbreviation Table: You can still use MYHRW as well as other codes. (Click for details.) ● Email Notification Warning: For each platform, every rostered staff account receives a "kickoff" email, which provides the username and instructions for creating a password. If your staff is not using all platforms, these automated emails can cause confusion. Additionally, if you are using SSO, you may not want these emails to be sent. To stop the email notifications, you must turn off the setting for each platform. (Click for details.) |
20 |
TC = ThinkCentral only
HMO = Holt McDougal Online only
ED = Ed only
TC.HMO = both ThinkCentral and Holt McDougal Online
TC.ED = both ThinkCentral and Ed
HMO.ED = Holt McDougal Online and Ed
TC.HMO.ED = ThinkCentral and Holt McDougal Online and Ed
***Blank (NULL) field = ThinkCentral and Holt McDougal Online and Ed ***Only leave blank if you plan to use all three platforms. |
TC.HMO.ED |
||||||||||||||||
Q |
metadata.orv1p1.password |
N |
Enter the password each user must use to sign into the application.
For single sign on (SSO) users: ● Leave the password field blank (NULL). ● Before proceeding, see the list of SSO considerations. (Click link to learn more.)
For district-controlled passwords: ● Set this field to a value of your choice. ● Provide classroom teachers with their credentials and the credentials of their students. ● Provide instructions for classroom teachers to follow if they forget or misplace the login credentials. ● Warn
users that even if they change a password in the UI, the password
may be changed back on next import.
For districts allowing users to control their own passwords: ● Leave the password field blank (NULL). For the first upload, this creates a random password; for subsequent uploads, this retains the existing password. ● Provide your teachers with the following instructions: – Manage Teacher Passwords: – Manage Student Passwords: ○ Change the students’ passwords themselves and provide the passwords to the students. ○ Set temporary passwords for students and provide students with the temp passwords. After successful login with temp passwords, students are prompted to create their own passwords. |
Min. Field Length = 8 |
Teachers and Administrators: A–Z, a–z, 0–9, and *symbols acceptable Note: Spaces are not allowed. *See Supported Symbols for complete list. Case sensitive Must contain at least one of each: ● uppercase character (A–Z) ● lowercase character (a–z) ● number (0–9) ● special character (! @ # $ % ^ & ( ) _ - + = { } [ ] | \ : ; " ' / ? < > , .)
For improved security, HMH strongly recommends the following: ● Do not match USERNAME. ● Use passphrases instead of passwords. (Click for details.) |
IloveTheGreenBayPackers1991! |
||||||||||||||||
Min. Field Length = 5 |
Students: A–Z, a–z, 0–9, and *symbols acceptable Note: Spaces are not allowed. *See Supported Symbols for complete list. Case sensitive
For improved security, HMH strongly recommends the following: ● Do not match USERNAME. ● Use passphrases instead of passwords. (Click for details.) |
MyNameIsJames |
||||||||||||||||||||
R |
metadata.globalusername |
Optional |
You do not need to include this field; however, if you choose not include this field, you MUST complete the student/teacher username template fields on the OneRoster District Details Page.
If you are including this field, enter the globally unique username.
For single sign on (SSO) users, see the list of SSO considerations. (Click link to learn more.)
Note: ● This value must be globally unique across all users in the world. See Tips for Creating Usernames for recommendations. ● If you operate as an independent school, do not have a SIS, or are a private/Catholic school, consider these recommendations. (Click for details.) ● Ed allows for username changes.
Warning: Unlike Ed, TC and HMO accounts do not allow for username changes. – If a username is changed for a TC or an HMO user account, a new account is created and the old account goes inactive. – If a username is changed for an Ed user account, the username for that account is changed. – See Data Impact of Changing Usernames for more details. |
255, but HMH recommends 75
Ed supports 255.
TC and HMO support only 75. |
A–Z, a–z, 0–9, and *symbols acceptable Note: Spaces are not allowed. *See Supported Symbols for complete list. |
John.Doe@DistrictA.ca.usd |
*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.
v7.0