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