Configure email notifications

Configure Email Notifications for Application or Microservice Processes

Review these guidelines before configuring email notifications:

Notifications can be configured for application or microservice processes and application or microservice process steps (type: process).

When the Applications notifications or Microservices notifications dialog box is opened and the process details expanded, only the process steps appear in the list (type:process).
New email notifications are disabled by default in the application, the application processes, and the process steps.

Figure 1. Notification default status
Configure notifications in the Application notifications dialog box.

Once notifications are configured and saved, email notifications are enabled at that level until manually disabled.
- By default, the application expects that the user creates an email configuration called default. The email configuration defaults to the server property /server/ec_deploy/ec_defaultEmailConfiguration, which is set to default.
- To use a different name for the email configuration, change the value of /server/ec_deploy/ec_defaultEmailConfiguration to the new email configuration name. For more information, refer to Notifications.
- Define email configurations based on the context of the notifier. For example, define a Release Approvals configuration to notify recipients interested in release approval notifications. Another example: define a Deploy Notification configuration for general application process run notifications.
  
  At least one configuration must be defined to implement notifications. For information on creating email configurations, refer to Notifications.

Configure email notifications for application processes or application process steps as follows:

Select an application, then select the icon.
Select Notifications from the list.
Toggle the status to On and select Edit to open the Application notification dialog box.
Configure email notifications as follows:
1. Configure one or more notifications in an application process or an application process step (type: process).
  - Configure recipients:
    
    Add users, groups, or email addresses. The dynamic system will autofill a list of names or email addresses as potential matches while typing.
    
    Select the suggested matches of the name or email address, or continue typing. More than one name or email address can be added.
    
    The user and group settings are defined and managed at the platform level. For more information, refer to Users and Groups.
  - Configure the event that triggers the notification:
    
    From the event dropdown list, select the event that triggers a notification to be sent to the recipients. The default is Both Failed and Successful.
  - Configure the environments where the notification applies:
    
    From the Select Environments dropdown list, select the environments to which the notifications apply. The available environments listed apply to the application mapped in the tier map.
  - Select the email template:
    
    Select the email template to send to recipients. It is possible to edit it first, or send as is.
  - Select the email configuration:
    
    To tailor the context of the email notifier, check Advanced Email Configuration, and select the email configuration that matches the notifier’s context. Note this feature requires one or more email configurations defined for your CloudBees CD/RO site.
    
    Figure 2. Edit Notification
2. Add another notification for an application process or application process step.
3. (Optional) Enable email notifications for the application processes or application process steps that are not already enabled.
  - Select the Notifications toggle next to the process or process step to configure and toggle it to On.
  - Select Edit to open the Edit Notification dialog box.
  - Select the Add + to add a new notification.
  - Configure the new notification as described above.
  - Select OK.

Configure Email Notifications for Pipeline Gate Tasks or Manual Tasks

Configure email notifications for pipeline gate tasks or manual tasks by using the Notification toggle in the pipeline task editor.

Select the pipeline that contains the task to be configured.

If the task type is Manual, the Notifications tab is greyed out. Notifications can not be configured for manual tasks.
Select the icon next to the pipeline task to be configured.

Figure 3. Configure task menu
Select the appropriate menu option to configure the task. The Edit task screen displays.
Select the Task type from the dropdown.
Use the toggle to enable or disable notifications for a manual task.

Figure 4. Notification toggle
Configure remaining options as necessary.
Select Save changes.

Configure Email Notifications for Pipeline Stages or Tasks

Configure email notifications for pipeline stages or tasks by using the Notifications menu in the stage or task editor.

Select the icon next to the desired stage or task.
Select Notifications from the options available. The appropriate Edit screen displays.

View images

Pipeline Stage Notifications menu
Pipeline Task Notifications menu

To enable or disable notifications, do the following:

Select the menu Notifications tab and use the toggle to enable or disable Notifications.
1. When enabling notifications, the following options must be selected:
  1. the events receiving messages.
  2. the users and/or groups to receive messages.
  3. the appropriate email configuration from the dropdown.
    
    View images
    
    Edit Stage screen
    Edit Task screen
2. When disabling notifications, all selections are grayed out. Previous selections are invalidated.
Select Save changes.