iway iway Application Adapter for mysap ERP User s Guide Version Service Manager (SM) DN

Transcription

1 iway iway Application Adapter for mysap ERP User s Guide Version Service Manager (SM) DN

2 Cactus, EDA, EDA/SQL, FIDEL, FOCUS, Information Builders, the Information Builders logo, iway, iway Software, Parlay, PC/FOCUS, RStat, TableTalk, Web390, and WebFOCUS are registered trademarks, and Magnify is a trademark of Information Builders, Inc. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher s intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright 2009, by Information Builders, Inc. and iway Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.

3 iway Contents Preface...7 Documentation Conventions...8 Related Publications...9 Customer Support...9 Help Us to Serve You Better...9 User Feedback...11 iway Software Training and Professional Services Introducing the iway Application Adapter for mysap ERP...13 Features of the iway Application Adapter for mysap ERP...14 Supported Versions and Platforms...14 Classical SAP Technologies for ABAP...15 Integrating With SAP...16 Component Information for the iway Application Adapter for mysap ERP...17 Component Information Roadmap...18 iway Service Manager...18 iway Explorer...19 iway Business Services Provider...19 Enterprise Connector for J2EE Connector Architecture (JCA)...19 Web Services and Java Connector Architecture Functionality...20 Web Services...20 Java Connector Architecture Getting Started...23 Installing the iway Application Adapter for mysap ERP...24 Installing the SAP Java Connector (SAP JCo)...25 SAP JCo files by Platform...26 Installing SAP JCo on Windows Platforms...26 Installing SAP JCo on UNIX Platforms...27 Verifying the SAP Java Connector (SAP JCo)...27 iway Application Adapter for mysap ERP User s Guide 3

4 Contents Verifying SAP JCo on Windows Platforms...27 Verifying SAP JCo on UNIX Platforms...29 Identifying mysap Logon Parameters...31 User Parameters...32 System Settings (Application Server) Parameters...33 System Settings (Message Server) Parameters...34 Connection Pool Parameters...35 SAP Gateway Parameters...36 ALE Parameters...37 Global Processing Parameters...38 SNC Parameters...39 Verifying Connections to mysap...40 Verifying a mysap Client Connection...40 Verifying a mysap Server Connection Configuring SAP Inbound Processing...43 Overview...44 Configuring a Logical System...45 Configuring a Distribution Model...50 Defining a Partner Profile Creating XML Schemas for mysap...59 Overview...60 Starting iway Explorer (Servlet)...60 Establishing a Target for mysap...62 Creating a New Target...62 Connecting to a Target...71 Disconnecting From a Target...74 Modifying a Target...75 Deleting a Target...76 Viewing Application System Objects...77 Creating an XML Schema Creating and Publishing iway Business Services...87 Understanding iway Business Services iway Software

5 Contents Creating iway Business Services...88 Creating Business Services With iway Explorer...88 Identity Propagation Configuring the Event Adapter for SAP...99 Understanding iway Event Functionality Creating, Editing, or Deleting a Port Using the Default Event Port Creating, Editing, or Deleting a Channel Synchronous Event Processing Understanding SAP Events Overview Related Concepts and Terminology Client and Server Programs SAP Gateway Program IDs and Load Balancing Registering Your Program ID in SAPGUI Testing the SAP Event Adapter Application Link Enabling Configuration for the Event Adapter Document Processing Collected Inbound Configuration Testing the SAP ALE Configuration Configuring the Adapter in iway Designer Using the Adapter in iway Designer Configuring the Adapter in an iway Environment Configuring the Adapter in iway Service Manager Configuring the Adapter in Adapter Manager Troubleshooting Guidelines Identifying the Issue Design Time Connectivity Metadata iway Application Adapter for mysap ERP User s Guide 5

6 Contents RFC / BAPI IDoc Run Time Connectivity Service Scenario Event Processing Transactional Behavior Performance Issues Debugging Error Messages Error Messages in iway Explorer Error Messages in SAP Error Messages in JCA Error Messages in ibsp Adapter-Specific Error Handling Gathering Information Before Calling Customer Support Contacting Customer Support Reader Comments iway Software

7 iway Preface This documentation describes how to configure and use the iway Transaction Adapter for CICS. How This Manual Is Organized This manual includes the following chapters: Chapter/Appendix Introducing the iway Application Adapter for mysap ERP Getting Started Configuring SAP Inbound Processing Creating XML Schemas for mysap Creating and Publishing iway Business Services Configuring the Event Adapter for SAP Understanding SAP Events Configuring the Adapter in iway Designer Contents Provides an overview of the iway Application Adapter for mysap ERP. Describes key features and functionality of the adapter. Provides a quick start guide to use the iway Application Adapter for mysap ERP. Describes how to configure your SAP system for inbound (client) processing. Describes how to create XML schemas for SAP business objects using iway Explorer. Describes how to create and publish iway Business Services using iway Explorer. Describes how to create ports and channels to listen for SAP events using iway Explorer. Describes how to configure and test your SAP system for event processing. Describes how the adapter can be used within an iway Designer process flow. iway Application Adapter for mysap ERP User s Guide 7

8 Documentation Conventions 9 10 Chapter/Appendix Configuring the Adapter in an iway Environment Troubleshooting Guidelines Contents Describes how the adapter can be assigned to an iway Service Manager channel or iway Adapter Manager listener. Provides useful troubleshooting guidelines for the iway Application Adapter for mysap ERP. Documentation Conventions The following table lists and describes the conventions that apply in this manual. Convention THIS TYPEFACE or this typeface this typeface underscore this typeface Key + Key { } Description Denotes syntax that you must enter exactly as shown. Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option you can click or select. Indicates a default setting. Highlights a file name or command. Indicates keys that you must press simultaneously. Indicates two or three choices; type one of them, not the braces. Separates mutually exclusive choices in syntax. Type one of them, not the symbol. Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis points (...). Indicates that there are (or could be) intervening or additional commands. 8 iway Software

9 Preface Related Publications To view a current listing of our publications and to place an order, visit our World Wide Web site, You can also contact the Publications Order Department at (800) Customer Support Do you have questions about this product? Call Information Builders Customer Support Services (CSS) at (800) or (212) Customer Support Consultants are available Monday through Friday between 8:00 A.M. and 8:00 P.M. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Be prepared to provide your six-digit site code (xxxx.xx) when you call. You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, You can connect to the tracking system and knownproblem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section also provides usage techniques, diagnostic tips, and answers to frequently asked questions. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO. Help Us to Serve You Better To help our consultants answer your questions effectively, be prepared to provide specifications and sample files and to answer questions about errors and problems. The following tables list the environment information our consultants require. Platform Operating System OS Version JVM Vendor JVM Version The following table lists the deployment information our consultants require. iway Application Adapter for mysap ERP User s Guide 9

10 Help Us to Serve You Better Adapter Deployment Container Version Enterprise Information System (EIS) - if any EIS Release Level EIS Service Pack EIS Platform For example, JCA, Business Services Provider, iway Service Manager For example, WebSphere The following table lists iway-related information needed by our consultants. iway Adapter iway Release Level iway Patch The following table lists the types of iway Explorer. Specify the version (and platform, if different than listed previously) in the columns provided. iway Explorer Type Eclipse Embedded in iway Designer Version Platform The following table lists additional questions to help us serve you better. Request/Question Did the problem arise through a service or event? Provide usage scenarios or summarize the application that produces the problem. When did the problem start? Can you reproduce this problem consistently? Describe the problem. Error/Problem Details or Information 10 iway Software

11 Preface Request/Question Describe the steps to reproduce the problem. Specify the error message(s). Any change in the application environment: software configuration, EIS/database configuration, application, and so forth? Under what circumstance does the problem not occur? Error/Problem Details or Information Following is a list of error/problem files that might be applicable. Input documents (XML instance, XML schema, non-xml documents) Transformation files Error screen shots Error output files Trace files User Feedback Service Manager package to reproduce problem Custom functions and agents in use Diagnostic Zip Transaction log For information on tracing, see the iway Service Manager User's Guide. In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also go to our Web site, and use the Documentation Feedback form. Thank you, in advance, for your comments. iway Application Adapter for mysap ERP User s Guide 11

12 iway Software Training and Professional Services iway Software Training and Professional Services Interested in training? Our Education Department offers a wide variety of training courses for iway Software and other Information Builders products. For information on course descriptions, locations, and dates, or to register for classes, visit our World Wide Web site, or call (800) 969-INFO to speak to an Education Representative. Interested in technical assistance for your implementation? Our Professional Services department provides expert design, systems architecture, implementation, and project management services for all your business integration projects. For information, visit our World Wide Web site, 12 iway Software

13 iway Introducing the iway Application Adapter for 1 mysap ERP The following section provides an overview of the iway Application Adapter for mysap ERP. Topics: Features of the iway Application Adapter for mysap ERP Supported Versions and Platforms Classical SAP Technologies for ABAP Integrating With SAP Component Information for the iway Application Adapter for mysap ERP Web Services and Java Connector Architecture Functionality iway Application Adapter for mysap ERP User s Guide 13

14 Features of the iway Application Adapter for mysap ERP Features of the iway Application Adapter for mysap ERP The iway Application Adapter for mysap ERP is a remote function call adapter that provides a means to exchange real-time business data between SAP Enterprise Central Component (ECC) 5.0/6.0 systems and other application, database, or external business partner systems. The adapter enables external applications for inbound and outbound processing with SAP. The adapter uses XML messages to enable non-sap applications to communicate and exchange transactions with SAP using one of the following two methods. Service Adapter. Applications use this capability when they must initiate an SAP business event. Event Adapter. Applications use this capability if they require access to SAP data only when an SAP business event occurs. The iway Application Adapter for mysap ERP provides: Support for bidirectional message interactions. SAP object repository metadata browser support to build XML schemas and Web services to handle adapter requests or event data. Support for Remote Function Calls (RFC), Business Application Programming Interfaces (BAPI), and Intermediate Documents (IDoc) interfaces to SAP. Supported Versions and Platforms The following platforms are supported by the iway Application Adapter for mysap ERP: Windows Linux/Solaris/OS400 HP-UX AIX The iway Application Adapter for mysap ERP uses the SAP Java Connector (JCo) and the SAP RFC library to communicate with SAP ABAP server targets. To the extent these interfaces and their associated object types are supported, the adapter can function within the established protocols for the following object types: SAP ALE Intermediate Document (IDOC) Remote Function Call (RFC) Business API (BAPI) 14 iway Software

15 1. Introducing the iway Application Adapter for mysap ERP Other connection methods and interface types are not supported. The lowest application server release supported by the iway Application Adapter for mysap ERP is 4.6C. For more information about specific applications or servers, please consult your iway Software Customer Service Representative. SAP JCo Version 2.x is required for the iway Application Adapter for mysap ERP. The SAP JCo files are downloaded from the SAP Service Marketplace. A valid ID is required to access the SAP service marketplace. Please contact your SAP administrator for assistance. For the current release status of the SAP Java Connector (JCo), refer to SAP Note # in the SAP Service Marketplace. SAP JCo Version 3.0 is not supported for this release of the iway Application Adapter for mysap ERP. Note: SAP JCo files must match the JVM mode (32- or 64-bit). Strictly mixed mode JVM is not supported. It is possible to run the entire 32-bit stack on a 64-bit machine, but 64-bit can only be run on 64-bit machine types. For more information on installing the mysap ERP adapter, see Getting Started on page 23and the iway Installation and Configuration Guide. Classical SAP Technologies for ABAP The iway Application Adapter for mysap ERP is designed to provide standard access to SAP interfaces such as Remote Function Call (RFC) modules, BAPIs (Business Application Programming Interfaces), and IDocs (Intermediate Documents), that are used to support existing business processes. The adapter only supports Enterprise Central Components (ECC) that are accessed by classical SAP technologies. If you require support for additional SAP functionality and components, please contact your iway Software Sales Representative. These business components and methods are available to the adapter as requests of SAP and to the event adapter when SAP invokes its remote requests and work in the following ways: Business Application Programming Interfaces (BAPIs) are interfaces within the business framework that are used to link SAP components to one another or to third-party components. BAPIs are called synchronously and return information. Remote Function Call (RFC) Modules are SAP application interfaces that enable clients to invoke SAP technologies and receive responses. Note: Depending on the release or service pack installed, certain RFCs may not exist in your particular SAP system. Therefore, the examples included in this documentation may not be relevant to your system. If this is the case, you should use the examples as a general reference for adapter functionality and choose an RFC that exists within your SAP application environment. iway Application Adapter for mysap ERP User s Guide 15

16 Integrating With SAP As described in SAP Release Note , SAP Function Modules (RFCs) can be delivered with different release statuses. SAP supports only RFCs that are awarded with the Released for Customer status. There is no claim to the release independencies of the interfaces and the continued existence/functionality of the modules. For more information on the status of a specific function module, consult the SAP Service Marketplace. Intermediate Documents (IDocs) are the "logical messages" that correspond to different business processes. They enable different application systems to be linked by a messagebased interface. The IDoc type indicates the SAP format to use to transfer the data for a business transaction. An IDoc is a real business process in the form of an IDoc type that can transfer several message types. An IDoc type is described by the following components: Integrating With SAP Control records. A control record contains data that identifies the sender, the receiver, and the IDoc structure. An IDoc contains one control record. Data records. A data record consists of a fixed administration part and a data part (segment). The number and format of the segments can be different for each IDoc type. Status records. A status record describes the processing stages through which an IDoc passes. The following scenario is an example of IDoc functionality and its components: Purchase order number 4711 was sent to a vendor as IDoc number IDoc number 0815 is formatted in IDoc type ORDERS01 and has the status records "created" and "sent." The purchase order corresponds to the "logical" message ORDERS. You can use the iway Application Adapter for mysap ERP to invoke an SAP business process, for example, add/update account, or you can use the adapter as part of an integration effort to connect SAP and non-sap systems. All functions are processed synchronously, but all content in ALE IDocs is asynchronous. In service mode, the iway Application Adapter for mysap ERP can send requests to SAP using the BAPI, RFC, or ALE interfaces. The adapter quickly and easily integrates your SAP IDocs, RFCs, and BAPIs with mission critical SAP system applications and other enterprise applications. The benefits of the adapter include: Elimination of the requirement for custom coding. Consistent data representation. Provides a standard XML representation of event data and request/response documents for SAP. 16 iway Software

17 1. Introducing the iway Application Adapter for mysap ERP The developer is freed from the specific details of the SAP interface (BAPI, RFC, IDoc) and the specific configuration details of the target SAP system. Adherence to SAP ABAP serialization rules and SAP Interface Repository standards published by SAP AG. During event processing, the adapter receives RFCs and IDocs directly from SAP. The SAP system can be configured to send an IDoc or RFC to a logical system when a certain event occurs, in this case to the adapter. The output sent by SAP can be in any of the following forms: An RFC request, for example, RFC_SYSTEM_INFO. A BAPI request, for example, BAPI_COMPANYCODE_GETLIST. An IDoc. Component Information for the iway Application Adapter for mysap ERP In this section: Component Information Roadmap iway Service Manager iway Explorer iway Business Services Provider Enterprise Connector for J2EE Connector Architecture (JCA) The iway Application Adapter for mysap ERP works in conjunction with one of the following components: iway Service Manager iway Business Services Provider (ibsp) Enterprise Connector for J2EE Connector Architecture (JCA) When hosted in an iway environment, the adapter is configured through iway Service Manager and iway Explorer. iway Explorer is used to configure adapter connections, create Web services, and configure event capabilities. iway Application Adapter for mysap ERP User s Guide 17

18 Component Information for the iway Application Adapter for mysap ERP When the adapter is hosted in a third party application server environment, iway Explorer (used to configure SAP connections, create Web services, and configure event capabilities) can be configured to work in a Web services environment in conjunction with ibsp or JCA. When working in a JCA environment, the connector uses the Common Client Interface (CCI) to provide fast integration services using adapters instead of using Web services. Component Information Roadmap The following table lists the deployment component and the location of component information for the iway Application Adapter for mysap ERP. Deployed Component iway Service Manager iway Explorer iway Business Services Provider (ibsp) iway Enterprise Connector for J2EE Connector Architecture (JCA) For more information, see Chapter 9 of this guide iway Service Manager User's Guide Chapters 4, 5, 6, and 7 of this guide iway Service Manager User's Guide iway Installation and Configuration Guide iway Installation and Configuration Guide iway Service Manager iway Service Manager is the heart of the Universal Adapter Framework and is an open transport service bus. Service Manager uses graphical tools to create sophisticated integration services without writing custom integration code by: Creating metadata from target applications. Transforming and mapping interfaces. Managing stateless processes. Its capability to manage complex adapter interactions makes it ideally suited to be the foundation of a service-oriented architecture. 18 iway Software

