The new Bloomz v2 file format provides Bloomz with comprehensive data import capabilities while simplifying the export, data validation, and troubleshooting processes.


TABLE OF CONTENTS


Schools File

The schools.csv file provides the information necessary to generate the school structure as it relates to a district in Bloomz. 


Fields:

-- id: Unique to each school and referenced by all other files. 0 or a NULL value is commonly used for the district building id.

-- name: School Name


Ex:
id,name



Classes/Groups File

The classes.csv file provides the classroom and group information necessary to generate a classroom/group roster in Bloomz.


Fields:

-- school_id: Id of the school where the class/group is located. Must match an ID in the school.csv file.

-- id: Unique for each class/group. Will be referenced in the memberships.csv file.

-- name: Name of the class/group.

-- type: [optional] Group Type (class, room, group, team, club, etc.) Defaults is 'class'.

-- access: [optional] Access (public, private, filter). Defaults to 'private'.

-- grade: [optional] infant, preschool, transitional-k, k, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

-- section: [optional]

-- term: [optional]

-- period: [optional]

-- teacher_id: [optional] Primary. Must match an ID in the staff.csv file.

-- teacher_type: [optional] (primary, secondary, alternate). Defaults to 'primary'.

-- is_homeroom: [optional] 

-- subject: [optional]

-- student_count: [optional] Used for data validation and troubleshooting.

-- status: [optional]


Ex:
school_id,id,name,type,access,grade,section,term,period,teacher_id,teacher_type,is_homeroom,subject,student_count,status



Staff File

The staff.csv file provides the information necessary to generate staff accounts and relates them to the school(s) they belong to. List all staff members in this file, including faculty, teachers, office staff, admins, etc.


Fields:

-- school_id: Id of the school where the staff member is assigned. Must match an ID in the school.csv file.

-- id: Unique to each staff member. Will be referenced in the memberships.csv file.

-- first_name:

-- last_name:

-- preferred_name: [optional] The name that is displayed to the community, e.g., "Coach Carter" instead of "Kevin Carter"

-- email: Format must be a@bc.com

-- mobile_phone: [optional] 10 digits only. No dashes or spaces included.

-- home_phone: [optional] 10 digits only. No dashes or spaces included.

-- work_phone: [optional] 10 digits only. No dashes or spaces included.

-- preferred_language: [optional] See the list of supported languages for reference. Default is 'english'.

-- title: [optional]


Ex:
school_id,id,first_name,last_name,preferred_name,email,mobile_phone,home_phone,work_phone,preferred_language,title



Students File

The students.csv file provides the necessary information to generate student accounts and relates them to the school(s) they belong to.


Fields:

-- school_id: Id of the school where the student is assigned. Must match an ID in the school.csv file.

-- id: Unique for each student. Will be referenced in the memberships.csv and contacts.csv files.

-- first_name:

-- last_name:

-- preferred_name: [optional] The name that is displayed to the community.

-- email: [optional] Format must be a@bc.com

-- mobile_phone: [optional] 10 digits only. No dashes or spaces included.

-- home_phone: [optional] 10 digits only. No dashes or spaces included.

-- preferred_language: [optional] See the list of supported languages for reference. Default is 'english'.

-- grade: [optional] infant, preschool, k, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

-- gender: [optional] (Male/Female/Other)

-- birth_date: [optional] MM/DD/YYYY


Ex:
school_id,id,first_name,last_name,preferred_name,email,mobile_phone,home_phone,preferred_language,grade,gender,birth_date



Contacts File

The contacts.csv file provides the necessary information to generate specific contact (parent/guardian) accounts and relates them to students within the district.


Fields:

-- school_id: Id of the school where the student is located. Must match an ID from the school.csv

-- id: Unique for each contact. For multiple students, the ID must match across all of them.

-- child_id: The ID of a related student found in the students.csv file.

-- first_name:

-- last_name:

-- preferred_name: [optional] The name that is displayed to the community.

-- email: Format must be a@bc.com

-- mobile_phone: 10 digits only. No dashes or spaces included.

-- home_phone: 10 digits only. No dashes or spaces included.

-- work_phone: 10 digits only. No dashes or spaces included.

-- preferred_language: [optional] See the list of supported languages for reference. Default is 'english'.

-- contact_preference: [optional] (all, emergency, none). Defaults to 'all'.

-- relationship: [optional]

-- is_guardian: [optional]

-- lives_with: [optional]

-- receive_communications: [optional]


Additional Contact Notes:

  • One email, mobile_phone, or home_phone is required. Email and one phone number are recommended.


