Custom email properties

logo

To use a custom logo image in the email notifications:

• Add the logo file to be used to the folder with email templates. All mime formats are supported. For example, use png, gif, or jpeg.
• If the logo file must be used for a specific task or notification email notification. Add it to the subfolder with the same name as the workflow that generates the task or notification.
• Edit the content of the applicable .properties files to contain this line:

  logo=companylogo.png

  Where companylogo.png is the name of the file to be used as logo.

fromAddress

To use a custom email address displayed as “From:” in the email header, edit the content of the applicable .properties files. The files must contain this line:

fromAddress=name@company.com

Where the value name@company.com must be a valid email address.

DisplayTreesAsTable

Use the DisplayTreesAsTable property to specify that tree structures should be displayed as tables in alert details or workflow structures from tasks and notifications. Edit the content of the applicable .properties files to contain this line:

DisplayTreesAsTable=True

The table to display alert details is built as follows:

• A table is created for each noun included in the alert details.
• The tree root becomes the table header. This is the noun name.
• The tree leaves become column names. The SequenceNumber information added to the trees is not included as a column name.
• For each component level in the tree, a new row is created in the table. The level names are not displayed in the table.
• Cell values are filled with values of the tree elements. Values of elements from parent levels are repeated on each row for each child.
• If values are missing for a leaf from a child level, the cell is left empty. If a level does not have any values for the leaves, except the SequenceNumber. The empty row that would be generated for this level is removed from the table.

The table to show workflow structures in tasks and notifications is built as:

• For each structure, a different table is created.
• The structure name becomes the table header.
• The names of the fields in the structure become column names.
• For each structure level, a new row in the table is created.
• Call values are filled in with the field values from the structure.
• If the structure has fields on the root level, these values are repeated on each row in the table.
• If a level has a sublevel, a row is created for each occurrence of the sublevel in the structure. The values of the fields from the parent level are repeated on each row that is created for an occurrence of the sublevel. .

emailSubject

Use the emailSubject property to specify a custom email subject for alerts, tasks, or notifications as follows:

• For alerts that are generated by a monitor, use this property in the monitor .properties file:

  emailSubject= String to specify customized email subject

  The customized email subject is a string that cannot contain placeholders. The email subject is constructed by appending the alert status, such as “New Alert", and the customized subject string.

• For tasks or notifications that are generated by a workflow, use this property in the step-specific properties file. You can also use this property in the workflow .properties file to ensure all tasks and notifications from the same workflow have the same email subject:

  emailSubject= String to specify customized email subject with parameter placeholders

  Parameter placeholders are defined as the workflow parameter name between square brackets. The parameter must be part of the task or notification content and the names must match, using case-sensitive comparison. At runtime, the parameter placeholders are replaced with the value that is given to this parameter. If a parameter placeholder is not specified correctly, the [?] string is displayed.

  Note: You cannot use the square bracket characters in the emailSubject and content of email templates for other purposes than to define workflow parameter placeholders.