Volume pwrb | |
Attributes: Runtime | Development | System | Template | Detail C Binding: Struct | Class  ClassTree | INDEX NO INDEX |
Class SystemSup![]() |
||
---|---|---|
Version | 1.0 | |
Modified | 15-JAN-2025 13:23:35.00 |
System Supervisory. SystemSup objects are used by the event monitor to send system events and alarms to outunits. All SystemSup objects are placed in the SystemEvent array in the MessageHandler object.See Also
RtBody attributes pwr_sClass_SystemSup | |||
---|---|---|---|
SystemEventTypeEnum | SystemEvent | Type of system event | |
String80 | Description | Description | |
Boolean | DetectOn | Specifies whether to enable or disable the action, | |
String80 | DetectText | Alarm message. Optional text which will be written out at alarm state if DetectOn is TRUE. |
|
String80 | ReturnText | Return message. Text which will be written in the event list at return to normal state. |
|
EventTypeEnum | EventType | Specifies the type of the message (=DetectText ) which will be sent at alarm state. ALARM -- 64 The message always requires an acknowledgement and sent to the alarm INFO -- 32 If the message requires acknowledgement is it sent to the info part of the alarm window and the event list, otherwise only |
|
EventPrioEnum | EventPriority | Priorities concerning alarm messages. -- 67 A-alarm; highest priority. (=43Hex) -- 66 B-alarm (= 42Hex) -- 65 C-alarm (= 41Hex) -- 64 D-alarm ; lowest priority. (=40Hex) |
|
EventFlagsMask | EventFlags | Bit map. A combination of flags can be attached to the message. The possible values are as follows: -- Return (1) If this flag exists the return message ReturnText will be sent to the event lists at the out units, -- Ack (2) If this flag exists the acknowledgement message will be sent to the event lists at the out-units, -- Bell(4) If the single out unit has a beep-function this will be activated when the message is received. -- Force (8) The message is sent to every out unit regardless -- InfoWindow (16) If the message is of the type INFO it will be placed in the event list. If this flag exists the message is also placed in the INFO square of the alarm window where acknowledgement is to be done. -- Returned (32) The alarm status is set to returned already when the alarm is emitted. -- NoObject (64) Not used -- Email (128) The message will be handled by the email server and forwarded to the specified receiver. -- SMS (256) The message will be handled by the SMS server and forwarded to the specified receiver. -- UserDetectTime (512) DetectTime is set by the user when the alarm condition is set. |
|
AttrRef | Sound | Reference to a sound object, that defines the sound at the operator place when the alarm is active. If no sound object is supplied, an ordinary beep is used. The sound object should be of class Sound or SoundSequence |
|
Text256 | MoreText | Optional text supplying more information about the event. The more text can for example contain actions to be made when an alarm is detected. |
|
String40 | Recipient | Recipient for epost and mms alarms. The recipient is a user defined in the user database in the current system group. Recipient can also be a list of users separated by comma, eg 'dennis, jimmy'. Also symbols defined in the Symbol table in the PostConfig object can be used. Symbols should be referenced with a $ sign before the symbol name, eg '$on_duty'. The users should be defined in the current system group or in a subgroup to this, If a subgroup is used, the subgroup should be specified in the recipient name, eg 'sms.dennis'. |
|
AttrRef | Attribute | Attribute is filled in by the user if the input named IN is left open. If the input is connected the names are filled in by the PROVIEW/R system at compilation. |
|
UInt32 | AlarmStatus | Status value. Bit map containing 16 bits where the 8 least significant bits denote the state and the 8 most significant bits the priority. The state is a combination of: -- 0 Normal state -- 1 Alarm state -- 2 Unacknowledged alarm The priority is one of the priorities EventPriority. The following status can exist: EventPriority + 1 => Priority + alarm state EventPriority + 3 => Priority + unacknowledged alarm and alarm state |
|
Time | DetectTime | Date and time when alarm state was detected. | |
Time | ReturnTime | Date and time when the last return to normal was detected. |
|
UInt32 | EventId | Event identity. |
Template Object | |
---|---|
EventType | 64 |
EventPriority | 67 |
EventFlags | 7 |
DetectOn | 1 |
SystemEvent Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | SystemEventTypeEnum | |
Flags | NOEDIT | CONST | |
Kropp | RtBody |
Type of system event
Description Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | String80 | |
Flags | ||
Kropp | RtBody |
Description
DetectOn Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | Boolean | |
Flags | ||
Kropp | RtBody |
Specifies whether to enable or disable the action,
DetectText Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | String80 | |
Flags | ||
Kropp | RtBody |
Alarm message. Optional text which will be written out at alarm state if DetectOn is TRUE.
ReturnText Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | String80 | |
Flags | ||
Kropp | RtBody |
Return message. Text which will be written in the event list at return to normal state.
EventType Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | EventTypeEnum | |
Flags | ||
Kropp | RtBody |
Specifies the type of the message (=DetectText ) which will be sent at alarm state. ALARM -- 64 The message always requires an acknowledgement and sent to the alarm INFO -- 32 If the message requires acknowledgement is it sent to the info part of the alarm window and the event list, otherwise only
EventPriority Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | EventPrioEnum | |
Flags | ||
Kropp | RtBody |
Priorities concerning alarm messages. -- 67 A-alarm; highest priority. (=43Hex) -- 66 B-alarm (= 42Hex) -- 65 C-alarm (= 41Hex) -- 64 D-alarm ; lowest priority. (=40Hex)
EventFlags Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | EventFlagsMask | |
Flags | ||
Kropp | RtBody |
Bit map. A combination of flags can be attached to the message. The possible values are as follows: -- Return (1) If this flag exists the return message ReturnText will be sent to the event lists at the out units, -- Ack (2) If this flag exists the acknowledgement message will be sent to the event lists at the out-units, -- Bell(4) If the single out unit has a beep-function this will be activated when the message is received. -- Force (8) The message is sent to every out unit regardless -- InfoWindow (16) If the message is of the type INFO it will be placed in the event list. If this flag exists the message is also placed in the INFO square of the alarm window where acknowledgement is to be done. -- Returned (32) The alarm status is set to returned already when the alarm is emitted. -- NoObject (64) Not used -- Email (128) The message will be handled by the email server and forwarded to the specified receiver. -- SMS (256) The message will be handled by the SMS server and forwarded to the specified receiver. -- UserDetectTime (512) DetectTime is set by the user when the alarm condition is set.
Sound Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | AttrRef | |
Flags | ||
Kropp | RtBody |
Reference to a sound object, that defines the sound at the operator place when the alarm is active. If no sound object is supplied, an ordinary beep is used. The sound object should be of class Sound or SoundSequence
MoreText Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | Text256 | |
Flags | ||
Kropp | RtBody |
Optional text supplying more information about the event. The more text can for example contain actions to be made when an alarm is detected.
Recipient Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | String40 | |
Flags | ||
Kropp | RtBody |
Recipient for epost and mms alarms. The recipient is a user defined in the user database in the current system group. Recipient can also be a list of users separated by comma, eg 'dennis, jimmy'. Also symbols defined in the Symbol table in the PostConfig object can be used. Symbols should be referenced with a $ sign before the symbol name, eg '$on_duty'. The users should be defined in the current system group or in a subgroup to this, If a subgroup is used, the subgroup should be specified in the recipient name, eg 'sms.dennis'.
Attribute Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | AttrRef | |
Flags | NOEDIT | |
Kropp | RtBody |
Attribute is filled in by the user if the input named IN is left open. If the input is connected the names are filled in by the PROVIEW/R system at compilation.
AlarmStatus Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | UInt32 | |
Flags | STATE | INVISIBLE | |
Kropp | RtBody |
Status value. Bit map containing 16 bits where the 8 least significant bits denote the state and the 8 most significant bits the priority. The state is a combination of: -- 0 Normal state -- 1 Alarm state -- 2 Unacknowledged alarm The priority is one of the priorities EventPriority. The following status can exist: EventPriority + 1 => Priority + alarm state EventPriority + 3 => Priority + unacknowledged alarm and alarm state
DetectTime Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | Time | |
Flags | STATE | INVISIBLE | |
Kropp | RtBody |
Date and time when alarm state was detected.
ReturnTime Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | Time | |
Flags | STATE | INVISIBLE | |
Kropp | RtBody |
Date and time when the last return to normal was detected.
EventId Attribute | ||
---|---|---|
Klass | Attribute | |
Typ | UInt32 | |
Flags | STATE | INVISIBLE | |
Kropp | RtBody |
Event identity.