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

Alarm Summary Fields

You can use any fields listed below (or a combination) to format an alarm summary display and an alarm summary device.

Format the alarm summary for an entire category of alarms by specifying field names in the Summary Format field of the Alarm Category Properties dialog box (category zero (0) being the default for all categories).

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

Field Name

Description

{AckDate,n}

The date when the alarm was acknowledged.

{AckDateExt,n}

The date (in extended format) when the alarm was acknowledged (dd/mm/yyyy).

{AckTime,n}

The time when the alarm was acknowledged.

{DeltaMilli,n}

Adds milliseconds precision to the DeltaTime.

{DeltaTime,n}

The time difference between OnDate/OnTime and OffDate/OffTime, in seconds.

{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).

{Native_SumDesc,n}

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

{OffDate,n}

The date when the alarm returned to its normal state.

{OffDateExt,n}

The date (in extended format) when the alarm returned to its normal state (dd/mm/yyyy).

{OffMilli,n}

Adds milliseconds to the time the alarm returned to its normal state.

{OffTime,n}

The time when the alarm returned to its normal state.

{OnDate,n}

The date when alarm was activated.

{OnDateExt,n}

The date (in extended format) when the alarm was activated (dd/mm/yyyy).

{OnMilli,n}

Adds milliseconds to the time the alarm was activated.

{OnTime,n}

The time when the alarm was activated.

{SumDesc,n}

A description of the alarm summary.

{SumState,n}

Describes the state of the alarm when it occurred.

{SumType,n}

Type of alarm summary (similar to alarm "Type"). Values are ACKNOWLEDGED, DISABLED, UNACKNOWLEDGED.

{UserDesc,n}

The text related to the user event. If you specify an asterisk '*' as the first letter of the tag argument in AlarmSumAppend, the field value is the text following the asterisk '*' in the tag argument.

{UserLocation,n}

The IP of the machine which last raised, performed an action on or modified the alarm.
Note: If the last action performed is from a System machine, the IP will not over ride the last user machine IP address.

{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, disabling the alarm, and so on). When the alarm is first activated, the user name is set to "system" (because the operator did not trip the alarm).

{Value,n}

Formatted alarm value.

Where n specifies the display field size.

Note: You can also include in your Alarm Summary any alarm display field other than State.

See Also

Published June 2018