19 1. Introducing the iway Application Adapter for mysap ERP iway Explorer iway Explorer uses a tree metaphor to introspect the SAP system metadata. The explorer enables you to create XML schemas and Web services for the associated object. In addition, you can create ports and channels to listen for events in SAP. External applications that access SAP through the iway Application Adapter for mysap ERP use either XML schemas or Web services to pass data between the external application and the adapter. iway Business Services Provider The iway Business Services Provider (ibsp) exposes as Web services enterprise assets that are accessible from adapters regardless of the programming language or the particular operating system. ibsp simplifies the creation and execution of Web services when running: Custom and legacy applications. Database queries and stored procedures. Packaged applications. Terminal emulation and screen-based systems. Transactional systems. Coupled with a platform and language independent messaging protocol called SOAP (Simple Object Access Protocol), XML enables application development and integration by assembling previously built components from multiple Web services. Enterprise Connector for J2EE Connector Architecture (JCA) The Enterprise Connector for J2EE Connector Architecture (JCA) enables developers of JCAcompliant applications to deploy adapters as JCA resources. The connector is supported on J2EE-compliant application servers, such as your application server. The Connector for JCA is distributed as a standard Resource Adapter Archive (RAR) for deployment to the application server. Thus, the connector can be used in systems that are non-compliant, although services such as pooled connections are not available. iway Application Adapter for mysap ERP User s Guide 19

20 Web Services and Java Connector Architecture Functionality Web Services and Java Connector Architecture Functionality In this section: Web Services Java Connector Architecture The following topics describe how the iway Application Adapter for mysap ERP can incorporate Web services and Java Connector Architecture technology. Web Services Web services enable SAP calls to be made across the Internet or an intranet, using specialized versions of the XML language that allow a developer to specify the parameters, connections methods, and remote calls and store them for reference in a repository. At run time, a person, an interface, or another function, can read this repository and automatically invoke the service. Web services currently do not have industry standards for transactional behavior. Web services are useful when your function calls must be made across firewall boundaries. Using Web services, you can use functions provided by external providers, assuming you know the function interface. Web Services Example: A Web service exposes the "cup" interface, which provides a teacup. The Acme Company exposes the "tea" Web service, which provides a brown liquid when the correct parameter "money" is provided. A cup of tea can be received by invoking the "tea" Web service and passing the "money" parameter. Additional components are not required to receive tea using the "tea" Web service. Java Connector Architecture Java Connector Architecture (JCA) provides a reusable component model to build and deploy multi-tier applications that are platform and vendor independent. JCA acts as a type of envelope or "container" that enables the adapter to run inside the application server and connect to SAP and immediately return the results. JCA is useful when your SAP system resides within a local intranet or is accessed directly. JCA implements JAVA Connection and Transaction models. JCA requires a resource adapter to be physically deployed on the host application server to access the remote EIS system. For more information on event capabilities of the JCA connectors, see Configuring the Event Adapter for SAP on page 99. For more information on installing and deploying both connectors, see the iway Installation and Configuration Guide. 20 iway Software

21 1. Introducing the iway Application Adapter for mysap ERP Using combinations of JCA and Web services is possible. For example, a JCA application can be invoked by a Web service or a Web service may be implemented inside a JCA container. The standards and protocols are still evolving. JCA Example An application server, "Table" implements the "tea" container, which contains "tea, gas heat, water, and cup". A JCA container can be deployed that contains tea in the "Table" application server. If any of the elements of the "tea" container are missing, for example, "gas heat," then no tea is produced. The container must physically possess the "tea, gas heat, water, and cup" components to receive the tea. iway Application Adapter for mysap ERP User s Guide 21

22 Web Services and Java Connector Architecture Functionality 22 iway Software

23 iway 2 Getting Started This section provides a quick start guide to use the iway Application Adapter for mysap ERP. Topics: Installing the iway Application Adapter for mysap ERP Installing the SAP Java Connector (SAP JCo) Verifying the SAP Java Connector (SAP JCo) Identifying mysap Logon Parameters Verifying Connections to mysap iway Application Adapter for mysap ERP User s Guide 23

24 Installing the iway Application Adapter for mysap ERP Installing the iway Application Adapter for mysap ERP How to: Install the iway Application Adapter for mysap ERP To install the iway Application Adapter for mysap ERP, you must select it during the iway installation. This section provides a quick walk through of the installation process. For more detailed information, see the iway Installation and Configuration documentation. Procedure: How to Install the iway Application Adapter for mysap ERP To install the iway Application Adapter for mysap ERP: 1. Start the iway installation by executing the iway60.exe file. The iway 6.01 installation wizard opens. 2. Click Next. The License Agreement pane is displayed. 3. Review the license agreement and click Yes to continue. The Customer Information pane is displayed. 4. Enter your user name, company name, and site code. 5. Select the user group that will have access to the installed product. Options include: 6. Click Next. Anyone who uses this computer (all users) Only for me (Admin) The Setup Type pane is displayed. 7. Click Next. The Choose Destination Location pane is displayed. 8. Select a different destination folder on your file system for iway or accept the default (C:\Program Files\iway60\). 9. Click Next. The Adapter Selection pane is displayed. 24 iway Software

25 2. Getting Started Important: By default, only the Technology Adapters group is selected. You must expand the ERP Adapters group and select MYSAP from the list of adapters to install the iway Application Adapter for mysap ERP. 10. Verify that MYSAP is selected in the ERP Adapters group. Note: iway Application System Adapter for SAP is included for SAP R/3 legacy support only (existing usage). All new installations using SAP are required to use the iway Application System Adapter for MySAP, which provides support for R/3 4.6C and 4.7, and SAP ERP ECC 5 &6. MySAP and SAP targets have incompatible formats and cannot be interchanged. All targets and schemas must be recreated, since there is no migration utility between these adapters. 11. Click Next and finish the remaining steps of the iway installation according to your requirements. For more detailed information, see the iway Installation and Configuration documentation. Installing the SAP Java Connector (SAP JCo) In this section: SAP JCo files by Platform Installing SAP JCo on Windows Platforms Installing SAP JCo on UNIX Platforms The SAP Java Connector (SAPJCo) is a component provided by SAP that enables the development of SAP-compatible components and applications in Java. SAP JCo is required by the iway Application Adapter for mysap ERP to support communication with the SAP Server in both directions: inbound calls (Java calls ABAP) and outbound calls (ABAP calls Java). This section describes how to install SAPJCo. Note: For the current release status of the SAP Java Connector, refer to SAP Note # in the SAP Service Marketplace. A valid SAP service ID is required to access this site. To download the current version, follow the information provided on the SAP Java Connector (SAP JCo) overview page. For more information, contact your SAP BASIS Administrator. Using the appropriate archive tool, open the archive containing the SAP Java Connector (SAP JCo) and extract the run-time files. iway Application Adapter for mysap ERP User s Guide 25

26 Installing the SAP Java Connector (SAP JCo) SAP JCo files by Platform Since the SAP JCo library files vary by operating system, the following section provides a useful reference that lists the required files by platform. Windows sapjco.jar sapjcorfc.dll librfc32.dll Linux/Solaris/OS400 sapjco.jar libsapjcorfc.so librfccm.so HP-UX AIX sapjco.jar librfccm.sl libsapjcorfc.sl sapjco.jar librfccm.so libsapjcorfc.so Installing SAP JCo on Windows Platforms On Windows, the librfc32.dll must be placed in the Windows\System32 directory. The sapjco.jar and sapjcorfc.dll files must be placed in the following directory: <iwaysmhome>\lib where: <iwaysmhome> Is the directory where iway Service Manager is installed. 26 iway Software

27 2. Getting Started Installing SAP JCo on UNIX Platforms On UNIX platforms, the directory in which the shared library files are located must be added to the shared library variable applicable to the operating system. The following is a list of platforms and associated variables: AIX LIBPATH HP-UX SHLIB_PATH Other UNIX Platforms LD_LIBRARY_PATH Verifying the SAP Java Connector (SAP JCo) In this section: Verifying SAP JCo on Windows Platforms Verifying SAP JCo on UNIX Platforms Once you have installed the SAP Java Connector (SAP JCo), as a best practice, you can verify the connector to make sure it is installed correctly and that all the required SAP JCo library files are available. Verifying SAP JCo on Windows Platforms How to: Verify SAP JCo on Windows This section describes how to verify SAP JCo on Windows platforms. Procedure: How to Verify SAP JCo on Windows Perform the following steps to verify SAP JCo on Windows: 1. Navigate to the following directory: <iwaysmhome>\lib iway Application Adapter for mysap ERP User s Guide 27

28 Verifying the SAP Java Connector (SAP JCo) where: <iwaysmhome> Is the directory where iway Service Manager is installed 2. Right-click the sapjco.jar file, select Open With from the context menu, and click Java 2 Platform Standard Edition binary. 28 iway Software

29 2. Getting Started The SAP Java Connector (JCo) dialog box opens, as shown in the following image. All the required information that pertains to the SAP Java Connector on your Windows platform is provided. 3. Once you have reviewed the SAP Java Connector files, click Close. Verifying SAP JCo on UNIX Platforms How to: Verify SAP JCo on UNIX This section describes how to verify SAP JCo on UNIX platforms. iway Application Adapter for mysap ERP User s Guide 29

30 Verifying the SAP Java Connector (SAP JCo) Procedure: How to Verify SAP JCo on UNIX Perform the following steps to verify SAP JCo on UNIX: 1. Navigate to a UNIX command prompt. 2. Type the following command: $ java -jar sapjco.jar -stdout 3. Press Enter on your keyboard. All the required information that pertains to the SAP Java Connector on your UNIX platform is provided, as shown in the following example SAP Java Connector (JCo) Copyright (c) SAP AG. All rights reserved. Version Information Java Runtime: Operating System: Java VM: Java Codepage: Versions: SunOS 5.7 for sparc beta3 Sun Microsystems Inc. ASCII JCo API: ( ) JCo middleware: ( ) JCo library: ( ) RFC library: Paths: JCo classes: JCo library: RFC library: /u4/fpgjpr/iway60/lib/sapjco.jar /u4/fpgjpr/iway60/lib/libsapjcorfc.so System-defined path Manifest Manifest-Version: 1.0 Ant-Version: Apache Ant iway Software

31 2. Getting Started Created-By: 1.3.1_18-b01 (Sun Microsystems Inc.) Specification-Title: SAP Java Connector Specification-Version: Specification-Vendor: SAP AG, Walldorf Implementation-Title: com.sap.mw.jco Implementation-Version: [2.1.8 ( )] Implementation-Vendor-Id: com.sap Implementation-Vendor: SAP AG, Walldorf Main-Class: com.sap.mw.jco.about $ 4. Review the information for the SAP Java Connector on your UNIX platform. Identifying mysap Logon Parameters In this section: User Parameters System Settings (Application Server) Parameters System Settings (Message Server) Parameters Connection Pool Parameters SAP Gateway Parameters ALE Parameters Global Processing Parameters SNC Parameters This section allows you to identify mysap logon parameters, which are used to configure a connection to mysap using the iway Application Adapter for mysap ERP. This information can be used as a reference. iway Application Adapter for mysap ERP User s Guide 31

32 Identifying mysap Logon Parameters User Parameters The following table lists and describes User parameters. Parameter Description Example Comment Client Identifies the SAP client. 800 In commercial, organizational, and technical terms, a selfcontained unit in an SAP system with separate master records and its own set of tables. A client can, for example, be a corporate group. User Sap login id. "abc123" User type for dialog-free communication between systems. Password Confidential authentication information. "xyz999" A protected word or string of characters that identifies or authenticates a user for access to an SAP system. Language Language "E" When you log onto the SAP system, you must select a valid installed language. CodePage A valid sap code page (normally, do not set this parameter as conversions are done automatically). If you select an unknown codepage, the RFC terminates with the error SYSTEM_FAILURE. In the case where two systems with different code pages exchange data with each other, and where these do not use Unicode code pages, the code page conversion is performed on the receiver system side. 32 iway Software

33 2. Getting Started Parameter Description Example Comment Authentication Mode How the connection is validated. Selection see next column. Password - use the value in the supplied field. SSO - specify the user to be $MYSAPSSO2$ and pass the base64 encoded ticket as the password parameter. X509 - specify the user to be $X509CERT$ and pass the base64 encoded certificate as the password parameter. Note: The user and password parameters that are mentioned here refer to the User and Password parameter fields in iway Explorer. System Settings (Application Server) Parameters The following table lists and describes System Settings (Application Server) parameters. Parameter Description Example Comment Application Server Connects to an ABAP application server. iwjpsap Application programs in an R/3 System are run on application servers. To obtain meta data information, a connection to a single application server is required. System Number Identifies a unique instance on the application server. 00 An application server may have different system numbers. Use the one provided by your administrator. iway Application Adapter for mysap ERP User s Guide 33

34 Identifying mysap Logon Parameters System Settings (Message Server) Parameters The following table lists and describes System Settings (Message Server) parameters. Parameter Description Example Comment Message Server Connects to an ABAP application server. iwjpsap For load balancing purposes, application servers from one SAP system are usually configured in logon groups, where each group serves a particular kind of user. The message server is responsible for communication between the application servers. It passes requests from one application server to another within the system. It also contains information about application server groups and the current load balancing within them. It uses this information to choose an appropriate server when a user logs onto the system. R/3 Name Identifies a unique instance. P47 Symbolic SAP system name used to identify the system. Server Group Indentifies the logon group. Logon group that the userid belongs with. 34 iway Software

35 2. Getting Started Connection Pool Parameters The following table lists and describes Connection Pool parameters. Parameter Description Example Comment Connection pool A name for a unique pool of client connections. "foo" A pool is a set of clientconnections to a certain destination with the same logon data. The pool automatically creates new connections to the specified remote system or returns an already existing one. The reusing of existing connections can increase the performance of your application by avoiding logging on to the remote server. Connection Pool Size Maximum number of connections for the pool. 10 Sets the maximum number of connections that can be allocated from the pool. Connection Timeout Maximum time to keep open a free connection (in minutes). 5 Connections that have not been used for at least the connection timeout interval will be closed. Connection Wait Time Maximum wait for a free connection. 30 (seconds) Sets the maximum time to wait in a connection request for a free connection. If the pool is exhausted, and there is still no connection available after the specified time, a JCO.Exception with the key JCO_ERROR_RESOURCE will be thrown. The default value is 30 seconds. iway Application Adapter for mysap ERP User s Guide 35

36 Identifying mysap Logon Parameters SAP Gateway Parameters The following table lists and describes SAP Gateway parameters. Parameter Description Example Comment SAP GateWay Host Enter the name of a SAP Gateway server. "isdsrv2" The SAP Gateway carries out CPI- C services within the SAP world, which are based on TCP/IP. These services enable SAP Systems and external programs to communicate with one another. SAP Gateway Service Enter the service name (usually a compound of the service name and system number). Sapgw00 Service name on the gateway host. Program ID A program identifier that has been specified on the SAP Gateway server (case sensitive). "S1PROG" Unique identifier for your communication session specified by your system administrator. The value entered in this field must match the one exposed on the gateway. 36 iway Software

37 2. Getting Started ALE Parameters The following table lists and describes ALE parameters. Parameter Description Example Comment EDI Version Specifies the ALE version of the target system. 3 Version "3" (Release 4.0 onwards) should be selected in the port description for all R/3 partner systems with Release 4.0 or higher. Version "2" (release 3.0/3.1) must be set in the port description for all R/3 partner systems with releases lower than 4.0. IDOC Release Specifies the version in which the IDOC definition was released. Blank or a specific SAP release version, e.g. "46C" You can assign segment definitions from previous releases to an IDoc type in the current release. This may be necessary if, for example, the partner is using an older release which supports your current IDoc type but not your current segment definitions. IDOC Release Provider Specifies where the adapter will get the release information. Selection see next column. IDOCDOREL uses the information in the IDOC header. SAP release gets the information from the user account logon. USERINPUT uses the IDOC release field above to get the information. iway Application Adapter for mysap ERP User s Guide 37

38 Identifying mysap Logon Parameters Global Processing Parameters The following table lists and describes Global Processing parameters. Parameter Description Example Comment Error Handling Specifies the error handling method of the adapter. Selection see next column. Creates error document writes an exception document with the full error text to the output destination. Throws exception creates a java exception, this may or may not display the full error text depending on the underlying component error. Commit with Wait Specifies the commit behavior. Selection see next column. Off - default Sends Commit Request to Application Server at the end of the document. If there is a commit error it will not be reflected back (Optimal performance). On (checked) - waits for a full database server commit at the end of the document before returning. Commit errors are reflected back to the adapter level (slowest performance). See your SAP DB admin for your site's recommended setting. TRACE Turns on the SAP Java connectors trace behavior. Selection see next column. Off default - only hard errors are written to the trace file (dev_rfc.trc) in append mode. ON - individual rfc*.trc and JCO*.trc are written for each request. Useful in finding errors, not recommended in a productive system. 38 iway Software

39 2. Getting Started SNC Parameters The following table lists and describes SNC parameters. Parameter Description Example Comment SNC mode Flag for activating SNC. 1 (on) Required. SNC library path Specifies the path and file name of the external library. C:\SAPJ2EE_Engine\SAPCryptolib\sapcrypto.dl The default is the system-defined library as defined in the environment variable SNC_LIB. SNC level Specifies the level of protection to use for the connection. Selection see next column 1: Authentication only 2: Integrity protection 3: Privacy protection (default) 8: Use the value from snc/data_protection/use on the application server 9: Use the value from snc/data_protection/max on the application server Default value = 3 SNC name Specifies SNC name. p:cn=sapj2ee O=MyCompany, C=US Although this parameter is optional, we do recommend setting it to make sure that the correct SNC name is used for the connection. SNC Partner Specifies the application server's SNC name. p:cn=abc, O=MyCompany C=US You can find the application server's SNC name in the profile parameter snc/identity/as. iway Application Adapter for mysap ERP User s Guide 39

