Letter Macros
To insert a macro into a letter definition, surround the macro with ${}. Optionally, you can specify the width in characters and an alignment. For example:${STUDENT_NAME,40,R} would print the student's name in 40 characters right justified, where as ${STUDENT_NAME} would just print the student name without any padding. The macros are not case-sensitive. The only exception to this are the Signature macros.
Macro | Description | Notes |
LETTER_DATE_SHORT | Letter Date in the format mm/dd/yyyy. | |
LETTER_DATE_LONG | Letter Date in the format September 04, 2009. | |
STUDENT_NAME | Student's name as recorded in the database. Usually last name, first. | |
STUDENT_FULL_NAME | First Middle Last | |
STUDENT_LAST_NAME | Student's last name | |
STUDENT_FIRST_NAME | Student's first name (all student name fields are preferred name, not legal/birth name) | |
STUDENT_ID | Student ID | |
STUDENT_STATE_ID | Student State ID | |
STUDENT_DOB | Student's Date of Birth | |
STUDENT_CAREER | Student's Career Choice | |
STUDENT_SSN | Student's Social Security Number | |
STUDENT_GRADE_LEVEL | Student Grade Level | |
STUDENT_HOMEROOM | Student Homeroom | |
HR_TEACHER | Student's HR teacher. Ex. Smith, John | |
HR_TEACHER_FIRST_LAST | Student's HR teacher. Ex. John Smith | |
STUDENT_CASE_MANAGER | Student Case Manager's Name | |
STUDENT_CM_SIGNATURE | Student's Case Manager's Signature Name | |
STUDENT_CM_TITLE | Signature Title line from District Teacher object assigned as Case Manager. | |
STUDENT_COUNSELOR_NAME | Student Counselor's Name (Last, First) | |
STUDENT_COUNSELOR_FIRST_LAST_NAME | Student Counselor's Name (First Last) | |
STUDENT_COUNSELOR_EXTENSION | Student Counselor's Phone Extension | |
STUDENT_COUNSELOR_SIGNATURE | Student's Counselor's Signature Name | |
STUDENT_COUNSELOR_TITLE | Signature Title line from District Teacher object assigned as Counselor. | |
STUDENT_TEAM_CODE | ||
STUDENT_TEAM_NAME | ||
STUDENT_VP_NAME | Student's Vice Principals Name | |
STUDENT_VP_SIGNATURE | Student's Vice Principals Signature Name | |
STUDENT_VP_SIGNATURE_TITLE | Student's Vice Principals Title | |
SCHOOL_CODE | School Code | |
SCHOOL_PRINCIPAL | School Principal from school settings | |
SCHOOL_PRINCIPAL_EMAIL | School Principal Email | |
SCHOOL_PRINCIPAL_PHONE | School Principal Phone | |
SCHOOL_PRINCIPAL_PHONE_EXT | School Principal Phone Ext | |
SCHOOL_PRINCIPAL_EMAIL | School Principal Email | |
SCHOOL_NAME | School Name | |
SCHOOL_STATE_CODE | School State Code | |
SCHOOL_ADDRESS_LINE1 | School Address Line 1 | |
SCHOOL_ADDRESS_LINE2 | School Address Line 2 | |
SCHOOL_PHONE_NUMBER | School Office Phone Number | |
SCHOOL_PHONE_NUMBER_EXT | School Office Phone Number Ext | |
SCHOOL_EMAIL | ||
SCHOOL_FAX_NUMBER | School Office Fax Number | |
SCHOOL_ADDRESS_CITY | School City | |
SCHOOL_ADDRESS_STATE | School State | |
SCHOOL_ADDRESS_ZIP | School Zip code | |
SCHOOL_START_DATE | School Start Date in mm/dd/yyyy format | |
SCHOOL_END_DATE | School End Date in mm/dd/yyyy format | |
STUDENT_GENDER_HISHER | The Word his or her depending on the gender. Put :UPPER at end if you would like the first letter uppercase. | |
STUDENT_GENDER_HIMHER | The Word him or her depending on the gender. Put :UPPER at end if you would like the first letter uppercase. | |
STUDENT_GENDER_HESHE | The Word he or she depending on the gender. Put :UPPER at end if you would like the first letter uppercase. | |
STUDENT_GENDER_SONORDAUGHTER | The Word son or daughter depending on the gender. Put :UPPER at end if you would like the first letter uppercase. | |
ADDRESS_NAME | "To" mailing address | |
ADDRESS_LINE1 | mailing address line 1 | |
ADDRESS_LINE2 | mailing address line 2 | |
ADDRESS_LINE_ALL | mailing address line 1 and 2 | |
ADDRESS_CITY | mailing address city | |
ADDRESS_STATE | mailing address state | |
ADDRESS_ZIP | mailing address zip | |
ADDRESS_CITY_STATE_ZIP | mailing address bottom line (City, ST ZIP) | |
ADDRESS_CONTACT_FIRST_LAST_NAME | First Name Last Name of contact that address in letter belongs to. (e.g. John Smith) | |
PHONE_NUMBER_LR_HOME | Home Phone Number (From the LR Address Record) | |
ABSENCE_COUNT_IN_CYCLE:cycle | Count absences for a given School Letter Cycle. Pulls totals regardless of which attendance types are checked on the letter setup. Ex: ${ABSENCE_COUNT_IN_CYCLE:FY} Additional Options: Add ;UA or ;EA to specify Unexcused or Excused Absences. Ex: ${ABSENCE_COUNT_IN_CYCLE:FY;EA} | Daily Attendance Letter Only |
TRUANCY_COUNT_IN_CYCLE:cycle | Count truancy for a given School Letter Cycle. Ex: Truancy totals for the entire school year - ${TRUANCY_COUNT_IN_CYCLE:FY} | |
ABSENCES_COUNT_IN_CYCLE:cycle | Count absences (as defined in the letter template) for a given School Letter Cycle. Will only pull absences based on attendance types checked in letter setup. Only Daily Attendance codes with "Used in Letters: YES" Ex: ${ABSENCES_COUNT_IN_CYCLE:FY} Add in ;ALL_SCHOOLS to the end of macro to get attendance for all schools a student has attended in current year (This option only for Daily Attendance Letters). | |
ABSENCES_COUNT_W_TARDY_CONV_IN_CYCLE:cycle | Count absences (as defined in the letter template) for a given School Letter Cycle. The absence total will also include converted tardies as absences as set in Auto Credit Loss Rules. | |
TARDIES_COUNT_IN_CYCLE:cycle | Count tardies (as defined in the letter template) for a given School Letter Cycle. Will only pull absences based on attendance types checked in letter setup. Only Daily Attendance codes with "Used in Letters: YES" Ex: ${TARDIES_COUNT_IN_CYCLE:FY}. Additional Options: Add ;UT or ;ET to specify Unexcused or Excused Tardies. Ex: ${ABSENCE_COUNT_IN_CYCLE:FY;ET} Add in ;ALL_SCHOOLS to the end of macro to get attendance for all schools a student has attended in current year (This option only for Daily Attendance Letters). | |
CONSECUTIVE_ABSENCE_DATES | Consecutive dates that a student is absent. | Daily Attendance Letter Only |
DATE_AFTER_TENTH_CONSECUTIVE_ABSENCE | School day that falls after 10th consecutive absence. | Daily Attendance Letter Only |
ABSENCE_DATES_DETAIL | Lists dates and attendance codes descriptions in a single column for the number of days defined in this letter. If letter calls for 5 ABS, only the qualifying 5 Absence dates will appear. | Daily Attendance Letter Only |
ABSENCE_DATES | Displays the dates that a student is absent or tardy for the number of days defined in this letter. If letter calls for 5 ABS, only the qualifying 5 Absence dates will appear. | Daily Attendance Letter Only |
ABSENCE_DATES_IN_CYCLE | Shows Absence dates in Letter Cycle. Will show Excused and Unexcused based on the letter setup. Add in :ALL_SCHOOLS to the end of macro to get dates for all schools a student has attended in current year (This option only for Daily Attendance Letters). | |
TARDY_DATES_IN_CYCLE | Shows Tardy dates in Letter Cycle. Will show Excused and Unexcused based on the letter setup. Add in :ALL_SCHOOLS to the end of macro to get dates for all schools a student has attended in current year (This option only for Daily Attendance Letters). | |
POSSIBLE_DAYS_IN_CYCLE | Will display number of possible days that have passed so far from the start date of the letter cycle to the current date. | |
STUDENT_SCHEDULE_ATTENDANCE | Displays student schedule with attendance for the letter cycle. Attendance Display: Add :AA to end of macro to display all absences total, :UA for unexcused, :EA for excused, :AT for all tardies, :UT for unexcused or :ET for excused. You may add more than 1 option. Course Display: By default, all courses that meet during the letter cycle will be displayed. In order to only display courses that a letter was created for, add ~IN_LETTER to the end of the macro. If you would like ot display all courses with the number of absences that qualify for the letter (even if previous letter was generated for this course), then add ~QUALIFY to the end of the macro. Example: To show all absences value and unexcused absence total for all courses that qualify for attendance total on letter. STUDENT_SCHEDULE_ATTENDANCE:AA:UA~QUALIFY | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_ATTENDANCE_VALUES_COUNT | Displays the student schedule with the total absences and tardies (Calculated from Attendance Value) for each class. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_ATTENDANCE_VALUES_COUNT_IN_CYCLE | Displays the student schedule with the total absences and tardies (Calculated from Attendance Value) for each class during the cycle on the letter template. | Class Attendance Letter Only |
STUDENT_SCHEDULE_W_SEM_WITH_ATTENDANCE_VALUES_COUNT | Displays the student schedule plus course semester with the total absences and tardies (Calculated from Attendance Value) for each class. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_UNEXCUSED_ATTENDANCE_VALUES_COUNT | Display SCHEDULE_W_UNEXCUSED_COUNTS_AND_DATES_UP_TO_LETTER_DATE s the student schedule with the total unexcused absences and tardies (Calculated from Attendance Value) for each class. | Class Attendance Letter Only |
SCHEDULE_W_UNEXCUSED_COUNTS_AND_DATES_UP_TO_LETTER_DATE | :QUALIFYING_COURSES_ONLY :SHOW_TARDY_TOTAL :SHOW_ABSENCE_TOTAL :SHOW_NOCREDIT_TOTAL :HIDE_DETAIL | Class Attendance Letter Only |
STUDENT_SCHEDULE_WSEM_WITH_UNEXCUSED_ATTENDANCE_VALUES_COUNT | Displays the student schedule plus semester with the total unexcused absences and tardies (Calculated from Attendance Value) for each class. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_NOCREDIT_ABSENCE_COUNT | Displays the student schedule with the total absences and tardies (Calculated from No Credit Absence Value) for each class. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_NOCREDIT_ABSENCE_COUNT_FOR_CYCLE | Displays the student schedule with the total absences and tardies (Calculated from No Credit Absence Value) for each class during the cycle on the letter template. Add :QUALIFYING_COURSES_ONLY to end of macro in order to have only courses that qualified for letter appear. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_NOCREDIT_ABSENCE_COUNT_FOR_CYCLE2 | ||
STUDENT_SCHEDULE_WITH_NOCREDIT_ABSENCE_SUMMARY | Displays the student schedule with the total number of Absences (Calculated from converting X Tardies to Absences, based on setup of the Grading > Setup > ATC screen). The course name and absence total are displayed, along with the total number of individual Absences and Tardies per course, before the Tardies are converted to Absences. Add :QUALIFYING_COURSES_ONLY to end of macro in order to have only courses that qualified for the letter appear. | Class Attendance Letter Only |
STUDENT_SCHEDULE_WITH_NO_ATTENDANCE | Listing of the student's schedule. | Class Attendance Letter Only |
STUDENT_SCHED_IN_LETTER_CYCLE_WITH_CYCLE_ATTENDANCE | Listing of the student's schedule that meets during the letter cycle (Letter Cycle must be a semester type) and the attendance during that cycle. Accepts the following options: :AA for all absences, :UA for unexcused or :EA for excused, :AT for all tardies, :UT for unexcused or :ET for excused. | Class Attendance Letter Only |
CLASS_ATTENDANCE_LETTER_COURSE_NAME | Displays the name of the course for which this Class Attendance Letter was created. | Class Attendance Letter Only |
CLASS_ATTENDANCE_LETTER_COURSE_ABSENCES | Displays the number of absences of the course for which this Class Attendance Letter was created. Add :UNEXCUSED or :EXCUSED after macro for Unexcused or excused absences only. (CLASS_ATTENDANCE_LETTER_COURSE_ABSENCES:UNEXCUSED) | Class Attendance Letter Only |
CLASS_ATTENDANCE_LETTER_COURSE_TARDIES | Displays the number of tardies of the course for which this Class Attendance Letter was created. | Class Attendance Letter Only |
ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE | Displays all the courses who qualified for this letter and displays the number of unexcused absences for that class. In order to see the total for all absence types, add ":ALL" to the end of the macro (ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE:ALL). If you would like to see the Credit Loss value, add :CREDITLOSS to the end of the macro (ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE:CREDITLOSS ). If you add DETAIL to the end of the macro (ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE:DETAIL), then the macro will list the total absences, followed by the unexcused count and excused count. | Class Attendance Letter Only |
ALL_COURSE_SHORT_ABSENCE_TOTAL_IN_CYCLE | Displays all the SHORT description of courses who qualified for this letter and displays the number of unexcused absences for that class. In order to see the total for all absence types, add ":ALL" to the end of the macro (ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE:ALL). | Class Attendance Letter Only |
ALL_COURSE_TARDY_TOTAL_IN_CYCLE | Displays all the courses who qualified for this letter and displays the number of unexcused tardies for that class. In order to see the total for all absence types, add ":ALL" to the end of the macro (ALL_COURSE_ABSENCE_TOTAL_IN_CYCLE:ALL). | Class Attendance Letter Only |
PLEASE NOTE THESE MACROS MUST BE SURROUNDED BY #{ } #{STUDENT_PRINCIPAL_SIGNATURE_IMAGE} #{STUDENT_VICEPRINCIPAL_SIGNATURE_IMAGE} #{STUDENT_COUNSELOR_SIGNATURE_IMAGE} #{STUDENT_DISCIPLINARIAN_SIGNATURE_IMAGE} #{STUDENT_CASEMANAGER_SIGNATURE_IMAGE} |
Will return the signature image of a staff member marked as Principal on the Staff screen. Will return the signature image of the staff member set as the students VP on the student demographics page. Will return the signature image of the staff member set as the students counselor on the student demographics page. Adding a number within the brackets, i.e. #{STUDENT_VICEPRINCIPAL_SIGNATURE_IMAGE, 200} will offset the signature image by that amount. |
Sample Letter with Macros added:
${LETTER_DATE_LONG}
Please be advised that your ${STUDENT_GENDER_SONORDAUGHTER}, ${STUDENT_FIRST_NAME}, has been absent ${ABSENCES_COUNT_IN_CYCLE:FY} day(s) since the beginning of this school year. Although it is understood that children may need to miss school occasionally due to illness or other reasons, the importance of regular attendance cannot be overemphasized. Regular attendance is extremely important to a child's academic and social growth. Students who frequently miss school lose valuable learning time and opportunities to develop positive relationships with their classmates, even if make-up work is completed at home. Your assistance to ensure your child's regular attendance is requested.
${STUDENT_VP_NAME} |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article