BAPI

Business Application Programming Interface

Compiled by Y R Nagesh

What is BAPI
A Business Application Programming Interface is a precisely defined interface providing access process and data in Business Applications Systems Such as SAP R/3

Compiled by Y R Nagesh

Benefits of BAPI
Can be used in diverse languages / Development Environments (ABAP, Visual Basic, Java, C++, etc.) Can be called from diverse platforms (COM, CORBA, Unix) Reduced development cost Reduced maintenance cost Best-of-both-worlds approach Rich functionality of the R/3 system User-specific front-ends
Compiled by Y R Nagesh 3

Where BAPIs can be used

Compiled by Y R Nagesh

Return Code Information

Usually a structure, sometimes a table Data dictionary structures used BAPIRETURN BAPIRETURN1 BAPIRET1 BAPIRET2

Compiled by Y R Nagesh

BAPI Return Structure

Type Message type blank or "S"=Success "E"=Error "W"=Warning "I"=Information "A"=Abort Message Log_No Log_Msg_No Message_V1 - V4 Message text Application Log Number Application Log Message Serial Number Message variables
Compiled by Y R Nagesh 6

SAP transactions
BAPI Business Object Browser (BAPIs only) SWO1 Business Object Builder (all objects) SWO2 Business Object Browser (all objects) SE11 Data Dictionary SE37 Function Builder

Compiled by Y R Nagesh

JCO Overview
High-performance JNI-based middleware Support R/3 3.1H and higher. Supports inbound and outbound calls. Supports client pooling. Supports desktop and web/application server applications. Multi-platform Complete and correct code page handling Easy to install and deploy

Compiled by Y R Nagesh

Installation and Deployment

Required files in \WINNT\system32: librfc32.dll (at least 46D, build 263) jRFC11.dll (JDK 1.1) jRFC12.dll (JDK 1.2 and 1.3) Required files in Java class path: jCO.jar

Compiled by Y R Nagesh

BAPI step by step procedure

STEP 1 - Define Structure For The BAPI STEP 2 - Write Function Module STEP 3 - Create the API Method Using The BAPI WIZARD STEP 4 Final Steps

Compiled by Y R Nagesh

10

About the Example

About the Example:
Front End : Java Servlets (Web Application) Web Server : Apache Tomcat

The Servlet takes Vendor number and passes it to the BAPI which in turn fetches the Vendor information from the LFA1 table and returns it in BAPIRET2 format to the servlet, the servlet fetches the data from return structure and displays it.

Compiled by Y R Nagesh

11

Step 1 : Define a Structure for BAPI

In this step structures for the parameters and tables of the function module used for the BAPI are defined. USE TCODE : SE11 then Data type -> Structure Define the structure Name : Ex: ZVEND Important note: You will have to define a structure for every parameter in the BAPI. You cannot use the same structures used in existing applications because BAPI structures are frozen when BAPIs are released and then there are restrictions on changing them.
Compiled by Y R Nagesh 12

Creating a Structure

Enter the Structure name

Compiled by Y R Nagesh

Click on Create Button 13

Creating a Structure

Select Structure Click on Check Button

Compiled by Y R Nagesh

14

Creating a Structure
Activate the Structure

Compiled by Y R Nagesh

15

Step 2 : Write Function Module

Each BAPI must have its own function group. Under the attributes tab remember to select Processing Type Remote Enabled module, otherwise the function module cannot be invoked via RFC and used as a BAPI Import/Export parameters can only be BY VALUE for an RFC enabled function module

Compiled by Y R Nagesh

16

Creating Function group

Compiled by Y R Nagesh

17

Creating Function group

Compiled by Y R Nagesh

18

Creating Function module

Click on Create

Click on Save

Compiled by Y R Nagesh

19

Creating Function module

Make the function Remote Enabled

Compiled by Y R Nagesh

20

Creating Function module

Import Parameters

Check Pass Value

Compiled by Y R Nagesh

21

Creating Function module

Tables

Compiled by Y R Nagesh

22

Creating Function module

Source Code

Compiled by Y R Nagesh

23

Creating Function module

Activate Function Module

Activate

Compiled by Y R Nagesh

24

Releasing Function module

Release the Function Module

Compiled by Y R Nagesh

25

Step 2 : Create the API Method Using The BAPI WIZARD

BAPI wizard is used to expose the remote function module as a BAPI Wizard will generate some additional code, so the function module is a valid method of the BOR. This allows the BAPI to be called as a workflow method in addition to be called by an outside program. Each function module corresponds to a method in the BOR

Go to the Business Object Builder SWO1. You can either create the new Object type as a subtype of an existing business object or create a new business object from scratch..

Compiled by Y R Nagesh

26

Create new BAPI Object

USE TCODE SWO1

Supertype not required as we are creating a new Object

* for Cross Apps

Compiled by Y R Nagesh 27

Create new BAPI Object

Note that when you create the business object a standard interface, an attribute ObjectType and the methods ExistenceCheck and Display are automatically generated. These cannot be changed !

Compiled by Y R Nagesh

28

Adding API method

Compiled by Y R Nagesh

29

Adding API method

Click here
Compiled by Y R Nagesh 30

Adding API method

Compiled by Y R Nagesh

31

Adding API method

Click Yes

API method added

Compiled by Y R Nagesh

32

Implementing BAPI Object

Select the BAPI object

Compiled by Y R Nagesh

33

