Skip to main content

How to create/configure an email template (Part 1 of 2)

Email Templates are configured on the Email Templates screen which can be found at the System and the Company level.   Creating an Email Template To add a new Email Template click the sign. To modi

Updated over 2 weeks ago

Email Templates are configured on the Email Templates screen which can be found at the System and the Company level.

email_template_search.png

Creating an Email Template

To add a new Email Template click the

plus.png

sign. To modify an existing template or view a template to copy the template to create a new one, click the

pencil.png

system_email_template_screen.png

When viewing an existing template, click the

Copy_button.png

button to create a copy of the email template:

email_template_copy.png

When accessing the Email Templates page at a company level, note that all system level email templates are available at a company level.

Upon initiating the creation of a new email template, users are presented with 3 options. Click on the Create a new Email Template By drop down list and select from:

  • Defining a New Template

  • Copying A Company Template

  • Copying A System Template

Note: Use the above copy options when creating a new company template by copying a system template or copying a company level email template from a different company, otherwise consider using the

Copy_button.png

button on the Email Templates screen.

To create a new template select <Defining a New Template> and populate the Template Name field. The Template Name is the name that will be listed on the Note/Communication and/or Service Order Settings screens in the Email Template drop down list. This name must be unique and the field is a mandatory field. Click

next_ep.png

to continue.

system_email_template_define_new.png

There are 4 main parts to the email template:

email_template_new.png

Email Content Merge Source

If you do not need to merge data into your email you can leave the Not Applicable radio button selected. If you would like to use Merge Tags to merge data into the Email Content section, select either Data Source or User Report. Selecting Data Source allows users to use a predetermined set of merge tags from the Equus Standard Merge Data Sources. There are a number of Data Sources to choose from and each Data Source will have its own set of merge tags.

email_template_merge_source2.png

For greater flexibility in the choice of data and data formatting, select User Report. Then select the name of the user report using the type-ahead drop down list. When a user report is selected, a link to the User Report Details screen will appear:

email_template_merge_source_user_report.png

Email Content

Using merge tags in the Address Fields, Subject and/or Body fields in the email content section allows for data to be dynamic. Merge tags used for emails templates must have a prefix of "&EQ_”. Selecting the Data Source or User Report, determines the list of available merge tags that can be used. Click on the Available Merge Tag field to view the type-ahead drop down list of available merge tags for the selected merge source.

You can add multiple recipients in the Address Fields (To, Cc, Bcc) using a comma (,) as the separator. You may add a merge field for the email address from the Available Merge Tag field.

Once a merge tag is selected, the

mceclip3.png

button is enabled and can be used. After copying the selected merge tag, the merge tag can be copied to a field in the Email Content section.

email_template_select_merge_tag2.png

For user reports, merge tags are created by adding "&EQ_" before the user report's field column caption values. Note that column captions must be fully unique so that no merge tag can be found within another tag if matched using "start with" comparison, therefore it is recommended that column captions do not include spaces. If the user report contains fields that are hidden, the column captions for these fields will not appear in the drop down list.

email_template_content.png

Note, it is possible to define a section of the document which will repeat once for each record that is returned. You will need to signify the beginning of the repeating section by using the field &EQBEGINROW, then enter the fields you wish to repeat and close the section with &EQENDROW.

Save & Go Advanced

You have the options to switch to the Advanced Template editor to edit the body of the template.

To do this, click

save_and_go_button.png

. You will be presented with a warning message:

advanced_editor_warning.png

As detailed above, please note:

  • Advanced mode templates cannot be used with assignment level Notes

  • The change to advanced mode is permanent

  • No PII data should be entered into the editor

Once you click

ok.png

, Advanced Mode will be displayed:

email_template_advanced_mode_editor.png

The original contents of the email body will then be displayed in an HTML block within the Advanced Mode editor. Note - if you wish to make edits, you will need to edit the HTML code. If unfamiliar with HTML, copy the text and add it into a new 'paragraph' block.

The Advanced Mode Editor gives you additional options when customizing email templates, facilitating greater control over content and design for better alignment with company branding.

advanced_email_editor_example.png

  • For more information on how the editor works, check out this resource here

  • For Platform specific additional notes on best practice for advanced mode, click here.

Attach a Document

Two types of documents can be attached to email templates: Merge Documents and Static Documents.

To attach one or more Merge Documents to the template, click

apro_new_button.png

under Attached Merge Documents. This will allow you to create a row for each merge document you would like to attach. If you wish to remove a Merge Document simply tick the Delete checkbox and click

save.png

.

email_template_attach_files.png

To attach one or more Static Documents to the template, click the + icon from the grid under Attached Static Documents. If you wish to edit or delete an existing static document, simply click on the document icon. A pop up window will appear allowing edits to be made including a

apro_delete_button.png

button.

email_template_attach_static_doc.png

When the

plus_apro.png

is clicked, the Upload Document pop up window appears.

  1. Populate the two mandatory fields: Type and Name.

  2. Click

    select_file.png

    to select the file to attach.

Once the file is attached, the file name appears together with the

remove.png

button. Click

upload.png

to continue and return to the Email Template screen.

email_template_doc_uploader.png
Did this answer your question?