Table Of Contents

Query Alarms (With Transitions) (G Dataflow)

Last Modified: November 19, 2019

Searches the server for alarm instances that match the filter while obtaining the transition history of an alarm.

connector_pane_image
datatype_icon

configuration

Connection to the server.

datatype_icon

filter

Properties and values used to find and return matching alarm instances.

Wire Filter G Type to this input.

datatype_icon

only most recent?

Boolean that determines whether the server should return only the most recent instance of each alarm id.

datatype_icon

order of results

Order in which the results are sorted based on the updated at field of an alarm instance.

Name Description
Ascending Sorts the alarm instances returned in least to greatest order.
Descending Sorts the alarm instances returned in greatest to least order.

Default: Ascending

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

skip

Number of alarm instances to skip on the server.

Default: 0

datatype_icon

take

Number of alarm instances requested from the server.

If you leave skip and take empty, the query returns the first 1,000 results by default.

datatype_icon

alarms

Alarm instances matching the filter returned from the server.

datatype_icon

alarm information

Collection of notes about an alarm instance or group of alarm instances.

datatype_icon

total count

Total number of alarm instances matching the filter before taking skip and take into account on the server.

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