Administration - Email: Templates - Email Syntax
Email Syntax Overview
Email syntax allows you to dynamically include details about the recipient, sender or an attached entity in the email you are sending in XPLAN. Using syntax’s, you can produce custom emails from templates that contain client and user data, making each email personalized to each individual without the need to edit each email. When a report is generated, the Xmerge syntax is used to identify and insert data.
Email syntax can be used when sending an email or creating an email template.
Inserting email syntax
Syntax can be manually entered into the body of an email, or by using the X button in the email editor.
Once within the Syntax editor, you will have 3 main options to help find the particular field you would like to have dynamically entered.
-
From/To – XPLAN’s email syntax allows you to prepopulate values with either the recipient name or the email sender’s name.
-
Categories – similar fields are grouped into categories in XPLAN to assist with searching. In this drop down menu, you can choose from a list of groups that provide a way to limit the results that flow through to the ‘Properties’ dropdown menu.
-
Properties – the ‘Properties’ dropdown menu is where you can select the field you want to have dynamically entered into the email you are sending in XPLAN.
Manually Insert Email Syntax
While composing an email or email template, type the syntax in the body of the email. Depending on which entity you want to merge details about, the following syntax is used:
-
Recipient - $recipient
-
Sender - $sender
-
Attached entity - $attached_client
- An entity (client, supplier, professional adviser or referrer) must be attached to the email before using this syntax.
Within the syntax editor, you have different options to insert the desired output:
- In the ‘From/To’ list, select the entity who you want to insert details about. You can select the recipient, the attached client or the sender.
- In the ‘Categories’ list, select the category of detail you want to insert.
- In the ‘Properties’ list, select the specific detail you want to insert.
Testing the Syntax
Before you send an email, you can click ‘Preview’ to see a preview of the email, including the merged details from the email syntax.
When creating or editing an email template, you can click ‘Syntax Check’ to view an example email output using the email syntax. When you do a Syntax Check you keep a lookout for the word “Error” as this indicates that the syntax coding has a problem.
This can be used as a way of checking that the coding will work.
- Click on the Syntax Check button and a pop up screen will appear. Ensure there are no coding errors. Not will be notified of coding errors in the template with the wording: Content Error.
- Close the pop up screen.
Email Syntax Examples
Below are different types of Email coding syntax examples that you may want to use when creating a template.
Date and Time
<:=datetime_merge:> e.g. 05 June 2013 01:24:23 PM
<:=datetime_merge.date:> e.g. 05 June 2013
<:=datetime_merge.time:> (12 hour time) e.g. 02:24:21 PM
<:=datetime_merge.time24:> (24 hour time) e.g. 15:24:24
Recipient Contact Details
Home Phone
<:for item in $recipient.contact:>
<:if str(item.type)=='Home Phone':>
<:=item.value:>
<:end:>
<:end:>
Work Phone
<:for item in $recipient.contact:>
<:if str(item.type)=='Work Phone':>
<:=item.value:>
<:end:>
<:end:>
Postal Address
<:for item in $recipient.address:>
<:if str(item.type)=='Postal':>
<:=item.street:>
<:=item.suburb:> <:=item.state:> <:=item.postcode:>
<:end:>
<:end:>
Preferred Email
<:=$recipient.preferred_email:>
Residential Address
<:for item in $recipient.address:>
<:if str(item.type)=='Residential':>
<:=item.street:>
<:=item.suburb:> <:=item.state:> <:=item.postcode:>
<:end:>
<:end:>
Recipient and partner name
<:=$recipient.preferred_name:>
<:if $recipient.has_partner:> and <:=$recipient.partner.preferred_name:>
<:end:>
Recipient and partner, superfund, company or trust name
<:let has = False:><:if $recipent.first_name:><:=$recipient.first_name:>
<:if $recipient.has_partner:> and <:=$recipient.partner.preferred_name:><:let has = True:>
<:end:>
<:end:>
<:if not has:><:=$recipient.superfund_name:><:=$recipient.company_name:>
<:=$recipient.trust_name:>
<:end:>
Attached client's opt-in status
<:=$attached_client.opt_in_status:>
Sender details
<:=$sender.first_name:> <:=$sender.last_name:> <:=$sender.jobtitle:>
<:=$sender.employer:>
Adviser details
Advisers name
<:=$recipient.adviser.first_name:> <:=$recipient.adviser.last_name:>
Employer
<:=$recipient.adviser.employer:>
Job Title
<:=$recipient.adviser.jobtitle:>
Contact Email
<:=$recipient.adviser.preferred_email:>
Contact Work Phone
<:for item in $recipient.adviser.contact:> <:if item.type=='Work Phone':><:=item.value:
<:end:>
<:end:>
Contact Mobile Phone
<:for item in $recipient.adviser.contact:><:if item.type=='Mobile Phone':><:=item.value:>
<:end:>
<:end:>
Related Articles
Administration - Email: Templates
Email Templates Overview You can use XPLAN to send one email to one client or multiple template emails to a variety of clients. You will gain more efficiency in your work if you use templates and code within those templates. This introduction will ...Downloading - Email Templates
Email Templates 1. Click on XPLAN button 2. Go to Administration Functions > Templates. Ensuring your filter is set to All. Download all the email templates. If you cannot access the email templates section, send your dummy client all the ...Templates - Merge Templates
Merge Templates Overview The purpose of this guide is to provide instructions on Creating Merge Templates in XPLAN. To view the IRESS Insights Video, please view the following link here. (Created by Anthony Derriscott on Feb 21, 2018) XPLAN can ...Administration - Email
Email Overview The purpose of this guide is to providing instructions on using the Email to XPLAN functionality to save emails directly to XPLAN. There are several different options available for storing email communications with your clients in ...XPLAN Workshop - Templates
Introduction Templates allow you to save frequently used layouts, avoiding having to retype them. Email Templates Setting up email templates Setting up email templates can increase your efficiency in communicating to your client base. To set up ...
Popular Articles
Wealth Axis Files - Naming Convention
File Format: Date, Client Name, File Name Date - yymmdd E.g: 12 Sept 2013 - 130912 E.g: Undated - 010101 Client Names One Client / Only primary client (John Smith) E.g: Smith, J Two Clients (Primary and Secondary Client/Client and Partner) - Married ...Wealth Axis Wizards - Overview
Overview This article is designed to help you effectively use the Wealth Axis Wizards in XPLAN. The key features of the Wealth Axis Wizards are: Integration with key modules such as Client Focus, Portfolios (IPS), Risk Researcher, WealthSolver and ...New User Manual - Admin
XPLAN and the Advice Process Overview Many advisers use the Advice to Client process to manage the advice process in their business. To enable participants to be able to relate to the different modules in XPLAN, this course is structured along the ...Administration - Email: Setting up the Outlook Plugin
Outlook Plugin - Overview Outlook Plugin is a function available with XPLAN that allows you to quickly and easily save and record email correspondence in the XPLAN document library as a Note that is linked to a client or user entity. This allows for ...XPLAN Workshop - XPLAN Client Setup
Introduction Overview Each practice deals with leads, referrals and potential clients differently. However, most practices have a system regarding the way client information is recorded and relationships with clients are managed. In this section, ...
Recent Articles
XPLAN Legislative Rates June 2022
XPLAN Legislative Rates - June 2022 Legislative rates have been updated to reflect: 1. Social Security rates effective July 2022 2. AFSA Retirement Standard Benchmarks for the March Quarter 2022. Social Security Rate Changes - July 2022 The rate ...XPLAN: Task Notifications - Redirecting
XPLAN: Redirecting Task Notifications XPLAN task notifications can be sent to your Email Inbox (e.g. Outllok, Gmail) to notify you if a task has been created, unactioned, is overdue or complete. If the task notifications cannot be turned off, then ...XPLAN Version Enhancements - 18 November 2021 (Version 21.11.195)
XPLAN Version Enhancements - 18 November 2021 (Version 21.11.195) Client Focus Digital Signature Notification will Honour the "Override from Address" when sent by Super User The notify signatories template configured in system settings > client focus ...XPLAN Version Enhancements - November 2021 (Version 21.11.194)
XPLAN Version Enhancements - November 2021 (Version 21.11.194) Client Focus New Current Residential Address Field A new field, current residential address, has been added to record a client’s current address. When entering the first address for a ...XPLAN Datafeeds: HUB24 Enhancements (v4.3) 29 October 2021
HUB24 Enhancements: 29 October 2021 HUB24 have released enhancements to their XPLAN EPI 4.3 datafeeds, to be effective 15 November 2021. Below is the information directly from HUB24 on the enhancements. The Individual Holding extract is where the ...