Class MessageHandler
Version 1.0
Modified 08-MAR-2026 11:05:32.00
 Specifies attributes to a single message handler.

 Every message handler job needs a MessageHandler
 object.
 Message Handler (Mh) Jobs in Different Nodes with their MessageHandler Objects

 If any MessageHandler object is not explicitly
 configured to a node it will likewise be created in the
 runtime system. In this case the attributes are
 assigned their default values. If the user does not
 accept these default values, please create a
 MessageHandler object below the node's $Node object,
 name it MessageHandler and assign desired values to the
 attributes.

 In connection with configuring of a $Node object the
 development environment normally configure a
 MessageHandler object as well.

Object graph


RtBody attributes pwr_sClass_MessageHandler
Boolean OutunitServer   Not yet implemented.
Boolean BlockFile   If true, current alarm blocking are stored to file
and recovered after a restart.
UInt32 EventLogSize   Size of event log.
Max number of events that can be stored in the event log.
UInt32 EventListSize   Specifies the maximum number of events that the node's
message handler contemporary will contain in its event
list, i.e. the skyline of the events. When NoOfEvents
exceeds MaxNoOfEvents the oldest event disappears from
the list.
UInt32 MaxApplAlarms   Specifies the maximum number of contemporary alarms to
any application job. The attribute is used to prevent a
single job from occupying whole event list of the
message handler.
UInt32 MaxSystemAlarms   Specifies the maximum number of contemporary system alarms.
The attribute is used to limit alarm allocation when
system alarms are not acknowledged.
Float32 DetectTimer   Cycle time for detecting alarm conditions for supervision
objects which detection is handled by the event monitor, that
is supervision objects that is not in a PlcPgm and not under
a signal object.
Float32 MessageTimer   Cycle time for reading status of supervision object and sending
alarm messages.
UInt32 AlarmFirstIdx  
UInt32 AlarmLastIdx  
UInt32 AlarmCount   The number of active alarms counted from time of boot.
UInt32 AlarmMaxCount  
UInt32 BlockFirstIdx  
UInt32 BlockLastIdx  
UInt32 BlockCount  
UInt32 BlockMaxCount  
UInt32 EventFirstIdx  
UInt32 EventLastIdx  
UInt32 EventCount   The number of events counted from time of boot.
UInt32 EventMaxCount  
UInt32 FreeCount  
Boolean ScanCycleSup  
Array of SystemSup SystemEvents   Alarms and events emitted by the system.
An array of supervisory objects that is triggered by various
system events or errors.


