To create a new template, click Create or copy an existing out-of-box template or another custom template for an event.
To edit an existing template, click the link under the Template column.
Edit Template
The Edit Template screen shows some basic template information as well as the template components. The { } Custom header shown below indicates it's a custom template.
Code Editor
For more details on using the code editors on this page for Email Subject and Email Body, see Working with the Code Editor.
Field | Description |
|---|---|
Template Name | The name of the template. |
Events | Associate an event for the template (e.g. Workflow Request Completed). You can also assign more than one event to the same template. |
Email Subject | The script to be used for email subject for the event(s). |
Email Body | The script is to be used for the email body for the event(s). |
Payload | The payload is used in the code editor to give suggestions of what variables and methods are available when accessing the $payload variable, as this will vary depending on the event. If more than one event is associated with this template, use this to switch between the selected events. |
Template Components
The Email Subject and Email Body fields show the script needed to generate the content for the email message. FlexDeploy provides a rich set of APIs to generate the HTML content. See the Java docs for more details on the functions which can be referenced with the $FLEXDEPLOY object. You can also use your custom styles as needed. For help with the syntax of the Velocity Template Language (VTL) and examples, see the Apache Velocity User Guide.
Payload
Both Subject and Body will be able to reference the payload object related to an event. Using the shortcuts, you will be able to access all the data associated to an event using the variable $payload. The below table shows the events and associate payload objects.
Events | Payload Object Name |
|---|---|
Api Token Expiration | |
Pipeline Gate Approval Assigned Pipeline Gate Approval Rejected | |
Pipeline Manual Step Assigned | |
Pipeline Notification Step | |
Pipeline Step Execution Failed | |
Workflow PreDeploy Review Assigned Workflow PreDeploy Review Rejected | |
Workflow Approval Assigned Workflow Request Pending Approval | |
Workflow Request Failed Workflow Request Ready Workflow Request Rejected Workflow Request Scheduled | |
Work Item Mention |
Each payload object of an event holds a different set of data. Please use the link for each payload and go through the methods available to structure your HTML content for the template. You can always use the Preview and Send Test options to test and validate your script using the test data available.
All out-of-box templates use custom styling. The style settings can be found inside the application folder configured as part of the FlexDeploy installation. The files are located at <flexdeploy install root>/application/templates/notifications.
Any changes to the styles have to be tested thoroughly to make sure they work with the mail clients used within your organization. Please save a copy of the files before making any changes. Check FlexDeploy server logs for any errors while testing your custom changes. Look for "org.apache.velocity.runtime" text for any exceptions.