AlertServiceClient::shelveAlerts()
Shelves one or more alert instances, temporarily hiding them from the operator view for a specified duration.
Synopsis
int AlertServiceClient::shelveAlerts(dyn_atime alerts, time duration, string reason = "");
Parameters
| Parameter | Description |
|---|---|
| alerts | List of alert identifiers (datapoint element + alert time) to shelve. |
| duration | Dauer in Sekunden, nach der das Shelving der Meldungen automatisch aufgehoben wird. |
| reason | Optional reason text for the shelving action. Logged in the Security Event audit trail. |
Return value
Returns 0 on success, -1 on failure.
Errors
Missing or invalid arguments. Insufficient user permissions (bit 5 required).
Details
The function shelves the specified alert instances by setting the _add_value_5 attribute and _force_filtered to TRUE. All pending unacknowledged alerts on the affected elements are automatically acknowledged.
After the specified duration expires, the alerts are unshelved automatically. Use AlertServiceClient::unshelveAlerts() to manually restore alerts before the timer expires.
Assignment
AlertService functions
Availability
CTRL