Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Variable

Definition

Source ToolConfiguration Guide Item(s)
${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
$!termToRepresentEarlyAlertTerm to Represent Early Alert in Email MessagesSystem Configuration8.1
$earlyAlert.person.firstNameStudent's First NameEarly Alert8.1
$earlyAlert.person.lastName

Student's Last Name

Early Alert8.1
$!earlyAlert.person.schoolIdStudent's School IDEarly Alert8.1
$!earlyAlert.person.homePhoneStudent's Home Phone NumberEarly Alert8.1
$earlyAlert.person.primaryEmailAddressStudent's Primary Email AddressEarly Alert8.1
$earlyAlert.person.addressLine1Student's AddressEarly Alert8.1
$earlyAlert.person.addressLine2Student's AddressEarly Alert8.1
$earlyAlert.person.cityStudent's AddressEarly Alert8.1
$earlyAlert.person.stateStudent's AddressEarly Alert8.1
$!earlyAlert.person.zipCodeStudent's AddressEarly Alert8.1
$earlyAlert.campus.nameCampus Associated with the Early Alert (starting in v2.5.3)Early Alert8.1
$earlyAlert.courseNameCourse for which the alert was submittedEarly Alert8.1$institutionNameInstitution Name for Email MessagesSystem Configuration8.1
$earlyAlert.createdBy.firstNameAuthor's first nameEarly Alert8.1
$earlyAlert.createdBy.lastNameAuthor's last nameEarly Alert8.1
$earlyAlert.createdBy.workPhoneAuthor's work phone numberEarly Alert8.1
$earlyAlert.createdBy.primaryEmailAddressAuthor's primary email addressEarly Alert8.1
$earlyAlert.person.coach.titleTitle of the student's assigned coachEarly Alert8.1
$earlyAlert.person.coach.staffDetails.officeLocationLocation of the student's assigned coachEarly Alert8.1
$earlyAlert.person.coach.officeLocationLocation of the student's assigned coachEarly Alert8.1
$earlyAlert.person.coach.workPhoneWork phone for student's assigned coachEarly Alert8.1
$earlyAlert.person.coach.primaryEmailAddressPrimary email address for the student's assigned coachEarly Alert8.1
$!applicationTitleTitle of the Application for Email MessagesSystem Configuration8.1
$earlyAlert.createdDateDate the Early Alert was CreatedEarly Alert8.1
$earlyAlertReason.nameReason Name for Faculty Submitted ReasonsEarly Alert8.1
$earlyAlert.earlyAlertReasonIdsReason ID Associated with the Faculty Submitted ReasonEarly Alert8.1
$earlyAlertSuggestion.nameSuggest Name for Faculty Submitted SuggestionsEarly Alert8.1
$earlyAlert.earlyAlertSuggestionIdsSuggestion ID Associated with the Faculty Submitted SuggestionEarly Alert8.1
$earlyAlert.commentFaculty Submitted CommentEarly Alert8.1
$earlyAlertResponse.closedDateCreated Dated for the Early Alert ResponseEarly Alert8.1
$!earlyAlertResponse.earlyAlertOutcome.nameOutcome Name for the Coach Submitted ResponseEarly Alert8.1
$earlyAlertResponse.earlyAlertOutcomeOtherDescriptionOutcome ID Associated with the Coach Submitted ResponseEarly Alert8.1
$earlyAlertResponse.earlyAlertOutcomeOtherDescriptionValue of the Other Outcome for the Coach Submitted ResponseEarly Alert8.1
$earlyAlertReferral.nameReferral Name for the Coach Submitted ResponseEarly Alert8.1
$earlyAlertResponse.earlyAlertReferralIdsReferral ID Associated with the Coach Submitted ResponseEarly Alert8.1
$earlyAlertResponse.commentComment Provided by the Coach Submitted ResponseEarly Alert8.1
$earlyAlertResponse.createdBy.firstNameFirst Name of the Coach who Submitted a ResponseEarly Alert8.1
$earlyAlertResponse.createdBy.lastNameLast Name of the Coach who Submitted a ResponseEarly Alert8.1
${task.person.firstName}Student's First NameAction Plan8.2
${task.challenge.name}The Challenge Associated with the TaskAction Plan8.2
${task.challengeReferral.name}The Referral Associated with the TaskAction Plan8.2
${dueDateFormatted}Due Date of the Assigned TaskAction Plan8.2
${fullName}Student's Full NameAction Plan8.2
${description}Task descriptionAction Plan8.2
${taskTO.name}Name for Action Plan TaskAction Plan8.2
${taskTO.description}Description for Action Plan TaskAction Plan8.2
${goalTO.name}Name for Action Plan GoalAction Plan8.2
${goalTO.description}Description for Action Plan GoalAction Plan8.2
$message.idUUID for email that triggered this Journal Entry

Email

(available starting in 2.6.0)

$message.createdDateEmail creation timestamp

Email

(available starting in 2.6.0)

$message.createdBy.idUUID for user who requested email that triggered this JE

Email

(available starting in 2.6.0)

$message.createdBy.firstNameFirst name of user who requested email that triggered this JE

Email

(available starting in 2.6.0)

$message.createdBy.lastNameLast name of user who requested email that triggered this JE

Email

(available starting in 2.6.0)

$message.createdBy.fullNamefirstName + " " + lastName

Email

(available starting in 2.6.0)

$message.modifiedDateEmail modification timestamp (typically same as date sent)

Email

(available starting in 2.6.0)

$message.modifiedBy.idUUID for user who last modified the email that triggered this JE. Often the system user.

Email

(available starting in 2.6.0)

$message.modifiedBy.firstNameFirst name of user who last modified the email that triggered this JE. Often the system user.

Email

(available starting in 2.6.0)

$message.modifiedBy.lastNameLast name of user who last modified the email that triggered this JE. Often the system user.

Email

(available starting in 2.6.0)

$message.modifiedBy.fullNamefirstName + " " + lastName of user who last modified the email that triggered this JE. Often the system user.

Email

(available starting in 2.6.0)

$message.objectStatus1 = email active, 2 = email soft-deleted

Email

(available starting in 2.6.0)

$message.subjectSubject of email that triggered this JE

Email

(available starting in 2.6.0)

$message. carbonCopyCSV list of CC addresses on email that triggered this JE

Email

(available starting in 2.6.0)

$message. recipientEmailAddressCSV list of To addresses on email that triggered this JE

Email

(available starting in 2.6.0)

$message.bodyBody content of email that triggered this JE. Expect this to be a fully HTML document (i.e. has <html><body>...</body></html> wrapping) so typically not well-suited for inclusion in a JE comment. SeemessageContext.originalBody below

Email

(available starting in 2.6.0)

$message.sender.idID of the From user for the email that triggered this JE. Typically same as message.createdBy.id

Email

(available starting in 2.6.0)

message.sender.firstNameFirst name of the From user for the email that triggered this JE. Typically same as message.createdBy.firstName

Email

(available starting in 2.6.0)

message.sender.lastNameLast name of the From user for the email that triggered this JE. Typically same as message.createdBy.lastName

Email

(available starting in 2.6.0)

message.sender.fullNamefirstName + " " + lastName of the From user for the email that triggered this JE. Typically same as message.createdBy.fullName.

Email

(available starting in 2.6.0)

messageContext.originalBodyThe original email body content submitted by the end user when she submitted the bulk or single email request. This is typically a HTML document fragment rather than a full document so is better suited to including in Journal Entry comments than is message.body

Email

(available starting in 2.6.0)