SAP NetWeaver
 
 
 
 BI Java SDK Installation Guide
 

To deploy the BI Java SDK onto your local environment in order to develop applications with the SDK, check the system requirements and follow the configuration instructions below.

Note: to deploy applications you create with the SDK to SAP NetWeaver's Web Application Server, you need a BI Java Connector. Refer to the Connectors page for more information.

This page includes the following information:


System Requirements

Operating system Developing with the BI ODBO Connector requires Windows NT/2000/XP. Otherwise, there are no operating system restrictions.
Java Development Kit 1.4+
Web browser To view this documentation set, including the Javadocs, we recommend Internet Explorer 5 or Netscape 6 and above, or compatible frames-capable browsers such as Mozilla, Opera 7+, and Safari.
Adobe Acrobat Viewer To view the Developer's Guide (PDF), Adobe's Acrobat Viewer is required.
Memory Recommended: at least 256MB
Disk space Recommended: at least 50MB
Processor Recommended: at least 300MHz
JDBC If you are developing with the BI JDBC connector, you need to ensure that the JAR files of your database provider's JDBC driver are available in your classpath.
ODBO If you are developing with the BI ODBO Connector, copy the JNI library sapbiado.dll from the lib folder into a location in your system path (for example, into your WINNT\system32 directory).
SAP Query If you are developing with the BI SAP Query Connector, you need to be sure your system is properly configured with SAP JCo. JCo is available on the SAP Service Marketplace at: http://service.sap.com/connectors/ --> SAP Java Connector --> Tools & Services.
We recommend version 2.1.x.
XMLA If you are developing with the BI XMLA Connector, no additional configuration is necessary. See the note below.
BI Java Connector To deploy applications created with the SDK onto the J2EE server, you need a BI Java Connector.

Classpath Configuration

Configure your CLASSPATH for the SDK by adding the SDK's libraries. These are located in the /lib/ folder in the folder in which you have unpackaged the SDK. This folder contains all the libraries required by the SDK for development.

Note: If you are using an IDE such as Eclipse or NetWeaver Developer Studio, this step occurs automatically when you create a project. See below for details.

Eclipse / NetWeaver Developer Studio Configuration

To create a project with the SDK in Eclipse or SAP NetWeaver Developer Studio:

  1. In Eclipse or NetWeaver Developer Studio, select File --> New --> Project.
  2. In the New Project Wizard, select Java, and click Next.
  3. In the Project name field, enter a name for your project.
  4. In the Project contents section, deselect the Use default checkbox.
  5. Click Browse and navigate to the folder in which you unzipped the BI Java SDK. Select it, and click OK.
  6. Click Finish at the bottom of the Wizard dialog box.

Eclipse automatically locates the SDK libraries, and creates a package in the project for the SDK's examples under the docs/examples folder in the Package Explorer. In that same folder, you can also see the HTML files that display the rendered results of the example servlets, and the Java source code in a Web browser.

Logging and Tracing, JARM

Optionally, you may configure settings for logging and tracing, and JARM, when working locally in a non-managed environment. For more information, see the instructions in the package documentation for the util package.

Note on using the BI XMLA Connector in a non-managed environment

Since the BI XMLA Connector relies upon the SAP XML Parser package (SAPXMLToolkit.jar) and SAP SOAP package (webservices_lib.jar) normally present in a managed (J2EE) environment, some guidelines are helpful when using the XMLA connector in a non-managed environment (in the absence of SAP's J2EE server). In this case, you need to manually configure the correct reference to SAP's XML Parser and SOAP packages in the host application.

We provide some guidelines below on how to configure the correct parser reference. Please note that these guidelines are intended just for reference, and don't address, for example, scenarios where an application defines its own class loading mechanisms or refers to a default XML parser. In those cases, please consult the documentation of the host application on how to configure a reference to the third party XML Parser (in this case, the SAP XML Parser and SAP SOAP packages).

To manually configure your parser reference:

  1. Ensure that the SAP XML Parser and SAP SOAP packages (SAPXMLToolkit.jar and webservices_lib.jar) are in your classpath.
  2. If there are other XML parser packages in the classpath, move them behind the SAP XML Parser and SAP SOAP packages in your classpath sequence, or remove them if possible.
  3. Configure your system property. For example, use the following code to set the reference to SAP packages:

    System.setProperty("javax.xml.parsers.SAXParserFactory", "com.sap.engine.lib.jaxp.SAXParserFactoryImpl"); System.setProperty("javax.xml.soap.MessageFactory", "com.sap.engine.services.webservices.jaxm.soap.MessageFactoryImpl"); System.setProperty("javax.xml.parsers.DocumentBuilderFactory", "com.sap.engine.lib.jaxp.DocumentBuilderFactory"); System.setProperty("javax.xml.transform.TransformerFactory", "com.sap.engine.lib.jaxp.TransformerFactoryImpl"); System.setProperty("javax.xml.soap.SOAPConnectionFactory", "com.sap.engine.services.webservices.jaxm.soap.SOAPConnectionFactoryImpl");

    Use this option with caution, however, since the system property might affect other code, especially if the other code is using different XML Parser.

Some common error messages that may appear when the parser package is not configured correctly:

class not found exception: com.sap.engine.services.webservices.jaxm.soap.MessageFactoryImpl not found
class not found exception: org.apache.crimson.jaxp.DocumentBuilderFactoryImpl not found
javax.xml.parsers.FactoryConfigurationError: Provider org.apache.crimson.jaxp.DocumentBuilderFactoryImpl not found at javax.xml.parsers.DocumentBuilderFactory.newInstance( DocumentBuilderFactory.java:109)

 

 


Copyright © 2004-2005 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.