Page tree
Skip to end of metadata
Go to start of metadata

You can use notification templates to help send email messages when an event occurs.

Events can be related to requests, steps, system failure, and user accounts. Notifications are sent automatically on the occurrence of a system failure or user account event. Notifications for requests and steps are sent to the specified mailing list only when email notifications are configured via the Change Notification Options link available when you edit a request.

The request- and step-related notifications are sent to the request and step participants, respectively. The participants include the request owner and requester (for requests) and the person to whom the step is assigned (for steps). The Exception raised notification is sent to the mailing list specified in the smtp_settings.rb file located at <BRPM_HOME>/server/webapps/brpm/WEB-INF/config.

You can specify your mailing list by replacing the DEFAULT_SUPPORT_EMAIL_ADDRESS property with a comma-separated list of email IDs in the smtp_settings.rb file.

The BMC Release Process Management product provides a set of default notification templates that you can modify to suit your needs, and then use directly. You can also customize your own notification templates by creating, editing, and deleting notification templates.

You create the notification templates with the Liquid template language. You can add information in the email body of the notification template by using the Liquid markup framework made up of outputs and tags. Outputs are enclosed by two sets of curly braces: {{output in two curly braces}}. Tags are enclosed by single curly braces and a percentage sign: {% tags with single curly braces and percentage sign %}. Outputs usually contain references of tokens and tags usually use the {% if true %} and {% endif %} notations. Tokens are similar to variables used for automation that are dynamically set at run time and are added to the input file.

For more information about the Liquid template language, see http://wiki.shopify.com/Liquid.

Default notification templates

The following table describes the default notification templates that are available.

Default notification templates

TemplateWhen the notification is sent
Events related to system failure
Exception raised

This notification template is disabled

Events related to user accounts
LoginUser requests a login to the system 
New user email notification failedAn email verification for a new user failed
Password ChangedUsers changes own password by using the profile or an administrator changes the password for a user
Password ResetUser clicks the Forgot password? link during login to request new login details
User Admin CreatedUser logs on to the product via Light Directory Access Protocol (LDAP) authentication or Central Authentication Service (CAS)
User CreatedAdministrator creates a user account; the notification contains login details
User profile updated email notification failedAn email notification about an update to a user profile failed
Events related to releases
Release Stage Completed

At least one request is successfully deployed in the stage. When the stage is Complete, the next stage or stages, if any, become available for deployment. An email notification is sent to the users of the application.

Notes:

  • By default, email notification about the stage completion is enabled. For more information, see Specifying general settings.
  • A root user must be added to the appropriate team to receive this email notification.
Events related to requests
Request CancelledRequest is canceled
Request CompletedRequest is completed successfully
Request MessageDuring request execution, to the distribution list with the same message that you update when you cancel a request or manually move the step under the request into the problem state
Request On HoldRequest status changed to the On Hold state
Request In ProblemRequest status changed to the Problem state
Request PlannedRequest status changed to the Planned state
Request ResolvedRequest status changed to the Resolved state
Request StartedRequest has started
Request not Started due to DWRequest did not start because of the deployment window validations
Events related to steps
Step BlockedStep is blocked
Step CompletedStep is successfully completed
Step Not StartedStep did not start at the scheduled time
Step ProblemStep goes into the problem state
Step ReadyRequest is ready, so the step is in the ready state
Step StartedStep has started

Related topics

Creating, editing, or deleting notification templates

Tokens available for creating new notification templates