Using the AR System API for integration


Typically, the AR System API is not linked directly into a third-party application. Instead, a separate program is created that interfaces with the AR System server using the AR System API on one side and with the third-party application using its native interface on the other side. This interface program acts as a proxy between the two applications, functioning as a client to both sides.

Using APIs to link applications

UsingAPI.png

The proxy client that links AR System with another application does not need to provide all of the features seen in AR System clients such as Mid Tier. Only the functions necessary for useful integration need be implemented. A proxy client could run as a background process with no user interfaces. For example, a proxy client could be created to monitor a log file that a third-party application updates. Whenever new entries appear in the log file, the proxy client application could automatically submit new records into the AR System server database, with no user interaction. Similarly, a proxy client could monitor the AR System server database and periodically extract records and use them to create graphical reports or charts.

In addition to providing a means for custom clients to access the AR System server, the API can be used to integrate with existing AR System or legacy applications.

Network management platform integration accessories use case

BMC Remedy makes available a set of accessories that provide integration with network management platforms such as HP OpenView Network Node Manager, IBM NetView for AIX, and Oracle Solstice Domain Manager. The major portion of the integration consists of a set of proxy client applications that take selected events (such as alarms) identified by the management platforms and create trouble ticket records in an AR System server. There is a unique proxy client application for each management platform.

The management platform applications run on UNIX hosts. The proxy clients run as background processes on these hosts. Each proxy client implements the management platform API to get the event messages (on one side) and the AR System API (on the other side) to send the information to a AR System server and create a trouble ticket. Usually, a proxy client communicates with a management platform locally within the host system and communicates with a AR System server remotely across a network. However, if AR System and the management platform are running on the same host, everything can be implemented locally.

For example, for HP OpenView Network Node Manager, the proxy client is called arovd (AR System OpenView daemon). It was built using the HP OpenView Event API, so that it could register itself with the HP OpenView system and receive events. It was also built with the AR System API so that events of interest could be translated and stored as records in the AR System server database.

Integration of AR System with HP OpenView Network Node Manager


HP_OpenView.png