Traditional Rostering: Math template specification

There are 4 Imagine Math Traditional templates: Organization, Class, User, and Student templates. Populate the required fields in these Traditional template files with your roster data. Then you can use the Import Wizard in the Math portal to import your roster data into the Math Suite.

 Note

You can save the templates as CSV or Excel (.xls or .xlsx) files, but the Strict Open XML Spreadsheet file format is not supported.

Organization template file

When you create your Organization file, include the record type (i.e., name_organization.csv) in the filename and save it as a CSV file.

This table describes the required and optional fields or directives for the Organization template. Each column name is case-insensitive. If you are doing a full import, include the <DeleteUnlistedRecords> directive. If you are doing an incremental import, do not include the <DeleteUnlistedRecords> directive.

 Note

Leading zeros from record numbers, usernames, and passwords may be dropped during the import if you use Excel files. To avoid this problem, format the text in the columns before you import data.

Field or Directive Description
OrganizationNumber (required)

Specifies the number that has been assigned to this organization by the district or by the district SIS. This number is a primary identifier; it uniquely identifies the organization and will not change. In this and other templates, you use this number to associate schools, users, and students with this organization.

OrganizationName (required)
Specifies the name of the organization as it appears in Imagine Math. The first import creates a new organization and associates the organization number with this organization name. In subsequent imports, you can change the organization name by using the correct organization onumber.
OrganizationType (required)
Specifies the type of the organization that you want to create. Enter school (default value) or district.
ParentOrganizationNumber (required)
If you want to create a parent organization for a site, enter one of the organization numbers to associate this organization with its parent organization (always a district). Any organization that has a blank parent organization number will be created or updated at the root level of the site. Districts are not typically assigned to another organization; they are usually assigned to the root site.
StreetAddress (required)
Specifies the street address of the organization. The organization's street address is used to set the time zone for the school.
City (required)
Specifies the city where the organization is located. The organization's city is used to set the time zone for the school.
State (required)
Specifies the state where the organization is located. The organization's state is used to set the time zone for the school.
Zip (required)
Specifies the zip code of the organization. The organization's zip code is used to set the time zone for the school.
Country (required)
Specifies the country where the organization is located.
<DeleteUnlistedRecords> (optional)

The import automatically deactivates any previously imported records that are no longer listed in the import file as it adds and updates listed records. Manually created records that were never matched with an import record are not deactivated.

To use this directive, add <DeleteUnlistedRecords> to the import file between the column headings and the data rows, under the OrganizationNumber column.

Class template file

When you create your Class file, include the record type (i.e., name_class.csv) in the filename and save it as a CSV file.

This table describes the required and optional fields or directives for the Class template. Each column name is case-insensitive. If you are doing a full import, include the <DeleteUnlistedRecords> directive. If you are doing an incremental import, do not include the <DeleteUnlistedRecords> directive.

Field or Directive Description
ClassNumber (required)

Specifies the number that has been assigned to this class by the district or by the district SIS. This number is a primary identifier; it uniquely identifies the class and will not change. In this and other templates, you use this number to assign users and students to this class.

ClassName (required)
Specifies the name of the class as it appears in Imagine Math. The initial import creates the class and associates the class name with the class number. In subsequent imports, you can change the class name by using the correct class number.
OrganizationNumber (required)
Specifies the organization number so that you can assign this class to the correct school.
<DeleteUnlistedRecords> (optional)

The import automatically deactivates any previously imported records that are no longer listed in the import file as it adds and updates listed records. Manually created records that were never matched with an import record are not deactivated.

To use this directive, add <DeleteUnlistedRecords> to the import file between the column headings and the data rows, under the OrganizationNumber column.

User template file

When you create your User file, include the record type (i.e., name_user.csv) in the filename and save it as a CSV file.

This table describes the required and optional fields or directives for the User template. Each column name is case-insensitive. If you are doing a full import, include the <DeleteUnlistedRecords> directive. If you are doing an incremental import, do not include the <DeleteUnlistedRecords> directive.

Field or Directive Description
UserNumber (required)

Specifies the administrator or instructor's number as defined by the district or by the district SIS. This number is a primary identifier; it uniquely identifies the user and will not change.

