About the BI SAP Query Connector

Version 3.50 SP12

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

Note that the BI SAP Query 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

SAP Query is a component of SAP's Web Application Server that allows you to create custom reports without any ABAP programming knowledge. The BI SAP Query Connector uses SAP Query to allow applications created with the BI Java SDK to access data from these SAP operational applications. 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 SAP Query Connector to make these data sources available in BW, via UD Connect.

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

 

System Requirements

Requirement Detail
Software prerequisites

 

  • SAP BW 3.5 Java Components
  • SAP JCo

 

Supported data sources SAP R/3 4.6C or greater
Supported systems Systems supported by SAP JCo
Supported application server SAP NetWeaver '04 Web Application Server 6.40 or greater

 

Connection Properties

Connection Constant * Property Name Description Examples
SapqConnectionConstants.
USERNAME
UserName Data source username. (your username)
SapqConnectionConstants.
PASSWORD
Password Data source password. (your password)
SapqConnectionConstants.
LANGUAGE
Language Two-letter abbreviation of language. Sets the logon language for your system, and also specifies the language of exceptions evoked on the BI Java SDK layer. EN = English
DE = German
SapqConnectionConstants.
QUERYAREA
QueryArea Single-character value (char) specifying whether the SAP Query area is global (client-independent) or local (client-dependent). Default value is local. X = global
[blank] = local
SapqConnectionConstants.
CLIENT
Client Client specified as three-digit integer. 000
SapqConnectionConstants.
MESSAGESERVER
MessageServer Hostname for message server. server1.mydomain.com
SapqConnectionConstants.
APPLICATIONSERVER
ApplicationServer Hostname for application server. server1.mydomain.com
SapqConnectionConstants.
SYSTEMNUMBER
SystemNumber Two-digit integer identifying the R/3 instance. 00
SapqConnectionConstants.
SERVERGROUP
ServerGroup Logon group for load balancing. a string, such as PUBLIC or SPACE
SapqConnectionConstants.
R3NAME
R3Name R/3 name. OSS

* Note: For the set of connection properties relevant for your system, refer to the JCo documentation in your JCo download.

If you have trouble establishing a connection to a server that does not have a PUBLIC logon group, try removing the properties for R3Name and ServerGroup. See the JCo documentation on the SAP Service Marketplace (http://service.sap.com/connectors/) for more connection troubleshooting information.

 

Deployment Procedure

The BI SAP Query 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. JCo:

      JCo is already present in your managed environment.

  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_sapq.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.

Your BI SAP Query Connector is now ready for use in a managed environment. Refer to this connector in your application by its JNDI name: SDK_SAPQ. 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:

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

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:

For more information about SAP Query, see:


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.