Message Template Fields

This article lists the fields available for use in Absorb LMS Message Templates, describes the information each field provides, and identifies the Message Templates in which each field is available. For instructions on editing a Message Template and adding fields to it, see the Message Templates guide.

 

How Message Template Fields Work

Fields are data variables that you add to a Message Template to personalize the communications the LMS sends. When a Message is generated, each field pulls in specific information about the recipient User and their activity in the LMS, such as their name, an enrolled Course, or a transaction detail.

You add fields from the expandable Fields list at the bottom of the Body editor in the Edit Message Template menu. Click and drag a field into the Subject line or Body where you want the value to appear, and remove any fields that are not relevant to your organization. For full editing instructions, see the Message Templates guide.

 

Add-On Features

Some fields relate to features that are available as a separate purchase, such as Absorb Create. These fields only populate when the associated feature is in use in your Portal.

 

Available Message Template Fields

The table below lists each available field, the information it provides, and the Message Templates in which it can be used. In the Message Templates column, Only In: indicates that the field is available only in the listed Message Templates, while Not In the Following: indicates that the field is available in all Message Templates except those listed.

Field Description Message Templates
Absorb Create Shared Link

The link to an eLearning course that is created in the Absorb Create authoring tool.

Note: This is related to the Absorb Create content authoring tool available for purchase.

Only In:

  • Absorb Create Shared Link
Admin LMS Link A URL that directs to the Login page of the Admin Interface so that the recipient Admin can log in directly.

Not In the Following:

  • Absorb Create Shared Link
  • Approval Request
  • Course Comment Reply
  • Course Upload Approved/Declined
  • Enrollment Key
  • External Training Approved/Declined
  • Import Online Course Failure
  • Import Online Course Success
  • Infuse License Expiry Reminder
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Reviewer User Type Enabled
  • Session Approval Request
  • User Import Error
Admin Task Report Link A deep link that directs to the Tasks Report in the Admin Interface, automatically applying filters for the associated Course, Learner Username, and Task referenced in the notification.

Only In:

  • Task Notification
Approver First Name The recipient Approver's First Name as defined in Edit User > General > First Name.

Only In:

  • External Training Approval Request
Approver Last Name The recipient Approver's Last Name as defined in Edit User > General > Last Name.

Only In:

  • External Training Approval Request
Approval Link A URL that allows the Approver to approve the Learner's associated enrollment request.

Only In:

  • Approval Request
  • Session Approval Request
Billing Address The value populated in the Billing Address field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing City The value populated in the Billing City field of the billing information on a purchase made in the LMS.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing Country The value populated in the Billing Country field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing First Name The value populated in the Billing First Name field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing Last Name The value populated in the Billing Last Name field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing Postal Code The value populated in the Billing Postal Code field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Billing Province/State The value populated in the Billing Province/State field of the billing information on a purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Cadence The value populated in the Cadence field of the Mandatory Course Digest Email template.

Only In:

  • Mandatory Course Digest Email
Certificate Expiry The calendar date and time of the Certificate's expiration, as defined in Edit Course > Completion > Certificate.

Only In:

  • Certificate Expiry
  • Curriculum Completed
  • Instructor-Led Course Completed
  • Online Course Completed
  • Session Reminder
Classes The calendar date, time, and Venue of the Instructor-Led Course Session.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Reminder
  • Session Updated
Company Email The email address for the Portal as defined in Portal Settings > Info > Email Address.

Not In the Following:

  • Contest Qualification
  • Course Comment Reply
  • Infuse License Expiry Reminder
  • User Import Error
Company Name The company name for the Portal as defined in Portal Settings > Info > Company Name.

Not In the Following:

  • User Import Error
  • Course Comment Reply
  • Export Data
  • Infuse License Expiry Reminder
Company Phone The phone number for the Portal as defined in Portal Settings > Info > Phone.

Not In the Following:

  • Absorb Create Shared Link
  • Course Upload Approval Request
  • External Training Approval Request
  • Import Online Course Failure
  • Import Online Course Success
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • Course Comment Reply
  • Export Data
  • Infuse License Expiry Reminder
