Single File ARM CSV Instructions

When using DreamBox ARM, you will export school and roster information in one, single, CSV spreadsheet file. The roster information in the file will create the schools, educators, students, classrooms, classroom memberships, and enrollments.

When building your file, use a CSV (comma-separated value) format. Each file must contain a header row. Headers must be named exactly as specified in the attached template and use line breaks between rows. Field values must be separated by commas. If a field value contains a comma, then the field value itself must be enclosed in double quotes. If a field value contains a double quote, then two double quotes should be substituted ("").

Every time you transmit the file, it must contain all schools, educators, classrooms, and students that will be using DreamBox. All changes will be processed during the upload, but the file must be complete each time. If your file contains only updated information rather than all of your schools and rosters, then any object that is no longer included on the file will be deleted in DreamBox.

Each file should be self-contained. This means that it does not reference objects defined in another file.

The table below details the type of data that should be contained in each column of the file.

SPREADSHEET OVERVIEW

Column Letter and Header

What data should be entered in this cell?

DreamBox default value if left blank

Object types that require data in this cell

A

object*

Type of object described by this row. The object can be either "school", "student", "educator", or "classroom"

None

All objects

B

email address*

Educator email address

None

educator

C

title

Educator title

None

educator

D

educator type

Type of educator. The type can be either "teacher", "principal", "schooladmin", or "districtadmin"

teacher

educator

E

first name*

Student or educator first name

None

student, educator

F

last name*

Student or educator last name

None

student, educator

G

school student id*

Unique student ID or student number.

None

student

**

saml id

The ID you have set for your saml ID will need to be added to the saml id column.  Use the DreamBox-ARM-template_samlID.csv template if using DreamBox SSO and need to shared a saml ID.

None

student, educator

H

username

Student username

first name + last initial

student

I

password

Student password

random

student

J

gender*

Student gender. The gender can be either "male", "m", "female", or "f".

male

student

K

student birth date

Student birth date

None

student

L

language

LCID of student's preferred language. May be either "1033" (English) or "21514" (Spanish).

1033

student

M

grade*

Student or classroom grade level. The allowed values are different for students and classrooms.

For students, the grade can be "prek", "k", "kindergarten", "adult", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13"

For classrooms, the grade can be "prek", "k", "kindergarten", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"

"-1" is an alias for "prek"

"0" is an alias for "kindergarten"

"k" is an alias for "kindergarten"

"13" is an alias for "adult"

 None

student, classroom

initial placement level

Initial Placement Level is used for a student’s initial placement in DreamBox. If this is not specified, the student’s placement in DreamBox will be based on the academic grade in the previous column.

The curricular grade can be "prek", "k", "kindergarten", "adult", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13"

None

student

O

classroom name*

Name of a classroom. This should be unique within a school.

When provided for a classroom object row, this cell defines the classroom's name.

When provided for a student or educator object row, this names the student’s or educator’s primary classroom.”

None

classroom,

student,

educator

P

subject

Classroom subject

None

classroom

Q

school name*

Name of a school. This should be unique within the district.

When provided for a school object row, this defines the name of the school.

When provided for a classroom object row, this names the school to which the classroom belongs.

When provided for a student or educator object row, this names the student or educator primary school.

None

school,

classroom,

student,

educator

R

school address 1*

School address

None

school

S

school address 2

School address

None

school

T

school city*

School city

None

school

U

school state*

School state, province or region

For US and Canada, this must be valid two character abbreviation, if specified.

None

school

V

school zip*

School zip or postal code

None

school

W

phone

School phone number

None

school

X

school low grade

Lowest grade level taught at school

This may be one of "prek", "k", "kindergarten", "adult", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13"

None

school

Y

school high grade

Highest grade level taught at school

This may be one of "prek", "k", "kindergarten", "adult", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13"

None

school

Z

time zone

The timezone associated with each school, classroom, educator, and student

Timezones should be entered using ISO timezone names ie. "America/New_York" or "America/Los_Angeles"

None

ALL

AA

school administrator

Indicates if educator is an administrator of the school identified by the school name column

This may be 'Y' or 'N'

N

educator

AB

district administrator

Indicates if educator is an administrator of the district

This may by 'Y' or 'N'

N

educator

*required

Some columns provide reference data, like school name and classroom name. Rows for classrooms, educators, and students need to include the name of the primary school with which they are associated. Rows for educators and students need to contain the name of a classroom which they are teaching or are enrolled in. If an educator or student is a member of more than one classroom, multiple rows should be used that differ only in the classroom name value. When school name and classroom name are used as references, then there must be a matching row defining the school or classroom somewhere in the same file. For additional tips, please visit our overview article by clicking HERE.

If you have any questions, please contact Client Success via email at support@dreambox.com or by phone at ext. 3. We are available Monday through Friday from 5AM to 5PM PT.

 

Was this article helpful?
0 out of 0 found this helpful

Have more questions? Submit a request