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.
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 |
|---|---|
|
{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). |
|
{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). |
|
{UserDesc,n} |
The text related to the user event |
|
{OnDate,n} |
The date when alarm was activated |
|
{OnDateExt,n} |
The date (in extended format) when the alarm was activated (dd/mm/yyyy) |
|
{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) |
|
{OnTime,n} |
The time when the alarm was activated |
|
{OffTime,n} |
The time when the alarm returned to its normal state |
|
{DeltaTime,n} |
The time difference between OnDate/OnTime and OffDate/OffTime, in seconds |
|
{OnMilli,n} |
Adds milliseconds to the time the alarm was activated. |
|
{OffMilli,n} |
Adds milliseconds to the time the alarm returned to its normal state. |
|
{AckTime,n} |
The time when the alarm was acknowledged |
|
{AckDate,n} |
The date when the alarm was acknowledged |
|
{AckDateExt,n} |
The date (in extended format) when the alarm was acknowledged (dd/mm/yyyy) |
|
{SumState,n} |
Describes the state of the alarm when it occurred |
|
{SumDesc,n} |
A description of the alarm summary |
|
{SumType,n} |
Type of alarm summary (similar to alarm "Type"). Values are ACKNOWLEDGED, CLEARED, DISABLED, UNACKNOWLEDGED |
|
{Native_SumDesc,n} |
A description of the alarm summary, in the native language |
|
{Comment,n} |
A comment the operator adds to an Alarm Summary entry during runtime. The comment is specified using the AlarmComment() function. |
|
{Native_Comment,n} |
Native language comments the operator adds to an Alarm Summary entry during runtime. |
|
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