(350).png){kind=logo}
Email Template Variables
- 10 Minutes to read
- Print
- DarkLight
Email Template Variables
- 10 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Email template variables are built-in identifiers that when used in an email template or snippet are replaced with their actual value. For example, the course.name variable will be replaced with the actual course name (e.g., Accounting 101) and the user.fullname variable will be replaced with the user's full name (e.g., Gary Carter).
The variables are organized into the following categories:
- Account
- Certification
- Course
- Enrollment
- Group
- Learning Plan
- Login
- Miscellaneous
- Snippet
- Subscription
- User
- Video
Account Variables
account.adminthemename
The account's theme for the admin interface.
account.learnerthemename
The default theme selected for the user's dashboard set.
account.logo
The account's logo.
account.name
The account's name.
account.systemfromemail
The "From" email address for system-generated emails.
account.systemfromidentity
The "From" identity for system-generated emails.
account.unsubscribecontact
The unsubscribe contact. For user-generated or system-generated emails, this displays the "From" address and identify for system- and user-generated emails.
account.userfromemail
The "From" email address for user-generated emails.
account.userfromidentity
The "From" identity for user-generated emails.
Certification Variables
certification.description
The certification's description.
certification.name
The certification's name.
Course Variables
course.chaptername
course.courseid
The course's identifier.
course.description
The course's description.
course.name
The course's name.
course.pointsinfo
If points and rewards are enabled for your account, information about point trackers associated with the course. The information includes the point tracker's name, points earned, expiration type, and expiration date. If licensing is enabled for the account, the licensing category and licensing reference ID are also included.
course.quiztaskname
The online course's quiz or task name.
course.sessioncalendar
Links to add the session's information to an Outlook, Google, or iCal calendar.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
course.sessionenddate
The course session's end date. If a session has multiple parts, this variable returns the end date of the first part.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
course.sessionendtime
The course session's end time. If a session has multiple parts, this variable returns the end time of the first part.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
course.sessioninformation
Information about a course's session. This includes the session's start date, end date, and location, plus a link to add the session's information to an Outlook, Google, or iCal calendar.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
Session information will be available once all prerequisites are completed.
course.sessionlink
A link to the session's information on the learner interface.
course.sessionlocation
The course session's venue. If a session has multiple parts, this variable returns the information of the first part. The information returned will depend on the session's type:
- Venue - The session's venue, room, and room location.
- Webinar - The webinar URL.
- Other - The text entered in the Other setting for the session.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
course.sessionstartdate
The course session's start date. If a session has multiple parts, this variable returns the start date of the first part.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
course.sessionstarttime
The course session's start time. If a session has multiple parts, this variable returns the start time of the first part.
The session's information is only included if the learner has completed all of the course's prerequisites. If the learner has not completed all of the prerequisites, the following displays:
[Not Available]
Email Variables
email.allquizzesmustpass
The description of the All Graded Quizzes Must Pass online course setting. This variable is only available for the Course Completion to Home Group or Custom Contact email type.
The description will only display in the email if the All Graded Quizzes Must Pass online course setting is checked.
email.changes
The changes made to a user's login credentials (i.e., email, employee ID, name, and password). This variable is only available for the Login Credentials Changed email type.
email.chaptername
The name of a chapter in a course. This variable is only available for the Task Feedback email type.
email.confirmationurl
The link that allows a learner to confirm their session attendance. This variable is only available for the Confirm Attendance email type.
email.courseenrollmentlist
A table of the learner's course enrollments that includes their progress, course due date, and number of days before the course due date. This variable is only available for the Weekly Reminder to Learner email type.
email.coursenamelist
The list of courses that the learner was enrolled in. This variable is only used when a learner receives an email about multiple course enrollments. This variable is only available for the Course Enrollment email type.
email.editedby
The name of the person who modified the user’s login credentials. This variable is only available for the Login Credentials Changed email type.
email.emailinstructorsubject
Text indicating whether a user was added as an instructor to, or removed as an instructor from a session. This variable is only available for the Session Instructor Notification email type.
email.enrolleremail
The email address of the person who performed the enrollment. This variable is only available for the Course Enrollment email type.
email.enrollername
The full name of the person who performed the enrollment. This variable is only available for the Course Enrollment email type.
email.evaluationurl
The link to the course’s evaluation survey. This variable is only available for the Course Completion email type.
email.groupcount
The number of groups included in the Weekly Summary Report. This variable is only available for the Weekly Summary Report email type.
email.homegroupreportingmessage
This variable is only available for the Weekly Summary Report email type. Text explaining what metrics are included in the report. The text included with this variable will depend on the following account settings.
- Enable Home Group Reporting checked - Home group reporting is on, meaning that these metrics include all of your learners’ enrollments, regardless of the group they are in.
- Course Manager Access setting's Report on Enrollments option checked- Course manager reporting is on, meaning that these metrics include all enrollments for courses you manage.
- Supervisor Access setting's Report on Supervisees option checked - Supervisor reporting is on, meaning that these metrics include all enrollments for learners you supervise.
email.inviteremail
The email address of the person who sent the account invitation. This variable is only available for the Account Invitation email type.
email.invitername
The full name of the person who sent the account invitation. This variable is only available for the Account Invitation email type.
email.messagetype
The type of feedback (i.e., suggestion, feedback, bug). This variable is only available for the Task Feedback email type.
email.quizdetails
The details of a learner's completed quiz attempt (i.e., time limit, number of questions, percent to pass, max attempts, and number of correct questions per attempt). This variable is only available for the Task Completion email type.
email.quizquestiontext
A quiz's question. This variable is only available for the Task Feedback email type.
email.reportdashboardgrid
Tables that summarize last week's enrollments, the status of all enrollments, and status of learning plans and certifications for the group(s) included in the Weekly Summary Report. This variable is only available for the Weekly Summary Report email type.
email.resultmessage
Displays whether a learner passed or failed a course. Unlike the enrollment.passfail variable, this variable displays a sentence. For example, "John Smith has just completed and passed the Team Management course within the Fina Shoes Academy (Demo) account."
This variable is only available for the Course Completion to Home Group or Custom Contact email type.
email.reviewquizurl
The link to the learner's completed quiz attempt details. This variable is only available for the Quiz Graded email type.
email.senderemail
The email address of the user sending the email.
email.senderimage
The profile image of the user sending the email.
email.sendername
The full name of the user sending the email.
email.subjectresultmessage
Displays whether a learner completed a course. This variable is only available for the Course Completion to Home Group or Custom Contact email type.
email.troubleshootingguidetext
The link to a troubleshooting guide for webinar registration failures. This variable is only available for the Webinar Registration Failure Notification email type.
email.webinarfailures
The number of webinar registration failures. This variable is only available for the Webinar Registration Failure Notification email type.
Enrollment Variables
enrollment.completiondate
The date the learner completed the course. This variable is only available for the following email types:
enrollment.duedate
The course's due date.
enrollment.duration
The total amount of time the learner was in the course.
enrollment.grade
The learner's grade for the course.
enrollment.group
The name of the group in which the enrollment occurred.
enrollment.groupid
The ID of the group in which the enrollment occurred.
enrollment.grouplogo
The logo of the group in which the enrollment occurred.
enrollment.learnerenrolledcourselist
A list of the learner's course enrollments. This variable is only available for the Course Enrollment Notification to Supervisor email type.
enrollment.learnerenrolledsubscriptionlist
A list of the learner's subscription enrollments. This variable is only available for the Subscription Enrollment Notification to Supervisor email type.
enrollment.passfail
Displays Passed or Failed depending on whether the learner passed or failed the course.
enrollment.points
If points and rewards are enabled for your account, the total number of points that the learner earned for the course enrollment. If multiple point trackers are associated with the course, this number includes points for all point trackers.
enrollment.state
The learner's course enrollment status.
enrollment.startdate
The date the learner started the course.
enrollment.subscriptionvariantinfo
The subscription information associated with the course enrollment. This information includes the subscription name, variant name, start date, end date, and expiration.
enrollment.type
The course type (i.e., online, SCORM, instructor-led).
Group Variables
group.groupid
The group's identifier.
group.name
The group's name.
Learning Plan Variables
learningplan.fullstructure
The learning plan and the certifications, requirements, courses, and actions assigned to it. For example:
Learning Plan 01
- Certification 01
- Requirement 01
- Course 01
- Action 01
- Requirement 01
- Certification 02
- Requirement 02
- Course 02
- Action 02
- Requirement 02
learningplan.name
The learning plan's name.
learningplan.uptocertification
The learning plan and the certifications assigned to it. For example:
Learning Plan 01
- Certification 01
- Certification 02
learningplan.uptorequirement
The learning plan and the certifications, and requirements assigned to it. For example:
Learning Plan 01
- Certification 01
- Requirement 01
- Certification 02
- Requirement 02
Login Variables
login.url
The login portal URL.
login.password
The user's login password.
The password will only be sent out as plain text with the initial Account Invitation email. Resending the Account Invitation email to the user obscures the password (i.e., ***** displays). The user's password will also be obscured when this variable is included in other email templates.
login.userlogin
The user's login (email or employee ID).
Miscellaneous Variables
misc.completiondate
The date a course enrollment, subscription enrollment, or user import was completed. This variable is only available for the following email types:
misc.currentdatetime
The current date and time.
misc.headerlogo
The logo displayed in the header. The logo displayed will depend on the user's dashboard set.
misc.learnerdashboardcoursedetailsurl
The link to a course for a learner.
misc.message
The custom message for the email. A custom message may be specified for the following email types:
misc.numberrequested
The number of requested enrollments when enrolling learners to courses and subscriptions, or the number of requested imports when importing users. This variable is only available for the following email types:
misc.numbersuccessful
The number of successful enrollments when enrolling learners to courses and subscriptions, or the number of successful imports when importing users. This variable is only available for the following email types:
misc.numberunsuccessful
The number of unsuccessful enrollments when enrolling learners to courses and subscriptions, or the number of unsuccessful imports when importing users. This variable is only available for the following email types:
misc.requestdate
The date a course enrollment, subscription enrollment, or import was requested.
misc.requesterip
The requester's IP address for password recovery or login credential change requests.
misc.ziplocation
The link for downloadable course certificates, certification certificates, Enrollment Reports, and user import reports. This variable is only available for the following email types:
- Certification Completion to Custom Contact
- Certification Completion to Home Group Contact
- Course Completion to Group Contact
- Enrollment Automation Report
- Enrollment Process Complete
- Queued Exports Notification
- Requested Course Certificates
- User Import Completed
When the misc.ziplocation variable is included in the Course Completion to Group Contact email, the course certificate will only be available for download for 72 hours. If the learner's dashboard set includes a page that displays completed courses, the learner can also download the course certificate from the course details page.
Snippet Variables
snippet.contactcard
The user's contact card.
snippet.defaultfooter
The default footer that's displayed at the bottom of all emails:
This message was sent to *|user.email|* because you are a user of *|account.name|*. *|snippet.footerunsubscribemessage|* Delivered by *|login.loginurl|*.
snippet.defaultheader
The default header that's displayed at the top of all emails.
If the account's Enable Home Group Branding setting is not selected, the account's logo displays.
If the account's Enable Home Group Branding setting is selected, the group's logo displays. If the group does not have a logo, the account's logo displays.
snippet.footerunsubscribemessage
The default message for how to unsubscribe from emails.
Subscription Variables
subscription.duration
The subscription variant's duration.
subscription.enddate
The date the learner's subscription ends.
subscription.startdate
The date the learner's subscription begins.
subscription.subscriptiondescription
The subscription's description.
subscription.subscriptionname
The subscription's name.
subscription.variantname
The variant's name.
User Variables
user.email
The user's email address.
user.employeeid
The user's employee ID.
user.fullname
The user's full name.
user.givenname
The user's given name.
user.homegroup
The name of the user's home group.
user.homegroupid
The group ID of the user's home group.
user.homegrouplogo
The group logo of the user's home group.
user.surname
The user's surname.
Video Variables
video.filename
The video's filename.
video.information
The video's filename and location.
Was this article helpful?