Alarm Viewer API Operation Overview

The CIMPLICITY Alarm Manager Resident Process (AMRP) is responsible for maintaining a centralized database of current alarms. Users may view and act on these alarms with the Alarm Viewer or an Alarm Viewer control embedded in a CimView screen.

These standard viewers:

  • Display alarms sorted by various criteria.
  • Filter alarms by time, alarm class, alarm state, and resource.
  • Allow a user to acknowledge, delete, and comment on alarms.

In addition, sets of sorting and filtering preferences can be created, saved, loaded, and edited. The Alarm Viewer API (AMV API) allows a process engineer or system integrator to develop full-featured custom alarm viewers to meet special needs.

Important: The Alarm Viewer API must send the short alarm length (32 characters or fewer) to perform operations even if the alarm is assigned a longer ID. Both the short, and, if it exists, the long alarm names are available via the API.

No changes need to be made to existing applications that use this API; the short alarm name will be in the alarmid field used by the AlarmInfo structure in previous versions (Applications will already be using the correct alarmid field.). If an application requires communication with CIMPLICITY v9.0 servers that have projects with long alarm names, the only change required will be for the application to use the new long_name field (from the AlarmInfo structure) when displaying alarm names to the user.