Versions Compared

Key

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

...

8.18.1 

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
$!termToRepresentEarlyAlert Term to Represent Early Alert in Email MessagesSystem Configuration8.1
$earlyAlert.person.firstNameStudent's first nameFirst NameEarly Alert8.1
$earlyAlert.person.lastName

Student's last nameLast Name

Early Alert8.1
$!earlyAlert.person.schoolId   Student's School IDEarly Alert
$!earlyAlert.person.homePhone   Student's Home Phone NumberEarly Alert
$earlyAlert.person.primaryEmailAddress   Student's Primary Email AddressEarly Alert
$earlyAlert.person.addressLine1   Student's AddressEarly Alert
$earlyAlert.person.addressLine2   Student's AddressEarly Alert
$earlyAlert.person.city   Student's AddressEarly Alert
$earlyAlert.person.state   Student's AddressEarly Alert
$!earlyAlert.person.zipCode   Student's AddressEarly Alert
$earlyAlert.campus.name   Campus Associated with the Early Alert (starting in v2.5.3)Early Alert
$earlyAlert.courseNameCourse for which the alert was submittedEarly Alert8.1    
$institutionName System 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 Alert
$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$!applicationTitle System Configuration
$earlyAlert.createdDate   Date the Early Alert was CreatedEarly Alert
$earlyAlertReason.name  Reason Name for Faculty Submitted ReasonsEarly Alert
$earlyAlert.earlyAlertReasonIds   Reason ID Associated with the Faculty Submitted ReasonEarly Alert
$earlyAlertSuggestion.name   Suggest Name for Faculty Submitted SuggestionsEarly Alert
$earlyAlert.earlyAlertSuggestionIds   Suggestion ID Associated with the Faculty Submitted SuggestionEarly Alert
$earlyAlert.comment   Faculty Submitted CommentEarly Alert
$earlyAlertResponse.closedDate   Created Dated for the Early Alert ResponseEarly Alert
$!earlyAlertResponse.earlyAlertOutcome.name   Outcome Name for the Coach Submitted ResponseEarly Alert
$earlyAlertResponse.earlyAlertOutcomeOtherDescription   
$earlyAlertResponse.earlyAlertOutcomeOtherDescription</   
$earlyAlertReferral.name   Outcome ID Associated with the Coach Submitted ResponseEarly Alert
$earlyAlertResponse.earlyAlertOutcomeOtherDescriptionValue of the Other Outcome for the Coach Submitted ResponseEarly Alert
$earlyAlertReferral.nameReferral Name for the Coach Submitted ResponseEarly Alert
$earlyAlertResponse.earlyAlertReferralIds   Referral ID Associated with the Coach Submitted ResponseEarly Alert
$earlyAlertResponse.comment   Comment Provided by the Coach Submitted ResponseEarly Alert
$earlyAlertResponse.createdBy.firstName   First Name of the Coach who Submitted a ResponseEarly Alert
$earlyAlertResponse.createdBy.lastName   Last Name of the Coach who Submitted a ResponseEarly Alert
${task.person.firstName}  8.2Student's First NameAction Plan
${task.challenge.name}   The Challenge Associated with the TaskAction Plan
${task.challengeReferral.name}   The Referral Associated with the TaskAction Plan
${dueDateFormatted}   Due Date of the Assigned TaskAction 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
$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)