Username (required)
Specifies the username. The username must be an email address. The username is globally unique. The first import creates the user and associates the user number with this username. In subsequent imports, by using the correct user number, you can change the username; however, no two users may share the same username.
FirstName (required)
Specifies the first name of the user. Cannot begin with numbers (i.e. 1, 2, 3). Cannot begin with—or contain—commas or special characters (i.e., &, @, #, $, ?).
LastName (required)
Specifies the name of the user. Cannot begin with numbers (i.e. 1, 2, 3). Cannot begin with—or contain—commas or special characters (i.e., &, @, #, $, ?).
UserType (required)
Enter administrator or instructor (default value).
OrganizationNumbers (required)
Specifies an organization number (from the Organizations.xxx import file) to assign the user to a school or district. Users may only be associated with a single organization at one time.
ClassNumbers (required)
Specifies a class number to assign the user to a class. To associate a user with more than one class, separate class numbers with semi-colons. Users can only be assigned to classes within organizations to which they belong.
UserSsoId (optional)
Specifies the SSO realm and unique identifier assigned to this user by your Single Sign-On identity provider separated by a divider '|' (examplerealm|ssoid).
<DeleteUnlistedRecords> (optional)

The import automatically deactivates any previously imported records that are no longer listed in the import file as it adds and updates listed records. Manually created records that were never matched with an import record are not deactivated.

To use this directive, add <DeleteUnlistedRecords> to the import file between the column headings and the data rows, under the UserNumber column.

<DeleteUnlistedAssignments> (optional)

The import deletes old user assignments for organizations, classes, or both. Assignments associated with manually created users are not deleted.

To use this directive, add <DeleteUnlistedAssignments> to the Users.xxx file between the column headings and the data rows. Place the directive under the OrganizationNumbers column to remove each record's assignments to unlisted organizations. Place the directive under the ClassNumbers column to remove each record's assignments to unlisted classes. You can use the directive under either or both columns.

Student template file

When you create your Student file, include the record type (i.e., name_student.csv) in the filename and save it as a CSV file.

This table describes the required and optional fields or directives for the Student template. Each column name is case-insensitive. If you are doing a full import, include the <DeleteUnlistedRecords> directive. If you are doing an incremental import, do not include the <DeleteUnlistedRecords> directive.

Field or Directive Description
StudentNumber (required)

Specifies the student's number as defined by the district or by the district SIS. This number is a primary identifier; it uniquely identifies the student and will not change..

StudentUsername (required)
Specifies the student username. The student username must contain at least three characters. The student username is a secondary identifier; it is unique within the site. The first import associates the student number with this student username. In subsequent imports, by using the correct student number, you can change the student username. If left blank, username will be generated.
Password (required)
Specifies the student password. The password must contain at least four characters. If left blank, password will be generated.
FirstName (required)
Specifies the first name of the student. Cannot begin with numbers (i.e. 1, 2, 3). Cannot begin with—or contain—commas or special characters (i.e., &, @, #, $, ?).
LastName (required)
Specifies the last name of the student. Cannot begin with numbers (i.e. 1, 2, 3). Cannot begin with—or contain—commas or special characters (i.e., &, @, #, $, ?).
GradeLevel (required)
Specifies the nominal grade level of the student. Acceptable values are (PK, K, 1, 2, 3, 4, 5, 6, 7, 8) or strings (Algebra Readiness, Algebra I, Geometry, HS Math I, HS Math II).
Language (required)
Specifies the student's preferred support language: en (English - default value) or es (Spanish).
OrganizationNumbers (required)
Specifies a number to assign the student to a school. Students may only be associated with a single school at one time.
ClassNumbers (required)
Specifies a class number to assign the student to a class. To associate a student with more than one class, separate class numbers with semi-colons. Students can only be assigned to classes within organizations to which they belong.
StudentSsoId (optional) Specifies the SSO authentication realm and unique identifier assigned to this user by your Single Sign-On identity provider separated by a divider '|' (for example, enter "realm|ssoid.")
AlternateStudentNumber (optional)

Specifies the student's unique, state-assigned ID, or the Clever state_id.

<DeleteUnlistedRecords> (optional)

The import automatically deactivates any previously imported records that are no longer listed in the import file as it adds and updates listed records. Manually created records that were never matched with an import record are not deactivated.

To use this directive, add <DeleteUnlistedRecords> to the Students file in a new row between the column headings and the data rows, under the StudentNumber column.

<DeleteUnlistedAssignments> (optional)

The import deletes old student assignments for organizations, classes, or both. Assignments associated with manually created students are not deleted.

To use this directive, add <DeleteUnlistedAssignments> to the Students file between the column headings and the data rows.

Place the directive under the OrganizationNumbers column to remove each record's assignments to unlisted organizations. Place the directive under the ClassNumbers column to remove each record's assignments to unlisted classes.