40 Verifying Connections to mysap Verifying Connections to mysap In this section: Verifying a mysap Client Connection Verifying a mysap Server Connection This section allows you to verify a client and server connection to mysap to ensure that the iway Application Adapter for mysap ERP is installed and configured correctly. Verifying a mysap Client Connection How to: Verify a mysap Client Connection This section describes how to verify a mysap client connection. Procedure: How to Verify a mysap Client Connection To verify a mysap client connection: 1. Create a mysap target using iway Explorer. For more information on creating and connecting to mysap targets, see Creating XML Schemas for mysap on page Connect to the mysap target. 3. Expand the mysaptarget node. 40 iway Software

41 2. Getting Started 4. Expand the Business Object Repository node. 5. Expand Financial Accounting followed by CompanyCode. 6. Select the GetList method. 7. In the right pane, move the pointer over Operations to view the context menu. 8. Select Test Run. The Test Run dialog box opens. Note: You must have authorization for this component in SAP to proceed. The current valid objects are: Authorization Object: S_RFC RFC_TYPE = FUGR iway Application Adapter for mysap ERP User s Guide 41

42 Verifying Connections to mysap RFC_NAME = 0002 ACTVT = 16 Authorization Object: S_TABU_DIS DICBERCLS = V_T011 ACTIVITY = 03 If the data is present on the system, a list of valid company codes is displayed. Verifying a mysap Server Connection To verify a mysap server connection, have the RFC administrator run the Test Connection function in the RFC program administration transaction. 42 iway Software

43 iway 3 Configuring SAP Inbound Processing The following section describes how to configure your SAP system for inbound (client) processing. Topics: Overview Configuring a Logical System Configuring a Distribution Model Defining a Partner Profile iway Application Adapter for mysap ERP User s Guide 43

44 Overview Overview During inbound processing, IDocs are transferred to the interface and stored in the R/3 System. The document data is generated in a second step, also in the course of a workflow. The upstream system transfers an IDoc to the IDoc interface through the R/3 System port. For this reason, you are not required to specify a port in the inbound partner profiles. The IDoc interface must only "recognize" the upstream system as a port. A port definition, which provides a unique ID for the upstream system, must be available for the port. The technical parameters of this port definition can (and usually are) overwritten by the upstream system. The IDoc is "accepted," that is, saved in the database, if the upstream system is recognized. If your partner is defined with the corresponding message in your partner profiles, the IDoc is then processed further. This is done independently in a second step. This ensures that the external system can receive the data quickly and reliably (automatically).sap Remote Function calls require no system setup other than the Connection Target Parameters. If you do not intend to send IDocs to the SAP system, you may skip this chapter. In inbound IDoc processing, the adapter reads an XML document and creates an SAP Standard format IDoc. The adapter can optionally transform incoming data into the standard format through XML transformation or SAP ALE transformation. After assembled as an IDoc, the file is sent to SAP for inbound processing. Multiple IDocs can also be assembled into a larger document for efficient processing. For more information, see the SAP documentation. ALE IDocs used for transmission of Electronic Data Interchange (EDI) messages require information about the intended target and method of transmission stored on the SAP application server. An IDoc consists of a Header that contains sender, processing type, receiver and other information, and multiple data segments, which contain the information to be processed. To store the parameters for processing of the IDoc messages, SAP requires a "logical system" entry for each transmission system. The Logical System stores type information about the Partner and the kind of messages expected from the partner. The Partner Profile defines the kind of message and the type of SAP function called to process that particular IDoc in an application. SAP also requires a filtering model, whether or not it is used for a particular message, called a Distribution Model that defines a message type and applies optional segment filters. After these are established, Inbound ALE/IDoc processing can begin. The Control Section or reference structure file EDI_DC40 (defined in SAP ERP), must be completed and contains all the identifying information about the IDoc. The assembled header and data records are sent to SAP by the adapter. SAP does not require an incoming port to be specified. It takes the incoming RFC stream and assigns a port designation. In the Partner Profile, a function module must be identified to process the IDoc in the ERP system. 44 iway Software

45 3. Configuring SAP Inbound Processing Usually, IDocs are written directly to the database and slowly read by the application (for example, Purchasing for Purchase Orders). This can take time depending on the type of data and the application. The adapter can "post to the database and return" or "post and wait." This is defined in the Partner Profile on the host system. In either case, you may send a status IDoc message to obtain the status of your IDoc or use appropriate transaction codes in SAP to view the IDocs online. You must perform the following steps to configure SAP for inbound IDoc processing: 1. Configure a logical system. 2. Configure a distribution model. 3. Define an inbound partner profile. Configuring a Logical System How to: Configure a Logical System In a distributed environment, each participating system must have a unique ID to avoid confusion. In SAP, the name of the logical system is used as the unique ID. This name is assigned explicitly to one client in an SAP system. Procedure: How to Configure a Logical System The following image shows the /nsale transaction in the field under the menu bar. To configure a logical system: 1. Execute the sale transaction. iway Application Adapter for mysap ERP User s Guide 45

46 Configuring a Logical System The Display IMG window opens as shown in the following image. a. Expand Sending and Receiving Systems and then, Logical Systems. b. Select Define Logical System. 2. Click the IMG - Activity icon. An information window appears that informs you that the table is cross-client as shown in the following image. 3. To continue, click the checkmark icon. 46 iway Software

47 3. Configuring SAP Inbound Processing The Change View "Logical Systems" window opens with a list of logical systems and their names as shown in the following image. 4. Click the New entries button. iway Application Adapter for mysap ERP User s Guide 47

48 Configuring a Logical System The New Entries window opens where you can type information for the logical system and its corresponding name as shown in the following image. a. In the Log.System column, type the Logical System, for example, IWAY_IN. b. In the Name column, type a corresponding description. 5. Click Save. The Prompt for Workbench request window opens as shown in the following image. It includes fields for View maintenance and Request as well as several buttons. 6. Click the Create Request icon. 48 iway Software

49 3. Configuring SAP Inbound Processing The Create Request window opens as shown in the following image. It includes fields that are already populated (such as Owner, Status, Last Changed, Source client, and so forth), empty fields (such as Request and Project) in which to specify information about your request, and a Tasks list. a. In the Request field, type a name. b. In the Short description field, type a brief description of your request. 7. Click Save. The logical system you configured, for example, IWAY_IN, appears in the list as shown in the following image. iway Application Adapter for mysap ERP User s Guide 49

50 Configuring a Distribution Model Configuring a Distribution Model How to: Configure a Distribution Model A distribution model is used to describe the ALE message flow between logical systems. Business objects are distributed to connected recipients according to a unique distribution model that can contain rules of varying complexity depending on the type of business objects involved. Procedure: How to Configure a Distribution Model The following image shows the /nbd64 transaction in the field under the menu bar. To configure a distribution model: 1. Execute the /bd64 transaction. The Display Distribution Model window opens and displays a list of available distribution models and their descriptions as shown in the following image. 2. In the menu bar, click Distribution model. 50 iway Software

51 3. Configuring SAP Inbound Processing The Distribution model menu opens as shown in the following image. 3. Select Switch processing mode. The Display Distribution Model window switches to the Change Distribution Model. window as shown in the following image. 4. Click the Create model view button. iway Application Adapter for mysap ERP User s Guide 51

52 Configuring a Distribution Model The Create Model View window opens and includes fields for the name of your distribution model and for Start and End dates as shown in the following image. a. In the Short text field, type a model view name, for example, iway ale inbound. b. In the Technical name filed, type a technical name, for example, ziwayale, which also serves as a description. 5. To enter the information, click the checkmark icon. You are returned to the main Change Distribution Model window. The distribution model you configured is now added to the list as shown in the following image. 6. Click the Add message type button. The Add Message Type window opens and includes fields where you can name and specify your message type. a. In the Sender field, type the logical system you configured, for example, IWAY_IN. 52 iway Software

53 3. Configuring SAP Inbound Processing b. In the Receiver field, type the logical system you configured, for example, IWAY_OUT. To browse from a list of logical systems, you can click the icon to the right of each field. c. In the Message type field, type the message type to use, for example, MATMAS. To browse from a list of available message types, you can click the icon to the right of the field. 7. To enter the information, click the checkmark. You are returned to the main Change Distribution Model window. 8. Click Save. Defining a Partner Profile How to: Define a Partner Profile Partner profiles are a requirement for data exchange. You define who can exchange messages with the SAP system using a specified port. Procedure: How to Define a Partner Profile The following image shows the /nwe20 transaction in the field under the menu bar. To define a partner profile for a specific IDoc: 1. Execute the we20 transaction. iway Application Adapter for mysap ERP User s Guide 53

54 Defining a Partner Profile The Partner profiles window opens and displays two panes with information about the logical system as shown in the following image. a. If no Partner profile currently exists, click the Create icon on the tool bar or press F5. b. Click Save once you have created your Partner profile. 2. In the left pane, expand Partner type LS and select the logical system you configured from the list, for example, IWAY_IN. The right pane displays the details of the expanded folder including the logical system and type, language, and so forth, as shown in the following image. 54 iway Software

55 3. Configuring SAP Inbound Processing Note: The Partn.number field refers to the name of the logical system. 3. Click Save. 4. From the Inbound parameters table in the lower right, click the Create inbound parameter icon. iway Application Adapter for mysap ERP User s Guide 55

56 Defining a Partner Profile The Partner profiles: Inbound parameters window opens as shown in the following image. a. In the Message type field, type the message type to use, for example, MATMAS. To browse from a list of available message types, you can click the icon to the right of the field. The Inbound options tab is selected by default. b. In the Process code field, enter the process code you want to use, for example, MATM. To browse from a list of available process codes, you can click the icon to the right of the field. 56 iway Software

57 3. Configuring SAP Inbound Processing c. In the Processing by function module area, select one of the following options: 5. Click Save. Trigger by background program. In this case, the iway Application Adapter for mysap ERP writes IDocs to the SAP database, which are processed immediately. Trigger immediately. In this case, the iway Application Adapter for mysap ERP waits for the SAP system to process IDocs. This can take from one to fifteen minutes. iway Application Adapter for mysap ERP User s Guide 57

58 Defining a Partner Profile 58 iway Software

59 iway 4 Creating XML Schemas for mysap The following section describes how to create XML schemas for mysap business objects using iway Explorer. The functionality of iway Explorer is standard for any deployment type. This section uses the Java servlet implementation of iway Explorer to provide examples. Topics: Overview Starting iway Explorer (Servlet) Establishing a Target for mysap Viewing Application System Objects Creating an XML Schema iway Application Adapter for mysap ERP User s Guide 59

60 Overview Overview The iway Application Adapter for mysap ERP enables the processing of mysap BAPIs, RFCs, and IDocs. External applications that access mysap through the adapter use either XML schemas or Web services to pass data between the external application and the adapter. You can use iway Explorer to create the required XML schemas and Web services. mysap must be installed, configured, and available for client access. iway Explorer need not reside on the same system as the application system being accessed, but network access is required. Starting iway Explorer (Servlet) How to: Start iway Explorer The following procedure describes how to start iway Explorer (Servlet). Procedure: How to Start iway Explorer To start iway Explorer: 1. Enter the following URL in your browser window: where: hostname Is the name of the machine where your application server is running. port Is the HTTP port for the application server. 60 iway Software

61 4. Creating XML Schemas for mysap After you start iway Explorer, the following Welcome window opens, showing the iway Adapters, iway Events, and iway Business Services tabs. The iway Adapters node is highlighted in the left pane. The Available Hosts drop-down menu in the upper right lists the iway Connector for JCA or Servlet ibse instance you can access. 2. For more information on adding instances, see the iway Installation and Configuration Guide. You are now ready to create new targets for mysap. iway Application Adapter for mysap ERP User s Guide 61

62 Establishing a Target for mysap Establishing a Target for mysap In this section: Creating a New Target Connecting to a Target Disconnecting From a Target Modifying a Target Deleting a Target To browse mysap business objects, you must create a target for the system you intend to use. The target serves as your connection point and is automatically saved after you create it. You must establish a connection to this system every time you start iway Explorer or after you disconnect from the system. A list of supported application systems appears in the left pane of iway Explorer. The list is based on the adapters that you installed and have licenses to use. Creating a New Target How to: Create a New Target To connect to an mysap system, you must define a new target. The target holds your logon parameters for the mysap system. 62 iway Software

63 4. Creating XML Schemas for mysap Procedure: How to Create a New Target The following image shows a window with a navigation pane on the left that lists supported adapters. The right pane displays information about a selected adapter. To create a new target: 1. In the left pane, click the MySAP node. Descriptive information (for example, title and product version) about the iway Application Adapter for mysap ERP appears in the right pane. 2. In the right pane, move the pointer over Operations. iway Application Adapter for mysap ERP User s Guide 63

64 Establishing a Target for mysap The Define a new target menu option appears as well as title and product version information for the adapter in the right pane as shown in the following image. 3. Select Define a new target. The Add a new MYSAP target pane opens on the right as shown in the following image. a. In the Target Name field, type a name for the target, for example, mysaptarget. 64 iway Software

65 4. Creating XML Schemas for mysap b. In the Target Description field, type a brief description (optional). c. From the Target Type drop-down list, select the type of target to connect to. 4. Click Next. The default value is Application Server. The Set connection info pane opens on the right. The following tabs are available: User, System, Advanced, and Security. The User tab is active as shown in the following image. The User (required) tab enables you to provide authentication information for the mysap system to which you are connecting. Note: For systems based on 6.40 UNICODE, all parameter values are case sensitive. As a result, the values you specify using iway Explorer must match those that have been configured on your system. This also applies to user names and passwords. a. In the Client field, type the client number defined for the mysap application for client communications. b. In the User field, type a valid user ID for the mysap application. c. In the Password field, type a valid password for the mysap application. d. In the Language field type a language key. EN (English) is the default. iway Application Adapter for mysap ERP User s Guide 65

66 Establishing a Target for mysap e. In the Codepage field, type a character code page value. f. From the Authentication mode drop-down list, select Password, Logon ticket (SSO2), or Logon ticket (X509). Secure Network Communications (SNC) provides protection for the communication links between the distributed components of an ERP System. Using SNC, mysap ERP can support products that adhere to the GSS-API Version 2 standard. SNC supports application level (end-to-end security), Smartcard authentication, and Single Sign-On (SSO). Note: Depending on the mysap system release, logging on using SSO or X.509 certificates is supported. For SSO, specify the user to be $MYSAPSSO2$ and pass the base64 encoded ticket as the passwd parameter. For X509, specify the user to be $X509CERT$ and pass the base64 encoded certificate as the passwd parameter. For more information, see your mysap system documentation. 5. Click the System tab. The System tab becomes available as shown in the following image. 66 iway Software

67 4. Creating XML Schemas for mysap The System (required) tab enables you to provide the application server name, system number, and connection pooling information for the mysap system to which you are connecting. Note: The mysap connection parameters are consistent with those found in your mysap system. For more information on parameter values that are specific to your mysap configuration, consult your mysap system administrator. a. In the Application Server field, type the host name or IP address for the computer that is hosting the mysap application. b. In the System Number field, type the system number defined to mysap for client communications. c. In the Connection pool name field, enter the name of your mysap connection pool. A default value (p1) is already provided. d. In the Connection pool size field, specify the number of client connections in a pool you want to make available to mysap for Web service calls. A default connection pool size of 2 is available by default. Note: A value of 1 does not create a connection pool. Instead, a single mysap connection with sequential processing is shared. A pooled connection invokes multiple connections to SAP with parallel processing. If you are using iway Explorer to create Web services, the connection pool size value is used by your Web service during runtime. As a result, ensure that the connection pool size is sufficient for your purposes. e. In the Connection timeout (min) field, specify a timeout value for your connection pool in minutes. 10 minutes is the default value. f. In the Connection wait time (sec) field, specify a wait time for your connection pool in seconds. 30 seconds is the default value. Connections to an ERP server take up valuable resources on both the client and the remote server. You can create a pool of connections to minimize the resource and time constraints. In estimating the size of the pool, you may calculate pool size by the amount of server resources to be consumed, the number and size of the documents to be received, and the size of your Java Virtual Machine. The section of mysap documentation "Memory Management (BC-CST-MM)" explains in detail the resources required on the mysap system. 6. To view the Advanced tab, click Advanced. iway Application Adapter for mysap ERP User s Guide 67

68 Establishing a Target for mysap The Advanced tab becomes available as shown in the following image. The Advanced tab enables you to specify your EDI and IDoc versions, and configure error handling. The following fields are available: a. From the EDI version drop-down list, select the Electronic Data Interchange (EDI) document version you are using with the iway Application Adapter for mysap ERP. Version 3 is the default value. b. In the IDOC release field, specify the IDOC versioning you want to use for your connection. c. From the IDOC release provider drop-down list, select, IDOC DOCREL field (default), SAP release, or user input. d. From the Error Handling drop-down list: If your application is Java centric, select Throws Exception so that code components can catch the exception and react accordingly. If your application is document based, select Creates Error Document to create an XML document that contains the Java exception. It is up to your application to read the XML document and obtain the error. 68 iway Software

