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 only exception to this are the signature macros seen below.
The macros are not case-sensitive
Macro | Description |
DISTRICT_NAME | Name of the School District |
SCHOOL_YEAR | The current school year in the format 20xx-xx |
CASE_MANAGER_NAME | The students case manager. |
COUNSELOR_NAME | The students current counselor. |
COUNSELOR_EMAIL | The students current counselor's email address. |
COUNSELOR_EXTENSION | The students current counselor's extension. (Voicemail field) |
NEXT_SCHOOL_YEAR | The next school year in the format 20xx-xx |
NEXT_SCHOOL_NAME | The next school for the student. |
NEXT_GRADE_LEVEL | The next grade level |
NEXT_COUNSELOR_NAME | The student's next counselor's name. |
STUDENT_REQUESTS_1COL | Student Requests (Each line is course code - description) (Course descriptions are not limited or truncated). |
STUDENT_REQUESTS_1COL_NOCODE | Student Requests (Each line is shows description w/o code) (Course descriptions are not limited or truncated). |
STUDENT_REQUESTS | Student Request Table with course code and full course descriptions (Course Descriptions are limited to 20 characters) |
STUDENT_REQUESTS_NOCODE | Student Request Table with no course codes and full course descriptions (Course Descriptions are limited to 35 characters) |
STUDENT_REQUESTS_W_ALT | Student Request Table with full course descriptions. The alternates are listed in the second column. |
SHORT_STUDENT_REQUESTS | Student Request Table with course short descriptions |
SHORT_STUDENT_REQUESTS_W_ALT | Student Request Table with course short descriptions. The alternates are listed in the second column. |
STUDENT_REQUESTS_COUNT | Count of Student Request |
STUDENT_REQUESTS_CREDITS | Total credits of requested courses. |
STUDENT_REQUESTS_BY_DEPT | This will show the description of any requests for a specific department. Ex. ${STUDENT_REQUESTS_BY_DEPT:ENG}, where the ENG is the department code for English. |
STUDENT_REQUESTS_ALT_CREDITS | Total credits of requested alternate courses. |
LETTER_DATE_SHORT | Letter Date in the format mm/dd/yyyy |
LETTER_DATE_LONG | Letter Date in the format September 04, 2003 |
STUDENT_NAME | Student's name as recorded in the database. Usually lastname, first |
STUDENT_LAST_NAME | Student's last name |
STUDENT_FIRST_NAME | Student's first name |
STUDENT_ID | Student ID |
STUDENT_STATE_ID | Student State ID |
STUDENT_SSN | Student Social Security Number |
STUDENT_GRADE_LEVEL | Student Grade Level |
STUDENT_HOMEROOM | Student Homeroom |
STUDENT_HOMEROOM_TEACHER | Student Homeroom Teacher |
STUDENT_HR_TEACHER_PREFIX_LASTNAME | Student Homeroom Teacher written with Prefix first and then Last Name. Ex. Mr. Smith |
STUDENT_GENDER_HISHER | The Word his or her depending on the gender. Add :UPPER to end of macro and the first letter will be upper case. (His) |
STUDENT_GENDER_HESHE | The Word he or she depending on the gender. Add :UPPER to end of macro and the first letter will be upper case. (He) |
STUDENT_GENDER_HIMHER | The Word him or her depending on the gender. Add :UPPER to end of macro and the first letter will be upper case. (Him) |
SCHOOL_CODE | School Code |
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_ADDRESS_CITY | School City |
SCHOOL_ADDRESS_STATE | School State Code |
SCHOOL_ADDRESS_ZIP | School Zip |
SCHOOL_PHONE_NUMBER | School Phone Number |
SCHOOL_OFFICE_FAX | School Fax Number |
ADDRESS_NAME | "To" mailing address |
ADDRESS_LINE1 | mailing address line 1 |
ADDRESS_LINE2 | mailing address line 2 |
ADDRESS_CITY | mailing address city |
ADDRESS_STATE | mailing address state |
ADDRESS_ZIP | mailing address zip |
ADDRESS_HOME_PHONE | This is the phone number for the student's Home Contact on the Address Record that the letter is going to. EX.(xxx) xxx-xxxx |
PLEASE NOTE THESE MACROS MUST BE SURROUNDED BY #{ } #{STUDENT_PRINCIPAL_SIGNATURE_IMAGE} #{STUDENT_VICEPRINCIPAL_SIGNATURE_IMAGE} #{STUDENT_COUNSELOR_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. NOTE: Adding a number within the brackets, i.e. #{STUDENT_VICEPRINCIPAL_SIGNATURE_IMAGE, 200} will offset the signature image by that amount. |
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