IBM Support

InfoSphere Optim Data Tools Runtime Client Bulk Deploy for InfoSphere Optim Performance Manager Extended Insight

Product Documentation


Abstract

Starting in version 3.1.0.2 of InfoSphere Optim Data Tools Runtime (DTRC), you can use the DTRC bulk deploy process to install and configure your client applications for InfoSphere Optim Performance Manager Extended  Insight (OPM EI) in fewer steps.

Content

Overview
The bulk deploy process includes a compressed file (bulk-deploy.zip) that you use to perform the configuration and deployment of extended insight monitoring with OPM. In a typical installation, you extract the compressed file on a staging machine, and then create the configuration files (pdq.properties, db2dsdriver.cfg) for your OPM environment. You then copy the configuration files and the binary files from the staging machine to the client driver machines where the DB2 Driver is installed.


Download
To download InfoSphere Optim Data Tools Runtime Client Bulk Deploy, see the following documents for instructions:


Procedure
Select one of the following tabs for instructions about installing or migrating to the IBM InfoSphere Optim Data Tools Runtime Client bulk deploy process:

Generic setup

Identify a staging machine and perform the following steps. We recommend that you use your OPM server machine as the staging machine.

  1. Extract the bulk deploy compressed file (bulk-deploy.zip) to a directory, for example: ClientFiles.
  2. Rename the file ClientFiles/bulkDeploy/Java/pdq.properties.sample to ClientFiles/bulkDeploy/Java/pdq.properties.
  3. Rename the file ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg.sample to ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg.
  4. Edit the pdq.properties and db2dsdriver.cfg files by replacing the values that correspond to your OPM server for pdq.cmx.controllerURL and controllerURL. (Tip: The default port number is 65000).
    Examples:
    • For pdq.properties: pdq.cmx.controllerURL=opmserver.ibm.com:65000
    • For db2dsdriver.cfg: <parameter name="connectionSupervisorProperties" value="controllerURL= opmserver.ibm.com:65000"/>
  5. Remove the comments around pdq.cmx.controllerURL and connectionSupervisorProperties if they exist.
  6. Step 6 and 7 are for ODBC/CLI, Embedded SQL and .NET applications that do not use DB2 10.5.3 or later versions or cannot copy files to the DB2 driver installation directory on the client driver machine.
  7. Identify a directory location on each client driver machine where you can copy files into, for example: ClientMachineLocation. For ease of deployment, choose the same location on every client driver machine.
  8. Edit ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg by adding the connectionSupervisorLibrary attribute with appropriate value for ClientMachineLocation
    <configuration>
       ...
       <parameters>
          <parameter name="connectionSupervisorLibrary" value="ClientMachineLocation/pqcmx"/>
       </parameters>
    </configuration>


Setup for Java applications
  1. Identifying the client driver machines
    Identify the Java applications for which you want to configure extended insight monitoring with OPM. Determine the location of the db2jcc.jar for these application. Note that for Websphere applications, the db2jcc.jar exists on the Websphere Application Server machine. The machine on which the db2jcc.jar files exists is the client driver machine.
  2. Deploying the files to the client driver machines
    You have two options to choose from. Use the table below to determine your option.

    JCC 3.67 or later or JCC 4.17 or later

    JCC 3.66 or earlier or JCC 4.16 or earlier

    Deploy to the location of db2jcc.jar

    Option 1

    Option 2

    Deploy to an alternate location

    Option 2

    Option 2

    Option 1: Copying the configuration files to the same directory as the db2jcc.jar file

    1. On each client driver machine, use the CLASSPATH environment variable to determine the location of the db2jcc.jar file that is used by your application.
    2. Use any remote file copy command like scp or rcp to copy all the files from ClientFiles/bulkDeploy/Java directory on the staging machine to the directory where the db2jcc.jar file is located on each client driver machine.

    Option 2: Copying the configuration files to an alternate directory on the client driver machine

    1. Determine a directory location on each client driver machine where you can copy the files, for example: ClientMachineLocation. For ease of deployment, choose the same location on every client driver machine.
    2. Use any remote file copy command like scp or rcp to copy all the files from ClientFiles/bulkDeploy/Java directory on the staging machine to the ClientMachineLocation directory on the client driver machine.
    3. In the CLASSPATH environment variable, add both ClientMachineLocation/pdq.jar and ClientMachineLocation/pdq.properties.
  3. Validating the installation and configuration. This step is optional, but recommended.
    1. Run the DataVersion utility to validate the installation and configuration. Edit the line below by adding the values that correspond to your database for dbhost, dbport, dbname, dbuser and dbpassword.
      java com.ibm.pdq.tools.DataVersion -configuration -url jdbc:db2://dbhost:dbport/dbname -username dbuser -password dbpassword
    2. In the output of the script, the line that contains monitorEnabled=1 indicates that your application is correctly setup for OPM EI.
  4. Later on, as new Java applications are added to your enterprise and you want to enable extended insight monitoring for those applications, follow steps 1, 2 and 3 listed above.
  5. If you want to disable extended insight monitoring for a Java application, edit the pdq.properties file that was deployed for that application and comment out the line pdq.cmx.controllerURL. Later on, you can enable extended insight monitoring by removing the comments.


