Page tree
Skip to end of metadata
Go to start of metadata

This article describes how to set up an email template in PRIME Designer.

In all fields, variables from data pools can be used. To use a variable, navigate to the data pool and variable name in the list to the left, and drag-and-drop it to the intended field. The mail body can be represented in plain text or in HTML format. 

Expand/Collapse All

Prerequisites

 Prerequisites
  • Installed PRIME
  • Available process to trigger emails to be sent
  • If signed email shall be used, Sign and encrypt engine must be configured, see Do settings for signed emails below. See also Sign and encrypt engine.

Step-by-step instruction

 Log in to PRIME Designer
  1. Log in to the PRIME Designer as an admin user.
 Add or edit email template

To add or edit an email template:

  1. Go to Home > Emails.
  2. To add a new email template, click +New. Enter details:
    1. Enter a Name, for example EmailNewPassword, and optionally a Description.
    2. Enter an email address in the To field.
    3. Click Save+Edit.
  3. To edit an existing email template, double-click the email template name.
 Enter recipients and subject
  1. In the fields Cc, and Bcc, enter one or more recipients, for example ${BaseDpEmployee_Email} from the Employee datapool.
  2. Enter a Subject.
  3. Check S/MIME Encryption if the email is to be encrypted.
  4. Check Sign Email if the email is to be signed by the server.
 For email signing: replace the certificate

If you shall use signed emails, you must replace the email signing certificate, emailSignCert. This is done in the file engineSignEncryptConfig.xml. For more information, see Sign and encrypt engine.

  1. Open the file engineSignEncryptConfig.xml for editing.
  2. Replace the email signing certificate file, emailSigning.p12, with the correct certificate file.

    Example: Snippet of engineSignEncryptConfig.xml
    ....
      <key name="emailSigningCert">
                <type name="pkcs12" locationValue="classpath:emailSigning.p12" 
    ....
 Enter message as html

The html-formatted message is shown, when the mail server of the recipient supports html.

To enter an email message in HTML format:

  1. Go to the Html tab.
  2. Write an html-formatted email message in the text field. To insert a variable, for example BaseDpEmployee_FirstName, select the corresponding data pool in the left field and drag-and-drop the variable into the text field.
 Enter message as plain text

The plain text message is a fallback solution for when the mail server of the recipient does not support html.

To enter an email message in plain text:

  1. Go to the Text tab.
  2. Write an email message in the text field. To insert a variable, for example BaseDpEmployee_FirstName, select the corresponding data pool in the left field and drag-and-drop the variable into the text field.
 Add attachments

The contents to attach to an email must be in binary form in a data pool. Typical examples of binary data are photos and signatures.

To add an attachment:

  1. Go to the Attachments tab.
  2. Navigate to the data pool and field in the list on the left, and drag-and-drop it to the table in the Attachments tab.
  3. If you want, edit MIME type, to attach the file in a different format.
  4. If you want, edit the Name of the attachment.
  5. Click Save.
 Edit SMTP settings

To edit the SMTP settings:

  1. In the Test area field, click on the Expand symbol on the top. On the SMTP Settings tab, the settings are shown.
  2. To edit the settings, click on the SMTP Settings button.
  3. Enter the SMTP server settings. Click OK to save.

    Example: SMTP settings

    Host: localhost
    Port: 25
    User:
    Password:
    Default sender: activiti@localhost
    Timeout: 5000

  4. Go to the Preview tab to view all variable expressions.
  5. If you want, Send test mail to the Test Recipient entered in the SMTP Settings.