Customize emails for monitoring alert

  • Log in to the Abiquo API Server as an administrator
  • In the config folder, if there is no mail folder, create a mail folder and set the owner as the tomcat user

    /opt/abiquo/config/mail
  • In the mail folder, create the following files

    • Email file

      monitoringAlertTemplate.mustache
      <p>You are receiving this email because the alert <strong>{{name}}</strong> has been <strong>{{state}}</strong> at {{alertDate}}.</p>
      
      <h4>Alert description</h4>
      <p>{{description}}</p>
      
      <h4>Notified alarms</h4>
      <ul>
      {{#alarms}}
      <li><em>{{alarmName}}</em>: {{alarmDescription}} - <em>{{entityType}}<em>: {{entityName}}</li>
      {{/alarms}}
      </ul>
      
      <p>For further details, go to the {{{portalname}}} at: {{{portaladdress}}}</p>
    • Properties file

      monitoringAlert_en_US.properties
      subject=Alert {0} has been {1} at {2}
      portalname=Abiquo console
      portaladdress={0}

      If you change the subject property, you must restart the Tomcat server to apply your changes

    • The variable "{1}" represents the state of the alert as "activated" or "deactivated" 

    • The variable "{2}" represents the timestamp of when the alert changed state
    • In the properties file you can only set the subject, portalname and portaladdress.

  • Optionally add custom variables and content

    • In the email body, to add a custom variable, use double curly braces (also called double mustaches). For example

      <p>Please call your system Administrator on <strong>{{helpline}}</strong></p>
    • Then in your properties file, set value for your custom variable

      helpline=555 12345

      To return unescaped HTML as part of a template property, use the triple mustache, which is "{{{" and "}}}". The Mustache templating software that adds the property values will escape HTML variables in double mustaches by default.

  • If your users have a language other than English, rename the file to change the language code to the user language 
    • For example, for "Spanish - Spain" change the en_US to es_ES
    • The user language is the UI language when you create the user
  • Change the owner of the files to the tomcat user

Copyright © 2006-2022, Abiquo Holdings SL. All rights reserved