Using the AR System API for integration
Typically, the AR System API is not linked directly to a third-party application. Instead, a separate program is created that interfaces with the AR System server using the AR System API and the third-party application. This interface program acts as a proxy between the two applications, and functions as a client to both sides.
Using APIs to link applications
The proxy client that links AR System with another application need not provide all of the features seen in AR System clients. Only the functions necessary for useful integration must be implemented. A proxy client must be able run as a background process with no user interfaces.
Related topic
For example:
A proxy client can 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 to the AR System server database, with no user interaction.
Similarly, a proxy client can 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.
Use case to integrate AR System server with a network management platform
AR System 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 the hosts. Each proxy client performs the following tasks:
- Implements the management platform API
- Gets the event messages and the AR System API
- Sends the information to a AR System server
- Creates 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