Implementing BAPI Object

Change release status To implemented

Compiled by Y R Nagesh

34

Releasing BAPI Object

Change release status To released

Compiled by Y R Nagesh

35

Implementing API Method

Select the API Method

Compiled by Y R Nagesh

36

Implementing API Method

Change release status To implemented

Compiled by Y R Nagesh

37

Releasing API Method

Change release status To released

Compiled by Y R Nagesh

38

Generating API Method

Click on Generate Button

Compiled by Y R Nagesh

39

Configuring Apache Tomcat

Directory Structure Jakarta-tomcat-4.1.31 Webapps <User Folder> (Vendor) WEB-INF classes lib Web.xml Index.html
Compiled by Y R Nagesh 40

Configuring Apache Tomcat

classes
This folder contains all the class files created for successful execution of the servlet.

lib
This folder contains all the library files required i.e sapjco.jar servlet.jar
Note: While compiling the java code make sure that the Classpath is set to the above to .jar files
Compiled by Y R Nagesh 41

Configuring Apache Tomcat

<?xml version="1.0" encoding="ISO-8859-1"?> <web-app xmlns="http://java.sun.com/xml/ns/j2ee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd version="2.4"> <servlet> <servlet-name>Some internal name</servlet-name> <servlet-class>display_vend</servlet-class> </servlet> <servlet-mapping> <servlet-name>Some internal name</servlet-name> <url-pattern>/NameSeenByUser.do</url-pattern> </servlet-mapping> </web-app>
Compiled by Y R Nagesh 42

Web.xml

Servlet name

Servlet Program
import statements required import javax.servlet.*; import javax.servlet.http.*; import java.io.*; import com.sap.mw.jco.*;

Compiled by Y R Nagesh

43

Servlet Program
public class display_vend extends HttpServlet { PrintWriter pw; public void doPost(HttpServletRequest req, HttpServletResponse res) { int num = Integer.parseInt(req.getParameter("rand")); String no,name,city,district,po,tele,fax; String SID = "R"+num; String vendno = req.getParameter("vendno"); IRepository repository; // The repository we will be using try {
Unique name for connection pool each time connection is established random number is generated in the index.html i.e starting page and value is passed to servlet

// Add a connection pool to the specified system

JCO.addClientPool(SID, 100, "800", "hari", "sapnjoy", "EN", "sapides", "00 );

// Alias for this pool , Max. number of connections , SAP client , userid // password , language , host name
Compiled by Y R Nagesh 44

Servlet Program
repository = JCO.createRepository("MYRepository", SID); // Create a new repository

// Get a function template from the repository

IFunctionTemplate ftemplate = repository.getFunctionTemplate("ZVENDFUN");

// Create a function from the template

JCO.Function function = new JCO.Function(ftemplate); JCO.Client client = JCO.getClient(SID); // Get a client from the pool JCO.ParameterList input = function.getImportParameterList(); // Fill in input parameters input.setValue(vendno, "LIFNR" ); client.execute(function); // Call the remote system JCO.Structure ret = function.getExportParameterList().getStructure("RETURN"); pw = res.getWriter(); pw.println("<html><body bgcolor=#eeeff8><center><hr><h1>Customer Details</h1><hr>");

// Get table containing the data

JCO.Table vend = function.getTableParameterList().getTable("ITAB"); Compiled by Y R Nagesh 45

Servlet Program
for (int i = 0; i < vend.getNumRows(); i++) { vend.setRow(i); no = vend.getString("LIFNR"); name = vend.getString("NAME1"); city = vend.getString("ORT01") ; district = vend.getString("ORT02") ; po = vend.getString("PFACH") ; tele = vend.getString("TELF1") ; fax = vend.getString("TELFX") ;

// Fetching data from SAP database and storing in local variables

Compiled by Y R Nagesh

46

Servlet Program
pw.println("<table border=1><tr><td><B>Vendor Number</B></td><td>"+no+ "</td></tr><tr><td>" + "<B>Customer Name</B></td><td>"+name+ "</td></tr><tr><td>" + "<B>Customer Address</B></td><td></tr>"+ "<tr><td> "<tr><td> "<tr><td> </td><td><B>City</B></td><td>"+city+"</td></tr>" + </td><td><B>District</B></td><td>"+district+"</td></tr>"+ </td><td><B>PO Box</B></td><td>"+po+"</td></tr>"+

"<tr><td><B>Telephone</B></td><td>"+tele+"</td></tr>"+ "<tr><td><B>TeleFax</B></td><td>"+fax+"</td></tr></table>" ); pw.println("<form name=form1 action='index.html' method=get><input type=submit value='Back'></form></center></body></html>"); }} catch (Exception E) { System.out.println(E); } } } Compiled by Y R Nagesh 47

Index.html
<html> <head><script language="JavaScript"> function randomnumber() { var r=Math.floor(Math.random()*1111) if (r!=0) document.form1.rand.value=r; } </script> </head> <body bgcolor=#eeeff8 onLoad="javascript:randomnumber();"> <center><hr><h1>Enter the Vendor Number</h1><hr> </center><form name=form1 action="NameSeenByUser.do" method=post> <center><input type=text name=vendno> <input type=submit value="Submit"> <input type=hidden name="rand"></center> </form></body></html> Compiled by Y R Nagesh 48

Output

Compiled by Y R Nagesh

49

Output

Compiled by Y R Nagesh

50