Connecting to the Adapter Monitor (SAP Library

Connecting to the Adapter Monitor

Use

The Adapter Framework uses the adapter monitor interfaces to display the status of the adapter, its channels, and its subcomponents to system administrators.

Recommendation

As of XI 3.0 SP17 and SAP NetWeaver 7.0 SP8, the adapter monitor is replaced by the communication channel monitor. However, the API and the user interfaces of the adapter monitor are still available to ensure that you can still run and monitor older adapter solutions. However, since the communication channel monitor has more functions (starting and stopping channels, alerting), we recommend an upgrade.

Interface Overview

Characteristic	Value
Name	Adapter Framework adapter monitor
Purpose	Queries the adapter status for display in the adapter monitor.
Type	J2EE service
Technical name	com.sap.aii.af.monitor.api
Certification	Optional
Syntax	See under path: JavaDoc (.\index.html) package com.sap.aii.af.monitor.api

Note

uml_monitor.wmf contains the class diagram in UML format. Open Word and import uml_monitor.wmf as a graphic.

Integration

● Call the adapter monitor from the Runtime Workbench on the SAP Exchange Infrastructure start page. Choose Component Monitoring and select an Adapter Engine as the component. On the Status tab page, choose Adapter Monitoring.

● You can call the adapter monitor at //localhost:50000/AdapterFramework/monitor/monitor.jsp. The JavaServer Pages application calls the interface specified here to display the adapter status data.

Features

● To display your adapter in the adapter monitor, you must register it in the Adapter Framework. You must use the same adapter name and namespace in the registration as were used to create the adapter metadata, or the name that was used for CPA callback registration.

In the example adapter, the adapter name is JCA and the namespace is http://sap.com/xi/XI/sample.

If an adapter is stopped, it must deregister itself. You can deregister an adapter by using the MonitorManager class in com.sap.aii.af.monitor.api.

● The AdapterMonitor interface specifies the getStatus() method, which is called by the adapter monitor when the corresponding adapter entry, as known in the CPA, is selected. getStatus() returns an array with AdapterStatusData lines in an object of the AdapterStatus class. This array lists the status of the adapter, its subcomponents, and its channels.

For example, you can return a status line for each communication channel and a general status line for each adapter. Depending on the adapter architecture, additional entries are possible.

If possible, return the current status of the adapter. Some adapter types do not implement a certain object for a communication channel because they listen to a port, for example, and use address data to determine the sender agreement dynamically. In such cases, the adapter may not manage the status of the communication channel and cannot return the status. However, the adapter should return a subcomponent status.

● In the adapter configuration in the Integration Directory, you have the option of activating or deactivating individual channels of an adapter. To do this, define the adapterStatusattribute in the adapter metadata:

Query the Active and Inactive values in your adapter.

If a channel is set to inactive, cancel message processing for this channel. This should also release reserved resources (port, files, and so on).

If a channel is set to active, continue the message processing.

<Name>adapterStatus</Name>

<Usage>optional</Usage>

<Default>active</Default>

<DataType>xsd:string</DataType>

<value>active</value>

<GuiLabels><Label language="EN">Active</Label></GuiLabels>

</FixedValue>

<value>inactive</value>

<GuiLabels><Label language="EN">Inactive</Label></GuiLabels>

</FixedValue>

</Attribute>

Caution

Adapter solutions that use the functions for starting and stopping from the communication channel monitor and previously provided this mechanism in the configuration in the Integration Directory (Adapter Status parameter (Active/Inactive)) must keep this mechanism to ensure compatibility with old communication channel configurations.