AlertServiceClient::resetOutOfService()

Removes out-of-service mode from datapoint elements, restoring the original alert class configuration.

Synopsis

int AlertServiceClient::resetOutOfService(dyn_string dpes, string reason = "");

Parameters

Parameter Description
dpes List of datapoint element paths to restore from out-of-service mode.
reason Optional reason text for the reset 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). Datapoint element not currently in out-of-service mode.

Details

The function restores the original alert class configuration on datapoint elements that were previously placed into maintenance mode. The maintenance alert classes (alarm-maint, warning-maint, info-maint) are swapped back to the original operational alert classes that were stored when out-of-service was applied.

After restoration, alerts are generated using the original alert classes and count toward operational KPIs.

Assignment

AlertService functions

Availability

CTRL