Table Of Contents

Set Alarm

Version:
Last Modified: November 14, 2019

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 VI to clear the alarms associated with the alarm instance.

spd-note-note
Note  

SystemLink Cloud does not support this VI.

HTTP configuration

HTTP connection to the server.

If you leave this input unwired, this VI uses the default connection and automatically retrieves your SystemLink Server credentials when you execute the application on a managed system or on the server.

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 VI ignores this input when updating an existing alarm instance.

alarm id

Unique identifier for a process or condition tracked by an alarm. The Build Alarm ID VI 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>.

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.

display name

Title you want to give the alarm instance.

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

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 VI ignores this input when it updates an existing alarm instance.

error in

Error conditions that occur before this VI runs. The VI responds to this input according to standard error behavior.

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 VI ignores this input when it updates an existing alarm instance.

alarm

Alarm instance created or updated.

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.

error out

Error information. This VI produces this output according to standard error behavior.

Recently Viewed Topics