System Model > Alarms > Customize Alarm Pages > Alarm SOE Fields

Alarm SOE Fields

You can use any fields listed below (or a combination) to format an alarm SOE display. Those fields specific to the event journal can be archived.

Format the alarm SOE for an entire category of alarms by specifying field names in the SOE Format field of the Alarm Category Properties dialog box.

Note: To change the font and format of the system events on the SOE page, use alarm category 0 (zero).

You can also use the [Alarm]DefSOEFmt parameter to format the alarm SOE, particularly if your alarm SOE formats are to be the same.

Field Name

Description

Archived

{AcqDesc,n}

Textual representation of Alarm Acquisition Error.

No

{AcqError,n}

Acquisition error. Separate event (error code) in SOE.

No

{AlarmType,n}

Alarm type (text). "Digital", "Analog", "Advanced", "Multi-Digital", "Time Stamped", "Time Stamped Digital", "Time Stamped Analog"

No

{AlmComment,n}

Alarm comment

No

{Area,n}

Alarm area. Numeric value (integer)

No

{Category,n}

Alarm category. Numeric value (integer)

No

{Classification,n}

The class of the event. E.g:

Action—The event was logged due to an action being performed. An action can be triggered manually by an operator, or automatically.

Comment—The event was logged due to a comment being created.

Configuration—The event was logged due to configuration changes being made (for example, a new item being created, the configuration of an existing item being modified, an item being renamed or deleted from the database).

System—The event has been logged due to an occurrence that affects the entire system, such as the server being stopped and restarted. The System category is also used for miscellaneous events that are not suited to the other categories.

Alarm type - Type of Alarm e.g. Digital, Multi-digital etc

Yes

{Cluster,n}

The cluster to which the tag belongs.

No

{CUSTOM1,n}
{CUSTOM2,n}
{CUSTOM3,n}
{CUSTOM4,n}
{CUSTOM5,n}
{CUSTOM6,n}
{CUSTOM7,n}
{CUSTOM8,n}

Alarm custom fields from 1 to 8

No

{Date,n}

Part of event record time in event journal.

Yes

{DateExt,n}

Part of event record time in event journal.

Yes

{DeadBand,n}

Alarm deadband. For Analog, and Timestamped Analog alarms: Numeric value (real).

No

{Deviation,n}

Alarm deviation. For Analog, and Timestamped Analog alarms: Numeric value (real).

No

{Desc,n}

Alarm Description

Yes

{Equipment,n}

The name of the equipment the alarm is associated with.

No

{FullName,n}

The full name of the user (Full Name) who was logged on and performed some action on the alarm (for example acknowledging the alarm or disabling the alarm, etc.). When the alarm is first activated, the full name is set to "system" (because the operator did not trip the alarm). This field is not localized.

No

{Group,n}

Alarm group. For Argyle Digital (Multi-digital) alarms: Numeric value.

No

{Help,n

Alarm help. The name of the help page.

No

{High,n}

High Alarm trigger value

No

{HighHigh,n}

High High Alarm trigger value

No

{LocalTimeDate,n}

Alarm date and time in the form: "yyyy-mm-dd hh:mm:ss[.ttt]"

Yes

{LogState,n}

The last state that the alarm passed through. (This is useful when logging alarms to a device.)

Yes

{Low,n}

Low Alarm trigger value

No

{LowLow,n}

Low Low Alarm trigger value

No

{Message,n}

The event message.

Yes

{MilliSec,n}

Alarm milliseconds. Numeric value (integer)

Yes

{Name,n}

Alarm Name

No

{Native_SumDesc,n}

A description of the alarm summary, in the native language.

No

{Paging,n}

Alarm paged flag. A flag to indicate that the alarm is going to be paged. Values are 1 (TRUE) or 0 (FALSE).

No

{PagingGroup,n}

Paging group for alarm. A free form text field indicating the sequence of people to notify in the event the alarm occurred.

No

{Priority,n}

Alarm category priority. Numeric value (integer)

No

{Priv,n}

Alarm privilege. Numeric value (integer)

No

{Quality, n}

The IO server will pass the quality of the tag to the Alarm server when a tag's value is changed. If the changed tag value causes a state transition the alarm server will pass the quality to the database. This field displays the raw value (2 bytes numeric). The field TSQuality relates to this field and displays high byte of the 2 byte value in a string.

No

{Rate,n}

Alarm rate. For Analog, and Timestamped Analog alarms: Numeric value (real)

No

{ReceiptDate,n}

Date the master station received the event.For example, Date the RTU received the event.

 

{ReceiptLocalDateTime,n}

This field displays the alarm’s occurrence time (if known), otherwise it displays the receipt time of the alarm.

 

{ReceiptTime,n}

Time the event was logged into the database.

No

{State,n}

Current state of alarm.

Yes

{State_Desc,n}

The configured description (for example healthy or stopped) of a particular state. This description is entered when configuring the Multi-Digital Alarm Properties.

No

{State_Desc0,n}
{State_Desc1,n}
{State_Desc2,n}
{State_Desc3,n}
{State_Desc4,n}
{State_Desc5,n}
{State_Desc6,n}
{State_Desc7,n}

Argyle state 0-7. For Argyle Digital (Multi-digital) alarms: "OFF". For others: "INVALID"

No

{SumDesc,n}

Alarm description text. Analog alarm - Alarm state text. Otherwise - Configured event [or alarm in case event not defined] description.

No

{SumState,n}

Describes the state of the alarm when it occurred.

No

{Tag,n}

Alarm Tag
Note: If the Tag field is configured to support long names (up to 79 characters), it might cause overlap in an alarm display. Use a smaller display font if long names are expected.

Yes

{TagItem,n}

Alarm Tag with Cluster Name prefix

Note: If the TagEx field is configured to support long names (up to 79 characters), it might cause overlap in an alarm display. Use a smaller display font if long names are expected.

No

{TagEx,n}

Alarm source

Yes

{Time,n}

Alarm Time 12 hh:mm:ss [am|pm].
Note: works between: UTC time 1/1/1980 - UTC time 31/12/2037, otherwise ""

Yes

{TimeDate,n}

Special SQL formatted time. HH:MM:SS.

Note: The format can be configured in the citect.ini file by specifying TimeDate under the section [Alarm].

Yes

{TSQuality,n}

The IO server will pass the quality of the tag to the Alarm server when a tag's value is changed. If the changed tag value causes a state transition the alarm server will pass the quality to the database. The field displays high byte of the 2 byte value (available under the Quality field) in a string . Expected Timestamp Quality strings are: Time Good, Time Uncertain, Clock Not Synchronized, or empty string if no match is found.

Yes

{Type,n}

The type of alarm or condition: ACKNOWLEDGED, DISABLED, UNACKNOWLEDGED

Yes

{TypeNum,n}

Alarm type number (use AlarmType to get string value instead). Values are: -1 Invalid, 0 Digital 1, Analog 2, Advanced 3, Multi-Digital 4, ArgAna 5, User Event 6, timestamped 7, hardware 8, timestamped digital 9, timestamped analog

No

{UserLocation,n}

The IP address where the event was triggered.

Yes

{UserName,n}

The name of the user (User Name) who was logged on and performed some action on the alarm (for example acknowledging the alarm or disabling the alarm, etc.). When the alarm is first activated, the user name is set to "system" (because the operator did not trip the alarm).

Yes

Where n specifies the display field size.

 

See Also

Published June 2018