Project Execution Notifications
- Karl Henselin
- Chandresh Patel
Email is used as notification mechanism for project execution events. Email communication settings must be completed for notifications to work. Notifications for project execution events are processed even when request is initiated automatically from pipeline.
There are some default recipients for each event (see table below), but any person with an email address can subscribe to specific events and receive notifications. This is possible even when recipient is not a configured user within FlexDeploy. See section below for configuring such additional notifications beyond default recipients.
Unlike approvals & windows, notifications are additive (on Project Explorer hierarchy) and any notification that is found will be processed. This is accomplished by searching up the project navigation tree from the deploying or project until the root folder is reached.
Notification setup described in this section is with respect to project level requests (build, deploy, test, utility etc.). Requests can be either manually triggered or automatically including pipeline execution.
Event Name | Attribute Name on User Settings | Default Recipients | Description |
|---|---|---|---|
Request Approval Pending | Notify on Approval Required |
| Submitted request has pending approval. |
Request Scheduled | Notify on Request Scheduled |
| Submitted request is scheduled for execution. |
Request Approval Rejected | Notify on Request Rejected |
| Approver has rejected pending approval. |
Request Deploying | Notify on Request Deploying |
| Request is ready for deployment, i.e. all approval and schedule requirements are met or were not present. |
Request Completed | Notify on Request Completed |
| Request is successfully executed. |
Request Failed | Notify on Request Failed |
| Request failed during execution. |
1 - Submitter is a user that initiates build, deployment, utility or test request. Submitter recipient notifications can be turned off if desired for specific user by controlling specific attribute on User Settings. If request is initiated from pipeline, there will be no submitter notification.
2 - Commit users are derived from change logs captured during build, which are considered for notification when that specific build (project version) is deployed.
Create Notifications
Select Projects from the menu.
To add a Notification to a folder, open a folder.
Go to the Notifications tab.
Click Override Notifications.
Click Create.
Provide the Name to the Notification.
Fill in the Environment that you want the Notifications to apply to.
Choose the Events, In which stage you would like to receive the Notifications.
Add one or more Recipients by clicking on ADD RECIPIENT button.
Click on the SAVE button to save the Notification.
By clicking on ADD RECIPIENT button, will see three options as Email, Group, User in the dropdown.
Select a Type and Recipient.
Type | Recipient |
|---|---|
<Any valid email address> | |
Group | <Any valid FlexDeploy group> |
User | <Any valid FlexDeploy user> |
Click the Save button when finished.
Edit Notifications
Select Projects from the menu.
Click on an existing Folder and click the Notifications tab.
Click on a Notification Id to edit the existing Notification.
Optionally modify the Environment, Name, or check or uncheck Events, add or remove recipients for this notification.
Click the Save button to save changes to the notification.
- style