Adapter Requirements
Use
The adapters that you develop for SAP NetWeaver Process Integration must meet certain requirements. SAP sets out these requirements to provide the customer with an adapter that is easy to use, configure, and manage.
Integration
The requirements that are defined as mandatory are also examined in the SAP certification process.
Features
Guidelines for Adapter Design
● Cluster-enabled
The SAP J2EE server allows clustering of a large number of J2EE application servers. Therefore, you must take the side effects of clustering into account during adapter design.
If the quality of service in your adapter is ExactlyOnceInOrder, the adapter must prevent queue-jumping, which is possible due to the parallel processing of multiple clusters of the same physical connection.
● Specialization
Your adapter must establish a connection to exactly one type of business system or industry transport protocol, for example, UCCnet, EDI, or CIDX.
● Direct connection
Your adapter must establish the connection to a business system or an industry protocol directly, that is, without using any other software.
● Lightweight
Your adapter must be “lightweight”. Avoid unnecessary and excessive changes (for example, a large number of new or changed system DLLs).
Using Adapter Framework Interfaces
Your adapter must or should use the following Adapter Framework interfaces:
Interface |
Comment |
Use Obligatory |
JCA 1.0-compliant |
Your adapter must meet the JCA 1.0 SPI requirements (for example, deployment, server contracts) and the optional JCA 1.0 requirements that are used by SAP NetWeaver Process Integration (for example, CCI). You can ignore the JCA 1.0 requirements that are not needed in Process Integration. |
Yes |
Adapter Framework message exchange See also: Message Exchange |
The minimum requirement for your adapter is connectivity. It must be able to receive messages from the Adapter Framework and forward them to the connected business system, and the other way round. |
Yes |
Adapter Framework adapter-specific modules See also: Message Exchange |
Program the specific message and protocol conversion either entirely within the adapter or implement it in adapter-specific modules. These modules are then called in the module processor. |
No |
Configuration services, see also: Adapter Configuration in the Integration Builder |
Without a uniform adapter configuration, customers, consultants, and technical support have difficulties in managing adapters. |
Yes |
Administration services See also: Administration |
Use of this API is not mandatory. However, it is advisable to integrate it in the common management and monitoring user interface of Process Integration. |
No |
Utility services See also: J2EE Resource Access |
The Adapter Framework utility service provides access to basic J2EE server resources, mainly to transactions and threads. These must be controlled by the J2EE server. Multi-threading and transaction use are both required in the adapters. |
Yes |
Logging API See also: Tracing, Logging, and Monitoring |
You can use separate logging mechanisms for your adapter. |
No |
Message data exchange See also: Message Metadata |
Message metadata
provides the structure definition of the XI message. You can also define
message types in the SAP XI Integration Repository. See also:
|
No |
External
Definitions