Chapter 1   Installation and Administration


iPlanet Application Server Enterprise Connector for R/3 iPlanet Application Serverenables you to build interactive web-based applications that accesses data stored in a R/3 database. These web-based applications might be for electronic commerce, or for any management, financial, distribution, and manufacturing of a supply chain within an enterprise system. Specifically, iPlanet Application Server Enterprise Connector for R/3 enables you to manipulate data within a R/3 transaction from a servlet or EJB controlled by the iPlanet Application Server .

This chapter describes concepts the administrator should be familiar with when setting up iPlanet Application Server Enterprise Connector for R/3 or using the API in servlets or EJBs, and contains the following:

• Overview

• Installing the Enterprise Connector for R/3

• Mining the R/3 Functions

Overview

---

The Enterprise connectors fit into a three tier application model setup that supports the iPlanet 6.0 application web server setup.

Figure 1-1    Application Model

The three tier application model is composed of the following:

• Presentation Tier

• Application Server Tier

• Data Access Tier

Presentation Tier

The presentation tier is where information is accessed by the user, usually a web browser. The user accesses iPlanet Application Server for R/3 from his browser using HTML via HTTP and HTTPS (1).

Application Server Tier

The application server tier (2) houses the intelligence for the web server, applications, and communications to databases such as Oracle, DB2. Enterprise Java Beans (EJB) and servlets are supported by the iPlanet Application Server . In addition, iAB and iEB Tools provide ways to create EJB's and servlets, which are accessed by the Unified Integration Framework (UIF), as seen in the Data Access Tier.

Data Access Tier

The data access tier consists of the UIF which provides business logic needed to enable uniform access to different backend systems (3). The function of the UIF is to act as an interpreter to ease the transfer of information. The UIF interfaces with EJBs and servlets on one side, and product-specific Enterprise connectors on the other side. This tier also works closely with the Mining Tool, which is provided by the iPlanet Application Server Enterprise Connectors for R/3 and is used to convert metadata to XML, and populate the UIF Repository.

The UIF is composed of two parts:

• Application Programming Interface (API) framework

• UIF Repository

API Framework

The API framework is an API that enables the client to talk to the backend systems. Information exchange occurs at this stage. iPlanet Application Server Enterprise Connector for R/3 uses a unique system to communicate with the backend system. The R/3 Worker is a single threaded function that is created by the SRVDAEM daemon. A daemon is a special program that is not directly invoked, but remains dormant until a special condition to arise. A request from the browser is routed through the iPlanet Application Server Enterprise Connector for R/3 server (1), which exits to the R/3 Worker. The SRVDAEM is contacted, which invokes an R/3 Worker (3). The worker then exchanges information between the R/3 server and the connector. More workers are created and connected as needed.

Figure 1-2    API Framework

UIF Repository

The UIF Repository is particularly sensitive to data in XML format. The UIF is actually a consistent way to access backend data. It consists of a set of ten API's that act as a means to communicate with the backsystem.

An EJB calls for various commands/information from the backend system. This call is routed through the UIF, which serves as a translator between the backend system and the EJB. A dialog is established, an exchange of information occurs, and the dialog is concluded. See Figure 1-1 Application Model.

The Mining Tool uses a common cross-platform format, XML, to populate the repository by taking backend information and converting it to XML. The XML is then stored in the UIF Repository in a specific structure that can be recalled when necessary.

Figure 1-3    Mining Tool

Enterprise Connector for R/3 Architecture

Unified Integration Framework (UIF), a common Application Programming Interface (API) used to access data. For example, programmers use the UIF API to query different data bases with one set of calls.

• R/3 independent core services module.

• A repository that contains data that drives iPlanet Application Server Enterprise Connector for R/3. The repository is associated with the UIF to hold parameters and other information about the R/3 system; for example, the kind of connection, the data that can be accessed, and the access methods.

• A connector that implements the R/3-specific data access services. The connector provides the translation and packaging of data between the UIF and the R/3 system.

The following describes

