Show TOC

Function documentationRaise Alert Locate this document in the navigation structure

 

You use this action to raise an alert.

Features

On the Configuration screen, you select the alert definition. All the properties of the alert definition except Delivery Transaction are displayed. You cannot edit or delete the follow-up actions and the container properties that are already defined in the Alert. You can only add a new follow-up action and container property. You can only edit or delete the actions defined by you in the alert action block.

You use the Raise Always check box to raise an existing alert.

If the check box is selected, an alert existing in the Alert Watchlist is raised again.

If the check box deselected, the system checks for an existing alert with the same name and status New. . If the status is New, the alert will not be raised. An alert is raised in case of the following status:

  • In Process

  • Acknowledged

  • Expired

The properties for this action are listed in the following table:

Parameter

Description

Input/Output

Type

ShortText

Provides list of values to be replaced against the placeholders defined in the definition.

Input and Output

List

LongText

Provides list of values to be replaced against the placeholders defined in the definition.

Input and Output

List

Follow-up Actions

Provides a map of additional follow-up actions other than the ones defined in the definition.

Input and Output

Map

ContainerProperties

Provides a map of additional container properties other than the ones defined in the definition.

Input and Output

Map

AlertPath

The alert object to which the action refers to. You have to provide the full path.

Note Note

This field cannot be null.

End of the note.

Input and Output

String

RaiseAlways

Indicates whether the alert has to be raised even if there the same alert existed on a previous occasion and still exists in the watch list.

Input and Output

Boolean

Severity

Defines the severity (Low/Medium/High) of the alert.

Input and Output

String

LastErrorMessage

Accessible for debugging and error handling and if the system encounters an error in the configured transaction, the message is returned to this property.

Output

String

Success

Determines whether the action passed or failed.

Output

Boolean