Adapter Framework

SAP XI 3.0Adapter Framework

SAP AG

Agenda

Adapter Framework Overview

Adapter Strategy

Adapter Modules and Development

Summary

SAP AG 2002, Title of Presentation, Speaker Name / 3

SAP XI 3.0 Architecture

Integration Repository / Integration Directory / System Landscape Directory

Integration Server

Partner ConnectivityKitOptional local

Adapter EngineCentral Adapter Engine

Business Process Engine

Integration Engine

Adapter FrameworkMessagingQueuing

Security Handling

Resource

Adapter

Resource

Adapter

Resource

Adapter

Adapter FWMessagingQueuing

Security Handling


Security Handling

PCK Configurationand Monitoring

HTTP

/IDoc

Adapter

FileDB

JMSSOAP

File/DB/JMSMarketplace

3rd Party Sys.


3rd Party Sys.

PlainJ2SE

Adapter Engine

Adapter

SAP &Non-

System


3rd Party Sys.


Adapter Framework based on SAP J2EE Engine

Adapter Framework provides common functionality for Adapter Engine and SAP Partner Connectivity Kit

Adapter Framework is based on SAP J2EE Engine as part of SAP Web AS

Adapter Framework inherits properties and features such as scalability, clustering, high availability, thread management, etc.

Adapter Framework provides its own queuing and logging services

Temporary stand-alone operation without connection to an Integration Server is possible, while still providing e. g. guaranteed exactly once messaging to and from connected application system


JCA enabled Adapter Framework

Adapter Framework supports J2EE Connector Architecture (JCA)

JCA is standard architecture for connecting the J2EE platform toEnterprise Information Systems (EIS), e. g. ERP, DBMS, etc.A Resource Adapter plugs into an application server, providing connectivity between the EIS and a Java applicationJCA enabled Adapter Framework provides defined interfaces to which both our adapters and 3rd party adapters can conformJCA is a widely accepted standard that 3rd party adapter providers are familiar with


Central configuration, administration, monitoring

Additionally Adapter Framework provides comprehensive integration for central configuration, administration, monitoring of deployed adapters

One single point of access, only one common UI, enhanced transparancyAllows to move/copy configuration from one Adapter Framework to another (transportable configuration):

To transport configuration from test landscape to productive landscapeFor high availability/failover

Avoid redundant maintenance, ensure consistencyEnd-to-end monitoring of the message flow over all SAP XI components / applications


SAP XI-Adapters vs. SAP XI-Proxies

ProxiesOutside-in development approachInterfaces designed centrally in Integration RepositoryConnect new SAP applications to SAP XINative connectivity to Application system (adapter-less)

AdaptersInside-out development approach Interface semantics externally pre-defined Connect existing (legacy) systems to SAP XISpecific wire protocol




Integration Server




Integration Engine


Security Handling

Resource

Adapter

Resource

Adapter

Resource

Adapter


Security Handling


Security Handling


HTTP

/IDoc

Adapter

FileDB

JMSSOAP


3rd Party Sys.


3rd Party Sys.

PlainJ2SE

Adapter Engine

Adapter

SAP &Non-

System


3rd Party Sys.


Full integration of Adapter Engine in SAP XI landscape

Adapter Engine is based on Adapter Framework

Adapter Engine fully integrated with the SAP XI landscapeCentral configuration of connections to application systems (through appropriate adapters) in Integration DirectoryReuse of Integration Directory’s existing versioning and transport capabilitiesCentral administration and monitoring over adapters, IntegrationServer, Integration Engine through Runtime Workbench

The Adapter Engine can be deployed centrally as part of Integration Server, or as optional local Adapter Engine on its own SAP J2EE Server; reasons for use of local Adapter Engine:

Protocol of Sender- / Receiver system (e.g. ftp not allowed)Performance, High AvailabilityOrganizational Aspects, IT requirements


Adapters for SAP XI

Adapters developed by SAPTechnical Adapters

File/FTP (File Systems / FTP Servers)JDBC (RDBMS systems)JMS (Messaging systems, e. g. MQSeries, SonicMQ)SOAP (Web Services)Plain HTTPMail (Mail Servers via SMTP, IMAP4, POP3)SAP Business Connector (SAP BC)Marketplace (mySAP Marketplaces)

