Table Of Contents

Acknowledge Alarm (Single) (G Dataflow)

Version:
Last Modified: November 14, 2019

Acknowledges an active alarm instance on the server.

An alarm instance remains active until you acknowledge and clear it. Typically, the application that sets the alarm clears it when the condition(s) that triggered the alarm no longer exist. An operator must acknowledge the alarm in the user interface or call this node.

Use Query Alarms to find alarm instances you want to acknowledge.

connector_pane_image
datatype_icon

alarm in

Active alarm instance you need to acknowledge.

datatype_icon

note

Information you want to include about the alarm acknowledgement.

datatype_icon

clear alarm

A Boolean that determines whether to clear an alarm without waiting for the application that set the alarm to do it.

Default: False

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

alarm out

Active alarm instance you acknowledged.

datatype_icon

acknowledged?

An array of Booleans that determine whether your team acknowledged the alarm instances.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Supported in VIs that run in a web application


Recently Viewed Topics