Ex:
school_id,id,child_id,first_name,last_name,preferred_name,email,mobile_phone,home_phone,work_phone,preferred_language,contact_preference,relationship,is_guardian,lives_with,receive_communications


Memberships File

The memberships.csv file provides the necessary information to associate staff, students, and contacts to specific classes/groups that they belong to.


Fields:

-- school_id: Must match an ID in the schools.csv file.

-- group_id: Must match an ID in the classes.csv file.

-- staff_id: Must match an ID in the staff.csv file.

-- student_id: Must match an ID in the students.csv file.

-- contact_id: Must match an ID in the contacts.csv file.

-- role: admin/office/teacher/faculty/staff/parent/student/member


Additional Membership Notes:

  • A school_id or group_id must be provided for each membership. Exception: 0 or a NULL value is commonly used for the district building id.
  • A staff_id, student_id, or contact_id must be provided for each individual membership.
  • Staff members who are school or district admins, and should have complete access to the school or district, should be assigned the admin role at the appropriate level. Example: For a district administrator, enter a '0' or NULL value for the school_id, plus their staff_id and their role (admin).
  • Staff members who are teachers should be assigned the teacher role at the school(s) they are assigned to.
  • Staff members who are NOT teachers should be made staff at the school they belong to. If they work at the district level, they should be assigned the staff role in the district.


Ex:
school_id,group_id,staff_id,student_id,contact_id,role


Attendance File

The attendance_xx.csv file is an optional file that provides the necessary information to generate basic automated notifications to parents when a student is marked absent or tardy, based on the associated Auto Notice Template.


Fields:

-- school_id: Id of the school where the student is assigned. Must match an ID in the school.csv file.

-- id: Unique for each student, contact, or staff member. Referenced by all staff, student, and contact files.

-- type: [optional] Member type of the ID in file, (student, contact, staff). Default is 'student'.

-- first_name: [optional] Often used as a flex-field in the message.

-- last_name: [optional] Often used as a flex-field in the message.

-- period: [optional] Attendance period. Often used as a flex-field in the message and as a template filter value.

-- status: [optional] Attendance status code. Often used as a flex-field in the message and as a template filter value.

-- excuse: [optional] Attendance excuse code. Often used as a flex-field in the message and as a template filter value.

-- code: [optional] Full attendance code. Often used as a flex-field in the message and as a template filter value.

-- description: [optional] Attendance code description. Often used as a flex-field in the message.

-- date: [optional] MM/DD/YYYY. Often used as a flex-field in the message and as a template filter value.


Additional Attendance Notes:

  • Each Auto Notice Template is associated with a specific filename. Once the file arrives, it will be processed at the scheduled time set in the template. We recommend sending the file at least 30 minutes prior to delivery.
  • Multiple templates can be associated with a single attendance file. In this case, your school or district might want two separate messages to be delivered based on different criteria. For example, On code 'A', you might want an absence message to be delivered, and on code 'T', you might want a tardy message to be delivered.


Ex:
school_id,id,type,firstName,lastName,period,status,excuse,code,description,date


Nutrition Balance File

The nutrition_xx.csv file is an optional file that provides the necessary information to generate basic automated notifications to parents when a student has a low or negative nutrition balance, based on the associated Auto Notice Template.


Fields:

-- school_id: Id of the school where the student is assigned. Must match an ID in the school.csv file.

-- id: Unique for each student, contact, or staff member. Referenced by all staff, student, and contact files.

-- type: [optional] Member type of the ID in file, (student, contact, staff). Default is 'student'.

-- first_name: [optional] Often used as a flex-field in the message.

-- last_name: [optional] Often used as a flex-field in the message.

-- status: [optional] Nutrition status code (F, Free, R, Reduced, P, Paid). Often used as a template filter value.

-- balance: [optional] Nutrition Balance. Often used as a flex-field in the message and as a template filter value.

-- date: [optional] MM/DD/YYYY. Often used as a flex-field in the message and as a template filter value.


Additional Nutrition Balance Notes:

  • Each Auto Notice Template is associated with a specific filename. Once the file arrives, it will be processed at the scheduled time set in the template. We recommend sending the file at least 30 minutes prior to delivery.
  • Multiple templates can be associated with a single nutrition balance file. In this case, your school or district might want two separate messages to be delivered based on different criteria. For example, when a student has a balance less than $20, and their status is not 'F', you might want a low balance message to be delivered, and when a student has a balance less than $20, and their status is not 'F', you might want a negative balance message to be delivered.


Ex:
school_id,id,type,firstName,lastName,status,balance,date