HMH SAM Custom Template Setup

Product: Roster Server

The following article will guide you through the process of modifying your data in Roster Server in order to begin sending data to HMH SAM.

First, a preprocessor needs to be set up which will create the required metadata fields. To do this:

1. Head over to the Preprocessor section and create a new config or edit an existing one to have metadata fields needed from the following list.

A list of the metadata fields and their descriptions:

field	Notes
metadata.HMH_SAM_SCHOOL_NAME	Only used in HMH Sam Custom template

field

Description

metadata.HMH_SAM_CLASS_NAME

CLASS_NAME can either match an existing class name in the SmartBar, or it will be created as long as the SCHOOL_NAME provided matches a school in the SmartBar.

Note: SCHOOL_NAME and CLASS_NAME are co-dependent. If one value appears, then the other cannot be blank.

Field	Description
metadata.HMH_SAM_EXTERNAL_ID	This is a unique identifier used to match users to district's systems for SSO integration.
metadata.HMH_SAM_USER_NAME	For Users and Teachers Unique name with which the student will log into applications. Importing students with SIS_IDs that match the existing SIS_IDs of students currently in the SAM database will update and replace that student's existing SAM USER_NAME with the new USER_NAME being imported.
metadata.HMH_SAM_SIS_ID	For students only Unique ID by which a student is identified. Appears in SAM as student ID. Two student records with the same SIS_ID will be considered the same student and the incoming data will overwrite the destination. See the Instructions tab for more information.
metadata.HMH_SAM_DISTRICT_USER_ID	For teachers only DUID is the "key field" for matching a teacher account for all import functions.

Field	Meaning	Notes
metadata.HMH_SAM_AYP_ECON_DISADVANTAGED	Indicates if student is Economically Disadvantaged	- Values: Y/N or y/n - Not required
metadata.HMH_SAM_AYP_LTD_ENGLISH_PROFICIENCY	Indicates if student has limited English Proficiency	- Values: Y/N or y/n - Not required
metadata.HMH_SAM_AYP_GIFTED_TALENTED	Indicates if student is Gifted & Talented	- Values: Y/N or y/n - Not required
metadata.HMH_SAM_AYP_MIGRANT	Indicates if student is Migrant	- Values: Y/N or y/n - Not required
metadata.HMH_SAM_AYP_WITH_DISABILITIES	Indicates if student is With Disabilities	- Values: Y/N or y/n - Not required
metadata.HMH_SAM_LEXILE_SCORE	Most recently recorded Reading Inventory Lexile score	- Values: -2000 to 2000 This field is not required but if metadata.HMH_SAM_LEXILE_MOD_DATE appears, this field must as well
metadata.HMH_SAM_LEXILE_MOD_DATE	Date that LEXILE_SCORE is associated with	- Values: 01/01/1970 to present This field is not required but if metadata.HMH_SAM_LEXILE_SCORE appears, this field must as well - Format must be MM/DD/YYYY or YYYY-DD-MM

2. Next, head over to the Imports page and run an import so that the new metadata fields are visible.

3. After importing is complete, we need to add the HMH SAM (CSV) app or the app of your choice and choose permissions for it.

Note: Make sure to enable demographics in your permissions.

4. After your app permissions are set, go to the Apps page and enable metadata fields in the app we are exporting.

To do this, click on the action menu of your app and choose Filter Fields

In Filter Fields Enable the metadata fields you want by clicking the check mark next to each one. Do this for all the sections.

5. In the Server Details and Authentication Details sections, enter the server details provided by the vendor.

6. Under File Details, specify HMH SAM Custom as your template

7. Enter the Schedule Details.

8. Also in Schedule Details, switch the toggle to Enabled in order for the transfer to take place.

9. Click Save.

10. Click Send Now to initiate the transfer.

Updated: May 2020