BrowseAlarmClasses (RT Unified) - WinCC Unified

Description

The command "BrowseAlarmClasses" returns the alarm classes of the local HMI system or all HMI systems communicating via Runtime Collaboration.

Information on the general browse behavior of the command can be found in section Behavior of the browse commands.

Request

{"Message": "BrowseAlarmClasses", "Params": {"Filter": <String>, "Attributes"["<Attribute name>", ..., "<Attribute name>"], "SystemNames": ["<Name>", ..., "<Name>"]}, "ClientCookie": "<Cookie>"}

• Filter: Optional

  Restricts the command to alarm classes whose "Name" matches the filter.

  • Value: Filter string

    Permitted wildcards:

    Wildcard	Description	Example
    *	Replaces 0 to more characters	Filter string: "*Alarm" Alarm classes contained in the response: "Alarm" "SystemAlarm"
    ?	Replaces 1 character	Filter string: "Alarm_Prio_? Alarms contained in the response: "Alarm_Prio_1" "Alarm_Prio_2"

  • Default value: All alarm classes of the system specified by SystemNames are queried.

• Attributes: Optional

  Controls which attributes of the alarm class return the response:

  • Value: Comma-separated enumeration of attributes

    The response returns "Name" and "StateMachine" as well as the specified attributes.

  • Value: "*"

    The response returns the following attributes: Name, StateMachine, ID, Priority, NormalStateTextColor, NormalStateBackColor, RaisedStateTextColor, RaisedStateBackColor, RaisedStateFlashing, AcknowledgedStateTextColor, AcknowledgedStateBackColor, AcknowledgedStateFlashing, ClearedStateTextColor, ClearedStateBackColor, ClearedStateFlashing, AcknowledgedClearedStateTextColor, AcknowledgedClearedStateBackColor, AcknowledgedClearedStateFlashing

  • Default: The response returns "Name" and "StateMachine".

• System: Optional

  Controls from which system the tags are read.

  • Value: "*"

    All systems that communicate with each other via runtime collaboration

  • Value: Comma-separated list of systems that communicate with each other via runtime collaboration

    FOR EXAMPLE: "HMI_RT_1", "HMI_RT_2"

  • Default value: The local system

For example:

{"Message": "BrowseAlarmClasses", "Params": {"Filter": "*Alarm*", "SystemNames": ["HMI_RT_1"]}, "ClientCookie": "myBrowseAlarmClassRequest1"} //Browse for alarm classes in specified system with filter

Response

OnSuccess

NotifyBrowseAlarmClasses <System>::<Alarm class> ... <System>::<Alarm class>

For example:

NotifyBrowseAlarmClasses HMI_RT_1::Alarm HMI_RT_1::SystemNotification HMI_RT_1::SystemInformation HMI_RT_1::SystemAlarm HMI_RT_1::Notification HMI_RT_1::OperatorInputInformation

OnError

ErrorBrowseAlarmClasses <Error description>

For example:

ErrorBrowseAlarmClasses Invalid arguments passed to browsing function.