Application AdaptersRFCIDoc

Industry Standard AdaptersRosettaNet (RNIF 2.0)CDIX (RNIF 1.1)


Adapters for SAP XI

Industry Standard Adapters are part of a Business PackageBusiness Package for RosettaNetOrder to Invoice Scenario:

PIP3A4 Request Purchase Order PIP3A7 Notify of Purchase Order UpdatePIP3A8 Request Purchase Order ChangePIP3A9 Request Purchase Order CancellationPIP3B2 Notify of Advance ShipmentPIP3C3 Notify of Invoice PIP3A6 Distribute Order StatusPIP3C6 Notify of Remittance Advice

Business Package for CIDXOrder to Invoice Scenario:

Order CreateOrder ResponseOrder ChangeShip NoticeInvoice

Business Packages include scenario descriptions, business processes, message interfaces, message types, mappings etc.


Adapters for SAP XI

SAP relies on a system of partners to provide adapters for otherapplications and certain industry standards

Adapter Reseller Agreement withiWay SoftwareSeeburger AGwebMethods

iWay adapters as well as Seeburger adapters for SAP XI 3.0 don’t require separate runtime: They run on top of SAP XI Adapter Framework

webMethod’s current adapter architecture requires a separate runtime

Partner adapters are sold and delivered through SAP

Technical support for the partner adapters via the SAP Support Portal, 24x7


Adapters for SAP XI

Adapters by iWay Software for SAP XI 3.0

Application AdaptersAriba BaanBroadvision ClarifyJD Edwards One World XE JD Edwards Worldi2 LawsonManugistics Microsoft CRMOracle Applications PeoplesoftQAD MFG Pro SiebelVantive

Industry Standard AdaptersUCCnet SwiftTransora


Adapters for SAP XI

Adapters by iWay Software for SAP XI 3.0 (cont’d)

Technical AdaptersAS1 (EDIINT/SMTP) AS2 (EDIINT/HTTP(S))BEA WLI COM+/DCOMLotus Notes CorbaTibco Rendezvous

Mainframe/transaction AdaptersCICS TMS/IMSTuxedo Telnet (3270)Telnet (5270)

Optionally further adapters can be added from a list of 160 iWayadapters, e. g. HL7, DB2, AS3, ebXML


Adapters for SAP XI

Adapters by Seeburger AG for SAP XI 3.0Technical EDI Adapters

AS2 (EDIINT/HTTP(S))Protocol: AS2OFTPProtocol: OFTP/ISDN, OFTP/TCPIPVAN AccessProtocol: X.400Generic EDIProtocol: OFTP/ISDN or X.400EDI Converter: ANSI X.12, EDIFACTMapping Templates: Purchase order, Order confirmation,

Dispatch advice, InvoicePayment (Financial Service Providers)Protocol: OFTP/ISDN, X.400EDI Converter: EDIFACT, SWIFTMapping Templates: Payment orders, Debit advice,

Credit advice, Account Statement

Support of Compression, Cryptography/Signature, Splitting, Analyzing …


Adapters for SAP XI

Adapters by Seeburger AG for SAP XI 3.0 (cont’d)Industry Specific EDI Adapters

Aerospace & Defense AutomotiveChemicals Consumer ProductsHigh-Tech PaperPharmaceutical Retail

Communication ProtocolsOFTP/ISDN, X.400, File Transfer

EDI Converter (EDI <-> XML)AECMA/SPEC 2000, ANSI X.12, EDIFACT, ODETTE, VDA

Mapping Templates within SAP XI RepositoryDelivery forecast, Dispatch advise, Invoice,Purchase order, Order confirmation

Support of Compression, Cryptography/Signature, Splitting, Analyzing …


Adapters for SAP XI

Adapters by webMethods for SAP XI

Application AdaptersBaan BroadvisionJDE World Software Oracle ApplicationsPeoplesoft Siebel

Industry Standard AdaptersRosettaNet CIDX

Current adapter architecture requires a separate runtime


