To create a new template, click Create or copy an existing out-of-box template or another custom template for an event.
...
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.
...
| Info |
|---|
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 to with this template, use this to switch between the selected events. |
...
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.
...
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 | Recipients | ||
|---|---|---|---|---|
Api Token Expiration | FlexDeploy users whose API tokens are going to expire in 3 days. | |||
Pipeline Gate Approval Assigned | FlexDeploy users, groups or emails configured in the pipeline role assigned for the Approval Gate. | |||
Pipeline Gate Approval Rejected | Eligible FlexDeploy users who committed the code for the Projects/Packages in a Release Snapshot. Eligibility is by the flag checked for “Notify on Request Rejected” for the profile. | |||
Pipeline Manual Step Assigned | FlexDeploy users, groups or emails configured in the pipeline role assigned for the Manual Step. | |||
Pipeline Notification Step | FlexDeploy users, groups or emails configured in the pipeline roles selected for the Notification Step. | |||
Pipeline Step Execution Failed | FlexDeploy users, groups or emails configured in the pipeline roles selected for On Error option in the Pipeline Steps. | |||
Workflow PreDeploy Review Assigned | FlexDeploy groups configured in the Pre-deploy workflow. | |||
Workflow PreDeploy Review Rejected | FlexDeploy user who submitted the request, FlexDeploy users who subscribed for “Notify on Request Completed” | |||
Workflow Approval Assigned | FlexDeploy users who subscribed for “Notify on Approval Required” | |||
Workflow Request Pending Approval | FlexDeploy group responsible for approval of the deployment request. | |||
Workflow Request Failed Workflow Request Ready Workflow Request Rejected Workflow Request Scheduled | FlexDeploy users who subscribed for the following events “Notify on Request Failed” | Work Item Mention | WorkItemMentionPayload “Notify on Request Deploying” “Notify on Request Rejected” “Notify on Request Scheduled” FlexDeploy user who submitted the request. Eligible FlexDeploy users who committed the code. | |
Work Item Mention | FlexDeploy users who were mentioned in a Work Item. The mention could be either from a comment or the Work Item description. | |||
Work Item Subscription | FlexDeploy users who subscribed for Work Item changes, such as field updates, new comments etc. | |||
Saved Query Subscription | FlexDeploy groups who subscribed for extract of Saved Query result in PDF/ CSV format. | |||
Share Saved Query | Notification sent when a Saved Query has been shared with a user. |
| Info |
|---|
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. |
...