Setup for ODBC/CLI, Embedded SQL and .NET applications
  1. Identifying the client driver machines
    Identify the ODBC/CLI, Embedded SQL or .NET applications for which you want to configure extended insight monitoring with OPM. Determine the DB2 Driver installation used by these applications. The machine on which the DB2 Driver is installed is the client driver machine.
  2. Deploying the files to the client driver machine
    The deployment process involves copying the binary files and the configuration files.
    1. Deploying the binary files. To deploy the binary files, you have two options to choose from. Use the table below to determine your option.

      DB2 10.5.3 or later

      DB2 10.5.2 or earlier

      Deploy to the location within DB2 Driver install

      Option 1

      Option 2

      Deploy to an alternate location

      Option 2

      Option 2

      Option 1: Copying the binary files to a directory within DB2 driver install.

      1. Determine the location of the DB2 driver by running the db2level command on each client driver machine.
      2. Determine the value for the libdir directory by using the following table along with the environment of each client driver machine:

        Operating system

        Value of libdir for the DB2 Client or
        DB2 Runtime Client

        Value of libdir for the DB2 DS Driver

        Windows

        bin

        bin

        Linux or UNIX 32-bit

        lib32

        lib

        Linux or UNIX 64-bit

        lib64

        lib

      3. Use any remote file copy command like scp or rcp to copy all the files from ClientFiles/bulkDeploy/non-Java/platform/libdir directory on the staging machine to DB2 Driver install directory/libdir on each client driver machine.

      Option 2: Copying the binary files to an alternate directory on the client driver machine.

      1. Locate the ClientMachineLocation directory as identified in step 6 under Generic setup.
      2. Use any remote file copy command like scp or rcp to copy all files from ClientFiles/bulkDeploy/non-Java/platform/libdir directory on the staging machine to the directory chosen as ClientMachineLocation on each client driver machine

    2. Deploying the configuration files.
      1. Determine the location of the db2dsdriver.cfg file used by your application. If you do not know the location of the db2dsdriver.cfg used by your application, edit one of the lines below by adding the values that correspond to your database for dsnname, dbname, dbhost, dbport, dbuser and dbpassword. Use the header section of the output to determine the location of the db2dsdriver.cfg file.
        db2cli validate -dsn dsnname -user dbuser -passwd dbpassword
        db2cli validate -database dbname:dbhost:dbport -user dbuser -passwd dbpassword
      2. Open the db2dsdriver.cfg file in an editor and then perform one of the following steps.
        • If the db2dsdriver.cfg file is empty, replace it with ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg from the staging machine.
        • If the db2dsdriver.cfg file is not empty, edit it by inserting the connectionSupervisorProperties attribute and connectionSupervisorLibrary attribute (if exists) from the ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg file on the staging machine.
  3. Validating the installation and configuration. This step is optional, but recommended.
    1. ODBC/CLI applications
      1. Depending on whether you want to use ODBC/CLI with DSN, or without a DSN, edit one of the lines below by adding the values that correspond to your database for dsnname, dbname, dbhost, dbport, dbuser and dbpassword.
        db2cli validate -dsn dsnname -user dbuser -passwd dbpassword
        db2cli validate -database dbname:dbhost:dbport -user dbuser -passwd dbpassword
      2. Run the command that you edited.
      3. In the output of the script, the line Monitoring status: on indicates that your ODBC/CLI application is correctly set up for OPM EI.
    2. Embedded SQL applications
      1. Edit the line below by adding the values that correspond to your database for dsnname, dbuser and dbpassword.
        db2cli validate -dsn dsnname -user dbuser -passwd dbpassword -connect -embedded
      2. Run the command that you edited.
      3. In the output of the script, the line Monitoring status: on indicates that your Embedded SQL application is correctly set up for OPM EI.
    3. .NET applications
      1. Depending on whether you want to validate the .NET Framework 2.0, or the .NET Framework 4.0, edit one of the lines below by adding the values that correspond to your database for dbname, dbhost, dbport, dbuser and dbpassword
        testconn20 "Database=dbname;Server=dbhost:dbport;UserID=dbuser;Password=dbpassword" -validateEIWithConnect
        testconn40 "Database=dbname;Server=dbhost:dbport;UserID=dbuser;Password=dbpassword" -validateEIWithConnect
      2. Run the command that you edited.
      3. In the output of the script, the line Monitoring status: on indicates that your .NET application is correctly set up for OPM EI.
  4. Later on, as new ODBC/CLI, Embedded SQL or .NET applications are added to your enterprise and you can enable extended insight monitoring for those applications by following steps 1, 2 and 3 listed above.
  5. If you want to disable extended insight monitoring for an ODBC/CLI, Embedded SQL or .NET application, edit the db2dsdriver.cfg file that was deployed for that application and comment out the line that contains the connectionSupervisorProperties property. Later on, you can enable extended insight monitoring by removing the comments.
Migrating to the IBM InfoSphere Optim Data Tools Runtime Client bulk deploy process

To migrate to the InfoSphere Optim Data Tools Runtime Client bulk deploy process, you must perform the following steps:

  1. Uninstall the InfoSphere Optim Data Tools Runtime Client using the manual steps. For complete uninstallation instructions, see the Uninstalling InfoSphere Optim Data Tools Runtime Client software in the online documentation.
  2. Remove the remove pdq.jar and pdq.properties entries from the CLASSPATH environment variable.
  3. Install and configure InfoSphere Optim Performance Manager Extended Insight by following the instructions under the Installing and configuring with bulk deploy tab.

Original Publication Date

05 September 2014

[{"Product":{"code":"SSBH2R","label":"InfoSphere Optim Performance Manager for Db2 for Linux, UNIX, and Windows"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"--","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF013","label":"Inspur K-UX"}],"Version":"5.3.1","Edition":"Extended Edition;Extended Insight","Line of Business":{"code":"","label":""}}]

Document Information

Modified date:
08 July 2021

UID

swg27042303