Installation and Configuration → System Administration → E-mail Notifications → Configuring Notification Schemes

Configuring Notification Schemes

Prerequisites:

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.

Deployment Automation requires an external SMTP mail server to send notifications. For information about configuring a mail server, see System Administration.

You can configure the default scheme and set up additional schemes as needed for your implementation.

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 templates provided by default and should meet all your needs, including formatting the e-mail being sent. You should select the template to use based on the reason for the notification and the recipients of the notification. However, if the default templates do not suit your needs, you can create your own.

To configure a notification scheme:

  1. Navigate to Administration > System > Notification Schemes.
  2. Select and edit an existing scheme, such as Default Notification Scheme, or click Create New Notification Scheme to create a scheme.
  3. Select from the available notification scheme options as follows.
    Option Description
    Name Specify a name for the scheme.
    Description Specify a description for the scheme.
    Attach Logs Select this to includes a log file attachment for each target that shows the success or failure status of each step.
    Attachment maximum before archival Number of logs to attach before the logs are compressed into an archive.
  4. Edit an existing notification entry, such as Process Failure or Process Success, or click Add Notification Entry to create an entry.
  5. Select from the available notification entry options as follows.
    Option Description
    Type Select an event type for which to send notifications. The event type is typically determined by the type of recipient. For example, a deployment engineer would be interested in being notified about a failed deployment (Process Failure).

    Available types are:

    • Process Success
    • Process Failure
    • Process Started
    • Approval Completed
    • Approval Failed
    Target Select notification targets, such as Application or Environment. If you select Application notifications are sent only when the event type corresponds to an application. For example, the Process Success event, when paired with the Application target, would initiate a notification when a process, such as an application deployment, is successful. Similarly, the same event type, when used with the Environment target, would initiate a notification when a successful deployment has been run in an environment, such as SIT or PROD.
    Role Select a role to be notified. The role corresponds to those set in Administration > Security > Role Configuration. Each user assigned the role you select will receive an e-mail.
    Template Name Select a notification template name.

    Available templates are:

    • ApplicationDeploymentFailure
    • ApplicationDeploymentSuccess
    • ApprovalCreated
    • ApprovalFailed
    • DeploymentReadied
    • ProcessRequestStarted
    • TaskCreated
  6. Click Save.

Related Topics

Deployment Results in E-mail Notifications

Security Administration

System Settings

Copyright © 2011–2014 Serena Software, Inc. All rights reserved.