HTML templates

HTML templates are used as the content of emails. This kind of template allows you to create a fixed layout, for example if you want to add specific company styling like a font or logo's.

Creating an HTML template

Please take the following steps to create an HTML template:

  1. Go to Settings.
  2. Click on a Templates
  3. Click on New.
  4. Enter the label and the name of the status in the Label and Name fields respectively. If you enter a label and press Tab, BizzStream will automatically propose a name. The name has to be unique within the environment.
  5. Ensure that the Purpose field has the value Document.
  6. Choose a document definition in the Document Definition field.
  7. Set the Locale.
  8. In the field Based On, choose for HTML.
  9. In the Page field, choose the desired size (A3, A4, letter).
  10. The Direction field gives you the option to choose from Portrait or Landscape.
  11. Click Ok to save the new template.

Adding fields & lines

The template editor can be seen as the canvas for the template. You can add text, tables, markup, images, links and BizzStream Expressions, and if you want you can even work in plain HTML. All the fields that are in the document definition are available in the editor, including the special fields and translations.

To show the actual values from a document in a template, the template uses references to the document.

For adding a field/line to the template take the following steps:

  1. Expand the fields/lines pane on the left side of the editor.
  2. Click on a the field/line you want to add to the template. (lines should always be used in combination with a table)

In the editor, for fields it will look like this:

{!fieldName!}

In the editor, for lines it will look like this:

Styling of a template

An important aspect of a template are the styling and aligning options. For this you can use a table, by defining columns you can easily align the fields on the template.

Adding a table

  1. Go to Tables.
  2. You can provide the amount of columns and rows.

Adding an image

  1. Go to Images.
  2. Give the source URL of the image.
  3. You can add an image description, this will be used as the description (in case the image gets blocked by the email client).
  4. You can specify a dimension.

If you want to use an image from a site secured with SSL, the full certificate path should be published.

Be aware images might not loaded due to mail client restrictions (for example in Gmail this doesn't work). But when adding the images in a separate attachment they will be shipped with the e-mail.

Showing HTML editor

  1. Go to HTML.

Conditionally showing lines

Sometimes you only want to show a line if a conditions has been met. You can add a condition to a line.

{!IF [expression] !/}
The content of this part is only shown if the condition has been met.
{/!IF!}

Here you can use the same expressions as are being used when filtering in reference fields.

{!IF {!total!} > 500 !/}
Thank you for this big order!
{/!IF!}

This functionality will currently only work for top level fields. So it's not possible conditionally show (fields or columns within) lines.

Add translations to templates

You can add translations to templates, so that you can use one template to send mails/attachments to users with different languages.

{!_translation.yourTranslationKey!}

yourTranslationKey refers to the predefined translation key in the Translation page.

results matching ""

    No results matching ""