Sun Microsystems eWay SAP BAPI User Manual
SUN SEEBEYOND
eWAY™ ADAPTER FOR SAP BAPI
USER’S GUIDE
Release 5.1.3
Copyright © 2007 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved. Sun
Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this
document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents
listed at http://www.sun.com/patents and one or more additional patents or pending patent applications in the U.S. and in
other countries. U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc.
standard license agreement and applicable provisions of the FAR and its supplements. Use is subject to license terms. This
distribution may include materials developed by third parties. Sun, Sun Microsystems, the Sun logo, Java, Sun Java Composite
Application Platform Suite, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex, eBAM, eWay, and JMS are
trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries.
Products bearing SPARC trademarks are based upon architecture developed by Sun Microsystems, Inc. UNIX is a registered
trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. This product is covered and
controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile,
chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited.
Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but
not limited to, the denied persons and specially designated nationals lists is strictly prohibited.
Copyright © 2007 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, Etats-Unis. Tous droits réservés.
Sun Microsystems, Inc. détient les droits de propriété intellectuels relatifs à la technologie incorporée dans le produit qui est
décrit dans ce document. En particulier, et ce sans limitation, ces droits de propriété intellectuels peuvent inclure un ou plus
des brevets américains listés à l'adresse http://www.sun.com/patents et un ou les brevets supplémentaires ou les
applications de brevet en attente aux Etats - Unis et dans les autres pays. L'utilisation est soumise aux termes de la Licence.
Cette distribution peut comprendre des composants développés par des tierces parties. Sun, Sun Microsystems, le logo Sun,
Java, Sun Java Composite Application Platform Suite, Sun, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex,
eBAM et eWay sont des marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats-Unis et dans
d'autres pays. Toutes les marques SPARC sont utilisées sous licence et sont des marques de fabrique ou des marques déposées
de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont basés sur une
architecture développée par Sun Microsystems, Inc. UNIX est une marque déposée aux Etats-Unis et dans d'autres pays et
licenciée exclusivement par X/Open Company, Ltd. Ce produit est couvert à la législation américaine en matière de contrôle
des exportations et peut être soumis à la règlementation en vigueur dans d'autres pays dans le domaine des exportations et
importations. Les utilisations, ou utilisateurs finaux, pour des armes nucléaires, des missiles, des armes biologiques et
chimiques ou du nucléaire maritime, directement ou indirectement, sont strictement interdites. Les exportations ou
réexportations vers les pays sous embargo américain, ou vers des entités figurant sur les listes d'exclusion d'exportation
américaines, y compris, mais de manière non exhaustive, la liste de personnes qui font objet d'un ordre de ne pas participer,
d'une façon directe ou indirecte, aux exportations des produits ou des services qui sont régis par la législation américaine en
matière de contrôle des exportations et la liste de ressortissants spécifiquement désignés, sont rigoureusement interdites.
Part Number: 820-0973
Version 20070425133748
eWay™ Adapter for SAP BAPI User’s Guide 2 Sun Microsystems, Inc.
Contents
Contents
Chapter 1
Introducing the SAP BAPI eWay 7
About SAP 7
About the SAP BAPI eWay 7
Invoking BAPI/RFC Methods 8
The SAP BAPI eWay Data Flows 9
Outbound Data Flow: Java CAPS to SAP R/3 9
Inbound Data Flow: SAP R/3 to Java CAPS 9
What’s New in This Release 11
What’s In This Document 12
Scope 13
Intended Audience 13
Text Conventions 13
Related Documents 14
Sun Microsystems, Inc. Web Site 14
Documentation Feedback 14
Chapter 2
Installing the eWay 15
Installing the SAP BAPI eWay 15
Installing the SAP BAPI eWay on an eGate supported system 15
Adding the eWay to an Existing Sun Java Composite Application Platform Suite Installation 16
After Installation 17
Extracting the Sample Projects and Javadocs 17
ICAN 5.0 Project Migration Procedures 17
Installing Enterprise Manager eWay Plug-Ins 19
Viewing Alert Codes 20
Deploying an EAR File 22
WebLogic Application Servers 22
eWay™ Adapter for SAP BAPI User’s Guide 3 Sun Microsystems, Inc.
Contents
Chapter 3
Setting SAP BAPI eWay Properties 23
Creating and Configuring a SAP BAPI eWay 23
Configuring the eWay Connectivity Map Properties 23
eWay Connectivity Map Properties 25
Configuring the Inbound eWay Properties 25
Server Connection Settings 25
Configuring the Outbound eWay Properties 27
Client Connection Settings 27
Configuring the eWay Environment Properties 30
eWay External Properties 31
Inbound SAP BAPI eWay 32
Server Connection Settings 32
MDB Settings 34
Outbound SAP BAPI eWay 35
Client Connection Settings 35
Connection Retry Settings 37
Connection Pool Settings 37
Chapter 4
Creating SAP BAPI OTDs 39
SAP BAPI Encoding 39
Date and Time Stamp Requirements 40
SAP JCo Installation 40
Procedures (Windows 32) 40
Procedures (UNIX) 41
Creating BAPI and RFC OTDs 41
BAPI and RFC OTDs 45
Chapter 5
Configuring SAP R/3 48
Creating the RFC Destination for the eWay 48
Configuration Needed in SAP R/3 to Send and Receive IDocs 53
Configuring the Distribution Model 54
Naming the Logical System 54
Specifying the Distribution Model 57
Configuring Communications 60
Defining the Communications Port 60
eWay™ Adapter for SAP BAPI User’s Guide 4 Sun Microsystems, Inc.
Contents
Creating a Partner Profile 62
Configuring a Partner Profile 64
Security Issues 67
Chapter 6
Reviewing the Sample Projects 69
About the Sample Projects 69
prjBapiOutbound.zip 70
prjIDocInbound.zip 70
SAP Version Support 70
Steps Required to Run the Sample Project 70
Importing a Sample Project 71
Building and Deploying the prjBAPIOutbound Sample Project 71
Create a Project 72
Create the OTDs 72
Create the Java Collaboration Definitions 73
Create the Collaboration Business Rules 74
Create the Business Process 80
Create a Connectivity Map 84
Populate the Connectivity Map 84
Bind the eWay Components 85
Create an Environment 86
Configure the eWays 87
Configure the eWay Properties in the Connectivity Map 88
Configure the File eWay External Environment Properties 89
Configure the SAP BAPI eWay External Environment Properties 89
Create the Deployment Profile 90
Create and Start the Domain 91
Build and Deploy the Project 92
Run the Sample Project 92
Building and Deploying the prjIDocInbound Sample Project 92
Create a Project 93
Create the OTDs 93
Create the Java Collaboration Definitions 95
Creating the Collaboration Business Rules 96
Creating the Collaboration Business Rules 98
Create the Business Process 100
Configuring the bpIDocInbound Business Rule Components 102
Create a Connectivity Map 106
Populate the Connectivity Map 107
Bind the eWay Components 108
Create an Environment 109
Configure the eWays 110
Configure the eWay Properties in the Connectivity Map 111
Configure the File eWay External Environment Properties 112
Configure the SAP BAPI eWay External Environment Properties 112
Create the Deployment Profile 113
eWay™ Adapter for SAP BAPI User’s Guide 5 Sun Microsystems, Inc.
Contents
Create and Start the Domain 114
Build and Deploy the Project 115
Run the Sample 115
Additional Sample Project Scenarios 116
About Sending IDocs to SAP R/3 Using tRFCs 116
The RFC OTD used to send/receive IDOCs 116
Client Mode - sending IDOCs to SAP R/3 via IDOC_INBOUND_ASYNCRONOUS 117
Appendix A
SAP Data Type Conversion Table 121
Index 122
eWay™ Adapter for SAP BAPI User’s Guide 6 Sun Microsystems, Inc.
Introducing the SAP BAPI eWay
The Sun SeeBeyond eWay™ Adapter for SAP BAPI, also noted throughout this book as
the SAP BAPI eWay, provides Sun Java Composite Application Platform Suite (Java
CAPS) Projects with the ability to exchange data with SAP R/3 software. This chapter
provides an overview of the SAP BAPI eWay.
What’s In This Chapter
About SAP on page 7
About the SAP BAPI eWay on page 7
What’s New in This Release on page 11
What’s In This Document on page 12
Sun Microsystems, Inc. Web Site on page 14
Documentation Feedback on page 14
Chapter 1
1.1 About SAP
SAP creates software for the Enterprise Resource Planning (ERP) business sector. The
company main product is SAP R/3 which uses a three-tier application architecture—
database, application server, and client—to facilitate real-time data processing.
1.2 About the SAP BAPI eWay
The SAP BAPI eWay enables Java CAPS Projects to exchange data with SAP R/3
software using Business Application Programming Interfaces (BAPIs), RFCs, and
IDocs.
The SAP BAPI eWay uses the SAP Java Connector (SAP JCo) to allow Java applications
to access BAPIs and RFCs.
eWay™ Adapter for SAP BAPI User’s Guide 7 Sun Microsystems, Inc.
Chapter 1 Section 1.2
Introducing the SAP BAPI eWay About the SAP BAPI eWay
Figure 1 BAPI eWay
SAP R/3
Business Object
Repository
Cost
Center
BAPI
B
BAPI
A
SAP JCo
The functionality of the SAP BAPI eWay simplifies the process of determining the
requisite IMPORT, EXPORT, CHANGING, and TABLE parameters—collecting all
the necessary data using the correct type and format, calling the Remote Function
Module (RFM) that represents the BAPI, and then extracting and parsing data from the
EXPORT and/or TABLE parameters.
1.2.1 Invoking BAPI/RFC Methods
Before it can be invoked, a BAPI or RFM requires the following parameters:
BAPI eWay
A
B
BAPI
Repository
eGate Integrator
RFC
Function
OTD
A
IMPORT parameters: data provided to the BAPI
EXPORT parameters: data returned by the BAPI
CHANGING parameters: data provided to and/or returned by the BAPI/RFC
TABLE parameters - data provided to and/or returned by the BAPI/RFC
The detailed metadata for these parameters such as descriptions of their value types
and mandatory or optional nature, can be found under SAP transaction SE37.
Figure 2 Meta Data Extraction
IMPORT parameters
EXPORT parameters
TABLE parameters
CHANGING parameters
Cost
Center
BAPI
BAPI
IMPORT parameters
EXPORT parameters
TABLE parameters
CHANGING parameters
R
F
C
SAP R/3
C
F
R
eWay™ Adapter for SAP BAPI User’s Guide 8 Sun Microsystems, Inc.
Chapter 1 Section 1.2
Introducing the SAP BAPI eWay About the SAP BAPI eWay
The meta data for a BAPI/RFC in SAP R/3 is extracted by the BAPI wizard, which uses
it to build the BAPI/RFC OTD. This OTD is used in Java Collaborations and eInsight
Business Processes to invoke or receive the BAPI/RFC call.
1.2.2 The SAP BAPI eWay Data Flows
When the SAP BAPI eWay communicates with the SAP R/3 software, it uses the RFC
protocol. The list below shows the RFC types of communication used:
Outbound (Java CAPS to SAP R/3): non-transactional (regular) RFC and
transactional RFC (tRFC)
Inbound (SAP R/3 to Java CAPS): non-transactional and transactional RFC (tRFC)
Outbound Data Flow: Java CAPS to SAP R/3
Outbound communications occur when the eWay receives data from Java CAPS and
sends it to SAP R/3 by calling a specific BAPI or RFM. The figure below shows a nontransactional outbound process.
Figure 3 Outbound Data Flow: Java CAPS to SAP R/3
Business Process
Time
Collaboration
execute()
BAPI
OTD
BAPI
eWay
execute()
Call RFM
Call RFM
Return
SAP R/3
System
The figure above shows the following steps for the outbound data flow:
1 The Collaboration or Business Process populates the appropriate BAPI or RFC
Import, Changing, and Table parameter nodes on the BAPI/RFC OTD with data
from an inbound OTD.
2 The eWay logs onto the SAP R/3 application using preconfigured properties.
3 The eWay calls the BAPI OTD's execute() method. Any work performed is
immediately committed by SAP R/3 through autocommit.
4 The SAP R/3 applications returns successfully.
Inbound Data Flow: SAP R/3 to Java CAPS
For the inbound data flow, the SAP BAPI eWay can receive data from SAP R/3 via RFC
or tRFC. The sections below describe each protocol.
To enable the SAP BAPI eWay to receive data from SAP R/3, configure the
Environment properties with an RFC destination created within SAP R/3. For
information, refer to “Creating the RFC Destination for the eWay” on page 48.
eWay™ Adapter for SAP BAPI User’s Guide 9 Sun Microsystems, Inc.
Chapter 1 Section 1.2
Introducing the SAP BAPI eWay About the SAP BAPI eWay
Inbound Data Flow via RFC
The sequence diagram uses a sample CostCenter OTD to describe the RFC inbound
sequence.
Figure 4 Inbound Data Flow via RFC
Business Process SAP R/3
Time
Populate OTD
exception
BAPI
CostCenter
OTD
GetListReceive
GetListReply
BAPI eWay
(JCo server)
System
Call RFM
Call RFM
Return
The figure above shows the following steps for the inbound data flow via RFC:
1 The Business Process is activated when an RFM call is received from SAP R/3.
2 Finding that data from an RFM is available, the Business Process accesses all
pertinent data nodes and sends the gathered information to other Java CAPS
components.
3 The eWay returns the results of the RFM execution back to SAP.
Inbound Data Flow via tRFC
Communication via tRFC is the similar to RFC, except that it adds transactional
verification steps prior to committing or rolling back. tRFC is preferred over RFC
because of the additional reliability. By using unique TIDs associated with a BAPI/
RFM call, SAP R/3 processes the data once, and only once. The figure below shows
inbound data flow via tRFC.
eWay™ Adapter for SAP BAPI User’s Guide 10 Sun Microsystems, Inc.
Chapter 1 Section 1.3
Introducing the SAP BAPI eWay What’s New in This Release
Figure 5 Inbound Data Flow via tRFC
Time
Business
Process
Populate OTD
exception
BAPI
CostCenter
OTD
GetListReceive
BAPI
eWay
(JCo server)
Call RFM
GetListReply
Call RFM
onCommitTID()
onCommitTID()
onRollbackTID()
onRollbackTID()
SAP R/3
System
Return
Commit
Sequence
Return
OR
Rollback
Sequence
Return
The figure above shows the following steps for the inbound data flow via tRFC:
1 The Business Process is activated when an RFM call is received from SAP R/3.
2 Finding that data from an RFM is available, the Business Process accesses all
pertinent data nodes and sends the gathered information to other Java CAPS
components.
3 The eWay returns the results of the RFM execution back to SAP R/3.
4 If the RFM call returned successfully without exceptions, SAP R/3 informs the
eWay that the data can be committed by calling onCommitTID().
5 The eWay updates the TID in the file database as being Committed, commits the
data, and sends an onCommitTID() return to SAP R/3.
6 If the RFM call did not return successfully for any reason, SAP R/3 informs the
eWay that the data must be rolled back by calling onRollbackTID().
7 The eWay sends an onRollbackTID() return to SAP R/3, confirming that the TID
was not committed.
1.3 What’s New in This Release
The SAP BAPI eWay includes the following new features:
What’s New in Version 5.1.3
Added support: Supports automatic deployment of EAR files to WebLogic
Application Server (version 9.1).
eWay™ Adapter for SAP BAPI User’s Guide 11 Sun Microsystems, Inc.
Chapter 1 Section 1.4
Introducing the SAP BAPI eWay What’s In This Document
What’s New in Version 5.1.2
Support for SAP ECC 6.0 (Unicode only)
What’s New in Version 5.1.1
Supports automatic deployment of EAR files to WebLogic Application Server
(version 9.1).
What’s New in Version 5.1
Version Control: An enhanced version control system allows you to effectively
manage changes to the eWay components.
Manual Connection Management: Establishing a connection can now be performed
manually (using OTD methods from the Java Collaboration) for outbound Projects
only.
Multiple Drag-and-Drop Component Mapping from the Deployment Editor: The
Deployment Editor now allows you to select multiple components from the Editor’s
component pane, and drop them into your Environment component.
Support to obtain configuration from LDAP at Runtime: eWay configuration
properties now support LDAP key values.
MDB Pool Size Support: Provides greater flow control (throttling) by specifying the
maximum and minimum MDB pool size.
Connection Retry Support: Allows you to specify the number of attempts to
reconnect, and the interval between retry attempts, in the event of a connection
failure.
Relaunchable OTD Support: An OTD can be rebuilt and saved (under the same
name) then relaunched back to the same Java Collaboration or Business Process.
This allows you to rebuild the OTD with changed metadata without having to
completely recreate the business logic from scratch.
Connectivity Map Generator: Generates and links your Project’s Connectivity Map
components using a Collaboration or Business Process.
Additional methods to commit rollback BAPI/RFC in the Java Collaboration
Definition (JCD).
All BAPI OTDs can now be used to communicate with both Unicode and non-
Unicode SAP R/3 systems.
Support for BAPI/RFC with table types, changing parameters, and nested
structures.
Date fields are now represented as Java data type strings in the JCD.
1.4 What’s In This Document
This document includes the following chapters:
eWay™ Adapter for SAP BAPI User’s Guide 12 Sun Microsystems, Inc.
Chapter 1 Section 1.4
Introducing the SAP BAPI eWay What’s In This Document
Chapter 1 “Introducing the SAP BAPI eWay”: Provides an overview description of
the product as well as high-level information about this document.
Chapter 2 “Installing the eWay”: Describes the system requirements and provides
instructions for installing the SAP BAPI eWay.
Chapter 3 “Setting SAP BAPI eWay Properties”: Describes how to configure the
SAP BAPI eWay properties to enable data exchange between the SAP R/3 software
and a Java CAPS project.
Chapter 4 “Creating SAP BAPI OTDs”: Provides instructions for creating Object
Type Definitions to be used with the SAP BAPI eWay
Chapter 5 “Configuring SAP R/3”: Describes the configuration settings and
parameters of SAP R/3 in order to communicate with the SAP BAPI eWay.
Chapter 6 “Reviewing the Sample Projects”: Provides instructions for installing,
creating, and running the sample Projects.
Appendix A “SAP Data Type Conversion Table”: Provides a table that shows the
mapping between SAP data types to the SAP JCo and their corresponding Java data
types.
1.4.1 Scope
This document describes the process of installing, configuring, and running the SAP
(BAPI) eWay.
This document does not cover the Java methods exposed by this eWay. For information
on the Java methods, download and view the SAP (BAPI) eWay Javadoc files from the
Sun Java Composite Application Suite Installer.
1.4.2 Intended Audience
This guide is intended for experienced computer users who have the responsibility of
helping to set up and maintain a fully functioning Java Composite Application
Platform Suite. This person must also understand any operating systems on which the
Java Composite Application Platform Suite will be installed (Windows and UNIX), and
must be thoroughly familiar with Windows-style GUI operations. Familiarity with SAP
R/3 is recommended.
1.4.3 Text Conventions
The following conventions are observed throughout this document.
Table 1 Text Conventions
Text Convention Used For Examples
Bold Names of buttons, files, icons,
parameters, variables, methods,
menus, and objects
eWay™ Adapter for SAP BAPI User’s Guide 13 Sun Microsystems, Inc.
Click OK.
On the File menu, click Exit.
Select the eGate.sar file.
Chapter 1 Section 1.5
Introducing the SAP BAPI eWay Sun Microsystems, Inc. Web Site
Table 1 Text Conventions (Continued)
Text Convention Used For Examples
Monospaced Command line arguments, code
samples; variables are shown in
bold italic
Blue bold
Blue underlined
1.4.4 Related Documents
Hypertext links within
document
Hypertext links for Web
addresses (URLs) or email
addresses
The following Sun documents provide additional information about the Sun Java CAPS
product:
Sun SeeBeyond eGate™ Integrator User’s Guide
Composite Application Platform Suite Installation Guide
1.5 Sun Microsystems, Inc. Web Site
The Sun Microsystems web site is your best source for up-to-the-minute product news
and technical support information. The site’s URL is:
java -jar filename.jar
See
Text Conventions on page 13
http://www.sun.com
http://www.sun.com
1.6 Documentation Feedback
We appreciate your feedback. Please send any comments or suggestions regarding this
document to:
CAPS_docsfeedback@sun.com
eWay™ Adapter for SAP BAPI User’s Guide 14 Sun Microsystems, Inc.
Installing the eWay
This chapter describes the requirements and procedures for installing the SAP BAPI
eWay. Procedures for implementing sample projects, are described in Reviewing the
Sample Projects on page 69.
What’s In This Chapter
“Installing the SAP BAPI eWay” on page 15
“ICAN 5.0 Project Migration Procedures” on page 17
“Installing Enterprise Manager eWay Plug-Ins” on page 19
“Deploying an EAR File” on page 22
2.1 Installing the SAP BAPI eWay
Chapter 2
The Java CAPS Installer, a web-based application, is used to select and upload eWays
and add-on files during the installation process. The following section describes how to
install the components required for this eWay.
Refer to the readme for the latest information on:
Supported Operating Systems
External System Requirements
Java Composite Application Platform Suite Requirements
Known Issues
Note: When the Repository is running on a UNIX operating system, the eWays are loaded
from the Java Composite Application Platform Suite Installer, running on a
Windows platform connected to the Repository server using Internet Explorer.
2.1.1 Installing the SAP BAPI eWay on an eGate supported system
Follow the directions for installing Java CAPS in the Composite Application Platform Suite
Installation Guide.
After you have installed eGate or eInsight, do the following:
1 From the Suite Installer, click the Administration tab, and then click the link to
install additional products.
eWay™ Adapter for SAP BAPI User’s Guide 15 Sun Microsystems, Inc.
Chapter 2 Section 2.1
Installing the eWay Installing the SAP BAPI eWay
2 Select the following products from the eWay category:
FileeWay (the File eWay is used by most sample Projects)
SAPALEeWay (the SAP ALE eWay is used by the SAP BAPI eWay sample
Project)
SAPBAPIeWay
Select the following in the Documentation category to upload the User’s Guide,
Help file, Javadoc, Readme, and sample Projects for the Sun SeeBeyond eWay
Adapter for SAP BAPI:
SAPBAPIeWayDocs
3 Once you have selected all of your products, click Next in the top-right or bottom-
right corner of the Select Java Composite Application Platform Suite Products to
Install box.
4 From the Selecting Files to Install box, locate and select your first product’s SAR
file. Once you have selected the SAR file, click Next. Your next selected product
appears. Follow this procedure for each of your selected products. The Installation
Status window appears and installation begins after the last SAR file has been
selected.
5 Once your product’s installation is finished, continue installing the Java Composite
Application Platform Suite as instructed in the Composite Application Platform Suite
Installation Guide.
2.1.2 Adding the eWay to an Existing Sun Java Composite
Application Platform Suite Installation
It is possible to add the eWay to an existing Java CAPS installation.
Steps required to add an eWay to an Existing Java CAPS installation include:
1 Complete steps 1 through 4 in Installing the SAP BAPI eWay on an eGate
supported system on page 15.
2 Once your product’s installation is finished, open the Sun SeeBeyond Enterprise
Designer and select Update Center from the Tools menu. The Update Center
Wizard appears.
3 For Step 1 of the wizard, simply click Next.
4 For Step 2 of the wizard, click the Add All button to move all installable files to the
Include in Install field, then click Next.
5 For Step 3 of the wizard, wait for the modules to download, then click Next.
6 The wizard’s Step 4 window displays the installed modules. Review the installed
modules and click Finish.
7 When prompted, restart the IDE (Integrated Development Environment) to
complete the installation.
eWay™ Adapter for SAP BAPI User’s Guide 16 Sun Microsystems, Inc.
Chapter 2 Section 2.2
Installing the eWay ICAN 5.0 Project Migration Procedures
After Installation
You must incorporate the installed eWay components into a Project before using the
intended functions. See the Sun SeeBeyond eGate™ Integrator User’s Guide for more
information on incorporating the eWay into an eGate Project.
2.1.3 Extracting the Sample Projects and Javadocs
The SAP (BAPI) eWay includes sample Projects and Javadocs. The sample Projects are
designed to provide you with a basic understanding of how certain operations are
performed using the eWay, while Javadocs provide a list of classes and methods
exposed in the eWay.
Steps to extract the Javadoc include:
1 Click the Documentation tab of the Suite Installer, then click the Add-ons tab.
2 Click the Sun SeeBeyond eWay SAP BAPI Adapter link. Documentation for the SAP
BAPI eWay appears in the right pane.
3 Click the icon next to Javadoc and extract the ZIP file. Note that two separate
Javadocs are contained within, including:
Flight.zip
RFC_IDOC_ASYNCHRONOUS.zip
4 Extract each ZIP and then open the index.html within each extracted file to view
the Javadoc.
Steps to extract the Sample Projects include:
1 Click the Documentation tab of the Suite Installer, then click the Add-ons tab.
2 Click the Sun SeeBeyond eWay SAP BAPI Adapter link. Documentation for the SAP
BAPI eWay appears in the right pane.
3 Click the icon next to Sample Projects and extract the ZIP file. Note that the SAP
BAPI_eWay_Sample.zip file contains two additional ZIP files for each sample
Project.
Refer to Importing a Sample Project on page 64 for instructions on importing the
sample Project into your repository via the Enterprise Designer.
2.2 ICAN 5.0 Project Migration Procedures
This section describes how to transfer your current ICAN 5.0.x Projects to the Java
CAPS, version 5.1.3.
To migrate your ICAN 5.0.x Projects, do the following:
Export the Project
1 Before you export your Projects, save your current ICAN 5.0.x Projects to your
Repository.
eWay™ Adapter for SAP BAPI User’s Guide 17 Sun Microsystems, Inc.
Chapter 2 Section 2.2
Installing the eWay ICAN 5.0 Project Migration Procedures
2 From the Project Explorer, right-click your Project and select Export from the
shortcut menu. The Export Manager appears.
3 Select the Project that you want to export in the left pane of the Export Manager and
move it to the Selected Projects field by clicking the Add to Select Items (arrow)
button, or click All to include all of your Projects.
4 In the same manner, select the Environment that you want to export in the left pane
of the Export Manager and move it to the Selected Environments field by clicking
the Add to Select Items (arrow) button, or click All to include all of your
Environments.
5 Browse to select a destination for your Project ZIP file and enter a name for your
Project in the ZIP file field.
6 Click Export to create the Project ZIP file in the selected destination.
Install Java CAPS 5.1.3
1 Install the Java CAPS 5.1.3, including all eWays, libraries, and other components
used by your ICAN 5.0.x Projects.
2 Start the Sun SeeBeyond Enterprise Designer.
Import the Project
1 From the Sun SeeBeyond Enterprise Designer’s Project Explorer tree, right-click the
Repository and select Import Project from the shortcut menu. The Import Manager
appears.
2 Browse to and select your exported Project file.
3 Click Import. A warning message, “Missing APIs from Target Repository,” may
appear at this time. This occurs because various product APIs were installed on the
ICAN 5.0.x Repository when the Project was created, that are not installed on the
Java CAPS 5.1.3 Repository. These APIs may or may not apply to your Projects. You
can ignore this message if you have already installed all of the components that
correspond to your Projects. Click Continue to resume the Project import.
4 Close the Import Manager after the Project is successfully imported.
Deploy the Project
1 A new Deployment Profile must be created for each of your imported Projects.
When a Project is exported, the Project’s components are automatically “checked in”
to Version Control to write-protected each component. These protected
components appear in the Explorer tree with a red padlock in the bottom-left corner
of each icon. Before you can deploy the imported Project, the Project’s components
must first be “checked out” of Version Control from both the Project Explorer and the
Environment Explorer. To “check out” all of the Project’s components, do the
following:
A From the Project Explorer, right-click the Project and select Version Control >
Check Out from the shortcut menu. The Version Control - Check Out dialog box
appears.
B Select Recurse Project to specify all components, and click OK.
eWay™ Adapter for SAP BAPI User’s Guide 18 Sun Microsystems, Inc.
Chapter 2 Section 2.3
Installing the eWay Installing Enterprise Manager eWay Plug-Ins
C Select the Environment Explorer tab, and from the Environment Explorer, right-
click the Project’s Environment and select Version Control > Check Out from
the shortcut menu.
D Select Recurse Environment to specify all components, and click OK.
2 If your imported Project includes File eWays, these must be reconfigured in your
Environment prior to deploying the Project.
To reconfigure your File eWays, do the following:
A From the Environment Explorer tree, right-click the File External System, and
select Properties from the shortcut menu. The Properties Editor appears.
B Set the inbound and outbound directory values, and click OK. The File External
System can now accommodate both inbound and outbound eWays.
3 Deploy your Projects.
Note: Only projects developed on ICAN 5.0.2 and above using SAP BAPI 5.0.3 can be
imported and migrated successfully into the Java Composite Application Platform
Suite.
Note: Java collaborations that use date fields on the 5.0.3 BAPI/RFC OTD must be
corrected appropriately after importing into Java CAPS 5.1.3, since these fields in
5.1.3 are now represented as Java data type strings. In 5.0.x these date fields were
represented as data type java.util.Date.
2.3 Installing Enterprise Manager eWay Plug-Ins
The Sun SeeBeyond Enterprise Manager, also referred to as Enterprise Manager
throughout the document, is a Web-based interface that allows you to monitor and
manage your Java CAPS applications. The Enterprise Manager requires an eWay
specific “plug-in” for each different eWay you install. These plug-ins enable the
Enterprise Manager to target specific alert codes for each eWay type.
The Composite Application Platform Suite Installation Guide describes how to install
Enterprise Manager. The Sun SeeBeyond eGate Integrator System Administration Guide
describes how to monitor servers, Services, logs, and alerts using the Enterprise
Manager and the command-line client.
The eWay Enterprise Manager plug-ins are available from the List of Components to
Download under the Suite Installer’s DOWNLOADS tab. The plug-in required for
SAP BAPI is listed as the SAP BAPI eWay Enterprise Manager Plug-in.
The following steps are required to install eWay plug-ins into the Enterprise Manager:
1 From the Enterprise Manager’s Explorer toolbar, click the Configuration icon.
2 Click the Web Applications Manager tab, go to the Auto-Install from Repository
sub-tab, and connect to your Repository.
eWay™ Adapter for SAP BAPI User’s Guide 19 Sun Microsystems, Inc.
Chapter 2 Section 2.3
Installing the eWay Installing Enterprise Manager eWay Plug-Ins
3 Select the application plug-ins you require, and click Install. The application plug-
ins are installed and deployed.
Alternately, you can install eWay plug-ins using the following steps:
1 From the Suite Installer’s Download tab, select the Plug-Ins you require and save
them to a temporary directory.
2 From the Enterprise Manager’s Explorer toolbar, click the Configuration icon.
3 Click the Web Applications Manager tab and go to the Manage Applications sub-
tab.
4 Browse for and select the WAR file for the application plug-in that you
downloaded, and click Deploy. The plug-in is installed and deployed.
Viewing Alert Codes
You can view and delete alerts using the Enterprise Manager. An alert is triggered
when a specified condition occurs in a Project component. The purpose of the alert is to
warn the administrator or user that a condition has occurred.
To View the eWay Alert Codes
1 Add the eWay Enterprise Manager plug-in for this eWay.
2 From the Enterprise Manager’s Explorer toolbar, click the Configuration icon.
3 Click the Web Applications Manager tab and go to the Manage Alert Codes sub-
tab. Your installed eWay alert codes display under the Results section.
For information on Managing and Monitoring alert codes and logs, as well as how to
view the alert generated by the project component during runtime, see the Sun
SeeBeyond eGate™ Integrator System Administration Guide.
Table 2 SAP BAPI Alert Codes
Table 3
Alert Code\Description Description Details User Actions
SAPBAPI-CONNECT-CLIENTFAILED000001=
Alert to indicate that the SAP
JCO client initialization has
failed.
The eWay is unable to connect
to SAP as a client. Make sure that
the eWay is able to reach the SAP
system. Also check your SAP
BAPI External System values for
the Outbound SAP BAPI eWay.
In addition, check the SAP trace
logs.
SAPBAPI-CONNECT-CLIENTSUCCEEDED000002=
eWay™ Adapter for SAP BAPI User’s Guide 20 Sun Microsystems, Inc.
Alert to indicate that the SAP
JCO client initialization has
succeeded.
None
Chapter 2 Section 2.3
Installing the eWay Installing Enterprise Manager eWay Plug-Ins
Table 3
Alert Code\Description Description Details User Actions
SAPBAPI-CONNECT-CLIENTUP000003=
Alert to indicate that the SAP
JCO client is alive and valid.
If you are running in manual
mode, and this is an unexpected
state, check your collaboration
and verify all connect() calls;
otherwise, this Alert is only
informational.
SAPBAPI-CONNECT-CLIENTDOWN000004=
SAPBAPI-CONNECT-CLIENTRETRY000005=
SAPBAPI-TIDFILENOTAVAIL000006=
SAPBAPI-CONNECT-SERVERSTARTED000007=
SAPBAPI-CONNECT-SERVERSTARTED-ERROR000008=
Alert to indicate that the SAP
JCO client is disconnected.
Alert to indicate that the SAP
BAPI eWay is unable to
connect to SAP R/3 and is in
retry mode.
Alert to indicate that the TID
File is inaccessible.
Alert to indicate that SAP JCO
Server is registered with SAP R/
3 and started.
Alert to indicate that SAP JCO
Server could not be registered
with SAP R/3 and is not started.
If you are running in manual
mode, and this is an unexpected
state, check your collaboration
and verify all disconnect() calls;
otherwise, this Alert is only
informational.
None
Check that the directory for the
TID file exists and has write
permission for the user.
None
The eWay is unable to register
with SAP as a server. Make sure
that the eWay is able to reach the
SAP system. Also check your SAP
BAPI External System values for
the Inbound SAP BAPI eWay. In
addition, check the SAP trace
logs.
SAPBAPI-CONNECT-SERVERSTOPPED000009=
SAPBAPI-CONNECT-SERVERSTOPPED-ERROR000010=
SAPBAPI-RFCNOTPROCESSEDERROR000011=
Alert to indicate that SAP JCO
Server was successfully
shutdown.
Alert to indicate that SAP JCO
Server could not be properly
shutdown.
Alert to indicate that an
incoming RFC Function was
not processed due to a failure
in the Collaboration or
Business Process.
None
Check your domain server.log
and the SAP trace logs for further
information.
Check your domain server.log
for further information.
Note: An alert code is a warning that an error has occurred. It is not a diagnostic. The user
actions noted above are just some possible corrective measures you may take. Refer
to the log files for more information. For information on Managing and Monitoring
alert codes and logs, see the Sun SeeBeyond eGate Integrator System
Administration Guide.
eWay™ Adapter for SAP BAPI User’s Guide 21 Sun Microsystems, Inc.
Chapter 2 Section 2.4
Installing the eWay Deploying an EAR File
2.4 Deploying an EAR File
The Sun Java CAPS Enterprise Designer can be configured to automatically deploy an
EAR file to the Sun Java System Application Server. To configure the Enterprise
Designer for deployment, follow the directions for deploying applications to the Sun
Java System Application Server, provided in the Sun SeeBeyond eGate Integrator System
Administration Guide. Because automatic deployment is not supported directly from
Enterprise Designer for the Weblogic Application Server, additional instructions are
provided below.
2.4.1 WebLogic Application Servers
1 Build the EAR file, which is generated in the Enterprise Designer.
2 Use your WebLogic Admin console to deploy the EAR file.
Refer to your application server’s documentation for requirements regarding working
directories.
eWay™ Adapter for SAP BAPI User’s Guide 22 Sun Microsystems, Inc.
Setting SAP BAPI eWay Properties
This chapter describes how to set the SAP BAPI eWay properties to enable data
exchange between the SAP R/3 software and a Java CAPS project.
What’s In This Chapter
Creating and Configuring a SAP BAPI eWay on page 23
Configuring the eWay Connectivity Map Properties on page 23
eWay Connectivity Map Properties on page 25
Configuring the eWay Environment Properties on page 30
eWay External Properties on page 31
3.1 Creating and Configuring a SAP BAPI eWay
Chapter 3
All eWays contain a unique set of default parameters which you must configure from
the following locations:
From the Connectivity Map—which contains the parameters specific to the SAP
BAPI eWay, and may vary from other SAP BAPI eWays in the Project.
From the Environment Explorer tree—which contains global SAP connectivity
parameters that commonly apply to all SAP BAPI eWays (SAP BAPI external
systems having the same connectivity configuration) in the Project. Saved
parameters are shared by all eWays in the SAP BAPI External System Properties
window.
For additional information on creating the Connectivity Map components in a sample
Project, see Create a Connectivity Map on page 84. For information on creating the
Environment Explorer components, see Create an Environment on page 86.
Note: You must set configuration parameters for the SAP BAPI eWay in both locations.
3.2 Configuring the eWay Connectivity Map Properties
When you connect an External Application to a Collaboration, Enterprise Designer
automatically assigns the appropriate eWay to the link. Each eWay is supplied with a
eWay™ Adapter for SAP BAPI User’s Guide 23 Sun Microsystems, Inc.
Chapter 3 Section 3.2
Setting SAP BAPI eWay Properties Configuring the eWay Connectivity Map Properties
template containing default configuration properties that are accessible on the
Connectivity Map.
To configure the eWay properties:
1 On the Enterprise Designer’s Connectivity Map, double-click the SAP BAPI eWay
icon.
Figure 6 Connectivity Map with Components
SAP BAPI eWay
2 The Configuration properties window opens, displaying the default properties for
the eWay. The properties default to the correct eWay direction. In this case, it opens
properties for the outbound eWay.
eWay™ Adapter for SAP BAPI User’s Guide 24 Sun Microsystems, Inc.
Chapter 3 Section 3.3
Setting SAP BAPI eWay Properties eWay Connectivity Map Properties
Figure 7 Outbound eWay Properties
3.3 eWay Connectivity Map Properties
The eWay Connectivity Map consists of the following properties categories.
Inbound eWay Configuration Sections Include:
Server Connection Settings
Outbound eWay Configuration Settings Include:
Client Connection Settings
3.3.1 Configuring the Inbound eWay Properties
The Inbound eWay Properties include parameters required to receive data from SAP
R/3 into Java CAPS. The following server connection settings are configured in the
Inbound eWay Properties window.
Server Connection Settings
The following Server Connection Settings are used by the external database:
eWay™ Adapter for SAP BAPI User’s Guide 25 Sun Microsystems, Inc.
Chapter 3 Section 3.3
Setting SAP BAPI eWay Properties eWay Connectivity Map Properties
Table 4 Inbound eWay—Server Connection Settings
Name Description Required Value
Enable RFC Trace You enable RFC tracing with the Enable
RFC Trace property. The trace file
contains RFC API calls, and data sent to
and received from the SAP R/3 host.
The trace file is rfcnumber.trc, for
example, rfc00310_0156.trc.
RFC Trace Level Trace level specifies the complexity of
the information in the trace file. 0
provides minimal trace logging and 5
provides the maximum trace logging of
diagnostic information in the trace file.
Yes or No.
The default mode is No; the RFC
tracing is disabled.
Setting the Enable RFC Trace
parameter to Yes creates both the
JCo and RFC Trace logs. Both are
created in the same location under:
logicalhost\is\domains\<doma
in name>\config
The JCoTrace log provides Java
Runtime, version, and path
information. It also provides a
manifest.
If Enable RFC Trace is set to No, then
no trace file is generated.
Integer value from 0 (min) to 5 (max)
The default number is 0.
The Enable RFC Trace level only
affects the JCo trace level. It has no
effect on the RFC trace level.
Number of RFC
Servers to create
Specify the number of RFC servers to
create. The created RFC servers
facilitate parallel processing when
Integer value from 1 to 10.
The default number is 1.
receiving multiple requests from SAP
R/3.
Transaction Mode Specifies the transaction mode. The
transaction mode specifies whether
tRFC is enforced. With tRFC,
A transaction mode of Non-
Transactional or Transactional
RFC(tRFC)
transactions have unique TIDs and are
processed only once by this eWay.
The default mode is Non-
Transactional.
eWay™ Adapter for SAP BAPI User’s Guide 26 Sun Microsystems, Inc.
Chapter 3 Section 3.3
Setting SAP BAPI eWay Properties eWay Connectivity Map Properties
Table 4 Inbound eWay—Server Connection Settings
Name Description Required Value
Transaction ID
Verification
Database
3.3.2 Configuring the Outbound eWay Properties
Specifies the location of the
Transaction ID Verification database.
Specify the name of the file-based
database which persists the TIDs.
Provide the path to the database file
that records the disposition of all
transactions outgoing from this eWay.
The database records whether
transactions are:
C (committed)
U (unprocessed or rolled-back)
R (reserved or pending)
A valid path to the database file.
For example, the default location is:
C:\JavaCAPS51\data\SapTRFC.TIDdb
The Outbound eWay Properties include parameters required to communicate from
Java CAPS to SAP/R3. The following server connection settings are configured in the
Outbound eWay Properties window.
Client Connection Settings
The following Client Connection Settings are used by the outbound eWay:
Name Description Required Value
Client Connection
Mode
Table 5 Outbound eWay—Client Connection Settings
Determines the type of client connection
to use when logging onto SAP R/3.
Automatic or Manual.
The default mode is
Automatic.
eWay™ Adapter for SAP BAPI User’s Guide 27 Sun Microsystems, Inc.
Chapter 3 Section 3.3
Setting SAP BAPI eWay Properties eWay Connectivity Map Properties
Table 5 Outbound eWay—Client Connection Settings
Name Description Required Value
Enable RFC Trace You enable RFC tracing with the Enable
RFC Trace property. The trace file is
rfcnumber.trc, for example,
rfc00310_0156.trc.
RFC Trace Level Trace level specifies the complexity of the
information in the trace file. 0 provides
minimal trace logging and 5 provides the
maximum trace logging of diagnostic
information in the trace file.
Yes or No.
The default mode is No; the
RFC tracing is disabled.
Setting the Enable RFC Trace
parameter to Yes creates both
the JCo and RFC Trace logs.
Both are created in the same
location under:
logicalhost\is\domains\
<domain name>\config
The JCoTrace log provides
Java Runtime, version, and
path information. It also
provides a manifest.
If Enable RFC Trace is set to
No, then no trace file is
generated.
Integer value from 0 to 5.
The default number is 0.
The Enable RFC Trace level
only affects the JCo trace
level. It has no effect on the
RFC trace level.
eWay™ Adapter for SAP BAPI User’s Guide 28 Sun Microsystems, Inc.
Chapter 3 Section 3.3
Setting SAP BAPI eWay Properties eWay Connectivity Map Properties
Table 5 Outbound eWay—Client Connection Settings
Name Description Required Value
Transaction Mode Specifies the transaction mode.
Non-Transactional
Actions performed by BAPI call are
committed immediately and
automatically by SAP R/3 (auto commit). In
this mode, use the execute() method in
the OTD.
Transactional RFC (tRFC)
eWay communicates with SAP R/3 using
unique transaction IDs (TID) to avoid
message repeats. Use the
executeAsynchronous(eid) method in the
OTD in this mode.
VIA COMMIT/ROLLBACK BAPI
Performs a single phase commit, where
actions performed by BAPI calls are
committed or rolled back by calling
BAPI_TRANSACTION_COMMIT or
BAPI_TRANSACTION_ROLLBACK. In this
mode you must use the commit and
rollback methods on the BAPI/RFC OTD.
A transaction mode of Non-
Transactional or Transactional
RFC(tRFC), via VIA COMMIT/
ROLLBACK BAPI.
The default mode is NONTRANSACTIONAL.
Transaction ID
Verification
Database
Specifies the location of the Transaction
ID Verification database.
Specify the name of the file-based
database which persists the TIDs. Provide
the path to the database file that records
the disposition of all transactions
outgoing from this eWay. The database
records whether transactions are:
C (committed)
U (unprocessed or rolled-back)
R (reserved or pending)
A valid path to the database
file.
For example, the default
location could be:
C:\JavaCAPS\data\SapTRFC.TI
Ddb
eWay™ Adapter for SAP BAPI User’s Guide 29 Sun Microsystems, Inc.
Chapter 3 Section 3.4
Setting SAP BAPI eWay Properties Configuring the eWay Environment Properties
Table 5 Outbound eWay—Client Connection Settings
Name Description Required Value
Maximum TID
Database Rows
Enable ABAP Debug
Window
Use Load Balancing Enables load balancing for outbound
Specifies the maximum amount of rows
for the Transaction ID (TID) database for
outbound eWays.
Set this property only if tRFC is used. This
property specifies the maximum number
of rows in the outbound TID database
that are kept before the oldest rows are
purged and their corresponding TIDs
confirmed on SAP R/3. Confirmation
allows SAP R/3 to remove those TIDs from
its TID tracking database and reduce
resource consumption.
Enables the ABAP debugging window.
Enabling the Enable ABAP Debug
Window property opens the ABAP
debugging window on the Logical Host.
The window shows the debug
information for the RFC-enabled ABAP
application that is called by SAP R/3.
This property only works if the SAPGUI
software is installed on the Logical Host.
eWays.
This property allows you to take
advantage of the workload balancing
provided by SAP R/3. SAP R/3 provides
workload balancing to automatically
route requests to the SAP application
server within a group of servers that has
the best response time determined at that
moment by an SAP message server.
If you disable load balancing, use the
System number property as described in
“System Number” on page 34.
At least 1 row.
The default is 200 rows.
Yes or No.
The default mode is No; the
ABAP Debug window is
disabled.
Yes or No.
The default mode is No; load
balancing is disabled by
default.
3.4 Configuring the eWay Environment Properties
The eWay Environment Configuration properties contain parameters that define how
the eWay connects to and interacts with SAP R/3 within the Environment. When you
create a new SAP BAPI External System, you may configure the type of External
System required.
To Configure the Environment Properties:
1 In Enterprise Explorer, click the Environment Explorer tab.
eWay™ Adapter for SAP BAPI User’s Guide 30 Sun Microsystems, Inc.
Loading...