Comment Import Type

Overview

The Veracross Data Importer allows schools to import new comments for students. This import type is considered an importer — it only allows you to import new comments and not update existing ones. Though comments are often closely associated with behavior incidents in the context of Veracross, this import type is for comments only. To view the Behavior Import Type, please read our documentation on the Behavior import type here.

Uploading Comments involves the following two steps:

  1. Preparing the data for upload using the Comment import type template, which is provided before data import on the Importer site.
  2. Uploading the data using the Veracross Data Importer.

Preparing the Data for Upload

The user must prepare a comma separated value (CSV) file containing all data to import. This file must contain all columns in the order listed below, even if no content is populated in the columns. If there is no content in a column, that row must be left blank.

Fields in the Import Type Template

In addition to a number of required fields, this template has an instance of a "either this field or that field are required" scenario; specifically, regarding person_id, person_reference_type, and person_reference_value. See the notes in the table below for more information.

Outside of the scenario highlighted above, all required fields are designated in the Value Considerations column.

Column (Field) NameValue Considerations
Required fields:
person_id or
person_reference_type and person_reference_value
person_id
Numeric format. The person_id can be found in the Person ID field in a standard Find Person query.
person_reference_type


Must be an already existing person reference type. This information can be found in a Person Reference Type query. Must be either of the following:

  • person reference type id (numeric)
  • person reference type description (text/numeric)

person_reference_value
Text/numeric format. This value is the reference value in a Find Person Reference Number query.
incident_type
Required field. Text/numeric format. The incident type of the comment as it exists in Veracross. This information can be found in this Behavior Incident Type query. Must be either of the following:
  • ID (numeric format — to use this field, the "Category" column must be Comment)
  • Description (text format — wording must be exact, but it not case-sensitive. To use this field, the "Category" column must be Comment)
incident_date
Required field. Date format. Date that the comment was madeDate must be in the 'YYYY-MM-DD' format.
incident_notes
Text format. A location to store additional notes about the comment. This field has no character limit.
reporting_internal_class_id
Numeric format. The Internal Class ID field of the class that the comment references. Find this value in this Find Classes query (as the Internal Class ID field).
reporting_class_id
Text/Numeric format. This is the class ID for the class that the comment references. The school year for this value is assumed from the date given in the 'incident_date' column. Find this value in this Find Classes query (as the Class ID field).
reporting_person_id
Numeric format. Person ID of an existing person in the database. Find this information in a Find Person query.
outcome_type
Text/numeric format. The outcome type of the comment as it exists in Veracross. This information can be found in this Behavior Outcome Types query. Must be either of the following:
  • ID (numeric format)
  • Description (text format — wording must be exact, but it is not case-sensitive)
outcome_date
Date format. Date when the outcome is defined. Date must be in the 'YYYY-MM-DD' format.
outcome_notes
Text format. A location to store additional notes about the outcome of the comment. This field has no character limit.
status
Text format. The status of the comment if the Category in the Behavior/Comment Statuses query is "Status". This value is the Description field in the Behavior/Comment Statuses query. The wording must be exact, but it is not case sensitive.
status_date
Date format. Date when the status on the comment was set. Date must be in the  'YYYY-MM-DD' format.
notification_notes
Text format. A location to store additional notes about the outcome of the follow-up to the behavior incidient. This field has no character limit.

Additional Considerations

In addition to the criteria set in the table above, the Comment import type has a number of additional considerations that should be taken into account:

  • this import type only inserts new comments — it does not alter existing comments
  • if a comment is imported from a school year before the current school year, the importer assumes and assigns a grading period of ALL.
  • this import type is not for importing behavior incidents. For this process, read our documentation on the Behavior Import type here.