Trigger Plugin Reference 24.1.x
The Trigger plugin allows you to configure XL Deploy to send emails for certain events. For example, you can add rules to send an email whenever a step fails, or when a deployment has completed successfully.
This document provides information that is specific to this version of the Trigger plugin. For general information about the plugin, refer to Introduction to the XL Deploy Trigger plugin.
CI Reference
Configuration Item Overview
Other Configuration Items
| CI | Description |
|---|---|
| mail.SmtpServer | SMTP Mail Server Configuration |
| trigger.EmailNotification | Email Action |
| trigger.StepTrigger | Defines actions to executed for the specified state transition of a Step. |
| trigger.TaskTrigger | Defines actions to executed for the specified state transition of a Task. |
| trigger.Trigger | Trigger with associated actions. |
Configuration Item Details
mail.SmtpServer
SMTP Mail Server Configuration
| Public properties | ||
|---|---|---|
|
|
|
fromAddress: STRING
|
|
Default from address to use for messages sent with this server.
|
||
|
|
|
host: STRING
|
|
SMTP host
|
||
|
|
|
port: INTEGER = 25
|
|
SMTP port
|
||
|
|
|
password: STRING
|
|
Password to authenticate with host
|
||
|
|
|
smtpProperties: MAP_STRING_STRING
|
|
Refer to https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html for all properties that can be used.
|
||
|
|
|
testAddress: STRING
|
|
The address to which a test mail is sent when using the 'Send Test Mail' control task.
|
||
|
|
|
username: STRING
|
|
Username to authenticate with host
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| sendTestMail |
no description |
trigger.EmailNotification
| Interfaces | trigger.Action |
|---|
Email Action
| Public properties | ||
|---|---|---|
|
|
| |
|
The mail server used to send the email.
|
||
|
|
|
subject: STRING
|
|
Mail subject
|
||
|
|
|
toAddresses: LIST_OF_STRING
|
|
Mail addresses of recepients.
|
||
|
|
|
body: STRING
|
|
Mail body content in the form of a Freemarker template.
|
||
|
|
|
bodyTemplatePath: STRING
|
|
Freemarker template used to render mail body content. Path can be absolute or relative to XL Deploy's classpath.
|
||
|
|
|
fromAddress: STRING
|
|
From mail address. Defaults to SMTPServer fromAddress.
|
||
|
|
|
sendContentAsHtml: BOOLEAN
|
|
Mail body content should be sent as HTML
|
trigger.StepTrigger
| Type Hierarchy | trigger.Trigger >> udm.BaseConfigurationItem |
|---|
Defines actions to executed for the specified state transition of a Step.
| Public properties | ||
|---|---|---|
|
|
|
actions:
LIST_OF_CI<trigger.Action>
|
|
Actions to execute when specified state transition occurs.
|
||
|
|
|
fromState: ENUM [ANY, PENDING, SKIP, EXECUTING, DONE, FAILED, PAUSED, SKIPPED] = ANY
|
|
Trigger actions when the Step transitions from this state.
|
||
|
|
|
toState: ENUM [ANY, PENDING, SKIP, EXECUTING, DONE, FAILED, PAUSED, SKIPPED]
|
|
Trigger actions when the Step transitions to this state.
|
trigger.TaskTrigger
| Type Hierarchy | trigger.Trigger >> udm.BaseConfigurationItem |
|---|
Defines actions to executed for the specified state transition of a Task.
| Public properties | ||
|---|---|---|
|
|
|
actions:
LIST_OF_CI<trigger.Action>
|
|
Actions to execute when specified state transition occurs.
|
||
|
|
|
fromState: ENUM [ANY, QUEUED, PENDING, EXECUTING, DONE, STOPPED, EXECUTED, CANCELLED, FAILING, FAILED, STOPPING, ABORTING, ABORTED, SCHEDULED] = ANY
|
|
Trigger actions when the Task transitions from this state.
|
||
|
|
|
toState: ENUM [ANY, QUEUED, PENDING, EXECUTING, DONE, STOPPED, EXECUTED, CANCELLED, FAILING, FAILED, STOPPING, ABORTING, ABORTED, SCHEDULED]
|
|
Trigger actions when the Task transitions to this state.
|
trigger.Trigger
| Virtual Type |
|---|
Trigger with associated actions.
| Public properties | ||
|---|---|---|
|
|
|
actions:
LIST_OF_CI<trigger.Action>
|
|
Actions to execute when specified state transition occurs.
|