69 4. Creating XML Schemas for mysap e. If a high degree of accuracy is required in your application, select the Commit with Wait check box. The adapter waits until all records are physically written to the database before returning from the function call. The "Commit With Wait" has a performance impact on adapter performance, so consider carefully before selecting it. The commit behavior of BAPIs is described in the mysap documentation under "BAPI Programming Guide and Reference (CA-BFA)." All mysap Business Objects that change data must commit work to the database. Some BAPIs developed in version 3.1 of the ERP system use an internal commit behavior, and their commit behavior cannot be changed by the adapter. As soon as they are called, they commit the work they did. BAPIs developed since release 3.1 use the external commit method. The adapter issues a commit command, and the commit is put in the database queue. If there is an application error in the first part of the commit, the error message "Posting could not be carried out" is returned, and the adapter rolls back the transaction. If in writing to the database, a database error occurs, a short dump is issued in the database records of mysap, but no message is returned to the adapter about the failure. This option is disabled by default. f. To enable SAP traces, select the SAP trace check box 7. To view the Security tab, click Security. iway Application Adapter for mysap ERP User s Guide 69

70 Establishing a Target for mysap The Security tab becomes active as shown in the following image. The Security tab enables you to specify Secure Network Communication (SNC) information for the mysap system to which you are connecting. SNC provides protection for the communication links between the distributed components of an ERP System. Using SNC, mysap ERP can support products that adhere to the GSS-API Version 2 standard. SNC supports application level (end-to-end security), Smartcard authentication, and SSO. If you are using SAP Enterprise Portal, the J2EE engine generates the SAP logon ticket automatically. A possible SNC scenario would be from SAP Enterprise Portal to the iway Application Adapter for mysap ERP. If you want to use SAP logon tickets to enable SSO to non-sap components, consult the SAP documentation regarding Pluggable Authentication Services. A possible SNC scenario in this case would be from a non-sap Enterprise Portal to the iway Application Adapter for mysap ERP. a. To enable SNC, select 1 from the SNC mode drop-down list. By default, SNC is disabled. b. In the SNC partner field, type the name of the RFC server or message server (load balancing) that provides the SNC services. c. From the SNC level drop-down list, select the version of the SNC library. d. In the SNC name field, type the name of the SNC library you are using. 70 iway Software

71 4. Creating XML Schemas for mysap e. In the SNC library path field, type the path to the SNC library. 8. After you provide all the required information for your target, click Finish. The mysap target appears below the sap node in the left pane as shown in the following image. You are now ready to connect to your mysap target. Connecting to a Target How to: Connect to a Target To connect to mysap, you use a target you defined, for example, the one in the previous procedure, mysaptarget. Procedure: How to Connect to a Target To connect to a target: 1. In the left pane, expand the sap node and select the target you defined, for example, mysaptarget. 2. In the right pane, move the pointer over Operations. iway Application Adapter for mysap ERP User s Guide 71

72 Establishing a Target for mysap The following image shows the target, with a red 'x', selected in the left pane. In the right pane, the Operations menu appears in its expanded form. 3. Select Connect. 72 iway Software

73 4. Creating XML Schemas for mysap The Connect to mysaptarget pane opens on the right, which contains fields with information for a client, user, and language, as well as fields for entering a password and a code page as shown in the following image. Additionally, you can select to enable an mysap trace and to enable security. 4. In the Password field, type a valid password and click OK. The mysaptarget node in the left pane changes (the red 'x' disappears) to reflect that a connection was made as shown in the following image. 5. Expand the mysaptarget node. The following mysap business objects appear: Business Object Repository Remote Function Modules ALE (IDOCs) iway Application Adapter for mysap ERP User s Guide 73

74 Establishing a Target for mysap Disconnecting From a Target How to: Disconnect From a Target Although you can maintain multiple open connections to different application systems, it is a good practice to close connections when you are not using them. Procedure: How to Disconnect From a Target To disconnect from a target: 1. From the left pane, click the target, for example, mysaptarget, to which you are connected. 2. In the right pane, move the pointer over Operations. The following image shows the target selected in the left pane. In the right pane, the Operations menu appears expanded to display options. 3. Select Disconnect. Disconnecting from the application system drops the connection, but the node remains. 74 iway Software

75 4. Creating XML Schemas for mysap In the left pane, the mysaptarget node changes to reflect that a connection was closed (a red 'x' appears) as shown in the following image. Modifying a Target How to: Edit a Target After you create a target for mysap using iway Explorer, you can edit the information that you provided previously. Procedure: How to Edit a Target To edit a target: 1. In the left pane, click the target, for example, mysaptarget. The Operations menu appears in the right pane, as shown in the following image. 2. Move the pointer over Operations and select Edit. iway Application Adapter for mysap ERP User s Guide 75

76 Establishing a Target for mysap The Edit pane opens on the right with the target name, a description and a target type selected from the drop-down list as shown in the following image. 3. Modify the connection information. 4. To continue modifying additional information, click Next. 5. When you are finished making all of your edits, click Finish. Deleting a Target How to: Delete a Target In addition to closing a target, you can delete a target that is no longer required. You can delete it whether or not it is closed. If open, the target automatically closes before it is deleted. Procedure: How to Delete a Target To delete a target: 1. In the left pane, click the target, for example, mysaptarget. 76 iway Software

77 4. Creating XML Schemas for mysap The Operations menu appears in the right pane, as shown in the following image. 2. In the right pane, move the pointer over Operations. 3. Select Delete. A confirmation dialog box opens, asking if you want to delete the target. 4. To delete the target you selected, click OK. The mysaptarget node disappears from the left pane. Viewing Application System Objects How to: View Application System Objects Search for a Specific SAP Business Object After you are connected to mysap, iway Explorer enables you to explore and browse business object metadata. For example, iway Explorer enables you to view mysap BAPI, RFC, and idoc metadata stored in the mysap Business Object repository. Note: Depending on the release or service pack installed, certain RFCs, for example, RFC_CUSTOMER_GET, may not exist in your particular mysap system. Therefore, the examples included in this documentation may not be relevant to your system. If this is the case, you should use the examples as a general reference for adapter functionality and choose an RFC that exists within your mysap application environment. Procedure: How to View Application System Objects To view application system objects: 1. Click the icon to the left of the target name, for example, mysaptarget. iway Application Adapter for mysap ERP User s Guide 77

78 Viewing Application System Objects This expands the target to expose the available application system objects as shown in the following image. 2. To expand the desired mysap repository node, click the icon to the left of the repository name, for example, Business Object Repository. 3. In the list under Business Object Repository, click the icon next to Financial Accounting. 78 iway Software

79 4. Creating XML Schemas for mysap A list of business objects related to Financial Accounting appears in the left pane. In the right pane, the collapsed Operations menu and a table listing properties and values for the BAPI method named BAPI_COMPANY_GETLIST appears as shown in the following image. a. Scroll down and click the icon next to the Company business object. b. Click the icon next to the BAPI method called GetList. 4. In the right pane, move the pointer over Operations to view the context menu. iway Application Adapter for mysap ERP User s Guide 79

80 Viewing Application System Objects The following image shows the Operations menu expanded over the table listing properties and values for the BAPI method named BAPI_COMPANY_GETLIST in the right pane. The following options are available from the context menu: Help provides information about BAPI, RFC, and IDoc usage. Test Run simulates running the selected RFC or BAPI with sample data you provide. Create iway Business Services creates Web services for the mysap business object you selected. Create Event Port creates a port to be used for mysap event handling. Generate Schema generates XML request and response schemas for the mysap business object you selected. Procedure: How to Search for a Specific SAP Business Object You can use the search function in iway Explorer to locate an SAP business object. 1. Start iway Explorer and connect to your SAP system target. 80 iway Software

81 4. Creating XML Schemas for mysap 2. Expand the target and select Business Object Repository, Remote Function Modules, or ALE(IDOCs). The following image shows Business Object Repository selected in the left pane. 3. In the right pane, move the cursor over Operations and select Search from the menu. The following image shows the Search feature that appears in the right pane. It has a search path input area. 4. Enter the name of the business object you want to search for in the Search path text entry box, for example, Material. 5. Click OK. iway Application Adapter for mysap ERP User s Guide 81

82 Viewing Application System Objects The following image show the search results that appear when a search for Material is conducted against the Business Object Repository. 6. Select the radio button next to the item in which you are interested and click OK. 82 iway Software

83 4. Creating XML Schemas for mysap iway Explorer locates the business object you selected in the left pane, for example, Material. Creating an XML Schema How to: Create XML Schemas After you browse the mysap business object repository, you can generate XML request and response schemas for the object you wish to use with your adapter. Procedure: How to Create XML Schemas To create XML request and response schemas for the mysap BAPI method called BAPI_MATERIAL_GETLIST: 1. In the Business Object Repository, select the GetList method. iway Application Adapter for mysap ERP User s Guide 83

84 Creating an XML Schema In the right pane, the collapsed Operations menu and a table listing properties and values for the BAPI method named BAPI_MATERIAL_GETLIST appears as shown in the following image. 2. In the right pane, move the pointer over Operations and select Generate Schema from the menu. Request, response, and event schemas are created for your business object. 84 iway Software

85 4. Creating XML Schemas for mysap The following image shows the Schemas pane that opens on the right with a table that lists and defines the root tag for each schema and provides hyperlinks to click to view each schema. 3. Click the hyperlink associated with the type of schema you want to view. iway Application Adapter for mysap ERP User s Guide 85

86 Creating an XML Schema For example, if you click the hyperlink for the Request schema, the schema appears in the right pane as shown in the following image. 4. To return to the previous window, click the Back button on your Web browser. After you browse the list of business objects on your mysap system, you can create iway Business Services. For more information, see Creating and Publishing iway Business Services on page 87. After the schemas are created, you also can create events. For more information, see Configuring the Event Adapter for SAP on page iway Software

87 iway Creating and Publishing iway Business 5 Services This section describes how to create and publish iway Business Services using iway Explorer. The functionality of iway Explorer is standard for any deployment type. This section uses the Java servlet implementation of iway Explorer to provide examples. Topics: Understanding iway Business Services Creating iway Business Services iway Application Adapter for mysap ERP User s Guide 87

88 Understanding iway Business Services Understanding iway Business Services iway Explorer provides Web developers with a simple, consistent mechanism for extending the capabilities of the iway Application Adapter for mysap ERP. The iway Business Services Provider (ibsp) exposes functionality as Web services. It serves as a gateway to heterogeneous back-end applications and databases. A Web service is a self-contained, modularized function that you can publish and access across a network using open standards. It is the implementation of an interface by a component and is an executable entity. For the caller or sender, a Web service can be considered as a "black box" that may require input and delivers a result. Web services integrate within an enterprise as well as across enterprises on any communication technology stack, whether asynchronous or synchronous, in any format. After you browse the SAP business object repository and create an XML schema for the object, you can generate an iway Business Service for the object you wish to use with your adapter. Creating iway Business Services In this section: Creating Business Services With iway Explorer Identity Propagation The following topics describe how to create iway Business Services, including how to generate WSDL (Web Services Description Language) from a Web service. Creating Business Services With iway Explorer How to: Create iway Business Services Example: Sample iway Business Services Input XML The following procedure describes how to create iway Business Services using iway Explorer. The procedure uses the SAP BAPI method called BAPI_MATERIAL_GETLIST as an example and returns a list of materials. Note: If you want your Web service to use connection pooling, you must specify connection pooling information when connecting or reconnecting to your SAP target. 88 iway Software

89 5. Creating and Publishing iway Business Services Procedure: How to Create iway Business Services To create iway Business Services: 1. From the Business Object Repository, select the GetList method from the Material Master group. The following image shows the Operations menu in the right pane and a table listing properties and values for the BAPI method called BAPI_MATERIAL_GETLIST. 2. In the right pane, move the pointer over Operations. iway Application Adapter for mysap ERP User s Guide 89

90 Creating iway Business Services The Operations menu expands as shown in the following image to display options. 3. Select Create iway Business Services. 90 iway Software

91 5. Creating and Publishing iway Business Services A Create Web Service pane opens where you provide the specific information for the iway Business Service you are defining as shown in the following image. a. In the Service Name field, type a name for the iway Business Service. b. In the Description field, type a brief description (optional). c. In the License field, select the license definition you want to use. 4. Click Next. iway Application Adapter for mysap ERP User s Guide 91

92 Creating iway Business Services A second Create Web Service pane opens on the right that includes fields for the method name and a description as shown in the following image. a. In the Method Name field, type a descriptive name for the method. b. In the Description field, type a brief description for the method (optional). 5. Click Finish. 92 iway Software

93 5. Creating and Publishing iway Business Services The iway Business Services tab is active on the right as shown in the following image. All of the available services that were created appear in the left pane. The Material_List service node is expanded, and the GetList method is automatically selected. The test pane for the GetList method opens in the right pane. 6. Enter an XML instance of the schema you generated previously for the SAP business component. The document queries the service in the input xml field. To use the identical sample input XML illustrated in this example, see Sample iway Business Services Input XML on page 95. Note: For systems based on 6.40 UNICODE, all business object names are case sensitive. As a result, when creating your input XML instance that is based on the schema generated by iway Explorer, make sure the element names match the business object names as defined by your system. 7. Click Invoke. iway Application Adapter for mysap ERP User s Guide 93

94 Creating iway Business Services The result appears in the right pane as shown in the following image. 94 iway Software

