About the SAP BI JDBC Connector

Version 3.50 SP12

This document is called howto.html and is delivered in the resource adapter archive (RAR file) bi_sdk_jdbc.rar. You may extract howto.html to a separate location for your reference before deploying the resource adapter archive.

Note that the BI JDBC Connector is deployed to the Web Application Server by default with the BW 3.5 installer. Refer to this document for configuration information, or to manually deploy this connector if, for example, you did not choose to deploy it during the BW 3.5 installation.

This document contains the following information:

• Overview
• System Requirements
• Connection Properties
• Deployment Procedure
• Additional Information

Overview

Sun's Java Database Connectivity (JDBC) is the standard Java API for Relational Database Management Systems (RDBMS). The BI JDBC Connector allows you to connect applications built with the BI Java SDK to over 170 JDBC drivers, supporting data sources such as Teradata, Oracle, Microsoft SQL Server, Microsoft Access, DB2, Microsoft Excel, and text files such as CSV. This connector is fully compliant with the J2EE Connector Architecture (JCA) and may be deployed into SAP's J2EE Server.

You can also use the BI JDBC Connector to make these data sources available in BW, via UD Connect.

The connector adds the following functionality to existing JDBC drivers:

• Uniform connection management that integrates with user management in SAP's Enterprise Portal
• Uniform metadata service, by implementing Java Metadata Interface (JMI) capabilities based on the Common Warehouse Metamodel (CWM)
• Query model independent of SQL dialect of the underlying data source

The BI JDBC Connector implements the BI Java SDK's IBIRelational interface.

System Requirements

Connection Properties

Deployment Procedure

The BI JDBC Connector is deployed to the Web Application Server by default with the BW 3.5 installer. Follow the instructions below if you have not selected this connector for installation or to manually deploy the resource adapter archive onto the Web Application Server:

1. Check system requirements
   
   Ensure that your system is properly configured and that any software prerequisites are satisfied (see System Requirements table above).
   
   
   1. SAP BW 3.5 Java Components:
      
      The BW system installer allows you to deploy the necessary components to the Web Application Server. Verify that these components are present by using the Web Application Server's SDM (Software Deployment Manager).
      
      These components are required by this connector's deployment descriptor. You will receive a warning during the deployment process if they are not already present.
      
      
   2. JDBC driver:
      
      If you have not already done so, you must first deploy your data source's JDBC driver into the SAP Web Application Server. To do so, follow the steps below:
      
      
      1. Go to the JDBC Connector service in the server's Visual Administrator
      2. Select the Drivers node in the Resources tree, and press the Create New Driver button in the toolbar
      3. In the DB Driver field in the Add Driver dialog box, enter a name for your JDBC driver
      4. Navigate to and select your driver's JAR file
      5. To select additional JAR files, press Yes when prompted; when finished, press No
         
         
2. Deploy the resource adapter archive
   
   Deploy the archive using the SDM:
   
   
   1. In the SDM, select the Deployment tab
   2. Press the Add SCA/SWC/SDA to Deployment List button
   3. Navigate to and select the bi_sdk_jdbc.rar file
   4. Continue pressing Next until the Start button appears
   5. Press Start
   6. Once finished, press Confirm
      
      
3. Configure the connection properties
   
   Configure your connector with the properties in the Connection Properties table above by using the Connector Container service of the Web Application Server's Visual Administrator:
   
   
   1. In the Connector Container service, select the Runtime tab
   2. Find your connector in the Connector Container tree which shows the currently-installed resource adapters, and select it
   3. Select the Managed Connection Factory tab
   4. Select the Properties sub-tab
   5. Select and edit each property as appropriate
   6. Press Add to transfer the changes back into the active properties
   7. Save changes with the Save button in the toolbar
   
   Note: You may also clone an existing connection by using the Clone button in the toolbar. If you are using this connector with UD Connect, when entering the resource adapter name during the cloning process, you must prefix the name with "SDK_" in order for UD Connect to properly recognize the connector.
   
   
4. Configure a reference to your JDBC driver
   
   Still in the Connector Container service, configure a reference in the BI JDBC Connector to your JDBC driver:
   
   
   1. In the Connector Container service, select the BI JDBC Connector in the Connectors tree
   2. Select the Resource Adapter tab
   3. In the Loader Reference window, press Add to add a reference to your JDBC driver
   4. Enter "library:[jdbc driver name]" and press OK. The [jdbc driver name] is the name you entered for your driver in step 1.b.iii above.
   5. Save your configuration with the Save button in the toolbar

Your BI JDBC Connector is now ready for use in a managed environment. Refer to this connector in your application by its JNDI name: SDK_JDBC. For code samples, refer to the Connection Interfaces Javadocs package in the documentation set delivered with the BI Java SDK .

Additional Information

For more information about Sun's J2EE Connector Architecture, see:

• http://java.sun.com/j2ee/connector/

For information about the Visual Administrator in SAP's Web Application Server, see:

• http://help.sap.com/saphelp_nw04/helpdata/en/
  39/83682615CD4F8197D0612529F2165F/frameset.htm

For more information about the connection architecture in the BI Java SDK, refer to the following documentation in the SDK distribution package:

• Connection Interfaces Javadocs package
• Developer's Guide (PDF)

For more information about UD Connect, see:

• http://help.sap.com/saphelp_nw04/helpdata/en/
  78/EF1441A509064ABEE6FFD6F38278FD/frameset.htm

For more information about Sun's JDBC, see:

• http://java.sun.com/products/jdbc/