Installation and Configuration → System Administration → Notification Schemes
Deployment Automation can send email notifications whenever user-defined trigger events occur. For example, notifications can be sent when a deployment finishes or an approval is required.
Deployment Automation relies on LDAP and an associated e-mail server to send notifications. You must set up LDAP prior to configuring notifications. Notification recipients are defined with the security system's LDAP integration. See Security Administration.
When setting up notification schemes, you select both the triggering events and the role, which is inherited from the security system, to determine which users will receive notifications. For example, it is common for an administrator or environment owner to be notified when a work item, as part of the approval process, has been generated. The default notification scheme, which sends notifications to the application and admin default roles, can be edited or you can create your own scheme.
To set up your own notifications, navigate to the Notifications pane through Administration > System > Notification Schemes.
Configure the new scheme. Here, you will be setting up the who and when for notifications. Once configured, you can come back and add additional entries to the scheme or edit an existing one.
To select notification types to send for a particular role, navigate to the Add Notification Entry dialog, Administration > System > Notification Schemes > [select scheme] > Add Notification Entry [button], and select from the Type drop-down menu.
The process type is determined mainly by the type of recipient. For example, a deployment engineer would be interested in being notified about a failed deployment (Process Failure).
To select notification targets for a particular role, navigate to the Add Notification Entry pop-up, Administration > System > Notification Schemes > [select scheme] > Add Notification Entry [button], and select from the Target drop-down menu.
When setting the target, the application option will only send out notifications when the event selected above corresponds to an Application. For example, the "Process Success" event, when paired with the "Application" Target would trigger a notification when a Process (an application deployment) is successful. Similarly, the same event type, when used with the "Environment" target would instigate a notification when a successful deployment has been run in an Environment, such as SIT or PROD).
To select a role to be notified, navigate to the Add Notification Entry pop-up, Administration > System > Notification Schemes > [select scheme] > Add Notification Entry [button], and select from the Role drop-down menu.
The Role corresponds to those set in the Security System. Any individual assigned the Role you select will receive an e-mail.
To select a notification template name, navigate to the Add Notification Entry pop-up, Administration > System > Notification Schemes > [select scheme] > Add Notification Entry [button], and select from the Template Name drop-down menu.
The available templates are provided by default and should meet all your needs, including formatting the email being sent. Which template you use is based on why you want to set up a notification and the recipients of the notification. However, if the default templates do not suit your needs, you can create your own.
| Template | Description |
|---|---|
| Application deployment failure/success | Sends notifications about a specific application to the specified users, based on the role setting. |
| Task readied/created/completed | Used to report back on the state of manual tasks. |
| Deployment readied | A specialized email template for letting people know a deployment has been prepared. |
| Approval created/failed | These templates are used to notify the status of an approval. |
Once you have the entry done, add others using the same process. If you want to use the new notification scheme with existing applications, modify the application settings.
For information on creating email notification templates and setting their properties, see the following topics:
Copyright © 2012–2014 Serena Software, Inc. All rights reserved.