Table Of Contents

Set Alarm (G Dataflow)

Last Modified: February 18, 2020

Triggers an alarm instance to notify subscribers of an issue or a state requiring attention when an application detects a condition.

Wire Clear Alarm after this node to clear the alarms associated with the alarm instance.

connector_pane_image
datatype_icon

configuration

Connection to the server.

datatype_icon

additional information

Variety of data about the new alarm instance, such as the application or user who created it and keywords and properties associated with it.

This node ignores this input when updating an existing alarm instance

datatype_icon

alarm id

Unique identifier for a process or condition tracked by an alarm. The Build Alarm ID node concatenates the names of the system and top-level VI where the rule triggered with the alarm name into a path.

For example, an alarm id may look like <system>.<namespace>.<alarm name>.

datatype_icon

set transition

State change and severity level that meet a specific condition to create or update an alarm instance.

Wire Build Alarm Set Transition to this input.

datatype_icon

display name

Title you want to give the alarm instance.

This node ignores this input when updating an existing alarm instance.

datatype_icon

channel

Resource associated with the alarm. For example, if an application sets an alarm because a wireless network went down, the channel could be the name of the network and the resource type classifies the alarm as the network.

This node ignores this input when it updates an existing alarm instance.

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

resource type

Type of resource associated with the alarm. For example, if an application sets an alarm because a wireless network went down, the channel may be the name of the network where the alarm triggered and the resource type may classify the alarm as the network.

This node ignores this input when it updates an existing alarm instance.

datatype_icon

alarm

Alarm instance created or updated.

datatype_icon

alarm instance created or updated?

Boolean that determines whether an alarm instance with the provided set transition already exists. If an alarm instance already exists or the current severity level already occurred, it returns False and alarm returns default data.

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