Competencies The name of the Competencies earned upon the completion of training, as defined in Edit Course > Completion > Competencies.

Only In:

  • Course Upload Approval Request
Conversation Link A URL that will direct the Learner to the conversation another Learner has started.

Only In:

  • New Learner Conversation Message
Course URL Displays the direct link to the Course, making it easier for Learners to find the Course associated with the email.

Only In:

  • Online Course Enrollment
  • Instructor-Led Course Enrollment
  • Session Enrollment
  • Course Bundle Enrollment
  • Curriculum Enrollment
  • Course Due Date
  • Course Nudge
  • Session Reminder
  • Session Updated
  • Session Full
Country Tax The value populated in the Tax Rate field of the User's Country, as defined in Portal Settings > eCommerce Settings > Tax Rates.

Only In:

  • Receipt
  • Receipt with Subscriptions
Course Comment The new Learner comment that was submitted to a specific Course. This feature can be enabled in Edit Course > Social > Allow Comments.

Only In:

  • Course Comment Reply
Course Comment Link A URL that will direct the User to the full comment history on the defined Course. This feature can be enabled in Edit Course > Social > Allow Comments.

Only In:

  • Course Comment Reply
Course ID The Online Course ID created automatically by the LMS when the defined Online Course was created. This is a unique identifier for the Online Course.

Only In:

  • Course Upload Approved/Declined
  • Instructor-Led Course Enrollment
  • Instructor Notification
  • Online Course Enrollment
Course Name The name of the Online Course, as defined in Edit Course > General > Title.

Only In:

  • Approval Denied
  • Approval Pending
  • Approval Request
  • Certificate Expiry
  • Contest Qualification
  • Course Bundle Enrollment
  • Course Comment Reply
  • Course Due Date
  • Course Nudge
  • Course Upload Approval Request
  • Course Upload Approved/Declined
  • Curriculum Completed
  • Curriculum Enrolled
  • Import Online Course Success
  • Instructor-Led Course Enrollment
  • Instructor-Led Course Failed
  • Instructor Notification
  • Online Course Completed
  • Online Course Enrollment
  • Online Course Failed
  • User Import Error
  • Waitlist
Course Upload Name The name of the Course Upload as defined in Edit Course > Course Uploads > Label.

Only In:

  • Course Upload Approval Request
  • Course Upload Approved/Declined
Course Reply Comment A new reply by a Learner to the Course Comments posted to the defined Course.

Only In:

  • Course Comment Reply
Courses

The name of the Courses included in the defined Course Bundle.

or

The name of the Courses that can be used with an Enrollment Key.

Only In:

  • Course Bundle Enrollment
  • Enrollment Key
  • New User
Creator First Name

The first name of the content creator as defined in Edit User > General > First Name.

Note: This is related to the Absorb Create content authoring tool available for purchase.

Only In:

  • Absorb Create Shared Link
Creator Last Name

The last name of the content creator as defined in Edit User > General > Last Name.

Note: This is related to the Absorb Create content authoring tool available for purchase.

Only In:

  • Absorb Create Shared Link
Currency The type of currency used in the related transaction as defined in Portal Settings > Manage E-Commerce Settings > Settings > Default Currency.

Only In:

  • Receipt
Curriculum ID The Curriculum ID created automatically by the LMS when the defined Curriculum was created. This is a unique identifier for the Curriculum.

Only In:

  • Curriculum Completed
  • Curriculum Enrolled
Date The date and time the Message was triggered and sent.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Course Upload Approval Request
  • Export Data
  • External Training Approval Request
  • Import Online Course Failure
  • Infuse License Expiry Reminder
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • New User Activation
  • Online Course Completed
  • Receipt Error
  • Reviewer User Type Enabled
  • Scheduled Report
  • Session Approval Pending
  • Session Approval Request
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
  • Task Notification
  • User Import Error
Date Completed The calendar date and time that the Learner completed all requirements within the training.

Only In:

  • Curriculum Completed
  • Online Course Completed
