The SSP message templates contain a combination of static text and data variables. The data variables are derived from SSP database fields based on user entry or tool interaction. Each of the variables listed below can be used within a message template
Variable | Definition | Source Tool |
${institutionName} | Configuration option for Institution Name (Available starting in v2.3) | System Configuration |
${institutionHomeUrl} | Configuration option for Institution Home URL (Available starting in v2.3 ) | System Configuration |
${applicationTitle} | Configuration option for App Title (Available starting in v2.3) | System Configuration |
${linkToSSP} | Configuration options for Server External Path (Available starting in v2.3) | System Configuration |
$!termToRepresentEarlyAlert | Term to Represent Early Alert in Email Messages | System Configuration |
$earlyAlert.person.firstName | Student's First Name | Early Alert |
$earlyAlert.person.lastName | Student's Last Name | Early Alert |
$!earlyAlert.person.schoolId | Student's School ID | Early Alert |
$!earlyAlert.person.homePhone | Student's Home Phone Number | Early Alert |
$earlyAlert.person.primaryEmailAddress | Student's Primary Email Address | Early Alert |
$earlyAlert.person.addressLine1 | Student's Address | Early Alert |
$earlyAlert.person.addressLine2 | Student's Address | Early Alert |
$earlyAlert.person.city | Student's Address | Early Alert |
$earlyAlert.person.state | Student's Address | Early Alert |
$!earlyAlert.person.zipCode | Student's Address | Early Alert |
$earlyAlert.campus.name | Campus Associated with the Early Alert (starting in v2.5.3) | Early Alert |
$earlyAlert.courseName | Course for which the alert was submitted | Early Alert |
$earlyAlert.createdBy.firstName | Author's first name | Early Alert |
$earlyAlert.createdBy.lastName | Author's last name | Early Alert |
$earlyAlert.createdBy.workPhone | Author's work phone number | Early Alert |
$earlyAlert.createdBy.primaryEmailAddress | Author's primary email address | Early Alert |
$earlyAlert.person.coach.title | Title of the student's assigned coach | Early Alert |
$earlyAlert.person.coach.staffDetails.officeLocation | Location of the student's assigned coach | Early Alert |
$earlyAlert.person.coach.officeLocation | Location of the student's assigned coach | Early Alert |
$earlyAlert.person.coach.workPhone | Work phone for student's assigned coach | Early Alert |
$earlyAlert.person.coach.primaryEmailAddress | Primary email address for the student's assigned coach | Early Alert |
$earlyAlert.createdDate | Date the Early Alert was Created | Early Alert |
$earlyAlertReason.name | Reason Name for Faculty Submitted Reasons | Early Alert |
$earlyAlert.earlyAlertReasonIds | Reason ID Associated with the Faculty Submitted Reason | Early Alert |
$earlyAlertSuggestion.name | Suggest Name for Faculty Submitted Suggestions | Early Alert |
$earlyAlert.earlyAlertSuggestionIds | Suggestion ID Associated with the Faculty Submitted Suggestion | Early Alert |
$earlyAlert.comment | Faculty Submitted Comment | Early Alert |
$earlyAlertResponse.closedDate | Created Dated for the Early Alert Response | Early Alert |
$!earlyAlertResponse.earlyAlertOutcome.name | Outcome Name for the Coach Submitted Response | Early Alert |
$earlyAlertResponse.earlyAlertOutcomeOtherDescription | Outcome ID Associated with the Coach Submitted Response | Early Alert |
$earlyAlertResponse.earlyAlertOutcomeOtherDescription | Value of the Other Outcome for the Coach Submitted Response | Early Alert |
$earlyAlertReferral.name | Referral Name for the Coach Submitted Response | Early Alert |
$earlyAlertResponse.earlyAlertReferralIds | Referral ID Associated with the Coach Submitted Response | Early Alert |
$earlyAlertResponse.comment | Comment Provided by the Coach Submitted Response | Early Alert |
$earlyAlertResponse.createdBy.firstName | First Name of the Coach who Submitted a Response | Early Alert |
$earlyAlertResponse.createdBy.lastName | Last Name of the Coach who Submitted a Response | Early Alert |
${task.person.firstName} | Student's First Name | Action Plan |
${task.challenge.name} | The Challenge Associated with the Task | Action Plan |
${task.challengeReferral.name} | The Referral Associated with the Task | Action Plan |
${dueDateFormatted} | Due Date of the Assigned Task | Action Plan |
${fullName} | Student's Full Name | Action Plan |
${description} | Task description | Action Plan |
${taskTO.name} | Name for Action Plan Task | Action Plan |
${taskTO.description} | Description for Action Plan Task | Action Plan |
${goalTO.name} | Name for Action Plan Goal | Action Plan |
${goalTO.description} | Description for Action Plan Goal | Action Plan |