Reference (RT Unified) - WinCC Unified

The following section contains a reference of the properties of alarms and tags that you get with the commands ReadAlarm and ReadTag.

The commands transfer the property values as string.

Tag properties

"Name" property

Name of the tag

"Value" property

Value of the tag at the moment of the read operation.

"Quality" property

Quality of the read operation of the tag

Possible values:

• "Good"

• "Bad"

• "Uncertain"

"QualityCode" property

Quality code of the read operation of the tag

"TimeStamp" property

Time stamp of the last successful read operation of the tag

"Error" property

Error code of the last read or write operation of the tag

"ErrorDescription" property

Description of the error code of the last read or write operation of the tag

Alarm properties

"InstanceID" property

InstanceID for an alarm with multiple instances

"SourceID" property

Source at which the alarm was triggered.

"Name" property

Name of the alarm

"AlarmClassName" property

Name of the alarm class

"AlarmClassSymbol" property

Symbol of the alarm class

"AlarmParameterValues" property

Parameter values of the alarm

"AlarmText1" … "AlarmText9" properties

Additional texts 1-9 of the alarm

"ChangeReason" property

Trigger event of the modification of the alarm state

"Connection" property

Connection via which the alarm was triggered.

"State" property

Current alarm state

The property can contain the following values:

• "0": Normal

• "1": Raised

• "2": RaisedCleared

• "5": RaisedAcknowledged

• "6": RaisedAcknowledgedCleared

• "7": RaisedClearedAcknowledged

• "8": Removed

"StateText" property

Current alarm state as text, e.g. "active" or "inactive"

"EventText" property

Text that describes the alarm event.

"InfoText" property

Text that describes an operator instruction for the alarm.

"TextColor" property

Number with the text color of the alarm state

"BackColor" property

Number with the background color of the alarm state

"Flashing" property

Indicates whether the alarm flashes.

Values: "TRUE" or "FALSE"

"ModificationTime" property

Time of last modification to the alarm state

"RaiseTime" property

Trigger time of the alarm

"AcknowledgementTime" property

Time of alarm acknowledgment

"ClearTime" property

Time of alarm reset

"ResetTime" property

Time of alarm reset

"SuppressionState" property

Status of alarm visibility

"SystemSeverity" property

Severity of the system error

"Priority" property

Relevance for display and sorting of the alarm

"Origin" property

Origin for display and sorting of the alarm

"Area" property

Origin for display and sorting of the alarm

"Value" property

Current process value of the alarm

"ValueQuality" property

Quality of the process value of the alarm

"ValueLimit" property

Limit of the process value of the alarm

"UserName" property

User name of the operator control alarm

"HostName" property

Name of the host that triggered the alarm.

"ID" property

ID of the alarm that is also used in the display.

"AlarmGroupID" property

ID of the alarm group to which alarm belongs.

"SourceType" property

Source from which the alarm was generated, e.g. tag-based, controller-based or system-based alarm.

HmiAlarmSourceType SourceType { get; }

The enumeration "HmiAlarmSourceType" can contain the following values:

• Undefined (0)

• Tag (1)

• Controller (2)

• System (3)

• Alarm (4)

"DeadBand" property

Range of the triggering tag, in which no alarms are generated.

object DeadBand { get; }

"LoopInAlarm" property

Function that navigates from the alarm control to its origin.

string LoopInAlarm { get; }

"NotificationReason" property

Reason for the notification

The property can contain the following values:

• "O": Unknown

• "1": Add

  The alarm was added to the filtered result list. The alarm meets the filter criteria that apply to the monitoring.

• "2": Modify

  Properties of the alarm were changed, but the alarm is still part of the filtered result list.

• "3": Remove

  The alarm was part of the result list, but it no longer meets the filter criteria due to changes to its properties.

  Note Changes to the alarms will not result in notifications until the alarm again meets the filter criteria. In this case, "NotificationReason" is set to Add.

Note Removing an alarm from business logic The use case of the client determines whether the client ignores notifications via alarms with the "NotificationReason" Modify or Remove. For example: State-based monitoring: The client wants to show a list of incoming alarms. All notification reasons are relevant. The client removes an alarm from the list as soon as the notification reason is Remove. Event-based monitoring: The client wants to send an email when an alarm comes in. Only the notification reason Add is relevant.

Example:

A customer application begins monitoring with the filter criterion "State" = 1. An alarm is triggered. Runtime notifies the customer application of the "NotificationReason" as follows:

"Duration" property

Returns the time interval in nanoseconds between triggering of the alarm and its previous status change.