Unshelve​.Tag() method

The Unshelve.Tag() method unshelves all shelved alarms that have the same tag names from the same provider and alarm groups and are within the same priority range.

Syntax

AlarmClient.UnShelve.Tag("ProviderName","GroupName","Tag",FromPriority,ToPriority,"Duration=<Duration>;Reason="+"<Reason>"+"UnShelved"+"<Description>"+";");

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 unshelved.

FromPriority

Three-digit starting point of the alarm priority range. The FromPriority value must be less than the ToPriority value.

ToPriority

Three-digit end point of the alarm priority range. The ToPriority value must be greater than the FromPriority value.

Duration

Duration must be set to 0 to unshelve alarms.

Reason

Explanation up to 200 characters for shelving the active alarms that belong to the same alarm severities as the alarms selected by the user.

An explanation is optional to unshelve alarms and the Reason parameter can be specified as Reason="" to indicate a null explanation.

Example

AlarmClient1.UnShelve.Tag("\Galaxy","Area_001","User_Defined_001.Attribute004.LoLo",1,999,"Duration=0;Reason="+""""+"UnShelved"+""""+";");

Remarks

For more information about unshelving alarms, see Unshelve Alarms.