Shelve​.Tag() method

The Shelve.tag() method shelves all active alarms that originate from the same tag and belong to the same provider and alarm group within the same alarm priority range.

Syntax

AlarmClient.Shelve.Tag("ProviderName","GroupName","Tag"
FromPriority,ToPriority,Duration=Duration;Reason="Reason");

Parameters

ProviderName

Node and provider name combination that specifies the origin of alarm monitoring.

GroupName

Alarm group or area name whose alarms are monitored by the Alarm Control.

Tag

Name of the tag whose active alarms have been selected to be shelved.

FromPriority

Starting point of the alarm priority range (1-998). The FromPriority value must be less than the ToPriority value.

ToPriority

End point of the alarm priority range (2-999). The ToPriority value must be greater than the FromPriority value.

Duration

Length of time in hours that selected alarms are shelved. Duration can be specified as an integer or a floating point number greater than 0.

Example:

Duration=0.5

Reason

Explanation up to 200 characters for shelving alarms from the same tags.

An explanation can be delimited by double or single quotation marks. Quotation marks and back slashes (\) can appear within the text of an explanation. If an explanation is delimited by double quotation marks, a single quotation mark is simply a character in the string. If an explanation is delimited by single quotation marks, a double quotation mark is simply a character in the string.

Example

AlarmClient1.Shelve.Tag("\Galaxy","Area_002",
"UserDefined_002.Analog_003",1,999,"Duration=1.5;Reason=" + """" + "Shelved"+ """" + ";");

Remarks

For more information about selecting alarms to shelve, see Shelve alarms.