Deny Link A URL that allows the recipient Admin to deny the defined Learner's enrollment request.

Only In:

  • Approval Request
  • Session Approval Request
Department The recipient User's Department as defined in Edit User > General > Department.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Import Online Course Failure
  • Import Online Course Success
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Reviewer User Type Enabled
  • Scheduled Report
Department Image The value set for the Message Template image that is displayed for the recipient's Department. If no value is set for the recipient's Department, the Parent Department is used. This check is done through the hierarchy, up to and including the root Department.

Not In the Following:

  • Course Comment Reply
Digest Time Frame The time frame in which Mandatory Course due dates occur. Any Mandatory Courses with due dates within this time frame are included.

Only In:

  • Mandatory Course Digest Email
Digest Send Date The date that the Mandatory Course Digest is sent on.

Only In:

  • Mandatory Course Digest Email
Discount The discounted dollar amount on a transaction made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Due Date The date that Course completion is due for a Learner as defined in Edit Course > Availability > Due Date.

Only In:

  • Course Nudge
  • Curriculum Enrolled
  • Online Course Enrollment
Edit Online Course Link A URL directing the recipient Admin to the edit Course menu for the defined Course.

Only In:

  • Import Online Course Success
Enrolled Date The calendar date and time that the Learner enrolled or was enrolled into the defined training.

Only In:

  • Course Bundle Enrollment
  • Curriculum Enrolled
Exam Attempts The total number of Assessment attempts for the defined Learner in the defined Online Course.

Only In:

  • Online Course Completed
Exam Score The score obtained by the defined Learner in the defined Online Course Assessment.

Only In:

  • Online Course Completed
Expiry Date The date that the Learner will no longer have access to the defined training. It must be completed before this date. The Expiry Date is defined in Edit Course > Availability > Expiration.

Only In:

  • Course Bundle Enrollment
  • Course Nudge
  • Curriculum Completed
  • Curriculum Enrolled
  • Instructor-Led Course Enrollment
  • Online Course Completed
  • Online Course Enrollment
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
  • Waitlist
File Path The File Path within the File Manager for the defined CSV file uploaded using the User Import feature.

Only In:

  • User Import Error
  • Import Online Course Failure
First Name The recipient User's First Name as defined in Edit User > General > First Name.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Enrollment Key
  • External Training Approval Request
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • Scheduled Report
Google Calendar Links

A link to create a calendar event in the recipient's Google Calendar.

This feature can be enabled by a System Admin in Portal Settings > Info > Enable Google Calendar Session Emails.

Only In:

  • Session Enrollment
  • Session Reminder
  • Session Updated
Instructors The First Name and Last Name of the Instructor(s) assigned to the ILC Session as defined in Edit User > General > First Name and Last Name.

Only In:

  • Instructor Notification
  • Session Enrollment
  • Session Updated
Job Title The recipient User's Job Title as defined in Edit User > Employment Details > Job Title.

Not In the Following:

  • Approval Request
  • Enrollment Key
  • Import Online Course Success
  • Absorb Create Shared Link
  • Course Comment Reply
  • Course Upload Approval Request
  • Export Data
  • External Training Approval Request
  • Import Online Course Failure
  • Infuse License Expiry Reminder
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Scheduled Report
  • Session Approval Request
  • User Import Error
Key Name The name of the Enrollment Key as defined in Edit Enrollment Key > General > Name.

Only In:

  • Enrollment Key
  • Receipt
Last Name The recipient User's Last Name as defined in Edit User > General > Last Name.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Enrollment Key
  • External Training Approval Request
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • Scheduled Report
Learner Department The associated Learner's Department as defined in Edit User > General > Department.

Only In:

  • Approval Request
  • Session Approval Request
Learner Email Address The associated Learner's Email Address as defined in Edit User > General > Email Address.

Only In:

  • Approval Request
  • External Training Approval Request
  • Session Approval Request
Learner First Name The associated Learner's First Name as defined in Edit User > General > First Name.

Only In:

  • Approval Request
  • Course Upload Approval Request
  • External Training Approval Request
  • Session Approval Request