Template Object
EventListSize 100
MaxApplAlarms 50
MaxSystemAlarms 50
DetectTimer 1.0
MessageTimer 1.0
ScanCycleSup 1
SystemEvents[0].SystemEvent 0
SystemEvents[0].Description Link down event
SystemEvents[0].DetectOn 1
SystemEvents[0].DetectText Link down to node
SystemEvents[0].ReturnText Link up to node
SystemEvents[0].EventType 256
SystemEvents[0].EventPriority 67
SystemEvents[0].EventFlags 7
SystemEvents[1].SystemEvent 1
SystemEvents[1].Description Node up event
SystemEvents[1].DetectOn 1
SystemEvents[1].DetectText Node up
SystemEvents[1].ReturnText
SystemEvents[1].EventType 32
SystemEvents[1].EventPriority 67
SystemEvents[1].EventFlags 55
SystemEvents[2].SystemEvent 2
SystemEvents[2].Description Node restart event
SystemEvents[2].DetectOn 1
SystemEvents[2].DetectText Node restart initiated, node
SystemEvents[2].ReturnText Node restart completion, node
SystemEvents[2].EventType 256
SystemEvents[2].EventPriority 67
SystemEvents[2].EventFlags 7
SystemEvents[3].SystemEvent 3
SystemEvents[3].Description Outunit restart event
SystemEvents[3].DetectOn 1
SystemEvents[3].DetectText Outunit restarted, node
SystemEvents[3].ReturnText
SystemEvents[3].EventType 32
SystemEvents[3].EventPriority 67
SystemEvents[3].EventFlags 55
SystemEvents[4].SystemEvent 4
SystemEvents[4].Description Emergency break with reboot event
SystemEvents[4].DetectOn 1
SystemEvents[4].DetectText Emergency break reboot, node
SystemEvents[4].ReturnText
SystemEvents[4].EventType 256
SystemEvents[4].EventPriority 67
SystemEvents[4].EventFlags 7
SystemEvents[5].SystemEvent 5
SystemEvents[5].Description Emergency break with fixed output values event
SystemEvents[5].DetectOn 1
SystemEvents[5].DetectText Emergency break, fixed output values, node
SystemEvents[5].ReturnText
SystemEvents[5].EventType 256
SystemEvents[5].EventPriority 67
SystemEvents[5].EventFlags 7
SystemEvents[6].SystemEvent 6
SystemEvents[6].Description Emergency break with stop I/O
SystemEvents[6].DetectOn 1
SystemEvents[6].DetectText Emergency break, I/O stopped, node
SystemEvents[6].ReturnText
SystemEvents[6].EventType 256
SystemEvents[6].EventPriority 67
SystemEvents[6].EventFlags 7
SystemEvents[7].SystemEvent 7
SystemEvents[7].Description Simulate load event
SystemEvents[7].DetectOn 1
SystemEvents[7].DetectText Simulate load started, node
SystemEvents[7].ReturnText Simulate load completion, node
SystemEvents[7].EventType 256
SystemEvents[7].EventPriority 67
SystemEvents[7].EventFlags 7
SystemEvents[8].SystemEvent 8
SystemEvents[8].Description System status error event
SystemEvents[8].DetectOn 1
SystemEvents[8].DetectText System status error, node
SystemEvents[8].ReturnText
SystemEvents[8].EventType 256
SystemEvents[8].EventPriority 67
SystemEvents[8].EventFlags 7
SystemEvents[9].SystemEvent 9
SystemEvents[9].Description System status warning event
SystemEvents[9].DetectOn 1
SystemEvents[9].DetectText System status warning, node
SystemEvents[9].ReturnText
SystemEvents[9].EventType 256
SystemEvents[9].EventPriority 66
SystemEvents[9].EventFlags 7
SystemEvents[10].SystemEvent 10
SystemEvents[10].Description IO Soft error limit reached event
SystemEvents[10].DetectOn 1
SystemEvents[10].DetectText IO Soft error limit reached, node
SystemEvents[10].ReturnText
SystemEvents[10].EventType 256
SystemEvents[10].EventPriority 66
SystemEvents[10].EventFlags 7
SystemEvents[11].SystemEvent 11
SystemEvents[11].Description IO Hard error limit reached event
SystemEvents[11].DetectOn 1
SystemEvents[11].DetectText IO Hard error limit reached, node
SystemEvents[11].ReturnText
SystemEvents[11].EventType 256
SystemEvents[11].EventPriority 67
SystemEvents[11].EventFlags 7
SystemEvents[12].SystemEvent 12
SystemEvents[12].Description Application alarm quota exceeded event, node
SystemEvents[12].DetectOn 1
SystemEvents[12].DetectText Application alarm quota exceeded, node
SystemEvents[12].ReturnText
SystemEvents[12].EventType 32
SystemEvents[12].EventPriority 67
SystemEvents[12].EventFlags 55
SystemEvents[13].SystemEvent 13
SystemEvents[13].Description System alarm quota exceeded event
SystemEvents[13].DetectOn 1
SystemEvents[13].DetectText System alarm quota exceeded, node
SystemEvents[13].ReturnText
SystemEvents[13].EventType 32
SystemEvents[13].EventPriority 67
SystemEvents[13].EventFlags 55


Attributes detail


OutunitServer Attribute
Class Attribute
Type Boolean
Flags
Body RtBody
 Not yet implemented.

BlockFile Attribute
Class Attribute
Type Boolean
Flags
Body RtBody
 If true, current alarm blocking are stored to file
 and recovered after a restart.

EventLogSize Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Size of event log.
 Max number of events that can be stored in the event log.

EventListSize Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Specifies the maximum number of events that the node's
 message handler contemporary will contain in its event
 list, i.e. the skyline of the events. When NoOfEvents
 exceeds MaxNoOfEvents the oldest event disappears from
 the list.

MaxApplAlarms Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Specifies the maximum number of contemporary alarms to
 any application job. The attribute is used to prevent a
 single job from occupying whole event list of the
 message handler.

MaxSystemAlarms Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Specifies the maximum number of contemporary system alarms.
 The attribute is used to limit alarm allocation when
 system alarms are not acknowledged.

DetectTimer Intern
Class Intern
Type Float32
Flags
Body RtBody
 Cycle time for detecting alarm conditions for supervision
 objects which detection is handled by the event monitor, that
 is supervision objects that is not in a PlcPgm and not under
 a signal object.

MessageTimer Intern
Class Intern
Type Float32
Flags
Body RtBody
 Cycle time for reading status of supervision object and sending
 alarm messages.

AlarmFirstIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

AlarmLastIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

AlarmCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody
 The number of active alarms counted from time of boot.

AlarmMaxCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

BlockFirstIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

BlockLastIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

BlockCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

BlockMaxCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

EventFirstIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

EventLastIdx Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

EventCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody
 The number of events counted from time of boot.

EventMaxCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

FreeCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody

ScanCycleSup Attribute
Class Attribute
Type Boolean
Flags
Body RtBody

SystemEvents Attribute
Class Attribute
Type Array of SystemSup
Flags ARRAY | CLASS
Elements 14
Body RtBody
 Alarms and events emitted by the system.
 An array of supervisory objects that is triggered by various
 system events or errors.