•  IBM webMethods Adapter for SAP Documentation
  •  About This Help
    • Document Conventions
  •  IBM webMethods Adapter for SAP Installation and User’s Guide Documentation
    •  Overview of webMethods Adapter for SAP
      • What Is IBM webMethods Adapter for SAP?
      •  Functional Highlights
        • Complete SAP System Integration
        • Integrating SAP Systems Over the Internet
        • Routing IDocs, RFCs, and BAPIs
        • Support for IDoc- and RFC-XML
        • Support of BizTalk XML Envelopes for BAPI and RFC Calls
        • Support of Unified Error Handling of BAPIs and RFCs on the XML Level
        • Built-in BAPI Tools
        •  Maintaining Transaction Status Information
          • Shared Transaction Store in MySQL
          • Local Transaction Store in a File System
          • Centralized Transaction Store
          • Shared Transaction Store
      •  Architecture and Components
        • Basic Concepts
        • Invoking Business Logic
        • Sending Messages Through the Routing Listener
      • Adapter Package Management
      •  Adapter Connections
        •  Connection Pools
          • Run-Time Behavior of Connection Pools
        • Built-In Services for Connections
        • Changing the Connection Associated with an Adapter Service at Design Time
        • Changing the Connection Associated with an Adapter Service at Run Time
      • Adapter Services
      •  Adapter Listeners and Listener Notifications
        • Listeners
        • Listener Notifications
        • Choice of Publish Destinations
        • Service Execution Modes
      • Viewing the Adapter's Update Level
      • Controlling Pagination
    •  System Requirements
      • Overview
      • CPU
      •  Disk Space
        • Questions on Sizing
        • Local Transaction Store in a File System
        • Log Files
        • Example of Minimum Disk Space
      •  Memory
        • Questions on Sizing
        •  Initial Consumption
          • Consumption Per Session
          • Consumption for RFC Listeners
          • Payload
        • Example of Memory Usage
      •  Miscellaneous
        • Encryption
        • IDoc Packets
        • Logging
    •  Installing, Upgrading, and Uninstalling the adapter
      • Overview
      • Requirements
      • The Integration Server Home Directory
      • Installing Adapter for SAP
      • Post-Installation Steps to Configure Adapter for SAP to Use MySQL for Transaction Store
      • Upgrade Adapter for SAP 10.1 to use MySQL for Transaction Store
      •  Upgrading to IBM webMethods Adapter 10.1 for SAP
        • Upgrading from IBM webMethods Adapter 7.1 for SAP
        •  Upgrading from IBM webMethods Adapter 6.5 for SAP
          •  Manually Upgrading
            • Public Service API
            • Java IDoc API
      • Uninstalling Adapter for SAP
    •  Package Management
      • Overview
      •  Managing the Adapter Package
        • Package Dependency Requirements and Guidelines
        • Enabling Packages
        • Disabling Packages
        •  Loading, Reloading, and Unloading Packages
          • Reloading Packages Manually
          • Unloading Packages
        • Importing and Exporting Packages
        • Setting Package Dependencies
      • Controlling Group Access
      •  Using the Adapter in a Clustered Environment
        • What Is IBM webMethods Integration Server Clustering?
        •  About Clustering for Adapter for SAP
          • How Outbound RFCs Are Balanced
          • How Inbound RFCs Are Balanced
        • Configuring the Adapter in a Clustered Environment
        • Replicating Packages to IBM webMethods Integration Servers
        •  Clustering Considerations and Requirements
          • Requirements for Each Integration Server in a Cluster
          • Considerations When Installing Adapter for SAP Packages
          • Considerations When Configuring Connections with Connection Pooling Enabled
          • Considerations about Adapter for SAP Centralized Transaction Store or Shared Transaction Store
    •  Adapter Connections
      • Overview
      • Before Configuring or Managing Adapter Connections
      • Configuring Adapter Connections
      • Setting Up the SAP System for SNC Connections
      • Dynamically Changing a Service's Connection at Run Time
      • Enabling Adapter Connections
      •  Viewing Adapter Connections
        • Viewing Adapter Connections Using Integration Server Administrator
        • Viewing Adapter Connections Using Designer
      • Editing Adapter Connections
      • Copying Adapter Connections
      • Deleting Adapter Connections
      • Disabling Adapter Connections
      •  Testing the Execution of an RFC
        • Testing the Execution of an RFC-XML
      •  Testing the Execution of a BAPI Via XML
        • Starting to Browse
        • Displaying a List of Business Objects in the System
        • Displaying a Business Object
        • Displaying a BAPI
        • Displaying a BAPI Parameter
        • Displaying a Key Field
        • Generating XML Calls for a BAPI
        • Posting a BAPI from an HTTP Client
    •  Using Command Central to Manage Adapter for SAP
      • Configuration Types
      • Working with Adapter for SAP Configuration Types
    •  Adapter Services
      • Overview
      •  Creating an Adapter Service that Executes an RFC
        • Terminology
        • Creating an RFC Adapter Service
        • Testing the RFC Adapter Service
        •  Posting an RFC-XML Document from an HTTP Client
          • Invoking the RFC Adapter Service from a Browser
          • Invoking the RFC Adapter Service Using the pub.client.http Service
    •  Adapter Notifications
      •  Overview
        • Components of a Listener Notification
        • Monitor IDocs Flag
        •  Forward Confirm Event Flag
          • Action Equals 1
          • Action Equals 4
      • Creating an RFC Destination on an SAP System
      •  Listeners
        • Before You Configure New Listeners
        • Configuring an RFC Listener
        • Enabling Listeners
        • Testing the RFC Listener
        •  Viewing Listeners
          • Viewing Listeners Using Integration Server Administrator
          • Sorting and Filtering Listeners Using Integration Server Administrator
          • Viewing Listeners Using Designer
          • Viewing the Notification Order of a Listener
        •  Editing Listeners
          • Editing a Listener
          • Editing the Notification Order of a Listener
        • Copying Listeners
        • Deleting Listeners
        • Suspending Listeners
        • Disabling Listeners
      •  Listener Notifications
        • Before You Configure Listener Notifications
        • Dependencies for Listener Notifications
        •  Configuring Listener Notifications
          •  RFC Listener Notification (Synchronous)
            • Creating a Synchronous RFC Listener Notification
            • Configuring a Synchronous RFC Listener Notification
          •  ALE Listener Notification (Synchronous)
            • Creating a Synchronous ALE Listener Notification
            • Configuring a Synchronous ALE Listener Notification
          • Editing Synchronous Listener Notification Services
          •  RFC Listener Notification (Asynchronous)
            • Creating an Asynchronous RFC Listener Notification
            • Configuring an Asynchronous RFC Listener Notification
          •  ALE Listener Notification (Asynchronous)
            • Creating an Asynchronous ALE Listener Notification
            • Configuring an Asynchronous ALE Listener Notification
        • Enabling Listener Notifications
        • Testing Listener Notifications
        • Testing Publishable Document Types
        •  Viewing Listener Notifications
          • Viewing Listener Notifications Using Integration Server Administrator
          • Sorting and Filtering Listener Notifications
          • Viewing Listener Notifications Using Designer
        •  Editing Listener Notifications
          • Editing Document Types Used by the Listener
        • Deleting Listener Notifications
        • Disabling Listener Notifications
      •  Examples
        •  Creating a Synchronous RFC Adapter Notification
          • Creating a Function Module in an SAP System
          • Creating an RFC Adapter Notification
          • Testing the Product Retrieval Function
        •  Creating a Synchronous ALE Listener Notification
          • Create an Empty Flow Service Called mapOrders02
          • Create an Asynchronous ALE Listener Notification for IDoc Type Orders02
          • Define the Input and Output Signatures for the mapOrders02 Service
          • Map Fields from Orders02RequestDocument to PurchaseOrder Document
          • Testing the Listener Notification from the SAP System
          •  Setting Up the SAP System
            • Create an RFC Destination
            • Define a Logical Port
            • Create a Partner
            • Create a Partner Profile
            • Create a Distribution Model for the Partner and Message Type with SAP System 4.5 or Earlier
            • Create a Distribution Model for the Partner and Message Type with SAP System 4.6 or Later
    •  Generating Document Types
      • Generating Document Types for RFC Structure
      •  Generating Document Types for IDocs
        • Create an IDoc Document Type Using the DDIC
        • Generating an IDoc Document Type from an XML Document
        • Generating an IDoc Document Type from a DTD
        •  Generating a Document Type from a Sample IDoc
          • Saving a Pipeline Image Capturing the IDoc
          • Retrieving the Created Pipeline Image
    •  Routing Messages Through Adapter for SAP
      • Introduction
      •  Overview
        •  Components of a Routing Notification
          • Sender, Receiver, and Message Type
          • Forward Confirm Event Flag
        •  Routing Notification Order
          • Considerations for Routing Notifications
          • Using Wildcards as Routing Criteria
          • Example
          • Editing the Notification Order of a Listener
        • Routing the Message (Transport)
      •  Routing Notifications
        •  Configuring a Routing Notification
          • IS Transport
          • ALE Transport
          • RFC Transport
          • BAPI Transport
          • XML Transport
        • Disabling Routing Notifications
        • Deleting Routing Notifications
        • Editing a Routing Service
      •  Sending an RFC from an SAP System to Adapter for SAP
        •  The SBCHEADER Table
          • Example of Using an SBCHEADER Table
      •  Sending a BAPI from an SAP System to Adapter for SAP
        • Setting Up a Routing Notification for the XML Transport
        • Dynamic Routing Using the XML Transport
      • Sending IDocs with ALE from an SAP System to Adapter for SAP
      •  Routing RFCs Through Adapter for SAP
        • Posting RFC Based IFR-compatible XML Messages
        • RFC Based XML Messages Using IFR Format
        • Posting RFCs via FTP
        • Posting RFCs in an E-mail Message
      •  Routing BAPIs Through Adapter for SAP
        • Setting Up a Routing Notification and the BAPI Transport
        • Posting BAPI-based XML IFR-Compatible XML Messages
        • Transaction Control
        • BAPI XML Transaction Commit
        •  Synchronous Calls
          • Example
        •  Asynchronous Calls
          • Example
      •  Routing IDocs Through Adapter for SAP
        • Posting an IDoc-XML Document from an HTTP Client
        • Posting an IDoc via FTP
        • Posting an IDoc in an E-mail Message
        • Posting an IDoc from a Web Browser
        • Transmitting IDocs between Two Integration Servers
      •  Mapping IDocs to Other Formats
        • Creating an Empty Flow Service
        • Creating the Routing Notification
        • Creating a Document Type for Your IDoc
        • Transforming the IDoc to a Hierarchical Format
        • Mapping IDoc Information to Pipeline Variables
        • Defining Variables to which to Map Information from the IDoc
        • Testing the Mapping Service
      • Content-Based Routing and Mapping for IDocs
      •  Routing Arbitrary XML Documents Through the > Routing/Mapping
        • Configuring the Inbound Process Mechanism of the XML Transport
    •  Transaction Handling
      • Managing Transactions and the Transaction Store
      • Viewing Transactions
      • Deleting Transactions
      •  Automatic Cleanup of the Transaction Stores
        • Example
      • Configuration Parameters for the Transaction Manager
      •  Using the ALE Monitoring Features Via Adapter for SAP
        •  IDoc Trace
          • Overview
          • Prerequisites
          • Prepare Adapter for SAP for IDoc Trace
        •  Status Update Via ALEAUD IDoc
          • Preparation
          • Further Setup in Adapter for SAP
        •  Status Update Via SYSTAT IDoc
          • Overview
          • Set Up the Participating SAP Systems
          • Prepare Integration Server for Automatic SYSTAT IDoc
      •  Shared Transaction Store
        • Centralized Transaction Store
        • To migrate the CTS configuration into an STS configuration
        • Configuring a Shared Transaction Store
        • Configuring a Centralized Transaction Store (Server)
        • Configuring a Centralized Transaction Store (Client)
        • Viewing Centralized Store Configuration and Status
        • Removing the Configuration of a Centralized Transaction Store
      •  Transaction Store on MySQL
        • Enable the transaction store to use MySQL
        • Reverting Transaction Store to a File System
    •  Coding Client Applications and Services
      • Overview
      •  Invoking RFCs from Adapter for SAP
        • Calling Public Adapter for SAP Services from Java Services
      •  Receiving IDocs from an SAP System
        • Accessing and Modifying Fields in IDocs
        • Converting an IDoc to XML
      •  Constructing an IDoc with the SAP Java IDoc Class Library
        • Sending IDocs to an SAP System
      •  Transaction Features for HTTP and SAP-XML
        • Example: HTTP POST of an IDoc
      •  Calling a BAPI Synchronously from SAP System
        • Preparing a Routing Notification for the BAPI Call
        • Specifying a Second Routing Notification for the BAPI
      •  Calling a BAPI Asynchronously from an SAP System
        • Creating Similar Routing Notifications
        • Handling Inbound XML Message
        • Example of an XML
    •  Security
      • Adapter for SAP Configuration
      •  User Authentication Between Adapter for SAP and an SAP System
        • Authentication Through User Name and Password
        •  Authentication Through X.509 Certificate
          • Example
        • Authentication When Adapter for SAP Acts As an RFC-Server
        • Using Adapter for SAP with the SAP Cryptographic Library for SNC
      • Installing Adapter for SAP According to Your Security Policy
    •  Managing the DDIC Cache
      • Data DICtionary Cache (DDIC Cache)
      • Viewing Information in the DDIC Cache
      •  Removing Information from the DDIC Cache
        • Clearing the DDIC Cache for an SAP System
        • Clearing Elements from the DDIC Cache
    •  Managing SAP User Store
      • Managing the SAP User Store
      • Adding Entries to SAP User Store
      • Changing Entries in SAP User Store
      • Removing Entries from SAP User Store
    •  Predefined Health Indicator
      • Predefined Health Indicator
    •  Administrator APIs
      • Administrator APIs
    •  Configuration Variables Templates for Adapter Assets in Microservices Runtime
      • Configuration Variables Templates for Adapter Assets in Microservices Runtime
    •  Logging and Monitoring
      • Overview
      •  Logging
        • Output
        • Viewing and Deleting RFC Trace Files and SAP Log Files
      • Monitoring Statistics for Each Adapter for SAP Connection
      •  Monitoring Adapter for SAP Performance
        • Performance Output Information in the SAP Log File
        • Component Response Time Measurement
    •  Package Contents
      • Package Layout
    •  Adapter Configuration Parameters
      • General Adapter Settings
      • server.cnf
      •  Adapter Configuration Parameters
        • watt.sap.repo.maxPooledConnections
        • watt.sap.repo.timeout
        • watt.sap.repo.timeoutCheckPeriod
        • watt.sap.repo.maxWaitForPool
        • watt.sap.listener.checkTime
        • watt.sap.listener.responseTime
      •  Settings to improve performance
        • watt.sap.rfcxml.version
        • watt.sap.idocxml.escaping
        • watt.sap.xml.prettyPrint
        • watt.sap.xtn.fastAsyncMode
        • watt.sap.xtn.cacheFlushPeriod
        • watt.sap.xtn.cacheTimeToLive
      •  Settings to improve security
        • watt.sap.snclibpath
      •  Settings to monitor
        • watt.sap.throughput
        • watt.sap.monitor
      •  Settings to debug log
        • watt.sap.debug.CPICtrace
        • watt.sap.debug.sessionLog
      •  Settings for transaction store
        • watt.sap.xtn.cts.txstore
        • watt.sap.xtn.fileStore.threads
        • watt.sap.xtn.fallback
        • watt.sap.xtn.cacheFlushPeriod
        • watt.sap.xtn.cacheTimeToLive
        • watt.sap.xtn.fastAsyncMode
        • watt.sap.xtn.useSQL
        • watt.sap.xtn.sql_shared
        • watt.sap.xtn.sql_compression
      •  Setting for JCo options
        • watt.sap.jco.trace.dir
        • watt.sap.jco.timeout
        • watt.sap.jco.clientConnectTimeout
      •  Setting miscellaneous options
        • watt.sap.aclset
        • watt.sap.systat01.partnerNumber
        • watt.sap.idoc.usePartnerProfileRelease
        • watt.sap.systat01.idocLimit
        • watt.sap.fastTIDCreation
        • watt.sap.repo.check.interval
      •  Settings for backwards compatibility with IBM webMethods Adapter 4.6 for SAP
        • watt.sap.compatibility
        • watt.sap.ignoreCIMTYP
        • watt.sap.RFC.use46WrapperTypes
    •  ABAP Types in Adapter for SAP
      • ABAP Types
    •  Built-in Services
      •  SAP Client Services
        • pub.sap.client:connect
        • pub.sap.client:lockSession
        • pub.sap.client:releaseSession
        • pub.sap.client:invoke
        • pub.sap.client:invokeTransaction
        • pub.sap.client:createTID
        • pub.sap.client:confirmTID
        • pub.sap.client:getAttributes
        • pub.sap.client:getFunctionInterface
        • pub.sap.client:getStructureDefinition
        • pub.sap.client:getThroughput
        • pub.sap.client:sendIDoc
        • pub.sap.client:sendIDocLists
        • pub.sap.client:ping
      •  XRFC Services
        • pub.sap.rfc:decode
        • pub.sap.rfc:encode
        • pub.sap.rfc:createTemplate
      •  IDoc Services
        • pub.sap.idoc:encodeSDATA
        • pub.sap.idoc:decodeSDATA
        • pub.sap.idoc:encodeString
        • pub.sap.idoc:decodeString
        • pub.sap.idoc:iDocToDocument
        • pub.sap.idoc:documentToIDoc
        • pub.sap.idoc:iDocToTables
        • pub.sap.idoc:tablesToIDoc
      •  IDoc-XML Services
        • pub.sap.idoc:encode
        • pub.sap.idoc:decode
      •  Monitoring Services
        • pub.sap.monitor.aleaud01:swapSenderReceiverLS
        • pub.sap.monitor.idoc:trace
        • pub.sap.monitor.systat01:report
      •  bXML Services
        • pub.sap.bapi:decode
        • pub.sap.bapi:encode
        • pub.sap.bapi:createTemplate
      •  BAPI Services
        • pub.sap.bapi:commit
        • pub.sap.bapi:rollback
      •  Transaction Administration Services
        • pub.sap.transaction:createFunctionalPoolDriverAlias
        • pub.sap.transaction:copyTransactionsToDB
        • pub.sap.transaction:list
        • pub.sap.transaction:get
        • pub.sap.transaction:storeSize
        • pub.sap.transaction:getMessageBody
        • pub.sap.transaction:log
        • pub.sap.transaction:setCacheParameter
        • pub.sap.transaction:storeConfig
        • pub.sap.transaction:delete
        • pub.sap.transaction:deleteAll
        • pub.sap.transaction:sweep
      •  Transport Services
        • pub.sap.transport.ALE:InboundProcess
        • pub.sap.transport.ALE:OutboundProcess
        • pub.sap.transport.ALE:getRoutingInfo_Default
        • pub.sap.transport.IS:InboundProcess
        • pub.sap.transport.IS:OutboundProcess
        • pub.sap. transport.RFC:InboundProcess
        • pub.sap.transport.RFC:OutboundProcess
        • pub.sap.transport.XML:InboundProcess
        • pub.sap.transport.XML:OutboundProcess
        • pub.sap.transport.BAPI:InboundProcess
        • pub.sap.transport.BAPI:OutboundProcess
      •  Specifications
        • pub.sap.listener:listenerAuthorizationCheck
        • pub.sap.transport.ALE:aleRoutingInfo_Default
        • pub.sap.transport.ALE:aleRoutingInfo
        • pub.sap.transport.ALE:aleMappingInfo_Default
        • pub.sap.transport.ALE:aleMappingInfo
        • pub.sap.transport.XML:xmlRoutingInfo
      •  Sample Services
        • sample.sap:handleIDocXMLPost
        • sample.sap:handleRfcXMLPost
        • sample.sap:handlebXMLPost
        • sample.sap.Helpers:writeSAPXMLFile
        • sample.sap.Helpers:returnABAPException
        • sample.sap.Helpers:invokeBapiReturningBXml
        • sample.sap.Helpers:invokeAndReturnXml
        • sample.sap.Helpers:encodeRPCResponse
        • sample.sap.idoc.Mappings:orders
        • sample.sap.idoc.Mappings:ordrsp
      •  SAP Listener Services
        • pub.sap.listener:getAttributes
      •  SAP Utility Services
        • pub.sap.util:createTID
        • pub.sap.util:getListenerRuntimeStatus
      • IBM webMethods Adapter for SAP IDoc Java API
    •  Deprecated Services
      • List of Deprecated Services
    •  Working with Code Pages
      •  Using Different Code Pages
        • To Receive Data from HTTP, FTP, E-mail, or File
        • To Send Data Via HTTP, FTP, or E-mail or Save It to a File
        • To Encode Data from SAP Systems
    •  Using BizTalk Envelopes with Adapter for SAP
      • Overview
      •  Use of the BizTalk Header
        • Introduction to Standard BizTalk Header Fields
        • Representation of Routing and Address Information
        • Representation of SAP Transactions
        • Further BizTalk Header Fields
      •  Error Handling
        • Representation of Communication and Processing Errors
        • Representation of Application Errors
    •  Using IFR-XML Format with Adapter for SAP
      •  Overview
        • Use of XML Envelopes
        • Common Structure of Request and Response Documents
        • Common Way of Representing Parameters
        • Common Error Handling Concepts
      •  XML Format for BAPIs
        • Structure of Request Business Documents for BAPIs
        • Structure of Response Business Documents for BAPIs
        • Structure of Exception Business Documents for BAPIs
        • Exception Document for Return Structures
        • Exception Document for Return Tables
      •  XML Format for RFCs
        • Structure of Request Business Documents for RFCs
        • Structure of Response Business Documents for RFCs
        • Structure of Exception Business Documents for BAPIs
      •  XML Format for IDocs
        • XML Format for Manually Defined IDocs

IBM webMethods Adapter for SAP Documentation

XML Format for Manually Defined IDocs