Class and Student data requirements Follow

Mandatory requirements for Class and Student files loaded to Hapara via Manual and cURL Load Methods are described below. 

 

Mandatory and Optional Column Requirements

The Class and Student files both have minimum mandatory column requirements. We recommend stepping through the Manual Configuration page to configure your Hapara needs, and this will generate Class and Student templates as per your Hapara requirements.

A full list of mandatory columns is detailed in sections Class File Headers and Student File Headers.

 

Column header rules and variation

Hapara has some flexibility in how we recognise column headers:

  • Column headers are NOT case sensitive e.g. “SUBJECT FOLDERS” can be used instead of “Subject Folders”.
  • Column headers ignore spaces e.g. “  Subject  Folders  “ can be used instead of “Subject Folders”.
  • Various synonyms are supported e.g. “Folders” can be used instead of “Subject Folders”.

The full list of the acceptable synonyms is detailed in sections Class File Headers and Student File Headers.

 

Multiple value fields

Some columns support multiple comma separated values. There are two acceptable ways to specify multiple values:

Comma separated: Specify multiple values in a single spreadsheet cell, using commas to separate the multiple values. A trailing comma is not required. Eg: The Subject Folders this Class file example:

Mailbox

Name

Subject Folders

secondgrade-01-1617

secondgrade-01-1617

Math,English,Art

thirdgrade-01-1617

thirdgrade-01-1617

Math,English,Art

fourthgrade-01-1617

fourthgrade-01-1617

Math,English,Science,Art

 

Multiple Columns: Use multiple columns with the same column heading, and have a single value in each column. Eg: The Class columns in this Student file example:

Email

Class

Class

Class

fbeuller

english-01b-1617

algebra-01a-2016

science-04b-2016

mmcfly

english-01b-1617

geometry-02a-2016

science-05c-2016

cchase

spanish-03c-1617

worldHistory-03b-2016

 

A full list of columns that accept multiple values are detailed in sections Class File Columns and Student File Columns.

 

Class File Columns

In the Class Spreadsheet or CSV, the requirements for columns are below, or listed in this Google Spreadsheet:

Column

Accepted Column Headers

Type

Notes

Mailbox

Mailbox, Group Email

Mandatory

Do not edit once loaded

This is the name of the Google group that is created for the class. Google requires that these values must be unique, and spaces or special characters are not permitted.

If you need to edit these values, please submit a request with our Support team.

Name

Name

Mandatory

These are the names of your classes in Hapara Products. We recommend using the same value as “mailbox” to ensure uniqueness. Teachers can later “nickname” their class in Manage Classes.

Description

Description, Desc

Optional

An alternative to the Class Name

Teachers

Teacher, Teachers, Owner, Owners

Mandatory.

Accepts multiple values

This is the teacher email in the domain. Only need the @school.org email suffix if students and teachers are in different domains or subdomains.

Subject Folders

Folder, Folders, Subject Folder, Subject Folders

Accepts multiple values

Please read before editing.

In most cases, the Sync and Manual Configuration pages should be used instead of including this optional column.

These are the names of the folders Hapara creates and places into each student drive.

If setting up Highlights only, do not include folder names - instead an asterisk "*".

When an asterisk “*” is used in the place of a folder name, this does not create any folders, but rather displays the Sharing Tab in Hapara Dashboard.

Student Blogs

Student Blog, Student Blogs, User Blog, User Blogs, Private Blog

Accepts multiple values

In most cases, the Sync and Manual Configuration pages should be used instead of including this optional column.

E.g. “md-stud1shc”, or “md-stud1shc/math” to access a "labelled" blog.

The special token “any” can be used. This means the teacher can view all the blogs that each student has.

Student Sites

Student Site, Student Sites, User Site, User Sites, Private Site, Private Sites

Accepts multiple values

In most cases, the Sync and Manual Configuration pages should be used instead of including this optional column.

E.g. “Portfolio-7”

The special token “any” can be used. This means the teacher can view all the blogs that each student has.

Class Calendar

Class Calendar, Course Calendar, Calendar, Cal

 

In most cases, the Sync and Manual Configuration pages should be used instead of including this optional column.

E.g. “English year 9 Sec A-1617”

Gmail Viewers

Gmail Groups, Gmail Viewers, Gmail

Accepts multiple values

In most cases, the Sync and Manual Configuration pages should be used instead of including this optional column.

E.g. “senior.teachers@myschool.org,councilors@myschool.org”

The special token "##None##" can be used. This means that no-one can view the gmails associated with the class.

School Id

School Id

See Notes

This is only used if School Separation is enabled. School separation is used by Districts containing multiple schools.

The School Id is the unique identifier of the school that the class belongs to. The School Ids must match those listed in the Hapara Admin Console > Configuration > School Configuration page.

Also refer to the Classes Spreadsheet Column Headers article

 

Student File Columns

In the Student Spreadsheet or CSV, the requirements for columns are below, or listed in this Google Spreadsheet.

Column

Accepted Column Headers

Type

Notes

Email

Email, User Name, Account Name

Mandatory

These values must be unique. Spaces or special characters are not permitted.

Exception: In rare case, of  creating missing student accounts the Email is not mandatory.

Classes

Class, Classes, Course, Courses, Classroom

One of Classes and ClassId is Mandatory.

Accepts multiple values.

Must match the Mailbox values from Classes spreadsheet, including the academic year suffix e.g. room1-2016

It is valid to have multiple columns titled “Class” with each cell containing one class

Class Codes

Class Id, ClassID, Class Code, Class Codes

One of Classes and ClassId is Mandatory.

Accepts multiple values.

Must match the Mailbox values from Classes spreadsheet excluding the academic year suffix e.g. room1

It is valid to have multiple columns titled “Class” with each cell containing one class

School Code

School Code, School Codes

 

Only needed if School Separation is used. School separation is used by Districts containing multiple schools.

The School Code is the unique identifier of the school that the class belongs to. The School Codes must match those listed in the Hapara Admin Console > Configuration > School Configuration page.

UID

UID

 

Only needed if Parent Portal is used.

The UID is the identifier that parents use to log into Parent Portal

NID

NID, NSN

 

Only needed if Parent Portal is used.

The NID is the identifier that parents use to log into Parent Portal

First Name

F Name, First Name, Given Name

Rarely used

Only useful when Hapara is creating missing student accounts  

Last Name

L Name, Last Name, Surname

Rarely used

Only useful when Hapara is creating missing student accounts  

Password

Password. Pwd

Rarely used

Only useful when Hapara is creating missing student accounts  

Change Password

Change Password, Change Pwd, Reset Password, Reset Pwd

Rarely used

Used to force student to reset their password on their next login



Have more questions? Submit a request