Deploying JDBC proxy into WebSphere® Application Server

The JDBC proxy must be deployed on each application server that is running WebSphere® Application Server. The JDBC proxy enables a server that hosts applications to use JDBC to access a live database that you want to record or virtualize.

About this task

To deploy the JDBC proxy into the WebSphere® Application Server:

Procedure

  1. Download and extract the JDBC driver that is provided with HCL Quality Server. For more information, see HCL OneTest API tool packages.
  2. Copy the files that are listed in the following table, the JDBC proxy configuration file (registration.xml), and HCL OneTest™ API JDBC Provider installation script (setupJDBCProvider.py) from the downloaded JDBCIntercept.zip package to the file system of the server that is running WebSphere® Application Server. Make a note of the location of the files on the server ("Server_JDBC_installation_location").
    JDBC / Java™ version File name Description
    JDBC 4, Java™ 1.6 or later

    com.ibm.rational.rit.jdbcdriver4.jar

    jsqlparser15.jar and antlr-3.4.jar

    The JDBC proxy.

    Supporting libraries.

    Notes:
    • Currently, JDBC 4, Java 1.6 or later is supported for the JDBC proxy and its supporting libraries. You must add the three JAR files com.ibm.rational.rit.jdbcdriver4.jar, jsqlparser15.jar and antlr-3.4.jar to each application server directory that contains JDBC drivers.
    • The following items are not supported for vendor-specific Oracle SQLs:
      • Oracle-specific DDL statements
      • Custom functions
      • Subqueries
      • PIVOT and UNPIVOT statements
      • Nested tables containing multiple columns or single column of user-defined-types
      • Stubs with nested tables
    Important: HCL OneTest™ API does not have to be installed on the server that is running WebSphere® Application Server.
  3. If necessary, edit the server tag in the registration.xml file to the URL of the HCL Quality Server installation that is being used.

    For information about modifying this file, see Modifying the configuration settings of the JDBC proxy.

  4. Optional: Edit the domain and environment elements in the registration.xml file.

    If these elements are modified, the JDBC driver is used only when recording/stubbing within the specified domain and environment.

  5. Open a command prompt and navigate to the following directory:

    <WebSphere Application Server installation directory>\AppServer\profiles\<Profile name>\bin

    Tip: For Unix-like installations, a forward slash ("/") is used instead of a backslash ("\").
  6. Install the Green Hat JDBC Provider by running a command in the following format:

    wsadmin.bat -f Server_JDBC_installation_location/setupJDBCProvider.py Server_JDBC_installation_location installNode Node_name | installNode Node_name installServer Server_name | installCluster Cluster_name

    Tip: For Microsoft™ Windows™ and Unix-like installations, use the forward slash (/) instead of the backslash (\) for this command. In addition, for Unix-like installations, use wsadmin.sh instead of wsadmin.bat.

Results

The Green Hat JDBC Provider is installed. To verify, log in to the WebSphere® Integrated Solutions Console by using the relevant profile, and click Resources > JDBC > JDBC providers.

The JDBC providers screen displays the following data source:

Green Hat JDBC Provider

Example

To install the JDBC provider from every server, node, and cluster in the WebSphere® Application Server cell, run the following command:

wsadmin.bat -f Server_JDBC_installation_location/setupJDBCProvider.py Server_JDBC_installation_location

To install the JDBC provider in a single node, run the following command:

wsadmin.bat -f Server_JDBC_installation_location/setupJDBCProvider.py Server_JDBC_installation_location installNode Node_name

To install the JDBC provider in a single server, run the following command:

wsadmin.bat -f Server_JDBC_installation_location/setupJDBCProvider.py Server_JDBC_installation_location installNode Node_name installServer Server_name

To install the JDBC provider in a cluster, run the following command:

wsadmin.bat -f Server_JDBC_installation_location/setupJDBCProvider.py Server_JDBC_installation_location installCluster Cluster_name

What to do next

You must then select and enable JDBC data sources that you want to record or virtualize. For more information, see Selecting and enabling JDBC data sources in WebSphere Application Server.