Add Alert Handlers

Alert handlers provide the possibility to send emails for alerts raised in a deployed project. Alerts allow you to define business events in SAP Build Process Automation. Once an alert is created, it can be raised from an existing automation. That's why you need to create an alert handler to use the alert that you have created in your project.

Prerequisites

Before creating an alert handler, you first need to configure a Simple Mail Transfer Protocol (SMTP) server. For more information, see Configure an SMTP Mail Destination.

Procedure

  1. Choose Control Tower.
  2. Choose Alert Handlers and choose Add Alert Handler.

  3. In the Select Event dialog box, select the alert on which an email should be sent when it is raised in an automation. Click Next.

  4. In the Enter Properties dialog box, enter a name in the Name field.
  5. Optional: Enter a short description of the alert handler in the Description field.
  6. Click Next.

  7. Optional: In the Add Details dialog box, from the Available variables (1) list, you can use the following variables in the Subject or Content field:

    • The ${alert} variable has the following sub-properties:

      • ${alert.name}

      • ${alert.message}

      • ${alert.severity}

      • ${alert.parameters}

    • The ${automation} variable has the following sub-properties:

      • ${automation.monitoringLink}

      • ${automation.name}

      • ${automation.packageName}

      • ${automation.version}

      • ${automation.triggerCreator}

    • The ${context} variable has the following sub-properties:

      • ${context.agentNames}

      • ${context.agentLinks}

      • ${context.environmentName}

      • ${context.environmentLink}

    • The ${event} variable has the following sub-properties:

      • ${event.type}

      • ${event.name}

      • ${event.message}

      • ${event.timestamp}

  8. Enter the email address of the recipient in the Recipients (2) field.
    In the Recipients field, you can also use dynamic recipients through variable(s) from the alert parameters. Only alert parameters can be used as a variable for your recipients. Other available variables such as ${context} or ${automation} or ${event} are not possible to use in the Recipients field. A variable can hold one or multiple email addresses of the recipients.
  9. Enter the subject of the email in the Subject (3) field.
  10. Enter the content of the email in the Content (4) field.
  11. Click Add.

Results

The created Alert Handler will be triggered whenever the selected event source is raised from an automation in the corresponding project.


Task overview: Environments
Related Information