Contents

Alerts are a combination of a message and a transport for delivering that message. A message could be in different formats such as plain text, XML, etc and transports could be any of the supported ones. Alerts created can be reused across different policies.

Icon

Please refer to Alert Repository section to know how the alerts are stored in the Fiorano Enterprise Repository and recommendations on backing them up and migrating.

Alert Manager panel lists the alerts and the Transport Type. This is a paged data grid and the pages can be navigated by using the next  and previous  buttons. Refresh button reloads the alerts from the Alert Repository. Clicking on an alert displays the details of the alert.


Figure 1: Alert Manager screen before adding SMTP/JMS alerts

The Alert Manager screen lists all the alerts configured in the system along with the details of the alerts (see the figure below).

SMTP Alert

Alert messages are delivered as an Email via the SMTP Transport protocol. This is used to notify users asynchronously about certain events occurring in the system. Default message content will be in a readable text format. The content can be changed to reflect a context specific message. This transport is not ideal to start or execute a workflow.

Icon

All the property values described below appears after adding the SMTP Alert.


Figure 2: Alert Manager with SMTP alert details

Property Name

Description

From Name

The sender Name as it appears on the email client.

NotificationID

Unique identifier of the notification. one should use meaningful IDs to make it easier to reuse this alert in multiple policies.

Message Content Type

Text/Plain. The content type of the message to be delivered.

Message Body

The actual Message content to be delivered.

To

The intended recipient of the notification.

UseTransport

Boolean to indicate whether the default transport settings to be used or the alert specific transport settings have to be used. If true, it means that the alert specific setting has to be used.

Subject

Short description of the content / subject of the message.

CC

The list of recipients to be carbon copied.

BCC

The list of recipients to be black carbon copied.

Creating New SMTP Alerts

By clicking the Add button on the upper-right part of the Alert Manager page, users can add new alerts. A drop-down list of available transports is listed and on selecting a transport, a panel which describes the message format for that transport is displayed.

If Transport Settings property is enabled, the Alert Manager will use the transport parameters specified in this alert and the default transport settings are ignored.


Figure 3: Setting properties for SMTP alert

JMS Alert

This alert will be used to notify an end user or a program via the JMS transport asynchronously. This transport is typically used to start a workflow based on this alert condition, and the default message content is in XML format which can be read/parsed by a system to execute a set of workflow actionables. The Fiorano Event Process can also be used to execute this workflow with the inbound listening to the destination defined in this alert.

Icon

All the property values described below appears after adding the JMS Alert.


Figure 4: Alert Manager with JMS alert details

Property Name

Description

Connection Factory

The name of the unified connection factory which needs to be used for creating the connection with the specified server.

Destination Name

The name of the destination on which the Notification message has to be published. This can be a topic or a queue and the corresponding destination type has to be specified.

Message Content Type

Text/Plain. The content type in which the message content has to be delivered.

Notification ID

The identifier for this notification.

Content MIME

The MIME of the content. Text/xml by default.

Message Body

The content of the notification.

Delivery Mode

The Mode of delivery. Persistent or non-persistent. Persistent messages are stored in the hard drive if the in-memory buffer is full and are guaranteed to be delivered.

Backup Provider URL

The URL of the backup server to connect if the primary URL is not available.

TimetoLive

TimetoLive property of the JMS Message created.

AutoCreateDestination

Specifies whether to create the destination if it is not present in the target server.

Destination Type

The type of the target Destination (Queue or Topic).

Message Priority

The priority of the JMS Message created.

Username

The username of the principal which will be authenticated while making connection with the server.

Password

The credential of the principal which will be authenticated while making connection with the server.

Use Transport

Specifies whether the transport settings specified in this alert to be used or the default server settings to be used. If true, the settings local to this alert will be used.

Creating New JMS alert

Click the Add  button on the upper-right part of the panel to add new alerts. A drop-down list of available transports is listed. On selecting the JMS Transport, the Add New JMS Alert window is displayed.


Figure 5: Setting properties for JMS alert

Editing/Removing Alert

Alerts can be edited by clicking the edit  icon and can be removed by clicking the remove  icon. Once the alert is edited, it will be saved into the repository and will be automatically picked up from the next execution of the alert. AlertID and the Alert Type cannot be modified. An Alert with the same and different type can be created by deleting the old alerts with the same id. 

Icon

When an alert is deleted where a policy is dependent on it, the policy execution will fail with error logs notifying the user about the system cannot find the specified alert.

Adaptavist ThemeBuilder EngineAtlassian Confluence