Email Template Merge Field Glossary & Quick Links
Email Template Merge Field Glossary & Quick Links
Related Helpguide Pages
Learn how to add a Merge Field into your Email Templates
Email Template 'Merge Fields' are information placeholders that you can add into your Email Template that are replaced with specific data when the emails are generated. These fields allow you to personalise and customise emails by inserting relevant information from your Platform; including Delegates names, Email Addresses, Course Information, and any other relevant data
Follow this page to learn more about Email Template Merge Fields, Nested Fields, and Date Formatting within Email Templates.
How to add Merge Fields within your Email Templates
This step will show you where to find Email Template Merge Fields and how to add a Merge Field into your Email Template
How to add a Merge Field to a Email Template
Whether your updating and Email Template or creating an Email Template, you can use the same steps below to add a Merge Field to an Email Template
Once you have found the Email Template you want to add the Merge Field to, in the ‘Body' section of the Email Template, click the 'Field’ button to view the list of available Merge Fields for your selected Module
Click on the required Merge Field Label from the drop-down menu, and this will insert the Merge Field for you. Alternatively, you can add them manually using the examples provided below in the ‘Merge Field Glossary’
Merge Fields can be added to the ‘Subject’ of your email too, this helps to personalise the email and flag it for your recipient's attention
Merge Field Glossary
Here you will find the most commonly used Merge Fields within each Module for Email Templates
Course Merge Fields
Here are a list of commonly used Course Merge Fields for Email Templates
This module is used for communicating Course Information such as Course Statistics / Profitability, Courses that have been cancelled, Courses that have completed etc.
@@CourseName | @@Status | @@FillRate (%) |
---|---|---|
@@CourseID | @@Places | @@ViabilityForecast |
@@StartEndDateString | @@CandidatesBooked | @@ResourcesUnallocated |
@@TrainerNames | @@Venue | @@OverrideAlias |
Booking Merge Fields
Here is a list of commonly used Booking Merge Fields for Email Templates
The Booking module is commonly used for communicating Booking Information to Customers, such as Booking Confirmations
@@BookingUserName | @@BookingSummary |
---|---|
@@TotalCost | @@DateCreated |
@@CancelBookingUrl |
|
Invoice Merge Fields
Here is a list of commonly used Invoice Merge Fields for Email Templates
This module is commonly used for communicating Invoice Information such as informing Users that their Invoice has been Generated, their Invoice is Overdue or their Invoice has been Fully Paid etc
@@TargetUserFullName | @@Reference |
---|---|
@@TargetCompanyName | @@AmountPaid |
@@PONumber | @@Outstanding |
@@InvoiceAddress | @@Tax |
Password Reset Request Merge Fields
Here is a list of commonly used Password Reset Merge Fields for Email Templates
This module is commonly used for sending out password reset links when requested by Users
@@Forename | @@Surname |
---|---|
@@UserID | @@MinutesLinkActive |
@@DatePasswordResetRequested | @@UserEmail Address |
Placeholder Merge Fields
Here is a list of commonly used Password Reset Merge Fields for Email Templates
This module is commonly used for communicating Placeholder Information such as Cancelled Placeholders, Placeholders with unassigned Places etc
@@CourseID | @@CourseDateStartDate |
---|---|
@@CourseName | @@CourseDateEndDate |
@@Quantity |
|
User Award Merge Fields
Here is a list of commonly used User Award Merge Fields for Email Templates
This module is commonly used for communicating User Award Information, such as your Award is due to Expire, your Target Date is approaching etc.
@@UserFullname | @@AwardLabel |
---|---|
@@Expires | @@DateCompleted |
Delegate Merge Fields
Here is a list of commonly used Delegate Merge Fields for Email Templates
This module is commonly used for communicating Delegate and Trainer Information for all types of Courses such as Delegate Confirmations, Delegate Certification or Delegate Cancellations etc
@@CandidateForename | @@CandidateSurname |
---|---|
@@CourseName | @@CourseDateStartDate |
@@CourseDateEndDate | @@CourseJoiningInstructions |
@@VenueName | @@Status |
Class Delegate Merge Fields
Here is a list of commonly used Class Delegate Merge Fields for Email Templates
This module is commonly used for communicating Delegate & Trainer Information for Classroom Courses only such as Joining Instructions, Course Date Reminders etc
@@CandidateForename | @@CandidateSurname |
---|---|
@@CourseName | @@CourseDateStartDate |
@@CourseDateEndDate | @@VenueLabel |
@@VenueFullAddress | @@VenueMapUrl |
@@CourseJoiningInstructions | @@CourseOverview |
Web Delegate Merge Fields
Here is a list of commonly used Web Delegate Merge Fields for Email Templates
This module is commonly used for communicating Delegate & Trainer Information for Webinar Courses only such as Joining Instructions, Course Date Reminders etc
@@CandidateForename | @@CandidateSurname |
---|---|
@@CourseName | @@CourseDateStartDate |
@@CourseDateEndDate | @@JoiningInstructionsText |
eLearning Delegate Merge Fields
Here is a list of commonly used eLearning Delegate Merge Fields for Email Templates
This module is commonly used for communicating Delegate Information for eLearning Courses only such as how to access your eLearning etc
@@CandidateForename | @@CandidateSurname |
---|---|
@@CourseName | @@CandidateDirectELearningUrl |
@@JoiningInstructionsText | @@CourseOverview |
Knowledge Delegate Merge Fields
Here is a list of commonly used Knowledge Document Delegate Merge Fields for Email Templates
This module is commonly used for communicating Delegate Information for Document Courses only such as how to access your document etc
@@CandidateForename | @@CandidateSurname |
---|---|
@@CourseName | @@JoiningInstructionsText |
@@DocumentsUrl | @@CourseOverview |
Opportunity Merge Fields
Here is a list of commonly used Opportunity Merge Fields for Email Templates
This module is commonly used for communication for Opportunities such as the Opportunity is due to close, a new Opportunity has been raised etc.
@@CloseDate{ddd dd MMM yyyy} | @@SalesStageName |
---|---|
@@ExpectedRevenue | @@Probability |
@@LinkedToCompanyName | @@LinkedToUserEmails |
@@Competitors | @@LinkedToUserForenames |
@@LinkedToUserSurnames | @@LastContacted |
Product & Services Merge Fields
Here is a list of commonly used Product & Services Merge Fields for Email Templates
This module is commonly used to communicate information about Product & Service stock levels etc.
@@Label | @@StockLevel |
---|---|
@@Description | @@CostPerUnit |
Nested Merge Fields
This step will show you how to create a Nested Merge Field for your Email Templates
What is a Nested Merge Field?
This step will explain what a Nested Merge Field is and how Nested Merge Fields can be used
A nested merge field is a type of merge field that allows you to include data from related or neighboring modules within a Email Template. Unlike standard merge fields, which pull data from a single module, Nested Merge Fields enable you to incorporate information from other connected modules.
For example, if you have information in the CourseDate (Course) module that you would like to include in an Email Template that uses the UserCourseDate (Delegate) module, you can use Nested Fields to acheive this. This capability enhances the flexibility and comprehensiveness of the data you can present in your communications.
Nested Merge Field Modules available |
---|
Displaying CourseDate fields in UserCourseDate templates. |
Displaying User fields in UserAward templates |
Displaying CourseTemplate fields in CourseDate templates |
Nested Merge Field Examples
Here are some Nested Field Examples
The required format for a Nested Merge Field is as follows: @@ModuleName.FieldName
Nested Field Example | Reason |
---|---|
@@CourseDate.Advertise | For example, you want to know if the Course is advertised or not at the Course Date level |
@@CourseDate.ExternalID | For example, to include the Course’s (not Course Template’s) External ID in a UserCourseDate Email Template |
@@User.EmailAddress | For example, you want the Users Email Address |
@@CourseTemplate.Overview | For example, you want the Overview from the Course Template |
@@CourseTemplate.JoiningInstructionsText | For example, you want the Joining Instructions from the Course Template |
@@CourseDate.CF_Course_Contact | For example, if you have a Custom Field you would like to pull through from the Course Date |
Date Formatting
You can define the format of date and time fields within your communications. The standard format is dd/MM/yyyy hh:mm:ss, however with a little bit of extra text at the end of your Merge Field, you can change this to suit your needs
Date & Cost Formatting Examples
Please Note
If your Business/Organisation operates in a different date format, please ensure the date formatting matches your Platform
When adding text to an Email Template, make sure to note any places where a colon separates 2 pieces of text, without any spaces, for example - “example1:example2”. This includes any Merge Field formatting you use, for example - @@CourseStartDate{dd/MM/yy HH:mm:ss}
This will attempt to create a hyperlink, but the link won’t go anywhere, and may cause some users confusion.
This can be easily removed by clicking back into the text and clicking the “Unlink” button, or by separating the words from the colon with a space.
Add the Merge Field in as you would normally, then suffix it with your required format within curly brackets, for example:
@@StartDate{dd/MM/yyyy} |
---|
@@StartTime{hh:mm tt} |
@@CourseDateStartDate{dd MMM yyyy} |
@@CourseDateStartDate{ddd dd MMM yyyy} |
Date Formats available
Here is a quick table to explain the formatting options available:
d | Displays the day as a number without a leading zero i.e. 9 |
---|---|
dd | Displays the day as a number with a leading zero i.e. 09 |
ddd | Displays the abbreviation of the day i.e. Tues |
dddd | Displays the full name of the day i.e. Tuesday |
M | Displays the month as a number without a leading zero i.e. 4 |
MM | Displays the month as a number with a leading zero i.e. 04 |
MMM | Displays the abbreviation of the month i.e. Jan |
MMMM | Displays the full name of the month i.e. January |
yy | Displays the year as a two-digit number i.e. 18 |
yyyy | Displays the year as a four-digit number i.e. 2018 |
h | Displays the hour (1 to 12) without a leading zero i.e. 3 |
hh | Displays the hour (1 to 12) with a leading zero i.e 03 |
HH | Displays the hour (0 to 23) i.e. 15 |
m | Displays the minute without a leading zero i.e. 5 |
mm | Displays the minute with a leading zero i.e. 05 |
s | Displays the second without a leading zero i.e. 7 |
ss | Displays the second with a leading zero i.e. 07 |
tt | Adds AM or PM |
Use capital M for month and lowercase m for minute.
Use capital H for 24 hour format, use lowercase h for 12 hour format. For example:
@@CourseDateStartDate{ddd MMM dd yyyy hh:mm tt}
= Mon Jul 3 2024 04:30 PM
@@CourseDateStartDate{ddd MMM dd yyyy HH:mm tt}
= Mon Jul 3 2024 16:30 PM
Please Note
It is not possible to use a comma character within the format string. In order to get a format such as July 4, 2024, you would need to build the date using two separate merge fields separated by a comma. Like this:
myDate{"format":"MMMM dd"}, myDate{"format":"yyyy"}
Cost Formats Available
Please Note!
By adding the formatting, this ensures that the total amount shows as £0.00 and not the standard £0.0 within your Email Templates
Add the Merge Field in as you would normally, then suffix it with your required format within curly brackets, for example:
@@Outstanding{£0.00}
@@Total{£0.00}
@@Amount{£0.00}
£0.00 | For British pounds |
€0.00 | For Euros (hold ALT+ type 0128) |
$0.00 | For Dollars |
Quick Links
Quick Links allows you to attach links to documents stored within a Course's Course Template, such as Certificates, Course Surveys, and Evaluations within your Email Template
Whether your updating and Email Template or creating and Email Template, you can use the same steps below to add a Merge Field to an Email Template
Within the ‘Body’ of the Email Template, click the ‘Quick Link’ button and select which Quick Link you would like to use
Please note the options will vary depending on which module is selected
This will insert the relevant link into your Email Template
IMPORTANT: When setting up iCal links, make sure that the Training Provider of the course, has an email address.
For this functionality to work, it needs to be able to determine who the event organiser is, and differentiate them from other attendees. You can double check this by going to 'Accounts' finding the provider of the Course/event in question, right-click editing the record, going to details, and checking 'Email Address' is populated.
If iCal links are also in use for the first time, please check with our Support team if all required platform configuration settings are also enabled.
iCal links can be added to email templates under the following modules: Class Course Date, User Course Date Class, User Course Date Web, Web Course Date. However, please note that the iCal format currently cannot be change. (See example)
Contact Our Team
If you can't find what you're looking for, access our Support Portal, and our team of experts will be happy to help!
Is it your first time contacting the team? Learn how to raise a support ticket.
Follow Us
Copyright © 2024 accessplanit.
Social media icons by icons8.com