95 5. Creating and Publishing iway Business Services Example: Sample iway Business Services Input XML The following input XML retrieves a list of materials using the SAP BAPI_MATERIAL_GETLIST method. <?xml version="1.0" encoding="utf-8"?> - <!-- Sample XML file generated by XMLSPY v5 rel. 3 U ( --> - <Material.GETLIST xmlns="urn:sap-com:document:sap:business" xmlns:xsi=" xsi:schemalocation="urn:sap-com:document:sap:business C:\temp\service_BAPI_MATERIAL_GETLIST.xsd"> <MAXROWS>1000</MAXROWS> - <DISTRIBUTIONCHANNELSELECTION> - <item> <SIGN /> <OPTION /> <DISTR_CHAN_LOW /> <DISTR_CHAN_HIGH /> </item> </DISTRIBUTIONCHANNELSELECTION> - <MANUFACTURERPARTNUMB> - <item> <MANU_MAT /> <MFR_NO /> </item> </MANUFACTURERPARTNUMB> - <MATERIALSHORTDESCSEL> - <item> <SIGN /> <OPTION /> <DESCR_LOW /> <DESCR_HIGH /> </item> </MATERIALSHORTDESCSEL> - <MATNRLIST> - <item> <MATERIAL /> <MATL_DESC /> <MATERIAL_EXTERNAL /> <MATERIAL_GUID /> <MATERIAL_VERSION /> </item> </MATNRLIST> - <MATNRSELECTION> - <item> <SIGN>E</SIGN> iway Application Adapter for mysap ERP User s Guide 95

96 Creating iway Business Services <OPTION>BT</OPTION> <MATNR_LOW>1000</MATNR_LOW> <MATNR_HIGH>1010</MATNR_HIGH> </item> </MATNRSELECTION> - <PLANTSELECTION> - <item> <SIGN /> <OPTION /> <PLANT_LOW /> <PLANT_HIGH /> </item> </PLANTSELECTION> - <RETURN> - <item> <TYPE /> <ID /> <NUMBER /> <MESSAGE /> <LOG_NO /> <LOG_MSG_NO /> <MESSAGE_V1 /> <MESSAGE_V2 /> <MESSAGE_V3 /> <MESSAGE_V4 /> <PARAMETER /> <ROW>0</ROW> <FIELD /> <SYSTEM /> </item> </RETURN> - <SALESORGANISATIONSELECTION> - <item> <SIGN /> <OPTION /> <SALESORG_LOW /> <SALESORG_HIGH /> </item> </SALESORGANISATIONSELECTION> - <STORAGELOCATIONSELECT> - <item> <SIGN /> <OPTION /> <STLOC_LOW /> <STLOC_HIGH /> </item> </STORAGELOCATIONSELECT> </Material.GETLIST> 96 iway Software

97 5. Creating and Publishing iway Business Services Identity Propagation If you test or execute a Web service using a third-party XML editor, for example, XMLSPY, the user name and password values that you specify in the SOAP header must be valid. The values are used to connect to SAP. The user name and password values that you provided for SAP when you created a target using iway Explorer are overwritten for this Web service request. The following is a sample SOAP header that is included in the WSDL file for a Web service: <SOAP-ENV:Header> <m:ibsinfo xmlns:m="urn:schemas-iwaysoftware-com:iwse"> <m:service>string</m:service> <m:method>string</m:method> <m:license>string</m:license> <m:disposition>string</m:disposition> <m:username>string</m:username> <m:password>string</m:password> <m:language>string</m:language> </m:ibsinfo> </SOAP-ENV:Header> Note: You can remove the following tags from the SOAP header, since they are not required: <m:disposition>string</m:disposition> <m:language>string</m:language> iway Application Adapter for mysap ERP User s Guide 97

98 Creating iway Business Services 98 iway Software

99 iway 6 Configuring the Event Adapter for SAP This section describes how to use iway Explorer to connect to SAP and listen for events. The functionality of iway Explorer is standard for any deployment type. This section uses the Java servlet implementation of iway Explorer to provide examples. Topics: Understanding iway Event Functionality Creating, Editing, or Deleting a Port Creating, Editing, or Deleting a Channel Synchronous Event Processing iway Application Adapter for mysap ERP User s Guide 99

100 Understanding iway Event Functionality Understanding iway Event Functionality Events are generated as a result of activity on an application system. You can use events to trigger an action in your application. Applications or functions within SAP may broadcast processing information at predefined points, called events. You must configure an event listener if you are to receive events from SAP. For example, the SAP Business Object, Material, may raise the event status Material, assigned when a material is created. If you wish to consume this event, you must configure an event listener to capture this event within SAP and transmit the event notification to your system. To create an iway event, you must create a port and a channel using iway Explorer. The following is a description of how ports and channels work. Port A port associates a particular business object exposed by an adapter with a particular disposition. A disposition defines the protocol and location of the event data. The port defines the end point of the event consumption. For more information, see Creating, Editing, or Deleting a Port on page 101. Channel A channel represents configured connections to particular instances of back-end or other types of systems. A channel binds one or more event ports to a particular listener managed by an adapter. For more information, see Creating, Editing, or Deleting a Channel on page iway Software

101 6. Configuring the Event Adapter for SAP Creating, Editing, or Deleting a Port In this section: Using the Default Event Port How to: Create a Port for the File Disposition Create a Port for the ibsp Disposition Create a Port for the MSMQ Disposition Create a Port for the JMS Queue Disposition Create a Port for the SOAP Disposition Create a Port for the HTTP Disposition Create a Port for the MQSeries Disposition Edit an Event Port Delete an Event Port The following procedures describe how to create, edit, or delete an event port using iway Explorer. You can create a port for an SAP business function from the iway Adapters tab or from the iway Events tab. When you use iway Explorer with an iway Business Services Provider (ibsp) implementation, the following port dispositions are available: File ibsp MSMQ JMSQ SOAP WLWS HTTP MQSeries The following dispositions are available when using iway Explorer in conjunction with a JCA connector implementation: File iway Application Adapter for mysap ERP User s Guide 101

102 Creating, Editing, or Deleting a Port JMS HTTP Procedure: How to Create a Port for the File Disposition To create a port for the File disposition using iway Explorer: 1. Click the iwayadapters tab. 2. From the Business Object Repository, select the BAPI_MATERIAL_GETLIST method. The following image shows the Operations menu in the right pane and a table listing properties and values for the BAPI method named BAPI_MATERIAL_GETLIST. 3. In the right pane, move the pointer over Operations and select Create iway Event Port. 102 iway Software

103 6. Configuring the Event Adapter for SAP The Create iway Event Port pane opens on the right as shown in the following image. a. In the Event Port Name field, type a name. b. In the Event Port Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select FILE. 4. Click Next. iway Application Adapter for mysap ERP User s Guide 103

104 Creating, Editing, or Deleting a Port The Specify FILE Disposition pane opens on the right as shown in the following image and includes information about the File disposition. 5. In the Disposition Url field, type a destination where the event data is written. When pointing iway Explorer to an ibsp deployment, specify the destination file using the following format: ifile://location;[errorto=errordest] When pointing iway Explorer to a JCA deployment, specify the destination file using the following format: location The following table lists and describes the disposition parameters for File. Parameter location errordest Description Full directory path and file name to which the data is written. Location to which error logs are sent. Optional. Predefined port name or another disposition URL. The URL must be complete, including the protocol. For example: ifile://c:\temp\sapevent.txt;errorto=ifile://c:\temp\error 104 iway Software

105 6. Configuring the Event Adapter for SAP 6. Click Finish. The iway Events tab becomes available. The event port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. 7. To view the event schema that was created for the event port, click SchemaLink. You are now ready to associate the event port for File with a channel. For more information, see Creating, Editing, or Deleting a Channel on page 117. Procedure: How to Create a Port for the ibsp Disposition The ibsp disposition enables an event to launch an iway Business Services method. To create a port for an ibsp disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port pane opens on the right. a. In the Name field, type a name. iway Application Adapter for mysap ERP User s Guide 105

106 Creating, Editing, or Deleting a Port b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select IBSP. d. In the Disposition field, enter an ibsp destination using the following format: ibsp:svcname.mthname;[responseto=responseto];[errorto=errordest] The following table lists and describes the disposition parameters for ibsp. Parameter svcname mthname responseto errordest Description Name of the service created with ibsp. Name of the method created for the Web service. Location to which responses to the Web service are posted. Optional. Predefined port name or another disposition URL. The URL must be complete, including the protocol. Location to which error logs are sent. Optional. Predefined port name or another disposition URL. The URL must be complete, including the protocol. 5. Click OK. The port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. Procedure: How to Create a Port for the MSMQ Disposition The MSMQ disposition supports public and private queues. To create a port for an MSMQ disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port pane opens on the right. a. In the Name field, type a name. 106 iway Software

107 6. Configuring the Event Adapter for SAP b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select MSMQ. d. In the Disposition field, enter an MSMQ destination in the format: msmq://host/private$/qname;[errorto=errordest] The following table lists and describes the dispostion parameters for MSMQ. Parameter host queuetype qname errorto Description Name of the host on which the Microsoft Queuing system runs. Type of queue. For private queues, enter Private$. Private queues are queues that are not published in Active Directory. They appear only on the local computer that contains them. Private queues are accessible only by Message Queuing applications that recognize the full path name or format name of the queue. Name of the queue in which messages are placed. Location where error documents are sent. Predefined port name or another full URL. Optional. 5. Click OK. The port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. Procedure: How to Create a Port for the JMS Queue Disposition The JMS queue disposition enables an event to be enqueued to a JMS queue. To create a port for a JMS queue disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port window opens in the right pane. a. In the Name field, type a name. iway Application Adapter for mysap ERP User s Guide 107

108 Creating, Editing, or Deleting a Port b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select JMSQ. d. In the Disposition field, enter a JMS destination. When pointing iway Explorer to an ibsp deployment, use the following format: zjmsq:myqueuename@myqueuefac;jndiurl=[myurl]; jndifactory=[myfactory];user=[user];password=[xxx]; errorto=[pre-defined port name or another disposition url] When pointing iway Explorer to a JCA deployment, use the following format: jms:jmsqueue@jmsfactory;jndiurl=;jndifactory=; The following table lists and describes the parameters for the disposition. Parameter queue Connection Factory jndiurl jndifactory user password errorto Description JNDI name of a queue to which events are emitted. A resource that contains information about the JMS Server. The URL to use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. This value corresponds to the standard JNDI property, java.naming.provider.url Is JNDI context.initial_context_factory and is provided by the JNDI service provider. Valid user name required to access a JMS server. Valid password required to access a JMS server. Location where error documents are sent. A predefined port name or another full URL. Optional. 5. Click OK. The port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. 108 iway Software

109 6. Configuring the Event Adapter for SAP Procedure: How to Create a Port for the SOAP Disposition To create a port for a SOAP disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port pane opens on the right. a. In the Name field, type a name. b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select SOAP. iway Application Adapter for mysap ERP User s Guide 109

110 Creating, Editing, or Deleting a Port d. In the Disposition field, enter a SOAP destination, using the following format: soap:[wsdl-url];soapaction=[myaction]; method=[web service method];namespace=[namespace]; responseto=[pre-defined port name or another disposition URL]; errorto=[pre-defined port name or another disposition url] The following table lists and describes the parameters for the disposition. Parameter wsdl-url Description The URL to the WSDL file that is required to create the SOAP message, for example: e.ibs?wsdl where: webservice Is the name of the Web service you created using iway Explorer. To find this value, you can navigate to the iway Business Services tab and open the Service Description link in a new window. The WSDL URL appears in the Address field. Alternatively, you can open the WSDL file in a third-party XML editor (for example, XMLSPY) and view the SOAP request settings. 110 iway Software

111 6. Configuring the Event Adapter for SAP Parameter soapaction Description Method that is called by the SOAP disposition. For example: where: webservice Is the name of the Web service you created using iway Explorer. method test Is the method being used. Is the license that is being used by the Web service. This value can be found by navigating to the iway Business Services tab, opening the Service Description link in a new window, and performing a search for soapaction. You can also open the WSDL file in a third-party XML editor (for example, XMLSPY) and view the SOAP request settings to find this value. method namespace responseto errorto Web service method you are using. Value is found in the WSDL file. XML namespace you are using. Value is found in the WSDL file. Location to which responses are posted. Can be a predefined port name or another URL. Optional. The URL must be complete, including the protocol. Location where error documents are sent. A predefined port name or another full URL. Optional. Note: To use the SOAP disposition with a synchronous event, use Remote Function Modules to generate the schema and WSDL file instead of using the Business Object Repository for any RFC or BAPI. 5. Click OK. The event port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. iway Application Adapter for mysap ERP User s Guide 111

112 Creating, Editing, or Deleting a Port Procedure: How to Create a Port for the HTTP Disposition The HTTP disposition uses an HTTP URL to specify an HTTP end point to which the event document is posted. To create a port for an HTTP disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port pane opens on the right. a. In the Name field, type a name. b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select HTTP. d. In the Disposition field, enter an HTTP destination. When pointing iway Explorer to an ibsp deployment, specify the destination file using the following format: ihttp://url;responseto=respdest When pointing iway Explorer to a JCA deployment, specify the destination file using the following format: The following table lists and describes the disposition parameters for HTTP. Parameter url respdest host port uri Description The URL target for the post operation. Location to which responses are posted. A predefined port name or another full URL. Optional. The URL must be complete, including the protocol. Name of the host on which the Web server resides. Port number on which the Web server is listening. Universal resource identifier that completes the URL specification. 112 iway Software

113 6. Configuring the Event Adapter for SAP 5. Click OK. The event port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. Procedure: How to Create a Port for the MQSeries Disposition The MQSeries disposition enables an event to be enqueued to an MQSeries queue. Both queue manager and queue name may be specified. To create a port for an MQSeries disposition using iway Explorer: 1. Click the iway Events tab. 2. In the left pane, expand the SAP node. 3. Select the ports node. 4. Move the pointer over Operations and select Add a new port. The Create New Port pane opens on the right. a. In the Name field, type a name. b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select MQSeries. iway Application Adapter for mysap ERP User s Guide 113

114 Creating, Editing, or Deleting a Port d. In the Disposition field, enter an MQSeries destination. When pointing iway Explorer to an ibsp deployment, specify the destination file using the following format: mqseries:/qmanager/qname;host=[hostname]; port=[port];channel=[channnelname]; errorto=[pre-defined port name or another disposition url] When pointing iway Explorer to a JCA deployment, specify the destination file using the following format: mq:qmanager@respqueue;host=;port=;channel= The following table lists and describes the disposition parameters for MQSeries. Parameter qmanager qname or respqueue host port channel errorto Description Name of the queue manager to which the server must connect. Name of the queue where messages are placed. Host on which the MQ Server is located (MQ Client only). Number to connect to an MQ Server queue manager (MQ client only). Case-sensitive name of the channel that connects with the remote MQ Server queue manager (MQ client only). The default channel name for MQSeries is SYSTEM.DEF.SVRCONN. Location where error documents are sent. This can be a predefined port name or another full URL. Optional. 5. Click OK. The port appears under the ports node in the left pane. In the right pane, a summary of the information associated with the port appears. Procedure: How to Edit an Event Port To edit an event port: 1. Select the event port you want to edit. 2. In the right pane, move the pointer over Operations and select Edit. 114 iway Software

115 6. Configuring the Event Adapter for SAP The Edit Port pane opens on the right, with fields where you can modify the description, disposition protocol, and disposition of the port as shown in the following image. You cannot change the port name. 3. Make the required changes to the event port configuration fields and click OK. Procedure: How to Delete an Event Port To delete an event port: 1. Select the event port you want to delete. 2. In the right pane, move the pointer over Operations and select Delete. A confirmation dialog box opens, asking whether to delete the event port. 3. To delete the event port you selected, click OK. The event port disappears from the list in the left pane. iway Application Adapter for mysap ERP User s Guide 115

116 Creating, Editing, or Deleting a Port Using the Default Event Port How to: Modify the Default Event Port Output Directory When using iway Explorer to connect to SAP and listen for events, a default event port is available at all times as shown in the following image. The default event port can be used for testing purposes or when you do not want to route event data to a specific port you configured. The default port is enabled when you start a channel that does not have a specific event port assigned. The default event data is actually a file disposition that writes to an out.xml file in the following output directory: ifile://./eventout/out.xml Procedure: How to Modify the Default Event Port Output Directory To modify the default event port output directory: 1. In the ibse\web-inf\lib directory, open the ibse.jar file and locate the dispositioninfo.xml file. 2. Using a text editor, locate the following lines in the dispositioninfo.xml file: <?xml version="1.0" encoding="utf-8"?> <dispositioninfo pref="built-in" defaultporturl="ifile://./eventout/out.xml"> 3. Change the default output directory to a new location of your choice. You can also change the name and type of the default output file. 4. Save your changes and redeploy ibse. 116 iway Software

117 6. Configuring the Event Adapter for SAP Creating, Editing, or Deleting a Channel How to: Create a Channel Edit a Channel Delete a Channel The following procedures describe how to create, edit, or delete a channel for your event adapter as well as how to start or stop a channel. All defined event ports must be associated with a channel. You can create a channel using iway Explorer. Procedure: How to Create a Channel To create a channel using iway Explorer: 1. Click the iway Events tab. The list of adapters that support events appears in the left pane as shown in the following image. 2. Expand the iway Events node, for example, SAP. The ports and channels nodes appear in the left pane. 3. Click the channels node. 4. In the right pane, move the pointer over Operations and select Add a new channel. iway Application Adapter for mysap ERP User s Guide 117

118 Creating, Editing, or Deleting a Channel The Add a new MYSAP channel pane opens on the right as shown in the following image. a. In the Channel Name field, type a name, for example, TEST_CHANNEL. b. In the Description field, type a brief description (optional). c. From the Channel Type drop-down list, select SAP Channel -- App Server. 5. Click Next. 118 iway Software

119 6. Configuring the Event Adapter for SAP The edit channels pane opens on the right as shown in the following image, with fields for the client, user, password, language, and code page information for the channel. The User tab is active. iway Application Adapter for mysap ERP User s Guide 119

120 Creating, Editing, or Deleting a Channel a. On the User tab, enter the information that is specific to your SAP system. The following table lists and describes the user parameters. Parameter Client User Password Language Codepage Authentication Mode Description Client number defined for the SAP system for client communications. Valid user ID for the SAP system. Valid password for the SAP system. Valid language key. EN (English) is the default value. Character code page value used by the SAP system (optional). From the Authentication mode drop-down list, select Password, Logon ticket (SSO2), or Logon ticket (X509). For more information on Secure Network Communications (SNC), see Creating XML Schemas for mysap on page 59. Note: For more information on obtaining the values found in the User tab, see your SAP system administrator. 120 iway Software

121 6. Configuring the Event Adapter for SAP b. Click the System tab. The System tab becomes active as shown in the following image, with fields to enter a gateway host, gateway service, program ID of the server, application server, and system number for the channel. c. Enter the user information that is specific to your SAP system. The following table lists and describes the system parameters. Parameter Gateway host Gateway service Program ID of the server Application Server System number Description Host name of the SAP gateway. Service of the SAP gateway. Program ID of the registered server program. Note: The program ID of the server is case sensitive. Host name of the SAP system. Number of the SAP system (two-digit numeric value). Note: For more information on obtaining the values found in the System tab, see your SAP system administrator. iway Application Adapter for mysap ERP User s Guide 121

122 Creating, Editing, or Deleting a Channel d. Click the Security tab. The Security tab becomes active as shown in the following image. e. To enable SNC, select 1 from the SNC mode drop-down list. By default, SNC is disabled. f. In the SNC partner field, type the name of the RFC server or message server (load balancing) that provides the SNC services. g. From the SNC level drop-down list, select the version of the SNC library. h. In the SNC name field, type the name of the SNC library you are using. i. In the SNC library path field, type the path to the SNC library j. Specify additional information or criteria for the channel you are creating. 122 iway Software

123 6. Configuring the Event Adapter for SAP k. Click the Advanced tab. The Advanced tab becomes active as shown in the following image, with fields to enter or select an IDoc format, user defined function modules, and processing mode options, as well as check boxes to enable SAP traces or Unicode encoding of the event data. iway Application Adapter for mysap ERP User s Guide 123

124 Creating, Editing, or Deleting a Channel l. Specify additional information or criteria for the channel you are creating. Note: For more information on obtaining the values found in the Advanced tab, see your SAP system administrator. The following table lists and describes the parameters on the Advanced tab. Parameter IDOC Format IDOC release IDOC release provider User Defined Function Modules SAP trace Unicode Processing Mode Description The IDoc format to use for the channel you are creating. Possible values include: SAP IFR IDOC-XML (Default) FLAT IDOC In the IDOC release field, specify the IDOC versioning you want to use for your connection. From the IDOC release provider drop-down list, select, IDOC DOCREL field (default), SAP release, or user input. Path on the file system that points to your user-defined function module. A user-defined function module is used as a data source. Select this option to enable SAP traces. The iway Application Adapter for mysap ERP automatically detects whether the server you are connecting to is using UNICODE. Processing mode to use for your channel. Possible values include: REQUEST (Default) REQUEST_RESPONSE 6. Click Next. 124 iway Software

125 6. Configuring the Event Adapter for SAP The Select Ports pane opens as shown in the following image where you can move ports between the Available list and the Current list. a. Select an event port from the list of available ports. b. To transfer the port to the list of current ports, click the single right arrow button or to associate all event ports, click the double right arrow button. The port appears in the list of current ports as shown in the following image. 7. Click Finish. iway Application Adapter for mysap ERP User s Guide 125

126 Creating, Editing, or Deleting a Channel In the left pane, the TEST_CHANNEL is selected and has an 'X' over the icon. The summary pane opens on the right with the channel description, channel status, and available ports as shown in the following image. All the information is associated with the channel you created. The 'X' over the icon indicates that the channel is currently disconnected. To activate your event configuration, you must start the channel using the Operations menu, as shown in the following image. 8. Move the pointer over Operations and select Start the channel. 126 iway Software

127 6. Configuring the Event Adapter for SAP The channel you created is now active, and the 'X' disappears, as shown in the following image. Note: You can start a channel even if a specific event port is not assigned. A default port is used in these situations. However, it is recommended that you always assign a specific port to the channel you create. For more information on creating a port, see Creating, Editing, or Deleting a Port on page 101. For more information on using the default port, see Using the Default Event Port on page To stop the channel at any time, move the pointer over Operations and select Stop the channel. Procedure: How to Edit a Channel To edit an existing channel: 1. In the left pane, select the channel you want to edit. The Operations menu opens in the right pane over the summary of the channel information, as shown in the following image. 2. Move the pointer over Operations and select Edit. iway Application Adapter for mysap ERP User s Guide 127

128 Creating, Editing, or Deleting a Channel The Edit channels pane opens on the right as shown in the following image. 3. Make the required changes to the channel configuration fields. 4. To continue editing information on the other tabs, click Next. 5. When you complete your edits, click Finish. Procedure: How to Delete a Channel To delete an existing channel: 1. In the left pane, select the channel you want to delete. The Operations menu opens in the right pane over the summary of the channel information, as shown in the following image. 2. Move the pointer over Operations and select Delete. A confirmation dialog box opens asking if you want to delete this item. 3. To delete the channel you selected, click OK. The channel disappears from the list in the left pane. 128 iway Software

129 6. Configuring the Event Adapter for SAP Synchronous Event Processing How to: Configure Synchronous Event Processing Using iway Explorer You can configure synchronous event processing using iway Explorer to trigger a Web service after an event occurs in the SAP system. The event response that is received can then be routed to another disposition for further processing. Procedure: How to Configure Synchronous Event Processing Using iway Explorer To configure synchronous event processing: 1. Create a Web service for an SAP Remote Function Module, for example, BAPI_MATERIAL_GETLIST. 2. View the WSDL file. 3. In the Create New Port pane, create a port using the SOAP disposition. a. In the Name field, type a name. b. In the Description field, type a brief description (optional). c. From the Disposition Protocol drop-down list, select SOAP. iway Application Adapter for mysap ERP User s Guide 129

130 Synchronous Event Processing d. In the Disposition field, enter a SOAP destination, using the following format: soap:[wsdl-url];soapaction=[myaction]; method=[web service method];namespace=[namespace]; responseto=[pre-defined port name or another disposition URL]; errorto=[pre-defined port name or another disposition url] The following table lists and describes the parameters for the disposition. Parameter wsdl-url Description The URL to the WSDL file that is required to create the SOAP message, for example: webservice.ibs?wsdl where: webservice Is the name of the Web service you created using iway Explorer. To find this value, you can navigate to the iway Business Services tab and open the Service Description link in a new window. The WSDL URL appears in the Address field. Alternatively, you can open the WSDL file in a third-party XML editor (for example, XMLSPY) and view the SOAP request settings. soapaction Method that is called by the SOAP disposition, for example: webservice.method@test@@ where: webservice Is the name of the Web service you created using iway Explorer. method test Is the method being used. Is the license that is used by the Web service. To find this value, you can navigate to the iway Business Services tab, open the Service Description link in a new window, and perform a search for soapaction. Alternatively, you can open the WSDL file in a third-party XML editor (for example, XMLSPY) and view the SOAP request settings. 130 iway Software

131 6. Configuring the Event Adapter for SAP Parameter method namespace responseto errorto Description Web service method you are using. This value is in the WSDL file. The XML namespace you are using. This value is in the WSDL file. Location to which responses are posted. Can be a predefined port name or another URL. Optional. The URL must be complete, including the protocol. Location where error documents are sent. This can be a predefined port name or another full URL. Optional. Note: To use the SOAP disposition with a synchronous event, use Remote Function Modules to generate the schema and WSDL file instead of using the Business Object Repository for any RFC or BAPI. The following is an example of a completed SOAP disposition: soap: soapaction=soapws.getlistrequest@test@@;method=getlist; namespace=urn:iwaysoftware:ibse:jul2005:getlist; responseto=ifile://c:\output\sap\soapout.xml 4. Using the Edit channels pane, create a channel. a. Provide the required information to connect to SAP in the System and User tabs. b. In the Advanced tab, from the Processing Mode drop-down list, select REQUEST_RESPONSE. 5. Associate the port you created earlier with the new channel. 6. Start the channel. A Web service for an SAP Remote Function Module, for example, BAPI_MATERIAL_GETLIST, is triggered after an event occurs in the SAP system. The response document is returned and routed to a file location. iway Application Adapter for mysap ERP User s Guide 131

132 Synchronous Event Processing 132 iway Software

133 iway 7 Understanding SAP Events The following topics provide an overview of event functionality in SAP and describe how to configure and test your SAP system for event processing. Topics: Overview Related Concepts and Terminology Registering Your Program ID in SAPGUI Testing the SAP Event Adapter Application Link Enabling Configuration for the Event Adapter Testing the SAP ALE Configuration iway Application Adapter for mysap ERP User s Guide 133

134 Overview Overview An event in SAP is defined as an occurrence of a status change in an object. The event is created when the relevant status change occurs. You or SAP must implement event creation. An event is created from a specific application program (the event creator) and then "published" system-wide. An unlimited number of receivers can respond to the event with their own "response mechanisms". An event is usually defined as a component of an object type. SAP "pseudo events" are events that are not processed by the SAP Event manager, but are called from an ABAP program or Remote Function call (using the Destination parameter). Related Concepts and Terminology In this section: Client and Server Programs SAP Gateway Program IDs and Load Balancing The following topics list and define specific terminology related to SAP and SAP event handling. Client and Server Programs RFC (Remote Function Call) programs for non-sap systems can function as either the caller or the called program in an RFC communication. The two types of RFC programs are: RFC Client RFC Server The RFC client is the instance that calls the RFC library to execute the function that is provided by an RFC server. The functions that can be executed remotely are called RFC functions, and the functions provided by the RFC API are called RFC calls. SAP Gateway The SAP Gateway is a secure application server. No connections are accepted unless they were pre-registered previously from the SAP presentation Client. A server connection presents itself to the Gateway and exposes a Program Identifier. If the Program Identifier is found in the list of registered Program IDs, the Gateway server then offers a connection to the server, which accepts a connection. 134 iway Software

135 7. Understanding SAP Events The Program ID then is linked with an RFC Destination within SAP, which enables SAP Function Modules and ALE documents (IDocs or BAPI IDocs) to be routed to the destination. The RFC Destination functions as a tag to mask the Program ID to SAP users. An RFC server program can be registered with the SAP Gateway and wait for incoming RFC call requests. An RFC server program registers itself under a Program ID at an SAP Gateway and not for a specific SAP system. In SAPGUI, the destination must be defined with transaction SM59, using connection type T and Register Mode. Moreover, this entry must contain information on the SAP Gateway where the RFC server program is registered. Program IDs and Load Balancing If the Gateway Server has a connection to a particular server instance and another server instance presents itself to the Gateway, the Gateway offers the connection and then begins functioning in Load Balancing mode. Using a proprietary algorithm, the Gateway sends different messages to each server depending on demand and total processing time. This could cause unpredictable results in a scenario where messages are validated by schema and application. When configuring multiple events using a single SAP program ID, SAP load balances the event data. For example, if multiple remote function calls or BAPIs use the same program ID (for example, IWAYID) and multiple SAP listeners are configured with this program ID, then SAP sends one request to one listener and the next to another listener, and so on. The SAP Gateway Server includes a load balancing algorithm. This mechanism is proprietary to SAP application development and may work by comparing total throughput of the connection, the number of times in wait state, and so on. This means connection 1 may receive nine messages and connection 2 may receive one message. If five of nine messages are rejected for schema validation and the message on the other ID is rejected for schema validation, the customer can very easily make a case of missing messages. Registering Your Program ID in SAPGUI How to: Register Your Program ID To enable your SAP system to issue the following calls or interfaces to the SAP event adapter, you must register your program ID under an RFC destination. Remote Function Calls (RFC) Business Application Programming Interfaces (BAPI) Intermediate Documents (IDoc) iway Application Adapter for mysap ERP User s Guide 135

136 Registering Your Program ID in SAPGUI The RFC destination is a symbolic name (for example, IWAYDEST) that is used to direct events to a target system, masking the program ID. The Program ID is configured in both SAPGUI and the event adapter. Procedure: How to Register Your Program ID To register your program ID: 1. Launch the SAP Workbench and logon to the SAP system. 2. Select Tools, Administration, Network, and then RFC destination. 3. Execute the SM59 transaction. The Display and maintain RFC destinations window opens and displays a list of connections and drivers you can manage as shown in the following image. 4. Select TCP/IP connections. 5. Click Create. 136 iway Software

137 7. Understanding SAP Events The RFC Destination window opens and displays fields where you provide information about the RFC destination as shown in the following image. a. In the RFC destination field, type a name, for example, IWAYDEST. The value you type in this field is case-sensitive. b. In the Connection type field, type T (for destination type, TCP/IP). c. In the Description field, type a brief description. 6. Click Save from the tool bar or select Save from the Destination menu. iway Application Adapter for mysap ERP User s Guide 137

138 Testing the SAP Event Adapter The RFC Destination IWAYDEST window opens as shown in the following image. a. For the Activation Type, click the Registration button. b. In the Program field, type IWAYID. 7. Click Save from the tool bar or select Save from the Destination menu. 8. Ensure your event adapter is running. 9. To verify that the SAP system and the iway Application Adapter for mysap ERP are communicating, click Test connection. Testing the SAP Event Adapter How to: Test the SAP Event Adapter by Sending RFCs or BAPIs Manually In the SAP Server, the SE37 transaction enables you to send RFCs (Remote Function Calls) or BAPIs (Business Application Programming Interfaces) to any RFC destination. For more information on RFC destinations, see Registering Your Program ID in SAPGUI on page 135. Note: Depending on the release or service pack installed, certain RFCs may not exist in your particular SAP system. Therefore, the examples included in this documentation may not be relevant to your system. If this is the case, you should use the examples as a general reference for adapter functionality and choose an RFC that exists within your SAP application environment. 138 iway Software

139 7. Understanding SAP Events Procedure: How to Test the SAP Event Adapter by Sending RFCs or BAPIs Manually To test the SAP event adapter: 1. In the Function Builder: Initial Screen, select a function module, for example, RFC_CUSTOMER_GET. The following image shows the Function Builder: Initial Screen where you can select to display, change, or create a function module. RFC_CUSTOMER_GET is selected. a. To choose single test, press F8 and click the Single Test icon or select Function module, Test, and then Single Test. b. Enter an RFC target system, for example, IWAYDEST. c. Enter input data for the particular RFC module, for example, AB*. 2. To execute, press F8. iway Application Adapter for mysap ERP User s Guide 139

140 Application Link Enabling Configuration for the Event Adapter The Test Function Module: Initial Screen opens as shown in the following image. It includes information about the test, the function module, and the target system. You can select the check box for Upper/lower case. The upper left pane lists the import parameters, and the upper right pane contains fields for the values. The lower left pane lists tables, and the lower right pane lists the number of entries. 3. Enter data into the SAP GUI and click the Execute button. The function name and input data are transferred by RFC to create an XML document on the application server with the parameters input in SAPGUI. Application Link Enabling Configuration for the Event Adapter In this section: Document Processing Collected Inbound Configuration The SAP event adapter receives IDocs (Intermediate Documents) from SAP. Document Processing The iway Application Adapter for mysap ERP accepts IDocs in either SAP standard format or XML format. If you are using flat IDocs, no encoding is required and the EDI_DC40 control header must be the first entry in the IDoc. 140 iway Software

141 7. Understanding SAP Events Collected Inbound Configuration How to: Define a Port Create a Logical System Create a Partner Profile Create a Distribution Model for the Partner and Message Type When sending collected IDocs to SAP, if the DOCNUM field does not have a unique document number for each IDoc, the system creates an IDoc for each header record in the collected IDoc file. The system also duplicates the data for each IDoc. You must ensure that the DOCNUM field is included in the EDI_DC40 structure and that each IDoc has a unique sequence number within the collected IDoc file. To configure an SAP system to send IDocs to the SAP event adapter, you use the ALE (Application Link Enabling) configuration to: 1. Register your program ID in SAPGUI. For more information, see Registering Your Program ID in SAPGUI on page Define a port. A port identifies where to send messages. The port can be used only if an RFC destination was previously created. For more information on creating an RFC destination, see Overview on page 134. For more information on defining a port, see How to Define a Port on page Create a logical system. One type of partner is a logical system. A logical system manages one or more RFC destinations. For more information, see How to Create a Logical System on page Create a partner profile. A partner profile is a definition of parameters for the electronic interchange of data with a trading partner using the IDoc interface. To communicate with a partner using the IDoc interface, you must create a partner profile. For more information, see How to Create a Partner Profile on page Create a distribution model for the partner and message type. You create a distribution model for the partner and message type you designated. For more information, see How to Create a Distribution Model for the Partner and Message Type on page 146. iway Application Adapter for mysap ERP User s Guide 141

142 Application Link Enabling Configuration for the Event Adapter 6. Test the SAP event adapter. For more information, see Testing the SAP ALE Configuration on page 148. Procedure: How to Define a Port To define a port: 1. In the ALE configuration, choose Tools, Business Communications, IDocs Basis, IDoc, and then Port Definition or execute the WE21 transaction. The Creating a trfc port window opens as shown in the following image. On the left, the window is divided into a Ports pane and a Description pane. A pane for displaying information about the port is on the right. a. In the left pane under Ports, select Transactional RFC and click Create. b. Select Generate port name. The system generates the port name. c. In the right pane, select the IDoc version you want to send through this port. d. Click the destination you created, for example, IWAYDEST. 2. Save the session, making note of the system-generated RFC port. 142 iway Software

143 7. Understanding SAP Events Procedure: How to Create a Logical System To create a logical system called IWAYLOG: 1. In the ALE Configuration, enter the area menu selection SALE transaction. 2. Select SAP Reference IMG. 3. Expand the following nodes: Basis Components, Application Link Enabling (ALE), Sending and Receiving Systems, Logical Systems, and Define Logical System. 4. Click the green check mark beside Define Logical System. The Change View "Logical Systems": Overview window opens and displays a list of logical systems and their names as shown in the following image. 5. Click New entries. iway Application Adapter for mysap ERP User s Guide 143

144 Application Link Enabling Configuration for the Event Adapter The New Entries: Overview of Added Entries window opens, as shown in the following image, with columns labelled Log.System and Name for adding new log systems. a. Type an entry for Log System, for example, IWAYLOG. b. In the Name column, typea name (description) for the partner profile. 6. Save the session. Procedure: How to Create a Partner Profile To create a partner profile: 1. In the SAP Workbench, choose Tools, Business Communication, IDoc Basis, IDoc, and then Partner profile or execute the WE20 transaction. 144 iway Software

145 7. Understanding SAP Events The Partner profiles: Outbound parameters window opens and displays fields for specifying details for the partner profile as shown in the following image. a. Select Partner type LS (Logical system). b. Press F5 (Create). 2. For Type, enter USER. 3. For Agent, enter the current user ID, or you may select another agent type. 4. Under the outbound parameter table control, select Create outbound parameter. Partn.type is LS. Message type is DEBMAS (the IDoc document type). 5. Leave Partn.funct blank. 6. Click the Outbound options tab. a. Depending on your performance requirements, click Transfer IDoc Immed or Collect IDocs. b. For the IDoc, type a message type, for example, DEBMAS. c. Type a receiver port, for example, A Save the session and exit. iway Application Adapter for mysap ERP User s Guide 145

146 Application Link Enabling Configuration for the Event Adapter The Partner profiles summary window opens and displays information for the logical system that you created as shown in the following image. In the left pane are partners and descriptions. The right pane displays information depending on which tab is active. Procedure: How to Create a Distribution Model for the Partner and Message Type To create a distribution model called IWAYMOD: 1. In the SAP Workbench, choose Tools, AcceleratedSAP, Customizing, and then Project Management or execute the BD64 transaction. The Display Distribution Model window opens. 2. Select Create model view. (If required, switch processing mode to edit within Distribution Model/Switch Processing Mode.) 3. Type a short text string and a technical name for your new model view. 4. Click the Save button. 146 iway Software

147 7. Understanding SAP Events The Distribution Model Changed window opens with a tree structure of the distribution model in the left pane and the descriptions or technical names in the right pane, as shown in the following image. 5. In the Distribution Model tree, select a new model view. 6. At the right, in the button bar, select Add message type. The Add Message Type pane opens and displays the name of the model view. It includes fields for specifying the sender and receiver of the message, as well as the message type, as shown in the following image. a. In the Sender field, provide the sender that points to the SAP system that sends the IDoc, for example, I46_CLI800. In this case, the sender is an SAP 4.6B system. iway Application Adapter for mysap ERP User s Guide 147

148 Testing the SAP ALE Configuration b. In the Receiver field, provide the logical system, for example, IWAYLOG. c. In the Message type field, provide the type of IDoc, for example, DEBMAS. 7. Click the check mark icon. 8. Click the Save button. The Change Distribution Model window opens and displays the new model view to use to send message type, DEBMAS, from the I46_CLI800 SAP system to the IWAYLOG logical system, as shown in the following image. You are now ready to test the connection to the logical system. Testing the SAP ALE Configuration How to: Test the SAP ALE Configuration In the SAP Server, the BD12 transaction enables you to send IDocs to any logical system, for example, to an event adapter. 148 iway Software

149 7. Understanding SAP Events Procedure: How to Test the SAP ALE Configuration The following image shows the Send Customers window where you test the message type. It includes fields for Customer, Class, Output type, and Logical system. The Parallel processing pane includes a field for Server group and a field for the number of customers per process. To test the SAP Application Link Enabling (ALE) configuration: 1. In the Send Customers window, type the IDoc message type DEBMAS in the Output type field. 2. In the Logical system field, type the logical system, for example, IWAYLOG. 3. To transfer data, click the Run button. The SAP event adapter receives the IDoc in XML format. No response is expected from the event adapter. iway Application Adapter for mysap ERP User s Guide 149

150 Testing the SAP ALE Configuration A window opens and confirms the message entered in previous screens, as shown in the following image. 150 iway Software

151 iway 8 Configuring the Adapter in iway Designer After you successfully configure the adapter to represent a particular adapter target, the adapter can be used within an iway Designer process flow. Topics: Using the Adapter in iway Designer iway Application Adapter for mysap ERP User s Guide 151

152 Using the Adapter in iway Designer Using the Adapter in iway Designer How to: Add a Previously Defined Adapter Define a New Adapter in iway Designer You can make an adapter available to a process flow created in iway Designer, a GUI-based tool, used to build stateless process flows that execute within iway Service Manager (ism). The adapter can be incorporated as a node, called an Adapter object, in an iway process flow, allowing you to integrate it easily into a business process solution. When creating an Adapter object, you can add an adapter to the object in one of two ways: Add an adapter that has already been defined either in an iway Designer process flow or in iway Service Manager. For more information, see How to Add a Previously Defined Adapter on page 152. Add an adapter that has not been previously defined in iway Designer or iway Service Manager. For more information, see How to Define a New Adapter in iway Designer on page 155. To use an adapter in a process flow, you must first configure a target for the adapter within iway Explorer. For more information on configuring a target see Creating XML Schemas for mysap on page 59. Before you begin, ensure that you have created a project and created a process for that project. You can create a project by right-clicking the Processes folder in your project and selecting New Process from the context menu. For more information, see the iway Designer User's Guide. Procedure: How to Add a Previously Defined Adapter To add a previously defined adapter: 1. In the left pane of iway Designer, select the process to which you want to add the adapter. 2. From the button bar, click and drag the Adapter object icon to the workspace. 152 iway Software

153 8. Configuring the Adapter in iway Designer The New Adapter Object dialog box appears, as shown in the following image. a. Provide a descriptive name, for example, mysap, and a brief description (optional) for the Adapter object. b. If you have updated adapter target information in iway Explorer, click Refresh Adapters. 3. Click Next. Note: The Deactivate option allows you to configure the object, but suppress its function within the process flow (usually used for debugging). The Design mode option allows you to insert the object without configuring it, so that it acts as a placeholder in the process flow. You are prompted to select the adapter type from the Defined Adapters list. 4. Select the adapter from the Defined Adapters drop-down list. If you do not see the adapter in the list, you must go through the process of defining the adapter. For instructions, see How to Define a New Adapter in iway Designer on page Click Next. iway Application Adapter for mysap ERP User s Guide 153

154 Using the Adapter in iway Designer The Properties dialog box for the adapter you selected opens. The following image is an example of the adapter Properties dialog box. In this dialog box, you can review and change the properties associated with the target. To change a property, click in the field and edit it directly. If multiple dialog boxes appear, continue to click Next to review all of the properties. 6. Click Finish. An icon representing the Adapter object appears in the workspace and the adapter is available to your iway process flow. For information on defining relationships between the Adapter object and other objects in your iway process flow, see the iway Designer User's Guide. 154 iway Software

155 8. Configuring the Adapter in iway Designer Procedure: How to Define a New Adapter in iway Designer You can create a new adapter object that has not been previously defined in the repository from the New Adapter Object dialog box. 1. Select the process to which you want to add the adapter object. 2. From the button bar, click and drag the Adapter Object icon to the workspace. The New Adapter Object - Adapter Name and Description dialog box opens, as shown in the following image. a. Provide a descriptive name and a brief description (optional) for the Adapter object. b. If you have updated adapter target information in iway Explorer, click Refresh Adapters. 3. Click Next. 4. In the Adapter Type dialog box, click New. iway Application Adapter for mysap ERP User s Guide 155

156 Using the Adapter in iway Designer The New Adapter Definition - Adapter Name and Description dialog box opens, as shown in the following image. 5. Type a unique, descriptive name to be used as an alias and a brief description (optional) for the adapter you are defining. 6. Click Next. 156 iway Software

157 8. Configuring the Adapter in iway Designer The Define Adapter ibsp URL dialog box opens, as shown in the following image. 7. Select an available ibsp URL from the drop-down list or type a URL in the following format: where host port 8. Click Next. Is the name of the machine on which iway Service Manager is installed. Is the port number on which ibsp listens for SOAP requests. The default is iway Application Adapter for mysap ERP User s Guide 157

158 Using the Adapter in iway Designer The Adapter/Target dialog box opens, as shown in the following image. a. From the Adapter drop-down list, select the adapter. b. From the Target drop-down list, select the target you want to use in your iway process flow. 9. Click Next. The descriptor properties for the adapter and target you selected appear. You can review and change the parameters associated with the target. To change a parameter, click in the field and edit it directly. If multiple dialog boxes appear, continue to click Next to review all of the parameters. 10. Click Next at the last New Adapter Define dialog box. 158 iway Software

159 8. Configuring the Adapter in iway Designer The Main Properties dialog box appears. You can review and change the properties for the new adapter definition. 11. Click Finish. The Adapter Type dialog box appears with the newly created adapter in the Defined Adapters field. 12. To use this adapter to create the Adapter object, click Next. The adapter and target properties for the Adapter object appear in the Properties dialog box. You can review all parameters associated with the target again. Continue to click Next to move through the dialog boxes. 13. At the final Properties dialog box, click Finish. iway Application Adapter for mysap ERP User s Guide 159

160 Using the Adapter in iway Designer An icon representing the Adapter object appears in the workspace, and the adapter is available to your iway process flow. For information on defining relationships between the Adapter object and other objects in your iway process flow, see the iway Designer User's Guide. 160 iway Software

161 iway Configuring the Adapter in an iway 9 Environment After you successfully configure the adapter to represent a particular adapter target, the adapter can be assigned to an iway Service Manager channel or iway Adapter Manager listener. Topics: Configuring the Adapter in iway Service Manager Configuring the Adapter in Adapter Manager iway Application Adapter for mysap ERP User s Guide 161

162 Configuring the Adapter in iway Service Manager Configuring the Adapter in iway Service Manager How to: Define the Adapter Modify or Update an Adapter Connection Before configuring the adapter in iway Service Manager, you must first create a target, which represents a connection to a backend system, using iway Explorer. For more information on configuring targets and connections using iway Explorer, see Creating XML Schemas for mysap on page 59 or the iway Explorer User's Guide. You configure the adapter in the iway Service Manager console. The configuration process creates run-time connection and persistent data files within Service Manager. The configuration process interrogates the Service Manager repository entries that were built when the target and connection were created using iway Explorer. The define adapter process creates the run-time repository based on the design-time repository. Procedure: How to Define the Adapter To define the adapter: 1. In the Service Manager console, select Registry, then Adapters. 2. Click Add. The ibsp URL pane opens, as shown in the following image. 3. Enter your ibsp URL, which is the location of the Service Manager repository, for example, This field is required. 4. Click Next. 162 iway Software

163 9. Configuring the Adapter in an iway Environment An adapter selection pane opens, as shown in the following image. 5. From the Adapter drop-down list, select the Adapter, then click Next. 6. From the Target drop-down list, select a target you configured for the adapter in iway Explorer, then click Next. The connection information associated with the target selected is displayed. a. Select whether to return an error document when an error occurs. b. Select whether an adapter connection will be reused between executes. c. Review the connection information you specified in iway Explorer. You can change or update any information. 7. Click Next. 8. Provide a name and, optionally, a description, for the adapter, and click Finish. iway Application Adapter for mysap ERP User s Guide 163

164 Configuring the Adapter in iway Service Manager The adapter appears in the adapters list, as shown in the following image. Procedure: How to Modify or Update an Adapter Connection The following image shows the Adapter Defines pane which displays the name of the adapter and the description (optional). To modify or update an adapter connection: 1. From the Adapters list, click the adapter reference you defined, in this example, mysap_ism. The pane that displays the target connection information opens. You cannot change the name of the adapter or the target, but you can edit the connection information. 2. After you modify the connection information, click Update Connection Properties. 3. After you make changes or additions to the adapter target in iway Explorer, click Update Adapter Data. 4. Click Finish. 164 iway Software

165 9. Configuring the Adapter in an iway Environment Configuring the Adapter in Adapter Manager How to: How to Configure the Adapter How to Modify or Update an Adapter Connection Before configuring the adapter in Adapter Manager, you must first create a target using iway Application Explorer. The target represents a connection to a back-end system. For more information on configuring targets and connections using Application Explorer, see the Application Explorer User's Guide. You configure the adapter in the Adapter Manager console. The configuration process creates run-time connection and persistent data files within Adapter Manager. The configuration process interrogates the Adapter Manager repository entries that were built when the target and connection were created using Application Explorer. The define adapter process creates the run-time repository based on the design-time repository. Procedure: How to How to Configure the Adapter To configure the adapter: 1. In the left pane of the Adapter Manager console, click Configuration, select Defines, and then click Adapters. The Adapter Defines pane opens, as shown in the following image. a. In the Name field, type the name of the adapter, for example, MyAdapter. b. In the Description field (optional), type a description of the adapter, for example, Sample Adapter. 2. Click Add. iway Application Adapter for mysap ERP User s Guide 165

166 Configuring the Adapter in Adapter Manager The following pane opens where a value for ibsp URL is required in the Parameter Value field as shown in the following image. 3. Type the ibsp URL, which is the location of the Adapter Manager repository, or accept the default, 4. Click Next. The following pane, which consists of four columns, opens as shown in the following image. The first column lists the parameter name, the second column provides drop-down lists where you can select a value for each parameter, the third column lists the parameter type, and the fourth column provides a description for each parameter. a. From the Adapter drop-down list in the Parameter Value column, select the iway adapter. b. From the Target drop-down list, select the target corresponding to the adapter you configured in Application Explorer. c. To return an error document, select the Create Error Document check box (optional). d. To enable a persistent connection, select the Persist Connection check box (optional). 5. Click Next. 166 iway Software

167 9. Configuring the Adapter in an iway Environment The following pane opens and displays the target connection information that was previously configured in Application Explorer and the Logon pane, as shown in the following image. The first column lists the parameter name, the second column provides a value for each connection parameter, the third column lists the parameter type, and the fourth column provides a description for each parameter. 6. Review the imported configuration and if you wish, modify or update the connection information. 7. Click Finish. iway Application Adapter for mysap ERP User s Guide 167

168 Configuring the Adapter in Adapter Manager The adapter you configured, MyAdapter appears in the Adapter Defines list, as shown in the following image and displays the name of the adapter and a description (optional). Procedure: How to How to Modify or Update an Adapter Connection To modify or update an adapter connection: 1. From the Adapter Defines list, select the adapter you defined, in the previous procedure, MyAdapter. You are returned to the pane that displays the target connection information. You cannot change the name of the adapter or the target, but you can edit the connection information. a. After you modify the connection information, click Update Connection Properties. b. After you make changes or additions to the adapter target in Application Explorer, click Update Adapter Data. 2. Click Save. 168 iway Software

169 iway 10 Troubleshooting Guidelines This section provides useful troubleshooting guidelines for the iway Application Adapter for mysap ERP. Topics: Identifying the Issue Design Time Run Time Debugging Error Messages Gathering Information Before Calling Customer Support Contacting Customer Support iway Application Adapter for mysap ERP User s Guide 169

170 Identifying the Issue Identifying the Issue Design Time Take a moment to categorize the issue you are experiencing. This will help you identify the specific area of concern, find the cause, and ultimately determine a solution or a workaround. Take some time to verify each step of the procedure to eliminate all possible extraneous causes of the issue and determine the correct cause. In this section: Connectivity Metadata RFC / BAPI IDoc This section lists potential issues that you may encounter during the design-time phase of the development process and provides solutions. Connectivity Connectivity problems may occur when defining or connecting to a mysap target using iway Explorer. Check with your system administrator and verify that all SAP server and logon information is correct. For more information on how to create and connect to a target, see Creating XML Schemas for mysap on page 59. Metadata If you experience missing data or application errors when trying to browse and create metadata, verify: For BAPI/RFC, that the function is RFC callable and is in an activated state. For IDoc, that the IDoc has been released and that the IDoc segments are released. In addition, verify that you are using a correct version of the IDoc for the system target. For all objects, verify that the user ID for metadata has the correct authorizations in the target system. For more information, see Viewing Application System Objects on page iway Software

171 10. Troubleshooting Guidelines Run Time RFC / BAPI Remote Function Call (RFC) is the standard SAP interface for communication between SAP systems. The RFC subsystem calls a remote enabled function to be executed in a target system. BAPIs (Business Application Programming Interfaces) play an important role in the technical integration and in the exchange of business data between SAP components, and between SAP and non-sap components. BAPIs have a release and versioning system, and you must be sure that the BAPI you are attempting to use is in a valid release state before proceeding. For customer created Remote Functions or BAPIs, verify that the functions are in correct release state and that standard ABAP programming conventions have been followed. If you experience a problem with a custom RFC/BAPI/IDoc, you must be prepared to send the source code for examination and duplication of the problem. IDoc In SAP systems, the IDoc interface is used to exchange business data between two different Systems in an asynchronous manner. The IDoc interface consists of the definition of a data structure and the processing logic for this data structure. The systems involved must both recognize the data format used to exchange the data, this is done through segments and versioning. The IDoc must be in a released state for the SAP version you are using, and all segments must be released for the IDoc and release. The IDoc type must be assigned to a valid Message Type. At run time, determine whether you are integrating with collected IDocs or single IDocs, and adjust the SAP ALE profile parameters accordingly. In this section: Connectivity Service Scenario Event Processing Transactional Behavior Performance Issues This section lists potential issues that you may encounter during the run time phase of the development process and provides solutions. iway Application Adapter for mysap ERP User s Guide 171

172 Run Time Connectivity The design process target is used for run time connectivity. Verify that when you created the target, you specified the correct connection pool and IDoc parameters. For security reasons, target parameters can be overridden for a single session, but the base information can never be changed. You must delete and recreate the target for permanent changes. Processing Guidelines In a structural issue, information about the function or its parameters are faulty. This can be connectivity issues, release issues, authorizations or even incorrect document. What can you do? If you created your instance document in an external editor or program, verify the document against the iway created schema for the document. If this is correct, verify the schema against the SAP function parameters to make sure there were no errors or omissions in creating the schema. If all of these pass, note the error message, a reproduction scenario, traces of the error, and contact iway support. In a data issue, it is the values you are passing to the function that are incorrect. What can you do? Verify that you are sending the data for the release dependent version of the function or IDoc you wish to call. Make sure you are passing data that is valid for the SAP parameter for the function. Check with the functional area specialist for the application to make sure you meet the application requirements. Service Scenario Service processing occurs when the iway Application Adapter for mysap ERP calls an SAP ERP system and waits for a response. In this scenario, you typically create a Target, browse to the meta data of the function or IDoc you with to work with, and create a schema and / or a web service. You then create a channel with all valid processing parameters. You then create an XML instance with the data you want to pass to the function, and submit it to the iway adapter via any standard protocol. The response is delivered to the destination channel you configured when setting up the service. Event Processing Event processing occurs when an SAP ERP system calls the iway Application Adapter for mysap ERP. Verify correct Event registration in SAP using the correct event modality: change pointers / table update / BAPI Event, custom function. 172 iway Software

173 10. Troubleshooting Guidelines The following event-driven scenarios are possible: An SAP ERP system calls the iway Application Adapter for mysap ERP and the adapter is configured for asynchronos processing. BAPI/RFC interface - In this case, SAP passes the function name and any input parameters to the function. iway creates an XML document with these parameters and the function name as the root node at the defined destination. IDoc interface - the IDocs are created by the adapter at the defined destination. An SAP ERP system calls the iway Application Adapter for mysap ERP and the adapter is configured for synchronous processing. BAPI/RFC interface - You must define a service that will process the function parameters and return valid data in SAP format back to SAP. Any iway service or a custom service you program can be used for this type. IDoc interface - The IDoc interface is asynchronous by design. Any attempt to make synchronous events from IDocs can seriously impair the TRFC service on the SAP application server. Do not attempt to define this scenario. Transactional Behavior In SAP, the Transactional Remote Function Call subsystem ensures that events are always delivered and not duplicated. Transaction Identification Management (TID) is unique code that is used for a each communication process to guarantee the integrity of the data to be transferred. The receiving system can then use this code to decide whether this data has already been received and processed. In iway this file is tid2docnum.log found in the.\config\base subdirectory of the server. Each TID is mapped to an IDoc number. Do not modify this file, use it for verification only. Performance Issues Examine your entire system landscape configuration. Determine if the number of documents received or sent matches processing times and memory requirements. SAP maintains an online optimization help file for you to review all of these parameters. Increase hardware of total number of iway adapter instances can optimize performance. Here are some quick tips and suggestions: Use transaction ST06 to review the CPU, memory, swap, disk, and LAN response times. Use transaction ST02 to review the memory buffers. If any field has a indication (red color), investigate each field's dependant parameters and make the necessary adjustments. iway Application Adapter for mysap ERP User s Guide 173

174 Debugging Error Messages Determine whether the server has any external processes and/or programs running. In addition, review the shared pool buffers, redo log buffers, and how much is allocated for the SAP buffers. Determine whether you will use dialog or communication users and how many work processes have been allocated and make sure there is a sufficient amount available. For example, there can be some users who are running inefficient programs that are delaying the dialog work processes. Use transaction SM50 to check all dialog work processes that have a waiting status. Use transaction ST04 to review the database response times. Examine the physical reads ratio, logical reads ratio, wait times, and number of user calls. Use transaction SE30 to perform an ABAP runtime analysis. Every long running program can be optimized, whether on the ABAP layer or on the selection layer. In general, more attention should be focused toward custom programs. Since these are usually created quickly, performance considerations are often neglected. Debugging Error Messages In this section: Error Messages in iway Explorer Error Messages in SAP Error Messages in JCA Error Messages in ibsp Adapter-Specific Error Handling This section provides information that allows you to interpret various error message that can be generated when connecting to SAP. The adapter-specific errors that are also described in this section can arise whether you are using the adapter with a JCA or with an ibsp configuration. The following locations include log file information that is relevant for debugging purposes. JCA trace information can be found under the following directory: C:\Program Files\iWay60\config\base\log ibsp trace information can be found under the following directory: C:\Program Files\iWay60\ibsp\ibsplogs 174 iway Software

175 10. Troubleshooting Guidelines The log file for iway Explorer can be found under the following directory: C:\Program File\iWay60\tools\iwae\bin Error Messages in iway Explorer The following table lists errors and solutions when using iway Explorer with the adapter. Error Cannot connect to the adapter from iway Explorer. Cannot connect to the SAP target through iway Explorer. The following error message appears: Error getting target [SAP] - java.lang.exception: Error Logon to SAP System SAP does not appear in the iway Explorer adapter node list. Solution Ensure that: SAP is running. The Server name, System Number, and Client Number are correct. The SAP user ID and password are correct. Ensure that you enter the correct connection parameters when connecting to the SAP target. Ensure that you added the sapjco.jar and sapjcorfc.dll files to the lib directory. Ensure that you added the librfc32.dll file to the Windows system32 folder. iway Application Adapter for mysap ERP User s Guide 175

176 Debugging Error Messages Error Cannot connect to your SAP system through iway Explorer. The following error message appears: Problem activating adapter. (com.ibi.sapr3.sapadapterexception : com.sap.mw.jco.jco$exception: (102) RFC_ERROR_COMMUNICATION: Connect to SAP gateway failed Connect_PM GWHOST=isdsrv8, GWSERV=sapgw00, ASHOST=isdsrv8, SYSNR=00 LOCATION CPIC (TCP/IP) on Solution Ensure that SAP is running and that the parameter values for connecting to your server are correct. local host ERROR partner not reached (host isdsrv8, service 3300) TIME Fri Aug 27 11:49: RELEASE 620 COMPONENT NI (network interface) VERSION 36 RC -10 MODULE ninti.c LINE 979 DETAIL NiPConnect2 SYSTEM CALL SO_ERROR ERRNO ERRNO TEXT WSAECONNREFUSED: Connection refused COUNTER 1). Check logs for more information. 176 iway Software

177 10. Troubleshooting Guidelines Error Cannot connect to your SAP system through iway Explorer even though SAP is running. The following error message appears: Solution Ensure that you added the sapjcorfc.dll file to the lib directory and the librfc32.dll file to the Windows system32 folder. Problem activating adapter. (com.ibi.sapr3.sapadapterexception : java.lang.exceptionininitializerer ror: JCO.classInitialize(): Could not load middleware layer 'com.sap.mw.jco.rfc.middlewarerfc' JCO.nativeInit(): Could not initialize dynamic link library sapjcorfc [no sapjcorfc in java.library.path]. java.library.path The DLL is loaded in another class loader (ibsp and JCA are installed on the same server). The following error message appears: Ensure that you added the sapjco.jar file to the server class path. com.ibi.sapr3.sapadapterexception: java.lang.exceptionininitializerer ror: JCO.classInitialize(): Could not load middleware layer 'com.sap.mw.jco.rfc.middlewarerfc' JCO.nativeInit(): Could not initialize dynamic link library sapjcorfc [Native Library F:\iWay \lib\sapjcorfc.d ll already loaded in another classloader]. java.library.path Error Messages in SAP The following table lists errors and solutions when using the adapter. iway Application Adapter for mysap ERP User s Guide 177

178 Debugging Error Messages Error When executing a request, the following error message appears: AdapterException: java.lang.exception: Function Solution Check the syntax of your input XML document and ensure the name of the Remote Function module is correct and is available in SAP. module CUSTOMER_GETDETAIL2 does NOT exist. When executing a request, the following error message appears: AdapterException: java.lang.exception: Object type unknown for business object: CUST When executing a request, the following error message appears: AdapterException: java.lang.exception: Unable to retrieve BAPI name for: CUSTOMER.DETAIL2 When executing a request, the following error message appears: java.lang.runtimeexception: com.sap.mw.jco.jco$abapexcept ion: (126) OBJECT_UNKNOWN: Basic type or extension does not exist. When executing a request, the following error message appears: AdapterException: java.lang.exception: BapiError/BapiAbort: You are not authorized to display customers. Check the syntax of your input XML document and ensure the Object type is correct. Check the syntax of your input XML document and ensure the name of the BAPI is correct and is available in SAP. Check the syntax of your input XML document and ensure the IDoc extension is correct and is available in SAP. Make sure your user ID has the correct permissions configured in SAP. For more information, consult your SAP administrator. Error Messages in JCA The following table lists an error and a solution when using JCA. 178 iway Software

179 10. Troubleshooting Guidelines Error In iway Explorer, the following error message appears when you attempt to connect to a JCA configuration: Could not initialize JCA Solution In the Details tab in the right pane, ensure that the directory specified in the Home field points to the correct directory, for example, iway_home/lib Error Messages in ibsp The following topics discuss the different types of errors that can occur when processing Web services through the iway Business Services Engine (ibsp). The iway Business Services Engine (ibsp) serves as both a SOAP gateway into the adapter framework and as the engine for some of the adapters. At design time and run time, various conditions can cause errors in ibsp when Web services that use adapters are running. Some conditions and resulting errors are exposed the same way, regardless of the specific adapter; others are exposed differently, based on the adapter being used. This topic explains what to expect when you encounter the more common error conditions on an adapter-specific basis. Usually, the SOAP gateway (agent) inside ibsp passes a SOAP request message to the adapter required for the Web service. If an error occurs, the way it is exposed depends on the adapter and the API or interfaces that the adapter uses. A few scenarios cause the SOAP gateway to generate a SOAP fault. In general, when the SOAP agent inside ibsp receives an invalid SOAP request, a SOAP fault element is generated in the SOAP response. The SOAP fault element contains fault string and fault code elements. The fault code contains a description of the SOAP agent error. The following SOAP response document results when ibsp receives an invalid SOAP request: <SOAP-ENV:Envelope xmlns:soap-env=" <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>soap-env:client</faultcode> <faultstring>parameter node is missing</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> In the previous example, ibsp did not receive an element in the SOAP request message that is mandatory for the WSDL for this Web service. iway Application Adapter for mysap ERP User s Guide 179

180 Debugging Error Messages Adapter-Specific Error Handling Example: iway Application Adapter for mysap ERP Invalid SOAP Request Empty Result From SOAP Request Failure to Connect to SAP Invalid SOAP Request Empty Result From an iway Application Adapter for mysap ERP SOAP Request When an adapter raises an exception during run time, the SOAP agent in ibsp produces a SOAP fault element in the generated SOAP response. The SOAP fault element contains fault code and fault string elements. The fault string contains the native error description from the adapter target system. Because adapters use the target system interfaces and APIs, whether an exception is raised depends on how the target systems interface or API treats the error condition. If a SOAP request message is passed to an adapter by the SOAP agent in ibsp and that request is invalid based on the WSDL for that service, the adapter may raise an exception yielding a SOAP fault. Although it is almost impossible to anticipate every error condition that an adapter may encounter, the following examples show how adapters handle common error conditions and how error conditions are then exposed to the Web services consumer application. Example: iway Application Adapter for mysap ERP Invalid SOAP Request When the iway Application Adapter for mysap ERP receives a SOAP request message that does not conform to the WSDL for the Web service being executed, the following SOAP response is generated: <?xml version="1.0" encoding="iso "?> <SOAP-ENV:Envelope xmlns:soap-env=" soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>soap-env:server</faultcode> <faultstring>error processing agent [XDSapIfrAgent] - XD[FAIL] SapIFRException: java.sql.sqlexception: com.ibi.sapjco.sapcallablestatement: execute() j java.util.nosuchelementexception</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> 180 iway Software

181 10. Troubleshooting Guidelines Example: Example: Empty Result From SOAP Request When the iway Application Adapter for mysap ERP executes an SAP object as a Web service using input parameters passed in the SOAP request message that do not match records in SAP, the following SOAP response is generated: <?xml version="1.0" encoding="iso "?> <SOAP-ENV:Envelope xmlns:soap-env=" soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>soap-env:server</faultcode> <faultstring>error processing agent [XDSapIfrAgent] - XD[FAIL] SapIFRException: java.sql.sqlexception: com.ibi.sapjco.sapcallablestatement: execute() java.sql.sqlexception: JCO Error Key: NO_RECORD_FOUND Short Description: com.sap.mw.jco.jco$abapexception: (126) NO_RECORD_FOUND: NO_RECORD_FOUND</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Failure to Connect to SAP When the iway Application Adapter for mysap ERP cannot connect to SAP when executing a Web service, the following SOAP response is generated: <?xml version="1.0" encoding="iso "?> <SOAP-ENV:Envelope xmlns:soap-env=" soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>soap-env:server</faultcode> <faultstring>error processing agent [XDSapIfrAgent] - XD[RETRY] Connect to SAP gateway failed Connect_PM GWHOST=ESDSUN, GWSERV=sapgw00, ASHOST=ESDSUN, SYSNR=00 LOCATION CPIC (TCP/IP) on local host ERROR partner not reached (host ESDSUN, service 3300) TIME Mon Jun 30 16:01: RELEASE 620 COMPONENT NI (network interface) VERSION 36 RC -10 MODULE ninti.c LINE 976 DETAIL NiPConnect2 SYSTEM CALL SO_ERROR ERRNO ERRNO TEXT WSAECONNREFUSED: Connection refused COUNTER 1</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> iway Application Adapter for mysap ERP User s Guide 181

182 Gathering Information Before Calling Customer Support Example: Example: Invalid SOAP Request When the iway Application Adapter for mysap ERP receives a SOAP request message that does not conform to the WSDL for the Web services being executed, the following SOAP response is generated: <?xml version="1.0" encoding="iso "?> <SOAP-ENV:Envelope xmlns:soap-env=" soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>soap-env:server</faultcode> <faultstring>rpc server connection failed: Connection refused: connect </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Empty Result From an iway Application Adapter for mysap ERP SOAP Request Note: The condition for this adapter does not yield a SOAP fault. When the iway Application Adapter for mysap ERP executes a SOAP request using input parameters passed that do not match records in the target system, the following SOAP response is generated: <SOAP-ENV:Envelope xmlns:xsi=" xmlns:soap-env=" xmlns:xsd=" <SOAP-ENV:Body> <m:rundbqueryresponse xmlns:m="urn:schemas-iwaysoftware-com:iwse" xmlns="urn:schemas-iwaysoftware-com:iwse" cid="2a3cb42703eb20203f91951b89f3c5af"> <RunDBQueryResult run="1" /> </m:rundbqueryresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Gathering Information Before Calling Customer Support Gathering specific information about a problem before calling Customer Support helps familiarize you with the troubleshooting process and saves you time. This section outlines necessary information you should obtain for your iway Application Adapter for mysap ERP. In the SAP system, you find a set of tools for displaying detailed information on user sessions, work processes, and on the servers in your SAP system. 182 iway Software

183 10. Troubleshooting Guidelines If you want to work with these tools, choose the path Administration, System Administration on the initial SAP screen, or run transaction S002. The initial screen for system administration appears. The tools are available under Administration and Monitor. There are also programs that you can use at the operating system level to monitor themessage server or the gateway. Display an Overview of SAP Application Servers The Application Server Overview (transaction SM51) shows the application servers logged on at the SAP message server. Only these application servers are active in an SAP system.you can also administer the application servers, and manage and display the status of the users and work processes in all application servers belonging to the SAP system. Monitoring and Administration of the SAP Message Server If the messages server stops working, it must be restarted as quickly as possible, to ensure system continues to operate trouble-free. Display and Control Work Processes The Process Overview (transaction SM50) displays the current status of the work processes on the application server where you are logged on. The process overview is intended primarily for information-gathering. For example, you can monitor processes to determine if the number of work processes in your system is adequate, to assess if the instance is working to full capacity, to gather information for trouble-shooting, or for tuning. Display and Manage User Sessions In the User Overview (transaction SM04), you can display, log off, and monitor all the users active in the system who are logged on to this application server. Call Trace Facilities You can use the trace functions to follow the process of various operations in your SAP system. This allows you to monitor the system and to isolate problems that occur. You can use the trace functions to trace SQL database accesses, ABAP programs, internal operations in the SAP system, and authorization checks using flow traces (developer traces) generated by SAP processes. Use the SAP Gateway Monitor in the SAP System The Gateway Monitor is used for analyzing and administrating the SAP Gateway in the SAP system. The initial screen of the gateway monitor shows all the active gateway connections on this instance. Monitor RFC Resources on the Application Server iway Application Adapter for mysap ERP User s Guide 183

184 Contacting Customer Support You can monitor the RFC resources on all application servers and thus find out the load incurred by parallel RFCs on a server. You can also dynamically change the various quotas on all servers. Analyze Errors in the System with the System Log You can use the log to pinpoint and correct errors occurring in your system and its environment. Recording HTTP Requests and Evaluating the Log If you are using your SAP system as an HTTP client or server, you can record the HTTP requests and evaluate the log file created. The Internet Communication Manager (ICM) and the SAP message server support HTTP logging. Contacting Customer Support Customer Support consultants are available Monday through Friday between 8:00 A.M. and 8:00 P.M. EST to address your iway Application Adapter for mysap ERP questions. Information Builders consultants also can give you general guidance regarding product capabilities and documentation. Please be prepared to provide your six-digit site code (xxxx.xx) when you call. Important: When creating a package to allow Customer Support Services to diagnose a problem, be sure the export package that you create contains all components necessary for reproducing the problem. You also can access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide Web site, You can connect to the tracking system and database of known problems at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section of also provides usage techniques, diagnostic tips, and answers to frequently asked questions. To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO. 184 iway Software

185 iway Reader Comments In an ongoing effort to produce effective documentation, the Documentation Services staff at Information Builders welcomes any opinion you can offer regarding this manual. Please use this form to relay suggestions for improving this publication or to alert us to corrections. Identify specific pages where applicable. You can contact us through the following methods: Mail: Fax: Web form: Name: Company: Address: Telephone: Comments: Documentation Services - Customer Support Information Builders, Inc. Two Penn Plaza New York, NY (212) [email protected] Date: Information Builders, Two Penn Plaza, New York, NY (212) iway Application Adapter for mysap ERP User s Guide DN Version Service Manager (SM)

186 Reader Comments Information Builders, Two Penn Plaza, New York, NY (212) iway Application Adapter for mysap ERP User s Guide DN Version Service Manager (SM)