Difference between revisions of "Email Templates"
Jump to navigation
Jump to search
| (18 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| + | This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/email/templates/ Hornbill Document Library]. | ||
| + | |||
| + | [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/email/templates/]] | ||
| + | <!-- | ||
| + | |||
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | <div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | ||
__NOTOC__ | __NOTOC__ | ||
| Line 16: | Line 21: | ||
== Related Articles == | == Related Articles == | ||
| − | :* [[ | + | :* [[Email_Action_Item|Email Action Items]] |
| − | |||
| − | |||
|} | |} | ||
{{#ev:youtube|mvF7saw4MCI|350|right}} | {{#ev:youtube|mvF7saw4MCI|350|right}} | ||
| + | |||
==Template List== | ==Template List== | ||
The list of templates is controlled by the selection of the application that will be using the template along with the entity or business object within that application for which the template will use variables to include information from the entity when an email is sent using that template. | The list of templates is controlled by the selection of the application that will be using the template along with the entity or business object within that application for which the template will use variables to include information from the entity when an email is sent using that template. | ||
| Line 49: | Line 53: | ||
::* <nowiki>{{DATE}}</nowiki> = The current date in the format 2016-11-23 | ::* <nowiki>{{DATE}}</nowiki> = The current date in the format 2016-11-23 | ||
::* <nowiki>{{TIME}}</nowiki> = The current time in the format 23:53 | ::* <nowiki>{{TIME}}</nowiki> = The current time in the format 23:53 | ||
| + | ::* <nowiki>{{instanceId}}</nowiki> = The id of the Hornbill instance | ||
:* '''Modifiers''' | :* '''Modifiers''' | ||
| − | :: The following modifiers are used with variables and are available | + | :: The following modifiers are used with variables and are available: For example |
::* <nowiki>{{.H_firstname|upper}}</nowiki> = Will force the value to uppercase i.e JOHN. | ::* <nowiki>{{.H_firstname|upper}}</nowiki> = Will force the value to uppercase i.e JOHN. | ||
::* <nowiki>{{.h_firstname|lower}}</nowiki> = Will force the value to lowercase i.e john. | ::* <nowiki>{{.h_firstname|lower}}</nowiki> = Will force the value to lowercase i.e john. | ||
| − | ::* <nowiki>{{.h_firstname|empty | + | ::* <nowiki>{{.h_firstname|empty}}</nowiki> = Will only show the value if it exists else the variable will be removed from the output. |
| − | ::* <nowiki>{{.h_firstname|html | + | ::* <nowiki>{{.h_firstname|html}}</nowiki> = Allows HTML output from a template variable instead of HTML being shown as text. |
| + | ::* <nowiki>{{.h_firstname|wiki}}</nowiki> = Allows HTML output from a template variable that contains wiki markup, Currently only basic formatting (Bold, Italic, Ordered & Unordered lists) are supported. | ||
| + | ::* <nowiki>{{.datetimevariable|formatLocalTime}}</nowiki> = Allows formatting of datetime variables using system regional settings ('''system.RegionalSettings.timezone''' & '''system.RegionalSettings.dateTimeFormat'''), without this formatting the date time will use the DB value (UTC). | ||
| + | {{infobox|''Modifiers do not apply for extended variables. For example, modifiers cannot be applied (they will not work) on variables like "Customer Coworker.H_first_name"''}} | ||
| − | == | + | ==Variable Visibility == |
===The "empty" Variable Modifier=== | ===The "empty" Variable Modifier=== | ||
| Line 69: | Line 77: | ||
<br> | <br> | ||
An ESP expression controls whether the variable or specified text should be visible in the email being sent. | An ESP expression controls whether the variable or specified text should be visible in the email being sent. | ||
| − | i.e. If the expression evaluates to “True” then display the variable or text. If the expression evaluates to “False” then hide the variable | + | i.e. If the expression evaluates to “True” then display the variable or text. If the expression evaluates to “False” then hide the variable or text completely. |
<br> | <br> | ||
Ultimately, the visibility of the variable or text is dependent purely on the condition set against it. It is not dependent on whether any data exists in the database for the variable to resolve. | Ultimately, the visibility of the variable or text is dependent purely on the condition set against it. It is not dependent on whether any data exists in the database for the variable to resolve. | ||
<br> | <br> | ||
| + | ====What Operators can I use in my ESP Conditions?==== | ||
| + | The operators "'''='''" (equal to) and "'''!='''" (not equal to) are supported. | ||
| + | <br> | ||
| + | |||
====The Co-Worker Vs Contact ESP Condition Example==== | ====The Co-Worker Vs Contact ESP Condition Example==== | ||
One common situation where the ESP expression is essential is when you want to begin your emails with “Dear [Customer]”. | One common situation where the ESP expression is essential is when you want to begin your emails with “Dear [Customer]”. | ||
| Line 93: | Line 105: | ||
<li>Click OK</li> | <li>Click OK</li> | ||
</ol> | </ol> | ||
| + | <br> | ||
| + | '''Hornbill Hint:''' The example described here is evaluating a variable (Customer Type) that will contain a number (0 or 1). In other situations, you might want to evaluate a variable that contains a word, such as <nowiki>{{.H_resolvedby_teamname}}</nowiki>. When doing this the variable must be surrounded by single quotes e.g. '''<nowiki>'{{.H_resolvedby_teamname}}'</nowiki> = 'My Team'.''' i.e. if resolved by team name equals "My Team", show the text bound by the ESP expression. | ||
| + | <br> | ||
<br> | <br> | ||
When viewing your email template, any variable currently under the control of an ESP expression is highlighted in Grey. | When viewing your email template, any variable currently under the control of an ESP expression is highlighted in Grey. | ||
| Line 109: | Line 124: | ||
| − | [[Category:Administration]][[Category:Videos]] | + | [[Category:Administration]][[Category:Videos]][[Category:HDOC]] |
| + | --> | ||
| + | <<!-- esp-config/email/templates --> | ||
Revision as of 22:51, 20 November 2023
This document can now be found at its new location in the Hornbill Document Library.
<