OneRoster 1.1 academicSessions 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 academicSessions.csv file must be included in your zipped import file. HMH recommends that the academicSessions 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.

The OneRoster files that you prepare and submit must be:

● saved as .csv (comma delimited) files with quoted identifiers (HMH strongly recommends that you use quoted identifiers.)

● named to match the original file names (orgs.csv, users.csv, classes.csv, enrollments.csv, manifest.csv, courses.csv, academicSessions.csv, demographics.csv)

● combined and compressed into a single zipped file, which includes all CSV files, prior to upload and named according to the following rules:

– Valid values: alphanumeric (A–Z, a–z, 0–9), dashes ( - ), underscores ( _ )

– Must not contain special characters (except dashes and underscores)

– For SFTP site file submissions (automated imports), spaces are not allowed (Import Management accepts zipped files with spaces, but the SFTP site does not.)

● complete snapshots of your organization's data

Note: HMH supports BULK rostering, which is full files every run. Imports using the OneRoster templates require that all data be included at the time of the import. Your submitted import files are considered full year-to-date data files, so every import file replaces the last one imported. For example, if you import 500 users today and 15 tomorrow, then that triggers the removal of 485 users. Always submit full files for all locations if using OneRoster.

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

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

Note: When populating the academicSessions.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 academicSessions template fields are provided in the table below. (Fields that appear in gray are optional.)

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

Column	Field Name	Required	Instruction	Max. Field Length	Valid Values	Sample Entries
A	sourcedId	Y	Enter the unique ID of this academic session.	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	title	Y	Enter the name or title of this academic session.	255	A–Z, a–z, 0–9, spaces, and symbols acceptable See Supported Symbols for complete list.
E	type	Y		255
F	startDate	Y	Enter the start date for this academic session.	10	0–9 and dashes
G	endDate	Y	Enter the end date for this academic session.	10	0–9 and dashes
H	parentSouredId	N	Enter the SourcedId of the parent of this academic session.	255	A–Z, a–z, 0–9, spaces, and symbols acceptable See Supported Symbols for complete list.
I	schoolYear	Y	Enter the year that this school year ends.	4	0–9	2019