Learner Last Name The associated Learner's Last Name as defined in Edit User > General > Last Name.

Only In:

  • Approval Request
  • Course Upload Approval Request
  • External Training Approval Request
  • Session Approval Request
Learner Middle Name The associated Learner's Middle Name as defined in Edit User > General > Middle Name.

Only In:

  • Approval Request
  • Session Approval Request
Learner Phone Number The associated Learner's Phone Number as defined in Edit User > Contact Information > Phone.

Only In:

  • Approval Request
  • Session Approval Request
Learner Username The associated Learner's Username as defined in Edit User > General > Username.

Only In:

  • Approval Request
  • External Training Approval Request
  • Session Approval Request
  • Task Notification
Link A URL that will direct the Learner to the Course they just purchased using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
List of Purchased Courses The names of the trainings that the Learner purchased using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
LMS Link

A URL which directs the User to the Learner Dashboard Login page.

For most Message Templates, if you use Department specific URLs/Routes, this link will populate with the URL associated with the User's Department.

The Send Enrollment Key Instructions Message Template will use the same LMS Link that the Admin has logged in with to send the message.

Not In the Following:

  • Approval Request
  • Enrollment Key
  • Import Online Course Success
  • Absorb Create Shared Link
  • Course Comment Reply
  • Course Upload Approval Request
  • External Training Approval Request
  • Import Online Course Failure
  • Infuse License Expiry Reminder
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • Scheduled Report
  • Session Approval Request
  • User Import Error
LMS Name The name of the LMS Portal as defined in Portal Settings > Info > LMS Name.

Not In the Following:

  • Absorb Create Shared Link
  • Course Upload Approval Request
  • External Training Approval Request
  • Import Online Course Failure
  • Import Online Course Success
  • Infuse License Expiry Reminder
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • Receipt Error
  • Reviewer User Type Enabled
  • Scheduled Report
  • Session Approval Pending
  • Session Approval Request
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
  • Task Notification
  • User Import Error
Mandatory Courses List The list of Mandatory Courses associated with a specific User, Group, or Department.

Only In:

  • Mandatory Course Digest Email
Meeting URL The URL of the associated ILC Session's virtual Venue, as defined in Edit Venue > URL.

Only In:

  • Instructor Notification
  • Session Enrollment
  • Session Reminder
  • Session Updated
Middle Name The recipient User's Middle Name as defined in Edit User > General > Middle Name.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Course Upload Approval Request
  • Enrollment Key
  • External Training Approval Request
  • Import Online Course Failure
  • Import Online Course Success
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Scheduled Report
Payment Type The type of payment used to complete the associated transaction made using the E-Commerce feature.

Only In:

  • Receipt
  • Receipt with Subscriptions
Phone The recipient User's phone number as defined in Edit User > Contact Information > Phone.

Not In the Following:

  • Absorb Create Shared Link
  • Course Comment Reply
  • Course Upload Approval Request
  • Enrollment Key
  • External Training Approval Request
  • Import Online Course Failure
  • Import Online Course Success
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Scheduled Report
Proctor Code

The code the recipient Proctor must input to approve a Learner to take the associated Assessment.

This feature is enabled in Edit Course > Syllabus > Proctor.

Only In:

  • Task Notification
Province Tax The tax defined for the Learner's Province/State. Taxes are defined in Portal Settings > Manage E-Commerce Settings > Tax Rates.

Only In:

  • Receipt
  • Receipt with Subscriptions
Remaining Seats The total remaining uses available for the associated Enrollment Key as defined in Edit Enrollment Key > General > Number of Uses.

Only In:

  • Enrollment Key
Reviewer Link A URL that directs the recipient Reviewer to their LMS login page.

Only In:

  • Reviewer User Type Enabled
Reset Password Link A URL that directs the recipient User to a page where they can reset their password.

Only In:

  • New User
  • New User Activation
  • Password Reset
Sender First Name The first name of the Learner who has sent a message using the Conversations feature. Their first name is defined in Edit User > General > First Name.

Only In:

  • New Learner Conversation Message
