Show TOC

Background documentationEmail Alert Gateways Locate this document in the navigation structure

 

Alerting gateways specify the addressee as well as the content of the message that is to be sent to the operator. You can have more than one email gateway, if you want to use multiple SMTP servers.

Actions

Email alert gateways support the following actions:

Action

Description

Export

Export the email alert gateway into a CAR file

Edit

Edit the email alert gateway

Edit Security

Edit the security of the email alert gateway

Delete

Delete the email alert gateway

Duplicate

Make a copy of the email alert gateway to create a similar one

Expand All

Expand all email alert gateways in the current filter

New

Create a new email alert gateway

Filter > New Filter

Create a new email alert gateway filter

Filter > Edit Filter

Edit current email alert gateway filter

Filter > Delete

Delete current email alert gateway filter

Patterns

Alert sources use patterns rather than names so that alerts can apply to all objects of a particular type and naming conventions can be used to minimize the number of required alerting rules.

Patterns support two wildcards:

  • '*' - matches any number of characters

  • '?' - matches any single character.

Example:

  • "System_*" - matches all jobs starting with System_

    • System_OperatorMessage - MATCHES

    • SystemJob1 - DOES NOT MATCH

  • ER? - matches all three letter strings starting with ER

    • ERP - MATCHES

    • ER1 - MATCHES

    • ERP1 - DOES NOT MATCH

Headers

Email gateways also allow you to override email headers. This is handy if you want to adapt the subject or add a reply-to address, for example. There is a special email header that can be used to override the SMTP server, named X-Redwood-Server. You can also add other custom email headers that may be required by your email system. You can use substitution parameters in email gateways, this allows you to dynamically set the subject of the email, for example.

The following substitution parameters can be used in headers:

  • ${address} - the addressee's address

  • ${messageTitle} - the title of the message

  • ${subject} - the subject

  • ${message} - the message

  • ${alertSource} - the alert source that triggered the alert

  • ${object} - the object that triggered the alert

Job Files

You can attach job files of the failed job to the email. This allows the operator to troubleshoot the problem without the need to connect to the system and gives other addressees, like managers, information on what went wrong, if they need to know.

Usually, you would send stderr which should contain specific error messages. The job output is usually stored in stdout, but you can specify any short name of a job file of the job.

Actions

Actions allow you to write script custom reactions to alerts in RedwoodScript. Stub code is already available to you and contains predefined objects.

Note Note

Actions require the Scripting Module, which requires the Module.Scripting license key.

End of the note.
Finding Email Alert Gateways

You can search for email alert gateways using filters and the Search Email Alert Gateways box on the Email Alert Gateways tab. This box is known as the intelliSearch box and located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short and long syntaxes. For example, if you want to display all email alert gateways with the term management in the comment, you would use the search criteria as follows:

c:management

You can search more than one property, as follows:

c:management n:corp

Note Note

No spaces should be entered before or after the colon (:).

End of the note.

See the Advanced Object Search for more information.

The following table illustrates the available prefixes for email alert gateways:

Prefixes

Description

n, name

searches the name property

c, com, comment

searches the comment property

d, desc, description

searches the description property

a, app, application

searches the application property

Deleting Email Alert Gateways

You can only delete gateways when no other objects relate to them. For example, if there are alert escalations that use the gateway, the gateway cannot be deleted until all alert escalations that use it have been modified. You can see all alert escalations that relate to the gateway in Related Objects in the lower detail pane and on the show page.

The table in related objects contains three columns:

  • Type - the type of object with a link to it

  • Related Object - the name of the object with a link to it

  • Used As - objects can sometimes be used in different roles

Security

Privilege

Description

EmailAlertGateway.Create

Create email alert gateways

EmailAlertGateway.Delete

Delete email alert gateways

EmailAlertGateway.Edit

Edit email alert gateways

EmailAlertGateway.View

Access email alert gateways

You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted system-wide, per partition or isolation group.

If you have the security module, which requires the Module.Security license key, you have an additional Security tab on the email alert gateway. It allows you to specify which users can access, edit, and delete the email alert gateway.