Adapter Info on SAP Service Marketplace

SAP Service Marketplace: http://service.sap.com/xiSAP XI in Detail Connectivity Connectivity SAP XI 3.0

http://service.sap.com/xi


Adapter Configuration

Adapter independent parameters

Adapter specific parameters


Adapter Engine

Configurationcache

ISRuntime

AdapterSender

AdapterReceiver

Adapter Engine in SAP J2EE

Q

Administration

Security

Monitoring

Adapter-Specific

ComponentServices

TracingLogging

Module ProcessorEIS

Channel

´Messaging

Config.cache

End-to-End MonitoringMessage flow over all XI components / applications

Runtime Workbench• Uis for adminstration,

monitoring

Integration Builder / Directory:

... Receiver determination• Party->Service->Action

... Channel Definition:• Adapter Engine• Adapter Type• Message Protocol• Transport Protocol• Security• Channel Configuration

(Sender / Receiver Agreement:• Party/Service/Action <-> Channel

ConfigurationMaster

System Landscape Directory• Holds component description

including address data

AdapterFramework

Integration Repository• Holds Adapter metadataIntegration Repository• Holds Adapter metadata

http://<IntegrationServerURL>

XI Message

http://<AdapterEngineURL>

OK / Error


Remark: Future of SAP XI 2.0 Adapter Engine

SAP XI 2.0 Adapter Engine is available in SAP XI 3.0 as „Plain J2SE Adapter Engine“

Functional scope as in SAP XI 2.0:Adopted to the SAP XI 3.0 message protocolMinor maintenance issues, bug fixes

Recommendation:Use where platform requirements or limitations (hardware, operating system, JVM support) demand it

SAP XI 2.0 Adapter Engine works with SAP XI 3.0 landscapes, too




Integration Server




Integration Engine


Security Handling

Resource

Adapter

Resource

Adapter

Resource

Adapter


Security Handling


Security Handling


HTTP

/IDoc

Adapter

FileDB

JMSSOAP


3rd Party Sys.


3rd Party Sys.

PlainJ2SE

Adapter Engine

Adapter

SAP &Non-

System


3rd Party Sys.


SAP Partner Connectivity Kit Overview

Enablement of smaller companies / subsidiaries to exchange XML documents with their business partner’s / headquarter’s SAP XI

SAPPCK

SAP / 3rdParty Appl. SAP XI

Smaller Company / Subsidiary

SAPPCK

SAPApplication

3rd PartyApplication

Large Business Partner /Headquarter

Internet

Providing a platform for development of own JCA Resource Adapters


SAP PCK – Adapters

SAP Partner Connectivity Kit (PCK) is based on Adapter Framework

SAP PCK‘s objective is to enable XML document exchangebetween SAP XI and business partner not using SAP XI

SAP PCK also provides an extensible platform for developing and running individual JCA Resource adapters

Communication between SAP XI and SAP PCK is via SAP XI messaging protocol

SAP PCK Includes the following adapters: File/FTP, JDBC, JMS, SOAP, RFC, IDoc (once available for SAP PCK), Mail, SAP BC

Optionally SAP PCK can host further adapters that are available from SAP or 3rd party adapter providers


SAP PCK – Configuration, Mapping

SAP PCK is deployed on stand-alone SAP J2EE Engine (part of SAP Web AS) within business partner’s landscape

Configuration, administration, monitoring done locally on SAP PCK itself without need for an Integration Directory

Configuration UI provides same „look and feel“ as configuration UI of Adapter Engine

SAP PCK supports the development of message mappings using an integrated graphical mapping editor

Any source XML structure can be mapped to any target XML structureStandard functions are provided to perform calculations, Boolean comparisons, text mappings, and other transformationsOptionally the standard functions can be enhanced with user-defined functions in Java


SAP PCK – Configuration UI

ConfigurationUI to configure Party, Service, Communication Channel, Sender and Receiver agreementsSample screenshot for configuration of communication channel with adapter type ‚File / FTP‘

Agenda


Adapter Strategy


Summary


SAP Exchange Infrastructure - Openness

Integration of SAP and non-SAP applicationsAdapter Framework for comprehensive integration of adaptersAdapters are used for technical connectivityAdapter metadata, mappings are stored in Integration Repository


Dual Strategy

Dual connectivity strategyAdapter Framework for comprehensive integration of adapters to provide technical connectivity, including central configuration,administration, monitoring of adaptersInteroperability based on open standards (SOAP, JMS, HTTP(S)) tointeroperate with EAI providers

Value propositionStandardized interfaces allow easy integration of adapters from different partnersMinimum knowledge of SAP XI requiredComprehensive integration avoids redundant maintenance, ensures consistency, enhances transparancyOpenness to integrate non-SAP applications, 3rd party systems, etc.Reduced TCO


Certification

CertificationSAP NetWeaver Certification of 3rd party adapters based on the adapter framework

Value propositionQuality (stability, HA aspects, performance, etc.) of adapters is controlledCertification helps customers to find right solutionQuick and convenient search for a variety of certified products with the online partner and product directory (http://www.sap.com/partners/icc/services/index.aspx)Faster implementation time and lower integration costs through the use of tested 3rd party integrationReduced TCO

http://www.sap.com/partners/icc/services/index.aspx


Adapter Mappings, Metadata in Integration Repository

Adapter mappings and adapter metadata are stored in the Integration Repository

Centralized Integration Repository contains all relevant information for collaborative and integrative processesAll content adheres to open standards Adapters provide technical connectivity

Value propositionUse largest content catalogReduce costs in integration projectsReduce maintenance costsReduced TCO

Agenda


Adapter Strategy


Summary


Module Processor Concept

For every adapter it is possible to define generic modules in the module processor: possibility to extend the functionality of the specific adapter

Equivalent to the dispatcher classes in the J2SE adapter engine; migration and examples

The default module configuration for the certain adapter is displayed in the channel configuration

Modules are EJB‘s

Sequence matters!


SAP XI Adapter Module Chain

Custom modulescan be added to default modulechains

Additional configurationparameters canbe specified eachmodule


Module Processor Documentation

SAP Help Portal (http://help.sap.com)SAP XI Runtime Connectivity Adapters Module ProcessorFeedback: Mail to [email protected]

http://help.sap.com/


Development Environment

Adapter development, deployment and testing is possible on a single machine, no full-blown SAP XI is required.

For testing purposes integration scenarioscan be configured in SAP PCK(e.g. loopback scenario).

Installation of SAP PCK already contains a sample adapter (including Adapter Meta Data) that should serve as a starting point.

SAP Partner ConnectivityKit


Security Handling

Resource

Adapter



3rd Party Sys.


Adapter Development Documentation

SAP Help Portal (http://help.sap.com)SAP XI Runtime Connectivity Partner Connectivity Kit Adapter DevelopmentFeedback: Mail to [email protected]

http://help.sap.com/xi


Requirements for Adapters

If not supported, the definition of message types can be done in the SAP XI Integration Directory manually

OptionalMeta Data Exchange8

Adapters may use their own loggingOptionalLogging API7

Access to basic J2EE resources, e. g. transactions & multithreading, must be under control of J2EE server

MandatoryUtility Service6

Administration & MonitoringOptionalAdministrational Services

5

Unique configuration approach to manage adaptersMandatoryConfiguration Services4

SAP XI message and protocol conversion may be done entirely by the adapter; or as adapter specific module and being called in the AF module chain context

OptionalAF Adapter Specific Modules

3

Adapter must be able to receive messages from AF and forward them to connected system and vice versa

MandatoryAF Message Exchange2

Adapter must fulfill JCA 1.0 requirements (e. g. deployment) plus optional JCA 1.5 parts which are used by SAP XI

MandatoryJCA 1.0 conformance1

DescriptionCategorySAP XI AF InterfaceNum


Requirements for Adapters

Cluster-enabledConsider side-effects of clustering, e. g. „ExactlyOnceInOrder“: Avoid passing maneuvers

SpecializationBuild connection to exactly one type of business system or industrystandard protocol

DirectnessBuild connection to business system or industry standard protocoldirectly without any intermediate software components

SmoothnessLight-weighted, low footprint adapter, unnecessary system changes(many new or changed system DLL) should be avoided


Sample Adapter Source Code

Beside the API documentation a working sample adapter is shipped.

The source code is available after installation.

Analyzing the code helps understanding the SAP XI Adapter Framework.


SAP XI Adapter Metadata

Adapter Metadata (AMD)XML file defines all configuration parameterseach adapter

AMD can be uploaded intoSAP XI IntegrationRepository and SAP PCK

Configurationparameters are renderedinto the graphicalconfiguaration frontend


SAP XI Adapter Metadata Fragment I

<AdapterTypeMetaData version="09">

<Type>NAESB</Type>

<Inbound>

<TransportProtocol>

<ChannelAttributes>

<AttributeGroup>

<Name>CRYPT.Configuration</Name>

<GuiLabels><Label language="EN">Cryptographic Configuration</Label></GuiLabels>

<AttributeReference><ReferenceName>CRYPT.UseSigning</ReferenceName>

</Inbound>


SAP XI Adapter Metadata Fragment II

<Attribute>

<Name>CRYPT.UseSigning</Name>

<DataType>xsd:boolean</DataType>

<GuiLabels>

<Label language="EN">Use Signing</Label>

<Label language="DE">Verwendung von Signierung</Label>

</GuiLabels>

</Attribute>


SAP XI Adapter Configuration

Configuration attribute of type boolean is rendered to a check-box


SAP XI Adapter Metadata Upload (PCK)

Integration Repositorydoes not exist in case ofSAP PCK installations

The upload mechanismfor for Adaper Meta Datafor SAP PCK installationsrequires additonalparameters


SAP XI AF CPA Cache

The Adapter configuration is deployed from the configuration time(SAP PCK or SAP XI Integration Directory) to the J2EE serviceCPACache (Collaboration Profile Agreement).

The Adapter configuration can be accessed at runtime from withinadapter modules or JCA resource adapters via the CPACache API.

The two main use cases are implemented inLookupManager to retrieve adapter configuation andNormalizationManager to retrieve Party information.


Packaging SAP XI Adapter Components

SAP recommends to use SAP Software Deployment Manager (SDM) for deployment

Software Delivery Archives (SDA) can contain software components of different types (e.g. applications, libraries)

Detailed version information and dependencies to other components simplify program management


Adapter Certification Program

SAP Integration & Certification Centers (ICC) have initiated a certification program to ensure a standardized and aligned development process for adapters provided by third-party vendors.

Certified integrations are included in the SAP online partner and product directory http://www50.sap.com/softwarepartnerdir/directory_nav.asp-> Select By “Advanced Query” -> In the dropdown listbox“Search by... Certified Interface” select “SAP NetWeaver - XI Adapter Framework 3.0 (NW-XI-AF 3.0)”.

http://www50.sap.com/softwarepartnerdir/directory_nav.asp

http://www50.sap.com/softwarepartnerdir/directory_nav.asp

Agenda


Adapter Strategy


Summary


Summary

Adapter Framework runs on J2EE Stack of SAP Web AS

Adapter Framework is platform for Adapter Engine and SAP PCK

Adapter Framework provides an extensible platform for developing and running adapters in SAP XI environment

Adapter Engine utilizes central configuration, monitoring, administration

Dual connectivity strategyAdapter Framework for comprehensive integration of adaptersInteroperability via open standards to interop. with EAI providers

SAP NetWeaver Certification for adapters based on Adapter Framework available

Adapter mappings, metadata stored in Integration Repository


Important links for Process Integration

SAP Service MarketplaceSAP NetWeaver information: www.sap.com ->Solutions

-> SAP NetWeaver

SAP XI general information: quicklink /xi

SAP XI in Detail: quicklink /xi -> SAP XI in Detail -> SAP XI 3.0

BPM in SAP NetWeaver: quicklink /bpms


Copyright 2004 SAP AG. All Rights Reserved No part of this publication may be reproduced or transmitted in any form or for any purpose without the express

permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other

software vendors. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries,

pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered

trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium,

Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and

implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver and other SAP products and services mentioned herein

as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated

companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

Documents

Adapter Framework