BI Java SDK Installation Guide
To develop applications with the BI Java SDK, check the system requirements
and instructions below.
Note: To deploy applications you create with the BI Java SDK to
the server, you need to create a system with 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,
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,
you need to install an ODBO driver for your data source.
In addition, you need to copy the JNI library sapbiado.dll into a
location in your system path (for example, into your WINNT\system32
directory). You can find sapbiado.dll in the following location:
[installation drive]:\Program Files\SAP\JDT\ecplise\plugins\
com.sap.tc.ap\comp\BI_UDI\DCs\sap.com\bi\sdk\odbo\_comp\gen\
default\public\default\lib\native\OS_libs\NUC\ntintel\32\. |
SAP Query |
If you are developing with the BI SAP Query Connector,
ensure that 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 server, you need to create a system with a BI
Java Connector. |
NetWeaver Developer Studio Configuration
This section describes how to set up a Development Configuration and
where to find two additional JAR files on the installation CD that are
required in order to develop with the BI Java SDK in the NetWeaver Developer
Studio.
- If you do not already have the BI Java SDK ZIP file, locate it on
the NetWeaver Developer Studio CD in the following path:.../eclipse/tools/bi_sdk/bi_sdk.zip
- Extract jARM.jar and jARMSat.jar from the /lib/ folder inside this
ZIP file to a local folder. You will need these during runtime of any
components you develop with the SDK (see Step 12, below).
- To set up a Development Configuration in the Developer Studio, open
the Development Configurations Perspective.
- In the Local DCs view go to Local Development - MyComponents.
- From the context menu, select Create new DC; give it a name
and select Java as the development component type. Choose Next
and then Finish.
- So that the BI Java SDK's example source files are available in your
Development Configuration, go to the folder [installation drive]:\Program
Files\SAP\JDT\eclipse\plugins\com.sap.ip.bi.sdk.doc_3.5.0 and open
doc.zip. Extract the contents of the docs\examples\com\sap\ip\bi\sdk\samples
path from the ZIP file to [installation drive]:\Documents and Settings\<your
user name>\.dtc\LocalDevelopment\DCs\sap.com\<your dc>\_comp\src\packages.
- In the Developer Studio, go to the Java Perspective and select
Properties in the context menu of the new project.
- Go to Java Build Path - Source and edit the contained folder
to point to src/packages/docs/examples. Choose OK twice.
- Go to the Development Configurations Perspective, in the Local
DCs view and open Local Development - My Components -<your
dc>- DC MetaData - DC Definition.
- In the context menu of Used DCs, select Add Used DC.
- In the dialog, expand Local Development, and from the contained
Software components select each of the following components by highlighting
and clicking finish (you can ctrl+select multiples):
- From BI_UDI:
- bi/mmr/core
- bi/mmr/cwm_1.0_source
- bi/mmr/jmi
- bi/sdk/core
- bi/sdk/jdbc
- bi/sdk/query
- bi/sdkresultset
- bi/sdk/xmla
- From SAP-JEE:
- activation
- com.sap.exception
- j2eeca
- jaxm
- jcert
- jnet
- jsse
- jta
- mail
- sapxmltoolkit
- servlet
- tc/logging
- webservices_lib
- From SAP_JTECHS:
- com.sap.util.monitor.jarm
- tc/conn/connectorframework
- To run an application created with the SDK, from the Run menu,
select Run …. Select Java Application in the tree and
choose New. Ensure that the project name is the name of your
development component. On the Class path tab, uncheck the flag Use
default class path, and add jARM.jar and jARMSat.jar, from the location
to which you unzipped them in Step 2 above, as external jars. Click
Run.
For more information on working with the BI Java SDK within the NetWeaver
Developer Studio, in the NetWeaver Developer Studio help system, see SAP
Web AS for J2EE Applications --> Development Manual --> Working
with the Development Infrastructure in this Help structure. See Scenario
2, Working with Development Components, in particular.
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:
- Ensure that the SAP XML Parser and SAP SOAP packages (
SAPXMLToolkit.jar
and webservices_lib.jar ) are in your classpath.
- 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.
- 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)
|