Servlet	The Servlet is an application that operates the iPlanet Application Server Enterprise Connector for R/3.
UIF API	The common UIF API that enables you to operate different Enterprise connectors with the same API.
Enterprise connector	The component in iPlanet Application Server Enterprise Connector for R/3 that enables you to access the R/3 packet.
Repository	A specialized structure where all the R/3 functions are stored for the use of iPlanet Application Server Enterprise Connector for R/3.
R/3 Management Console	The Graphic User Interface (GUI) that enables you to perform various administrative tasks.
R/3 Metadata Mining Tool	This component enables you to introspect from within the Management Console to the R/3 backend.
Repository Browser	This component enables you to view the Repository and its components. See the iPlanet Application Server Enterprise Connector for R/3 Developer's Guide for further details.
R/3 System (Message Agent)	A R/3 native component that enables you to access the R/3 system.

the components in a typical iPlanet Application Server

Technical Overview

In this section, we will discuss the following topics:

Prerequisites	This section describes existing conditions or required installed programs to run the iPlanet Application Server Enterprise Connector for R/3 connector.
Development	This section describes method definition and servlet application.
Deployment	This section describes how to strategically arrange the application.
Run	This section describes what occurs during the run time.

Prerequisites

To properly run the iPlanet Application Server Enterprise Connector for R/3 connector, the following requirements must be met:

• You must install iPlanet Application Server Enterprise Connector for R/3 and UIF (see iPlanet Application Server Enterprise Connector for R/3 Installation, Chapter 1).

• You must configure a connection to the backend system. In Windows NT, you must have a path to the SAP R/3 (RFC Extension) client dll file.

Development

During the R/3 servlet application development, the following occurs:

1. From the Management Console, from the Data Mining option, mine one or more of the methods defined in the backend (see Management Console in the iPlanet Application Server Enterprise Connector for R/3 Developer's Guide).

2. Use the R/3 mining tool found in the Management Console.

3. Write a servlet application using recently mined methods. Write an application or call the function object yourself using direct UIF API (see iPlanet Application Server Enterprise Connector for R/3 Developer's Guide, Chapter 3 Using the UIF API Directory).

Deployment

This section describes how to properly deploy the application.

To properly deploy the application, you need to:

1. Register the application.
   To register a servlet in iPlanet Application Server Enterprise Connector for R/3 6.0 you need to create two XML files. Name the XML file thoughtfully, as the name of the XML file is used as a lookup to run the servlet. For example, if you name the XML "test.XML", then you may want to create a file named "ias-test.XML". Access the servlet from an HTML page as follows: /NASAPP/<xmlfilename>/<servletname>.

   For example, consider the following two files as viewed through a simple editor:
   
   

   The first file is named "float_disp.xml". The other file is named ias-float_disp.xml". They are similar. They differ in the prefix "ias-" added to the second sample.

   
   
   

2. Use the servlet registration tool to register the application.
   Type webappreg <XML file name (without the prefix "ias-")>

3. Restart the application server.

Copying Files to Another iPlanet Application Server Installation

1. Create a zip file of the function directory with the R/3 function name; e.g. BAPI_EMPLOYEE_GETLIST.zip.

2. Copy the zip file to the parallel computer.

3. Unzip the zip file to directory \ias\APPS

4. Load the XML files.

   The directory will always contain <function_name.xml> and may also contain <ECUstructure.xml>.

5. Go to the directory ntv.

6. Register the server using the command: servletreg appInfo.ntv

7. Restart the application server.

Run

During the run time flow, the following occurs in the following:

1. The servlet is executed by HTML via a URL or a JSP.

2. The servlet Java code starts a R/3 function object in the iPlanet Application Server Enterprise Connector for R/3 through the UIF API.

3. The R/3 connector retains all the input definitions from the repository.

4. The R/3 connector executes a request against the R/3 backend. When a reply is received from the R/3 backend, the R/3 connector returns the reply to the UIF, which then returns all the output values to the servlet Java code. This can then be sent back via HTML or JSP to the user.

Installing the Enterprise Connector for R/3

---

The iPlanet Application Servermust be installed first. For information, please see the iPlanet Application Server, Version 6.0, Installation Guide.

The installation for the iPlanet Application Server Enterprise Connector for R/3 includes two installation platforms: Windows NT, and Solaris.

Installing on Windows NT

The following describes the procedures for installing and uninstalling iPlanet Application Server for R/3 on Windows NT.

Installation Prerequisites

The iPlanet Application Server Enterprise Connector for R/3 installation requires that both an appropriate web server, such as iPlanet Web Server (iWS) and iPlanet Application Server 6.0, are resident on your system.

iPlanet Application Server Enterprise Connector for R/3 supports SAP R/3 Version 4.5B.

Before beginning the installation:

1. Check that an appropriate web server has been installed.

   If your system does not have an installed web server, install one before beginning the iPlanet Application Server Enterprise Connector for R/3 installation. The disk size requirements for the web server are in addition to the requirements listed in the table below.

2. Check that iPlanet Application Server is installed on your system.

   iPlanet Application Server 6.0 must be installed on your system before you start the iPlanet Application Server Enterprise Connector for R/3 installation. The same installation program is used for installing both iPlanet Application Server and iPlanet Application Server Enterprise Connector for R/3.
   

   Minimum System Requirements

   
   
   

   Operation System	Windows NT version 4.0 with Service Pack 5
   Hard Drive	100 MB free for minimum installation; 150 MB is recommended.
   iPlanet Application Server	150 MB
   RAM	64 MB; 128 MB is recommended

iInstallation Procedure

1. Unzip the iPlanet Application Server Enterprise Connector for R/3 files.

2. Double-click on the setup.exe file.

3. Read the Welcome message and then click on the Next button.
   
   

4. Read the License Agreement; click on the Yes button if you agree.

   Thoroughly read and understand this information before installing.
   
   

5. Choose your installation directory, then click on the Next button.

   If you are only installing iPlanet Application Server Enterprise Connector for R/3, you must install iPlanet Application Server for R/3 in the same directory as you installed iPlanet Application Server.
   
   

6. Select the iAS SAP 6.0 check box and then click the Next button to continue
   
   .

7. Type in your R/3 host configuration and click the Next button to continue.
   
   

8. This must be loaded on the server on which the data base has been installed.
   
   

   Type in the requested information in the text boxes and then click the Next button to continue the installation.

---

Note	The System Name, Group Name, and Message Server text boxes can be left blank.

---

9. Type in your information and then click the Next button to continue.

   
   

   ---

   Note	Type in EN for English. For other languages consult your R/3 Guides.

   ---

   
   

   
   
   

10. 
    
    Review the configuration summary. If it is correct, press the Install button.

---

Note	If you have previously installed Windows NT on your computer the following messages will be displayed. Click No To All to complete the installation.

---

11. The Setup File Copy window appears. Click on the button that is best for your situation.
    
    

---

Caution

You must restart your computer after you complete the installation.

---

Uninstalling on Windows NT

This procedure is used to uninstall iPlanet Application Server Enterprise Connector for R/3.

1. Choose Uninstaller from the Windows NT start menu's programs - iPlanet Application Server 6.0 entry.

2. Deselect all components for iPlanet Application Server except iPlanet Application Server Enterprise Connector for R/3, then click OK.

   While deselecting the components for iPlanet Application Server Enterprise Connector for R/3, the uninstaller checks for dependencies between components.

Deselecting the Enterprise Connector for R/3

Deselect items in the following order:

1. Deselect iPlanet Server Family Core components.

2. Deselect Administration Services and iPlanet Directory Suite.

3. Deselect iAS 6.0.

Deselecting iPlanet Application Server

Deselect options in the following order:

1. Deselect Application Server 6.0 core binaries.

2. Deselect Web Connector Plug-in component

3. Deselect Administrator's component.

4. Deselect Deployment Manager component.

5. Deselect core Server component.

   
   

   ---

   Caution

   If you do not follow the above mentioned order of deselections, alert messages will be displayed and you may not be able to deselect the desired option.

   ---

   
   

Installing on Solaris

Here are the installation steps for iPlanet Application Server Enterprise Connector for R/3 on Solaris.

To ensure that you have everything necessary to complete the installation, review this section before starting the installation.

Installation Prerequisites

The following are required before you can install iPlanet Application Server Enterprise Connector for R/3.

• iPlanet Enterprise Server 4.1 or above installed

• iPlanet Application Server 6.0

• Unified Integration Framework

• Related software

Pre-Installation

The first step in the pre-installation is to download and unzip the file inssap.zip to a temporary directory.

Ensure that the same setup is used for installing iPlanet Application Server.

Installation Procedure

1. In the temporary directory type Type#./setup

   The following message appears:

   iPlanet E-Commerce Solutions, A Sun-Netscape Alliance
   iPlanet Server Products Installation/Uninstallation
   

   Welcome to the iPlanet Server Products installation program

   This program will install iPlanet Server Products and the

   iPlanet Console on your computer.

   It is recommended that you have "root" privilege to install the

   software.

   Tips for using the installation program:

   - Press "Enter" to choose the default and go to the next screen

   - Type "Control-B" to go back to the previous screen

   - Type "Control-C" to cancel the installation program

   - You can enter multiple items using commas to separate them.

   For example: 1, 2, 3.

   Would you like to continue with installation? [Yes]:

2. Type Yes to continue.

   The following message appears:

   BY INSTALLING THIS SOFTWARE YOU ARE CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THE AGREEMENT FOUND IN THE LICENSE.TXT FILE. IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, PLEASE DO NOT INSTALL OR USE THIS SOFTWARE.

   Do you agree to the license terms? [No]:

   If you agree with the terms of the agreement

3. Type Yes to continue.

The following message appears:

Select the items you would like to install:

iPlanet Servers

Installs iPlanet Servers with the integrated Netscape Console onto your computer.

Netscape Console

Installs Netscape Console as a stand-alone Java Application on your computer.

To accept the default shown in brackets, press the Enter key.

Select the component you want to install [1]:

4. Press <Enter> to install the iPlanet Server.

The following message appears:

This program will extract the server files and install them into a directory you specify. That directory is called the server root in the product documentation and contains the server programs, the Administration Server, and the server configuration files.

To accept the default shown in the brackets, press <Enter>.

Install location [/iPlanet/iAS6]:

5. Type the iPlanet Application Server installation directory, and then press <Enter>.

The following message appears:

iPlanet Server Products components:

Components with a number in () contain additional subcomponents

which you can select using subsequent screens.

1. iAS SAP connector 6.0

Specify the components you wish to install [All]: 1

6. Press <Enter> to install all the components.

   The following message appears:

   iAS SAP connector 6.0 components:

   Components with a number in () contain additional subcomponents

   which you can select using subsequent screens.

   1. iAS SAP connector Core Components

   Specify the components you wish to install [1]:

7. Press <Enter> to install all the components.

   The following message appears:

   Enter the fully qualified domain name of the computer

   on which you're installing server software. Using the form

   <hostname>.<domainname>

   Example: eros.airius.com.

   To accept the default shown in brackets, press the Enter key.

   Computer name [grass.tel-aviv.israel.sun.com]:

8. To accept the default shown in brackets, press the <Enter> key.

   The following message appears:

   Choose a Unix user and group to represent the iPlanet server

   in the user directory. The iPlanet server will run as this user.

   It is recommended that this user should have no privileges

   in the computer network system. The Administration Server

   will give this group some permissions in the server root

   to perform server-specific operations.

   If you have not yet created a user and group for the iPlanet

   server, create this user and group using your native UNIX

   system utilities.

   To accept the default shown in brackets, press the Return key.

   System User [nobody]:

   System Group [nobody]:

9. To accept the default shown in brackets, press the <Enter> key.

The following message appears:

Please enter the SAP host name.

Host Name [sap]:

10. Type in the Host Name.

The following message appears.

Please enter the system number.

System Number [0]:

11. Type in the system number.

The following window appears.

Please enter the destination.

Destination:

12. Type in the destination.

The following message appears:

Please enter the gateway host.

Gateway Host:

13. Type in the gateway host.

The following message appears

Please enter the gateway service.

Gateway Service:

14. Type in the gateway service.

The following message appears:

Please enter the system name.

System Name:

15. Type in the system name.

The following message appears:

Please enter the group name.

Group Name:

16. Type in the group name.

The following message appears:

Please enter the message server.

Message Server:

17. Type in the message server.

    The following message appears:

    Please enter 'y' for load balance or `n' for no balance.

    Load Balance:

18. Type in either a `y' or `n'.

    The following message appears:

    Please enter the client number.

    Client Number:

19. Type in the client number.

The following message appears:

Please enter the language.

Language:

20. Type in the language.

The following message appears:

Please enter the user ID and password:

User ID:

Password

21. Type in the user ID and password.

The following message appears:

Finished with gathering of information.

Next, the iAS for SAP files will be extracted. After that,

the configuration and registration based on your responses will begin.

Please hit ENTER to continue:

22. Press <Enter> to continue.

---

Note	After successful installation on Solaris, you can check the installation by going to the URL http://<machine.mcom.com>/sapSamples Refer to the Developer's Guide for the detailed procedure to run the sample examples.

---

Uninstalling on Solaris

1. To uninstall the iPlanet Application Server Enterprise Connector for R/3, go to the installation directory, [/user/netscape/server4]

2. Type ./uninstall.
   A list of uninstall options appears.

3. Select the specific product components you wish to uninstall.

Mining the R/3 Functions

---

The iPlanet Application Server Enterprise Connector for R/3 does a specialized form of data mining: it looks at data and extracts functions and parameters from backend systems, such as R/3, to allow the user of iPlanet Application Server to utilize (call) these functions.

See the iPlanet Application Server Enterprise Connector for R/3 Developer's Guide for more details. on R/3 functions.

Entering the Management Console from Windows NT

1. Select Start>Programs>iPlanet Application Server 6.0>R/3 Connector 6.0 - Management Console.
   
   

2. Select the R/3 Management Console icon, and click the Open button in the upper right to display the R/3 Management Console.
   
   

Data Mining

Data mining is the search for relationships and global patterns that exist in large databases. These relationships represent valuable knowledge about the database and objects in the database. The elements of the Data-mining tool are shown in the following illustration.

Figure 1-4    Elements of the Data Mining

You submit search criteria to the Management Console which queries R/3 for any functions matching the criteria. You then selects the function or functions to be mined. Data is extracted from R/3, converted to XML, and then loaded into the repository.

The three data-mining operations/options are:

Load into Repository	The Load into Repository option is used to load selected function, or functions, into the repository. The XML file is erased.
Save XML	This option is used to store a selected function, or functions, as XML which can be loaded later into a repository.
Archive XML	This is used to store function, or functions, as XML in zip format; these can be loaded later into a repository. The zip file name is the default. The zip file is located as a default at <root>/apps/archives.

Displaying the Data Mining Selections

1. Click the Data Mining icon to display the Choose Data Source list.
   
   

2. Select the Data source and click the OK button to display the Input dialog box.
   
   

3. Type in the search criteria and click the OK button to display the Choose SAP Function dialog box.

   You can use wildcards, e.g. BAPI*
   
   

4. Select the function(s) you want to activate.

   When you load the selection into a repository, it does not automatically save the XML file. You must select the Save XML check box to save the function. The operation is finished when the progress indicator disappears

   
   

   ---

   Note	You can select one, two, or all the check boxes.

   ---

   
   

Loading Functions Into Repository

The Load into Repository selection is used to load a function or functions into the repository.

1. Select the function in the list box

2. Select the Load into Repository check box.

3. Click the Open Button to load the file.
   
   

4. Select the Archive.
   
   

   Click the Load button to load the selected archive. Click the Cancel button to return to the previous window with no changes made. Click the Archive Details button to display the XML file (see the iPlanet Application Server Enterprise Connector for R/3 Developer's Guide for more details).

Saving XML Functions

This option is used to store a selected function, or functions, as XML which can be loaded later into a repository.

1. Select the Save XML check box.

2. Select the Load into Repository check box. An XML file is created and stored in a directory with name of function.

   
   

   ---

   Note	The default options are stored in a directory with the name of the function that can not be changed.

   ---

   
   

Archiving XML Functions

This is used to store a function, or functions, as XML in zip format; these can be loaded later into a repository.

1. Choose the SAP S/3 function

2. Select the Archive XML check box.

3. Click the OK button to display the dialog box.

   The name of the default zip file is <data source name>.zip.
   
   

4. Either type in a file name or click the Save button to accept the default directory.

   The files are generated and stored in the *.zip file.