Sender Last Name The last name of the Learner who has sent a message using the Conversations feature. Their last name is defined in Edit User > General > Last Name.

Only In:

  • New Learner Conversation Message
Session Address The address of the associated ILC Session's Venue, as defined in Edit Venue > Address.

Only In:

  • Session Approval Request
  • Session Reminder
Session Description The description of the associated ILC Session as defined in Edit Session > Details > Description.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Reminder
  • Session Updated
Session End Date The end date and time of the associated ILC Session as defined in Edit Session > Details > Class End Date and Time.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Reminder
  • Session Updated
Session Link A URL which redirects to the specific Session in the Learner Experience.

Only In:

  • Session Approval Pending
  • Session Approval Request
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
Session Location The name of the associated ILC Session's Venue, as defined in Edit Venue > Name.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
  • Waitlist
Session Name The name of the associated ILC Session as defined in Edit Session > Details > Title.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Reminder
  • Session Updated
Session Start Date

The start date and time of the associated ILC Session as defined in Edit Session > Details > Class Start Date and Time.

Note: The format for this date will reflect the selection made for Exported Report Date Format, found under Portal Settings > Defaults.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Full
  • Session Reminder
  • Session Updated
  • Waitlist
Session Time This field displays the value populated in the Time field of the ILC Session.

Only In:

  • Instructor Notification
  • Session Approval Request
  • Session Enrollment
  • Session Reminder
  • Session Updated
Start Date This field displays the calendar date and time that the User was enrolled in the training.

Only In:

  • Course Nudge
  • Instructor-Led Course Enrollment
  • Online Course Enrollment
Submission Title The Course Name entered into the associated External Training Form submitted by a Learner.

Only In:

  • External Training Approval Request
  • External Training Approved/Declined
Subtotal The subtotal amount on a transaction made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Task The name of the Task the associated Learner has confirmed as ready to complete.

Only In:

  • Task Notification
Tax for Country The tax defined for the associated Learner's country. Taxes are defined in Portal Settings > Manage E-Commerce Settings > Tax Rates.

Only In:

  • Receipt
  • Receipt with Subscriptions
Tax for Province The tax defined for the associated Learner's Province/State. Taxes are defined in Portal Settings > Manage E-Commerce Settings > Tax Rates.

Only In:

  • Receipt
  • Receipt with Subscriptions
Template Name The name of the associated External Training Template as defined in Portal Settings > Manage External Training Templates > Edit External Training Template > General > Name.

Only In:

  • External Training Approval Request
  • External Training Approved/Declined
Total Amount The total cost of the associated purchase made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Total Seats The total number of uses for the associated Enrollment Key as defined in Edit Enrollment Key > General > Number of Uses.

Only In:

  • Enrollment Key
Transaction Date The date and time of completion for the associated transaction made using E-Commerce.

Only In:

  • Receipt
  • Receipt with Subscriptions
Transaction Id The automatically generated Transaction ID of the associated purchase made using E-Commerce. This is the unique identifier for the transaction.

Only In:

  • Receipt
  • Receipt with Subscriptions
Unfollow Course Comment Link A URL which will direct the Learner to a page where they can stop all post and reply notifications from the associated Course Comment.

Only In:

  • Course Comment Reply
Used Seats The total number of seats used for the associated Enrollment Key.

Only In:

  • Enrollment Key
User Import Job Id The automatic Import Job created when an Admin performs a User Import in the LMS. This is the unique identifier for that specific import.

Only In:

  • User Import Error
User Import Reference Number The automatic Import Reference Number created when an Admin performs a User Import in the LMS. This is also a unique identifier for that specific import.

Only In:

  • User Import Error
Username The recipient User's Username as defined in Edit User > General > Username.

Not In the Following:

  • Absorb Create Shared Link
  • Approval Request
  • Course Comment Reply
  • Enrollment Key
  • External Training Approval Request
  • Import Online Course Failure
  • Import Online Course Success
  • Learner API Call Limit Exceeded
  • Learner API Call Limit Reached
  • New Learner Conversation Message
  • Scheduled Report
  • Session Approval Request

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.