Alert

This context lets you access and manage a single alert.

Unique Actions

[?]

Configure Alert

(Default Action)

This action is used to edit properties of alert.

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

Action Type:

Manage Pending Instances

This shows a list of pending alerts using Show Event Log UI Procedure. This action is normally used to acknowledge the pending alert instances in order to deactivate them.

Action Name:	pendingAlerts
Non-Interactive Mode:	Not Supported
Permissions:	Accessible at Observer permission level

Common Actions

[?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

Context States and Icons

Icon	Code	State
	0	Alert is enabled
	1	Alert is disabled
	2	Alert is active
	3	Alert is escalated

Advanced Information

Context Information

Context Type: alert

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.common.ALERT_NAME

Context Mask: users.*.alerts.*

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	Receiving the alert. Basic event monitoring. Status browsing.
Operator	Configuration browsing.
Manager	Alert configuration and removal.
Engineer	Same as Manager.
Administrator	Same as Manager.

Public Variables (Properties)

[?]

Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)

Alert Properties

See description of the variable and its fields here.

Variable Name:	childInfo
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String	1-50 characters
description	String	1-50 characters
enabled	Boolean
message	String	Nullable
permissions	String
persistState	Boolean

Triggers Activated By Events

See description of the variable and its fields here.

Variable Name:	eventTriggers
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
mask	String
event	String
filter	String
level	Integer
correlated	String
correlator	String
message	String

Triggers Activated By Variable State

See description of the variable and its fields here.

Variable Name:	variableTriggers
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
mask	String
variable	String
filter	String
monitorStateChange	Boolean
period	Long	Measured in milliseconds
delay	Long	Measured in milliseconds
level	Integer
deactivator	String
deactivationDelay	Long	Measured in milliseconds
message	String

Alert Notifications

See description of the variable and its fields here.

Variable Name:	notifications
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
notifyOwner	Boolean
notificationNecessityExpression	String
ackRequired	Boolean
sound	Data Block	Edited by Sound Editor
mailToOwner	Boolean
mailRecipients	Data Table
additionalMailRecipients	String
smsRecipients	Data Table

Alert Escalation

See description of the variable and its fields here.

Variable Name:	escalation
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
pending	Boolean
numberEscalation	Boolean
numberThreshold	Integer
timeEscalation	Boolean
timeThreshold	Integer

Automatic

Corrective Actions

See description of the variable and its fields here.

Variable Name:	alertActions
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
executionType	Integer
mask	String
action	String
input	Data Table
condition	String
runFromSource	Boolean

Interactive Corrective Actions

See description of the variable and its fields here.

Variable Name:	interactiveActions
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
executionType	Integer
mask	String
action	String
parameters	Data Table
runFromSource	Boolean

Alert Status

The variable contains different run-time alert parameters, such as number of pending alert instances. The variable is shown by View Status action.

Variable Name:	status
Records:	1
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
enabled	Boolean	Indicates whether alert is enabled.
pendingInstanceCount	Integer	Number of pending (non-acknowledged) alert instances.
maxPendingTime	Long	Life time of the oldest pending alert instance.
escalated	Boolean	Indicates whether alert is escalated.
escalationReason	String	Escalation reason(s).

Active Instances

This is a list of active and pending alert instances. Value of this variable is generated upon a read operation, so no update events are ever generated for it.

Variable Name:	activeInstances
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
event	Long	ID of alert event (hidden field).
type	Integer	Instance type: Active and Pending.
time	Date	Alert raise time.
level	Integer	Alert level.
source	String	Alert source context, i.e. context those event/state has originated the alert.
key	String	Key generated by the Record Key Expression of the Variable Trigger configuration.
message	String	Alert message.
trigger	String	Alert trigger message.
cause	String	Alert cause.
data	Data Table	Alert data.

Event Trigger Status

Table indicating statuses of individual event triggers. The variable is shown by View Status action.

Variable Name:	eventTriggerStatus
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
trigger	Integer	Zero-based trigger index in the Triggers Activated by Events table.
active	Boolean	Indicates whether trigger is active and fording alert to remain in active state.
details	Data Table	Contains details of trigger sub-status for each context matching trigger mask: Context path and description. Flag indicating whether trigger is active for the above context. Number of events registered within the last trigger Period (if trigger is activated by more than one event).

Variable Trigger Status

Table indicating statuses of individual variable triggers. The variable is shown by View Status action.

Variable Name:	variableTriggerStatus
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
trigger	Integer	Zero-based trigger index in the Triggers Activated by Variable State table.
active	Boolean	Indicates whether trigger is active and fording alert to remain in active state.
details	Data Table	Contains details of trigger sub-status for each context matching trigger mask: Context path and description. Flag indicating whether trigger is active for the above context. Time elapsed since the registration of activating condition (if inactive) or deactivating condition (if active). Once this time exceeds Period (or Deactivation Period), trigger will activate (deactivate). Flag indicating whether flapping is detected for the above context.

Public Functions

[?]

This context has no public functions.

Public Events

[?]

Common Events: info (Information), contextStatusChanged (Status Changed)

Alert

See description of the event and its fields here.

Event Name	alert
Permissions:	Accessible at Observer permission level
Expiration Period:	10 years
Records:	1

Record Format:

Field Name	Field Type	Notes
description	String	Alert description.
context	String	Context defining event/variable that has triggered an alert.
entity	String	Name of variable if alert was triggered by variable state/state change or name of event if alert was triggered by event
cause	String	Alert cause.
message	String	Alert message.
trigger	String	Alert trigger message.
data	Data Table	Alert data.
duration	Long	Alert duration. Has null value if alert is still active. Filled upon alert deactivation.

Deactivation

This event is fired when the alert is deactivated for a certain context.

Event Name	deactivation
Permissions:	Accessible at Observer permission level
Expiration Period:	10 years
Records:	1

Record Format:

Field Name	Field Type	Notes
id	Long	ID of an Alert event matching alert instance that was deactivated. This field is hidden.
context	String	Context for that the alert was deactivated.
duration	Long	Alert duration.
deactivatorData	Data Table	Data of deactivator event (when available).

DPF_EXPORT_V5.8.8 / TIME_1743710550 / 2025-04-03 20:02:30 / STRLEN_31263 / STRLEN_HTML_35498

{VERSION}

Was this page helpful?