Shelve​.Group() method

The Shelve.Group() method shelves all alarms belonging to a specified provider and alarm group.

Syntax

AlarmClient.Shelve.Group("ProviderName", "GroupName",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.

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 by groups shown in the Alarm Control.

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.

Examples

AlarmClient1.Shelve.Group("\\TankServer1\Galaxy","Area_001", Duration=0.1;Reason=" + """" + "Shelved"+ """" + ";");

AlarmClient1.Shelve.Group("\Galaxy","Area_001",Duration=0.1; Reason=" + """" + "Shelved"+ """" + ";");

Remarks

For more information about specifying provider and group names, see Alarm queries.