This Getting Started guide describes the SAP Extension.
Getting Started Guide
- 1.0 Installation notes
- 2.0 Configuration Requirements
- 3.0 Getting started and using the object browser
- 4.0 Communicating with an SAP system
The SAP Extension provides IBM® WebSphere® Portlet Factory users with the following important features.
Use of the SAP Java™ Connector (JCo) to connect to SAP
The SAP JCo interface supports connection pooling and oversees the management of portlet-to-SAP communications.Single-Sign-On capabilities
Note: For information about the versions of the SAP JCo that WebSphere Portlet Factory supports, refer to the detailed system requirements in the release notes topic.
Using IBM WebSphere Portal Server credential vault.Automation of portlet code
Including an execute method to get the data, a schema to describe the data returned by the function, and variables (typed with the schema) to hold the Tables, Imports, and Exports result sets.Seamless integration with other builders
To create robust, highly customized portlets, including custom look-and-feel and even access to custom (customer-created) BAPIs.
1.0 Installation notes
The components in the SAP Extension support the following SAP product version.
Table 1. SAP product version
|SAP Product||Versions Supported|
|R3||See the detailed system requirements in the WebSphere Portlet Factory release notes topic for the versions supported.|
Install the SAP Extension:
- In the project right-click menu, select Properties. Expand the WebSphere Portlet Factory category and select Feature Info.
- In the Feature Info screen, select the SAP Extension and click Apply. Click OK to add the feature set. Choose to publish the project when prompted.
For Windows® systems
On Linux®, UNIX®, and z/OS® Platforms
Copy the sapjco.jar
file into a directory from which your application server loads JAR files. Also copy the following DLL files into the system32
directory of your Windows operating system.
(For example, on Windows XP systems, C:\\Windows\\system32
\\WebSphere\\AppServer\\lib\\extIBM WebSphere Application Server Community Edition
WebSphere Application Server Community Edition requires that you deploy any JAR files to be shared among two or more Web applications as Common Libs. Each Web application references this deployed common lib in its geronimo-web.xml
file in the <dependencies />
node. WebSphere Portlet Factory populates the geronimo-web.xml
file with commented references to sample Common Lib deployments for the sapjco.jar
file (as well as references to JAR files for other WebSphere Portlet Factory integration builders.)
The values for the Group, Artifact, Version, and Type are largely arbitrary. Choose values that correspond to any naming conventions that you have or any other considerations. Clicking install results in the JAR file being placed in the <WASCE>/repository/Group/Artifact/Version/Type
directory and is loaded by the WebSphere Application Server Community Edition server-wide class loader.
- Open the WebSphere Application Server Community Edition server console.
- Select Common Libs link under Services.
- Using the Browse option select and add your SAP jar files.
- Enter Group, Artifact, Version, and Type using your naming conventions.
- Click install to add the JAR file.
Refer to the SAP Java Connector installation documentation for instructions specific for your operating system.
If you are running WebSphere Portlet Factory on a Linux system, set the following permissions on the sapjco.jar
The owner should be root and the group should be set to the group to which your WebSphere Portlet Factory user belongs. If your WebSphere Portlet Factory user is different than the WebSphere Application Server user, you must set up that user's environment as indicated in the SAP Java Connector installation documentation, so that user can access the SAP libraries.
The library files required in this step are available to SAP customers at http://service.sap.com
- The sapjco.jar file must be made available to your IDE plugin for Eclipse. To make this JAR file available:
- Locate your WebSphere Portlet Factory Designer core plugin folder. For example,
C:\\Program Files\\IBM\\WebSphere Portlet Factory\\Designer\\eclipse\\plugins\\com.bowstreet.designer.core_latest version
- Copy the sapjco.jar file into the \\lib folder in the plug-in folder you just located.
Note: Depending on your server settings, your application server and WebSphere Portlet Factory Designer may need to be restarted to correctly register all feature set files.
- Referencing Common Libs from WebSphere Portlet Factory applications (For WebSphere Application Server Community Edition usage only)
file in the WebSphere Portlet Factory project contains a list of commented out dependencies for the sapjco.jar
file. You must replace the Group, ArtifactID, and Version values with those you defined in the Common Lib deployment for the sapjco.jar
<?xml version="1.0" encoding="UTF-8"?>
1.1 Verify Installation
To confirm correct installation of the builders and JCo, follow these steps.
- Configure your default_sap_server.properties file for the SAP server you are using (as described under Configuration Requirements below).
- Restart the IDE or WebSphere Portlet Factory Designer environment to complete the installation process.
- Open the SAP object browser model in WebSphere Portlet Factory Designer and ensure that you do not see errors in the Task View. (This model is located in the WEB-INF/models/samples/SAP folder accessible from the Eclipse Navigator.)
- Run the model. Confirm that the model runs correctly and that you are able to drill down into the returned SAP data.
The SAPObjectBrowser is a model built using the SAP View and Form builder. This is possible because the mechanism for browsing the SAP Object Repository is SAP RFC's.
In an IBM WebSphere Portal server environment, you must set the class loading order such that third-party JAR files are loaded before other JAR files and classes. This loading order insures that WebSphere Portal can access and use these third-party files. See your IBM Installation Guide for the steps required to establish this setting in WebSphere Portal server.
2.0 Configuration Requirements
The first step in using the SAP builder is establishing a properties file. This file is located in the project WEB-INF/config/sap_config/
Because the WebContent/WEB-INF/config
directory is by default an excluded resource, you need to override the team file and directory exclusion to ensure that your new or modified file is kept updated in source control storage.
The properties file is used to specify SAP connection properties such as the name of the SAP server and a valid SAP user name and password. A typical SAP properties file might be named my_sap.properties
and would contain the following properties:
# SAP application server
# Logon user
# Logon password
# SAP client
# Logon language
# SAP system number
A default SAP server.properties
file is installed with the SAP Builder. This properties file is located in the WEB-INF/config/sap_config
directory. You can use the file to establish your basic SAP settings and view examples of valid property values. As configured at installation, this file is applicable to a MiniSAP server running on the local host.
3.0 Getting started and using the object browser
After you install and configure the SAP Extension, run the object browser model. You can use this model to explore the objects in an SAP system. Use the following steps.
- Run the model and view the initial screen. A table is displayed that contains information about the objects in the system. Columns list object type, object names and descriptive text for each object.
- Click on a link in the OBJNAME column. A new table is displayed. This table lists on each row the set of methods (BAPIs) associated with the object. Click on a link in the Method column.
- Another table is displayed that contains all of the parameters for that method. Information about the parameter (for example, Description and Short text) is also provided.
- Click on a parameter in the table and the fields of the parameter are listed. Here you can view field names and allowable lengths, data types and field text.
4.0 Communicating with an SAP system
The SAP Builder use the SAP JCo toolkit (available with your SAP system) to connect to SAP. This toolkit allows a Java application to communicate with any SAP System. The SAP JCo interface supports connection pooling and oversees the management of portlet-to-SAP communications.
4.1 Connection pool size
A property is available for setting the maximum size of the JCo connection pool. This property can be defined in WEB-INF/config/override.properties
is the maximum allowed number of SAP connections. The default value for pool-size
is 5 connections. This value has been found to provide an adequate number of connections and good performance.
4.2 Use of the clientProviderClass property
If you run SAP enabled models and define the following property with a fully qualified class name, the SAP runtime instantiates this class and uses it as the provider.
The property defines the JCO.Client provider implementation to be used by SAPAccess. If you do not define the property, a default implementation of a provider in IBM WebSphere Portlet Factory Designer is used.
Parent topic: Getting started with integration extensions: wpf7
Files that are excluded from source control: wpf7
Release notes IBM WebSphere Portlet Factory Version 7.0: wpf7