BrowseConfiguredAlarms (RT Unified) - WinCC Unified

Description

The "BrowseConfiguredAlarms" command returns "AlarmClass", "Name" and "Area" as well as optional further attribute values of the configured alarms of an HMI system or several systems communicating via Runtime Collaboration.

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

If the number of hits exceeds the page size of the response, the command consists of an initial request and 1 to N Next requests:

• You define the query in the initial request.

  It provides a response that delivers the first set of hits.

• You can call the remaining hits via Next requests.

Initial request

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

• LanguageId: Optional

  Controls in which language the alarm texts are returned.

  • Value: The language ID

  • Default value: The default language of the system from which the alarm originates

• Filter: Optional

  Restricts the command to alarms whose "Name" matches the filter.

  • Value: Filter string

    Permitted wildcards:

    Wildcard	Description	Example
    *	Replaces 0 to more characters	Filter string: "Motor*:Analog_Alarm" Alarms contained in the response: "MotorOn:AnalogAlarm" "MotorOff:AnalogAlarm"
    ?	Replaces 1 character	Filter string: "Motor_?:Analog_alarm" Alarms contained in the response: "Motor_1:Analog_alarm" "Motor_2:Analog_alarm"

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

• Attributes: Optional

  Controls which alarm attributes the response returns:

  • Value: Comma-separated enumeration of the attribute names

    The response returns "AlarmClass", "Name" and "Area" as well as the specified attributes.

  • Value: "*"

    The response returns the following attributes: Name, ID, SourceType, AlarmClassName, Priority, EventText, AlarmText1, AlarmText2, AlarmText3, AlarmText4, AlarmText5, AlarmText6, AlarmText7, AlarmText8, AlarmText9, InfoText, Group, Origin, Area

  • Default: The response returns "AlarmClass", "Name" and "Area".

• PageSize: Optional

  Controls how many alarms a response returns.

  Default value: The configured page size is used. See also section ReadConfig.

• SystemNames: Optional

  Controls from which system the alarms 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

• ClientCookie:

  Value: Name of the response cookie

For example:

{"Message": "BrowseConfiguredAlarms", "Params": {"LanguageId": 1033, "Filter": "*alarm_*", "Attributes": ["Priority"], "PageSize": 50, "SystemNames": ["HMI_RT_1"], }, "ClientCookie": "myBrowseAlarmsRequest1"}

Next request

{"Message": "BrowseConfiguredAlarms", "Params": "Next", "ClientCookie": "<Cookie>"}

For example:

{"Message": "BrowseConfiguredAlarms", "Params": "Next", "ClientCookie": "myBrowseAlarmsRequest1"}

Response

OnSuccess

{"ClientCookie": "<Cookie>", "Message": "NotifyBrowseConfiguredAlarms", "Params": {"AlarmClasses":[{"AlarmClassName":"<Value>", "Alarms":[{"AlarmClassName":"<Value>", "Area":<Value>, "Name":<Value>, "Name":<Value>, "Priority":<Value>}, {"AlarmClassName":"<Value>", "Area":<Value>, ...}], {"AlarmClassName":"<Value>", "Alarms":[{"AlarmClassName": "<Value>, ...}]}

For example:

{"ClientCookie":"myBrowseAlarmsRequest1", "Message":"NotifyBrowseConfiguredAlarms", "Params":{"AlarmClasses":[{"Name":"HMI_RT_1::Warning",

"Alarms":[{"AlarmClassName":"HMI_RT_1::Warning", "Area":"HMI_RT_1::Alarming", "Name":"HMI_RT_1::Tag6:Analog_alarm_2", "Priority":12}, {"AlarmClassName":"HMI_RT_1::Warning",

"Area":"HMI_RT_1::Alarming", "Name":"HMI_RT_1::AlarmTag_1:Discrete_alarm_1", "Priority":12}]}]}}

OnError

{"Message": "ErrorBrowseConfiguredAlarms", "ErrorCode": "<Code>", "ErrorDescription": "<Description>", "ClientCookie": "Cookie>"}

For example:

{"Message": "ErrorBrowseAlarms", "ErrorCode": "-2165323798 / -2165322773", "ErrorDescription": "Invalid system name.", or “Your browse request has been expired”, "ClientCookie": "myBrowseAlarmsRequest1"}