Behavior Letter Merge Fields
The following fields are included in the Behavior merge file. The merge file is created using the Send Communication option for Behavior Communications. For more information, refer to Send Communications Page.
Merge Field | Information to Print |
---|---|
template_path | File name for the letter. |
respond_to_email | Sender email address specified in Behavior Building Configuration for the building. When individuals select to reply to a notification email, this will be the address to which replies are sent. |
building | Enrollment building. |
date_run | Date that the Calculate Behavior Criteria option was run. |
date_from | Date that the calculation started from. |
date_thru | Date that the calculation calculated through when the letter was triggered. |
incidents_this_letter | Number of incidents that meet this criterion for the reset period. |
letter_reset_period | Indicator for the reset period. |
student_id | Student's identification number. |
student_name | Student's full name. |
student_apartment | Apartment complex for student physical mailing address. |
student_complex | Complex name for student physical mailing address. |
student_street_number | House number for student physical mailing address. |
student_street_prefix | Prefix for street name for student physical mailing address. |
student_street_name | Street name for student physical mailing address. |
student_street_suffix | Suffix for street name for student physical mailing address. |
student_street_type | Type for street for student physical mailing address. For example, Ave or St. |
student_city | City for student physical mailing address. |
student_state | State for student physical mailing address. |
student_zip | Zip code for student physical mailing address. |
contact_name | Full name of recipient. If more than one guardian is selected to receive discipline letters, the student will have multiple letter records in the merge file. |
contact_title | Title of recipient. |
contact_apartment | Apartment number for recipient. |
contact_complex | Complex name for recipient. |
contact_street_number | House number for recipient. |
contact_street_prefix | Prefix for street name for recipient. |
contact_street_name | Street name for recipient. |
contact_street_suffix | Suffix for street name for recipient. |
contact_street_type | Type of street for recipient. For example, Ave or St. |
contact_city | City for recipient. |
contact_state | State for recipient. |
contact_zip | Zip code for recipient. |
house_team | House/team for student. |
grade | Enrollment grade for student. |
counselor | Staff ID for student's counselor. |
counselor_name | Name for student's counselor. |
counselor_phone | Phone number for student's counselor. |
counselor_phone_extension | Extension for phone for student's counselor. |
contact_email | Email address for recipient. |
contact_email_preference | Indicator of whether the recipient has elected to receive notifications by email. |
primary_homeroom_staff_ids | Staff ID numbers for the teachers assigned to the student's primary homeroom. |
primary_homeroom_teacher_names | Names of the staff members for the teachers assigned to the student's primary homeroom. |
primary_homeroom | Room number for the student's primary homeroom. |
primary_homeroom_name | Description of the room for the student's primary homeroom. |
secondary_homeroom_staff_ids | Staff ID numbers for the teachers assigned to the student's secondary homeroom. |
secondary_homeroom_teacher_names | Names of the staff members for the teachers assigned to the student's secondary homeroom. |
secondary_homeroom | Room number for the student's secondary homeroom. |
secondary_homeroom_name | Description of the room for the student's secondary homeroom. |
offense_details | For each incident included in the letter, this field lists the date of incident, offense code and description. Please note that this field includes a hard return. You cannot include this field in the middle of a paragraph. It should be included below the letter text. |
offense_total_details | List of offense codes and description followed by the total number of times the student has had the offense code reported. Please note that this field includes a hard return. You cannot include this field in the middle of a paragraph. It should be included below the letter text. |
offense_and_action_details | For each incident, lists the offense and action information. Date of incident, offense code and description on the first line. For each action assigned for the offense, lists the action date (if a date is entered) and the action description. Please note that this field includes a hard return. You cannot include this field in the middle of a paragraph. It should be included below the letter text. |
action_total_details | List of action codes and description followed by the total number of times the student has had this action assigned. Please note that this field includes a hard return. You cannot include this field in the middle of a paragraph. It should be included below the letter text. |
action_occurrence_dates | Occurrence dates on which actions are to be served. If your district does not track occurrences, do not use this field. |
student_first_name | Student's first name. |
student_last_name | Student's last name. |
contact_first_name | Recipient's first name. |
contact_last_name | Recipient's last name. |
incident_code | Offense code for which letter was generated. |
incident_subcode | Incident category for the incident. |
incident_time | Time that incident occurred. |
reported_by_name | Name of student, non-student, or staff member who reported the incident. |
reported_to | Identifies to whom the incident was reported. |
location | Location where the incident occurred. |
gang_related | Text indicating if the incident was gang-related. Prints 'Gang-related'or 'Not Gang-related.' |
police_notified | Text indicating if the incident was reported to the police. Prints 'Police were not notified.' or 'Police were notified.' |
police_notify_date | Date the police were notified. |
police_department | Police department to which the incident was reported. |
complaint_number | Complaint number for the incident. |
officer_name | Name of the officer who took report. |
badge_number | Badge number of the officer who took report. |
incident_comments | Free text comments about the incident. This text may be 1024 characters long. |
offense_subcodes | Offense category for the offense. |
weapons | Weapon descriptions that student had as reported for the incident. Multiple weapons are listed in a comma-delimited list with no spaces between descriptions. |
drugs | Drug descriptions that student had as reported for the incident. Multiple drugs are listed in a comma-delimited list with no spaces between descriptions. |
referred_to | Identifies to whom the student was referred. |
police_action | Actions taken by the police. |
charges_filed_by | Name of the individual who filed charges. |
charges_filed_with | Name of the person with whom they filed charges. |
charges | Charges filed related to the incident. |
convictions | Convictions related to the incident. |
action_fine_amounts | Fine amount student was charged for the incident. |
action_cost_amounts | Cost student was charged for the incident. |
action_court_cost_amounts | This field will not have a value. |
<User defined fields> | Your district has selected the user defined fields that will display at the end of the merge file. |