OneRoster 1.1 users File

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.

●      Uppercase, lowercase, and all UTF8 versions of a character are considered the same; for example, "e" is treated the same as "E" and treated the same as any UTF-version over the letter "e" including, ë, è, é, and ê (upper and lower case):
"TèyE_123e" is considered a match with "TEYE_123E"

●      HMH does NOT recommend the use of special characters or LASIDs that use last names because last names can change for many reasons (custody, marriage, divorce), which can lead to the removal of old accounts and creation of new accounts. IDs should be numeric and come from your student information system.

●      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

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

enabledUser

Y

Enter "true" or "false" to indicate if this user record is active (true) or not active (false).

5

true

false

true

E

orgSourcedIds

Y

Enter the user's organization sourcedId.

If the user is enrolled in classes that span multiple orgs, do the following:

●      Enter ALL the orgSourcedIds to which the user is tied.

●      Enter multiple 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.1 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".

●      If a user attends classes that span across multiple schools, the best practice is to list all those schools here. However, per the IMS standard, HMH will automatically enroll the user in all schools in which the user has class enrollments regardless if the schools are listed here or not.

255

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

*See Supported Symbols for complete list.

A_1234567

F

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

G

username

Y

Enter the user name.

●      It is critical that this username be unique across all users and all locations within your district.

●      If the user accesses HMH Player®, the username must be globally unique. 

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

5–255

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

*See Supported Symbols for complete list.

John.Doe@mydistrict.com

H

userIds

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

I

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

J

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

K

middleName

N

Enter the user's middle name.

255

**See details regarding truncated values.

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

*See Supported Symbols for complete list.

L

identifier

N

Enter the user's identifier.

255

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

*See Supported Symbols for complete list.

M

email

Student:

Optional, unless you plan to use this field as your students' usernames, in which case it must be populated

For students, enter the 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

jsmith@ccpsmail.com

Teacher:

Y

Required by HMH despite not being required on OneRoster spec

Necessary to receive HMH email comms and for password reset notifications

For teachers, enter the teacher's email address.

Note: Recommended practice is to use official district or school email address.

jdoe@ccpsmail.com

N

sms

N

HMH does not store this data at this time.

255

O

phone

N

HMH does not store this data at this time.

255

P

agentSourcedIds

N

HMH does not store this data at this time.

255

Q

grades

Student:

Y

Required by HMH despite not being required on OneRoster spec

Enter the grade associated with the student.

●      Students can be assigned to only a single grade.

–      If multiple grades are entered for a student, it defaults to first grade listed.

–      If the field is blank, the student is not rostered and an import file error occurs.

●      To determine the of grade levels associated by platform, view this OneRoster Grade Level Table. (Click link to open file.)

Students support only one grade, so 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 this OneRoster Grade Level Table to see acceptable values by platform. (Click link to open file.)

06

Teacher:

N

Enter the grade(s) associated with the teacher.

●      If teacher grade is not provided, it defaults to all grades (PK through 12), which gives the teacher access to all available materials for all grade levels.

●      Teachers can be assigned to a single grade or a list of grades, such as 06, 07, 08.

–      If teachers need access to grade-level material above or below the grade level(s) that they teach, you can assign a list of grades, such as K, 01, 02 or 09, 10, 11, 12.

–      The more specific the list of grades, the easier it is for teachers to find the materials they need.

●      To determine the of grade levels associated by platform, view this OneRoster Grade Level Table. (Click link to open file.)

Teachers support lists of multiple grades, so allow up to 255 characters.

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

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

Teachers 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, 07, 08

R

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:

●      Plan to provide new users with their login credentials: Depending on the platform and how you want users to log in, you must make a plan to provide your new users with instructions on how to log in. (Click for details.)

●      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.
Passwords reset back if that user account has any changes. Example (Click to view.)

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:
If the password was set to null, it is not accessible. Upon first login, teachers must click Reset Password. Teachers receive an email with reset instructions, allowing them to change their passwords. Be sure to allow emails from *.hmhco.com.

–      Manage Student Passwords:
Teachers can do one of the following:

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

●      Avoid the same password for all users.

●      Use passphrases instead of passwords. (Click for details.)

IloveTheGreenBayPackers1991!

N

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.

●      Avoid the same password for all users.

●      Use passphrases instead of passwords. (Click for details.)

MyNameIsJames