IBM® UrbanCode Deploy can
send email notifications whenever user-defined trigger events occur.
Notifications can be sent when a deployment finishes or an approval
is required, for example. Notification recipients are defined with
the security system's (see Security)
LDAP integration. If you have not already done so, set up LDAP before
configuring notifications. IBM UrbanCode Deploy relies
on LDAP and an associated email server to send notifications.
Note: IBM UrbanCode Deploy requires
an external SMTP mail server to send notifications. For information
about configuring a mail server, see
System settings.
When you set up notifications, you select both the triggering events
and the role, which is inherited from the security system, to determine
which users receive notification. For example, it is common for an
administrator or environment owner to be notified when a work item
(as part of the approval process) is generated. The default notification
scheme, which sends notifications to the application and admin default
roles (see Security), can be edited or
you can create your own scheme.
To set up your own notifications, display the Notifications pane
().
Figure 1. Notification schemes
Configure the new Scheme. Here, you are setting up the who/when
for notifications. Later, you can come back to add more Entries to
the Scheme or edit an existing one.
- Role
- The role corresponds to the roles in the security system. Any
individual assigned the role that you select receives an email.
Figure 2. Notification role
- Type
- 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.
Figure 3. Notification Type
- Target
- When setting the target, the application option sends notifications
only when the event selected above corresponds to an application.
For example, the "Process Success" event, when pared 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 runs in an environment (such as SIT or PROD).
Figure 4. Notification Target
- Template Name
- The available templates are provided by default and suffice for
most or all needs; they format 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.
- Application deployment failure/success
- Sends notifications about a specific application to the specified
users, based on the role setting.
- Task readied/created/completed
- This template is used to report back on the state of manual tasks.
- Deployment readied
- A specialized email template for notifying people that a deployment
is ready.
- Approval created/failed
- These templates are used to notify the status of an approval.
After you have the entry, add others with the same process. If
you want to use the new notification scheme with existing applications,
modify the application settings.
Notification templates are XML files in the server’s conf/server/notification-template file
folder. If the default notification templates do not suit your needs,
you can create new ones.
To create a new notification template:
- Start a new XML file.
- Enter Script. (Notification templates support only Velocity™ reports)
- Save file in the server's conf/server/notification-template file
folder.
- Restart the server.