BrowseConfiguredAlarms (RT Unified) - WinCC Unified

Description

The "BrowseConfiguredAlarms" command returns the names of the configured alarms 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.

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

BrowseConfiguredAlarms <System> <Page size> --filter <Filter>

• System: Optional

  Controls from which system the alarms are read.

  • Value: "*"

    All systems that communicate with each other via runtime collaboration

  • Default value: The local system

• Page size: Optional

  Controls how many alarms a response returns.

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

• --filter <Filter>: Optional

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

  • --filter: Command line command

  • <Filter>: The 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 tags of the system specified by SystemNames are queried.

For example:

BrowseConfiguredAlarms * 100 --filter *Analog* // browse for alarms of all systems with filter and paging

Next request

BrowseConfiguredAlarms --next

Response

OnSuccess

NotifyBBrowseConfiguredAlarms <System>::<Alarm name> ... <System>::<Alarm name>

For example:

NotifyBrowseConfiguredAlarms HMI_RT_1::Motor_1:AnalogAlarm_1 HMI_RT_2::Motor_1:AnalogAlarm_1 HMI_RT_2::Motor_2:AnalogAlarm_1

OnError

ErrorBrowseConfiguredAlarms <Error description>

For example:

ErrorBrowseConfiguredAlarms A parameter is not valid or out of range.