Versions Compared

Old Version 16

changes.mady.by.user Martin Knapic

Saved on

compared with

New Version Current

changes.mady.by.user Ian RICKEBUSCH

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleHighlight

The feature is currently available for a subset of email templates (10) and is in the beta stage. We plan to expand the capability of using a new email designer editor across all transactional email templates. Please see the details below.

...

You will find this new feature upon the creation of the new email template for transactional email under Document types. Once you create a new model for supported document type you will be able to create a new "document model" by selecting the "Designer editor". See below.

What document types are supported?

We currently support only the subset of the document types, the remaining ones will be delivered in the following releases. 

Each document type has its own supported merge tags that allow operators to design personalized, dynamic email templates (see the example below). 

What are merge tags?

Merge tags are personalized variable pieces of information that is being applied to the email template dynamically respecting the data associated with (for example) an event name or individual receiving this email (e.g.: "Dear Mr Martin" - where "Mr" is "salutation" merge tag and "Martin" is "Contact first name" merge tag. Find more examples in the expansion section below per document type. 

Example of the merge tags

Supported document types with merge tags available 

Each document type (default templates) supports 6 languages (English, French, German, Italian, Spanish and Catalan) and has its own merge tags, as shown below:

Ui expand
titleAccompanying letter


Merge tag nameDescription
“Mark as specimen”Marks the document as specimen if the institution is a test institution
“Salutation”Shows letter salutation of the contact. It shows default text based on the language, if the contact does not have a specific one.
“Organisation address”Shows complete organization address
“Contact first name”Shows contact first name
“Contact last name”Shows contact last name
“Contact email”Shows contact mail 1
“Contact number”Shows contact number
“Contact address”Shows contact main address
“Contact username”Shows contact username - mail 1
“Order number”Shows order number
“Order amount”Shows order amount
“Order creation date”Shows order creation date
“File number”Show file number
“File creation date”Show file creation date


...

Ui expand
titleReset operator password


Merge tag nameDescription
“Mark as specimen”Marks the document as specimen if the institution is a test institution
“Salutation”Shows letter salutation of the contact. It shows default text based on the language, if the contact does not have a specific one.
“Organisation address”Shows complete organization address
“Operator login”Show operator login
“Operator email”Show operator internal email


How to set up a design editor for transactional email?

Ui steps

The instructions below outline how to set up a design editor for transactional email. For example: Accompanying letter.

Ui step

The operator is able to create a new document type or re-use an existing one and just create a new document model (step 2).

Because one document type enables only one document model with the type "Email," the operator must invalidate an existing "Email" document model before creating a new document model with the new type.


Ui step

 If the operator reuses the existing document type, they invalidate the existing one and create a new one.

The operator has to create a new document model with the type "Design Editor" in order to configure the new designer email template.


Ui step

If the operator does not set up a document template, the system uses the default template. If the operator wishes to customize the standard template, they need to create a new document template.

In the document template screen → A new menu "Template editor" is added. On click the designer editor is loaded and the operator is able to modify the content.

Adding merge tags

To modify the content by using merge tags click on the editable content block and look for merge tags. The system will offer you the ones that are available for this document type.


Ui step

We recommend the operator validate the new changes to the document template before putting it into use. The contact number selected represents a link to the concrete order number where the information is stored. The system will use this information to generate a test email respecting the configuration, data, and structure of the email template and selected order example.   

 

Validating the email will provide an example as seen below. 

When designing your email templates, we recommend you use a feature "Saved rows" which will make the process of applying shard design styles such as header or footer across multiple transactional emails much faster and more convenient. You have to create a row once (use save button as indicated below), store it, and simply reuse it in other email templates by finding it under Saved rows section (See below). 




Multi-language support per document model 

Multi-language support for your templates is available. Simply define multiple document models per each language you need. We provided some predefined templates per language for most used templates as part of the default setting.   

How to migrate a template from preproduction to production environments? 

You will notice that every template newly created template will be generating a *.json file that is available for download. Currently (in Beta status of the release) the uploading is not yet enabled. In future releases, we'll enable the possibility to upload those templates so that you can test them first in testing environments (such as preproduction) before uploading a final version to your production environment.

Other details

Specialities

While this new functionality provides a significant improvement to how transactional emails are managed today, you will notice that some of the documentation templates are populated with some technical code conditions. This will be improved over time but for now ...

Info
titleImportant

We recommend NOT removing any of those code conditions and purely focusing on adapting the text associated with actual messaging. Some templates provide templates that cover multiple use cases and the text from such templates will be applied only when specific criteria of action are met before the template is generated and shipped to the end user. Such a case is the template for Orders that you can also see below. Such a template will trigger only a specific part of the messaging applied on the template respecting specific cases. An example can be when the user's order was made by using the use of the product "options" or "reservations". 

Removing the mentioned code from the view will break the template and require you to configure the template from scratch.


Formats available

While this feature was primarily built for transactional emails, it might be useful to design other formats of documents. We also support the creation of document models in PDF format.