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:
- For InfoSphere Optim Performance Manager:
To download the IODT_RT_CLT_V3.1.0.2_BULK_DEPLY.zip file (CN186ML) from IBM Passport Advantage, see the instructions at: - For OMEGAMON XE for DB2 Performance Expert on z/OS:
To download the IBM.DTRC.v3.1.0.2.operating_system file, see the instructions in at:
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:
Identify a staging machine and perform the following steps. We recommend that you use your OPM server machine as the staging machine.
- Extract the bulk deploy compressed file (bulk-deploy.zip) to a directory, for example:
ClientFiles. - Rename the file
ClientFiles/bulkDeploy/Java/pdq.properties.sampletoClientFiles/bulkDeploy/Java/pdq.properties. - Rename the file
ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg.sampletoClientFiles/bulkDeploy/non-Java/db2dsdriver.cfg. - Edit the
pdq.propertiesanddb2dsdriver.cfgfiles by replacing the values that correspond to your OPM server forpdq.cmx.controllerURLandcontrollerURL. (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"/>
- For pdq.properties:
- Remove the comments around
pdq.cmx.controllerURLandconnectionSupervisorPropertiesif they exist.
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.
- 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. - Edit
ClientFiles/bulkDeploy/non-Java/db2dsdriver.cfgby adding theconnectionSupervisorLibraryattribute with appropriate value forClientMachineLocation
<configuration>
...
<parameters>
<parameter name="connectionSupervisorLibrary" value="ClientMachineLocation/pqcmx"/>
</parameters>
</configuration>
Setup for Java applications
- 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.jarfor these application. Note that for Websphere applications, thedb2jcc.jarexists on the Websphere Application Server machine. The machine on which thedb2jcc.jarfiles exists is the client driver machine.- 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.jarfile- On each client driver machine, use the
CLASSPATHenvironment variable to determine the location of thedb2jcc.jarfile that is used by your application. - Use any remote file copy command like
scporrcpto copy all the files fromClientFiles/bulkDeploy/Javadirectory on the staging machine to the directory where thedb2jcc.jarfile is located on each client driver machine.
Option 2: Copying the configuration files to an alternate directory on the client driver machine
- 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. - Use any remote file copy command like
scporrcpto copy all the files fromClientFiles/bulkDeploy/Javadirectory on the staging machine to theClientMachineLocationdirectory on the client driver machine. - In the
CLASSPATHenvironment variable, add bothClientMachineLocation/pdq.jarandClientMachineLocation/pdq.properties.
- Validating the installation and configuration. This step is optional, but recommended.
- 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,dbuseranddbpassword.
java com.ibm.pdq.tools.DataVersion -configuration -url jdbc:db2://dbhost:dbport/dbname -username dbuser -password dbpassword - In the output of the script, the line that contains
monitorEnabled=1indicates that your application is correctly setup for OPM EI.
- 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.
- If you want to disable extended insight monitoring for a Java application, edit the
pdq.propertiesfile that was deployed for that application and comment out the linepdq.cmx.controllerURL. Later on, you can enable extended insight monitoring by removing the comments.
Setup for ODBC/CLI, Embedded SQL and .NET applications
- 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.
- Deploying the files to the client driver machine
- The deployment process involves copying the binary files and the configuration files.
- 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.
- Determine the location of the DB2 driver by running the
db2levelcommand on each client driver machine. - Determine the value for the
libdirdirectory by using the following table along with the environment of each client driver machine:Operating system
Value of
libdirfor the DB2 Client or
DB2 Runtime ClientValue of
libdirfor the DB2 DS DriverWindows
bin
bin
Linux or UNIX 32-bit
lib32
lib
Linux or UNIX 64-bit
lib64
lib
- Use any remote file copy command like
scporrcpto copy all the files fromClientFiles/bulkDeploy/non-Java/platform/libdirdirectory on the staging machine toDB2 Driver install directory/libdiron each client driver machine.
Option 2: Copying the binary files to an alternate directory on the client driver machine.
- Locate the
ClientMachineLocationdirectory as identified in step 6 under Generic setup. - Use any remote file copy command like
scporrcpto copy all files fromClientFiles/bulkDeploy/non-Java/platform/libdirdirectory on the staging machine to the directory chosen asClientMachineLocationon each client driver machine
- Determine the location of the DB2 driver by running the
- Deploying the configuration files.
- Determine the location of the
db2dsdriver.cfgfile used by your application. If you do not know the location of thedb2dsdriver.cfgused by your application, edit one of the lines below by adding the values that correspond to your database fordsnname,dbname,dbhost,dbport,dbuseranddbpassword. Use the header section of the output to determine the location of thedb2dsdriver.cfgfile.db2cli validate -dsn dsnname -user dbuser -passwd dbpassworddb2cli validate -database dbname:dbhost:dbport -user dbuser -passwd dbpassword - Open the
db2dsdriver.cfgfile in an editor and then perform one of the following steps.- If the
db2dsdriver.cfgfile is empty, replace it withClientFiles/bulkDeploy/non-Java/db2dsdriver.cfgfrom the staging machine. - If the
db2dsdriver.cfgfile is not empty, edit it by inserting theconnectionSupervisorPropertiesattribute andconnectionSupervisorLibraryattribute (if exists) from theClientFiles/bulkDeploy/non-Java/db2dsdriver.cfgfile on the staging machine.
- If the
- Determine the location of the
- Validating the installation and configuration. This step is optional, but recommended.
-
- ODBC/CLI applications
- 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,dbuseranddbpassword.db2cli validate -dsn dsnname -user dbuser -passwd dbpassworddb2cli validate -database dbname:dbhost:dbport -user dbuser -passwd dbpassword - Run the command that you edited.
- In the output of the script, the line
Monitoring status: onindicates that your ODBC/CLI application is correctly set up for OPM EI.
- Embedded SQL applications
- Edit the line below by adding the values that correspond to your database for
dsnname,dbuseranddbpassword.db2cli validate -dsn dsnname -user dbuser -passwd dbpassword -connect -embedded - Run the command that you edited.
- In the output of the script, the line
Monitoring status: onindicates that your Embedded SQL application is correctly set up for OPM EI.
- .NET applications
- 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,dbuseranddbpasswordtestconn20 "Database=dbname;Server=dbhost:dbport;UserID=dbuser;Password=dbpassword" -validateEIWithConnecttestconn40 "Database=dbname;Server=dbhost:dbport;UserID=dbuser;Password=dbpassword" -validateEIWithConnect - Run the command that you edited.
- In the output of the script, the line
Monitoring status: onindicates that your .NET application is correctly set up for OPM EI.
- ODBC/CLI applications
- 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.
- If you want to disable extended insight monitoring for an ODBC/CLI, Embedded SQL or .NET application, edit the
db2dsdriver.cfgfile that was deployed for that application and comment out the line that contains theconnectionSupervisorPropertiesproperty. Later on, you can enable extended insight monitoring by removing the comments.
To migrate to the InfoSphere Optim Data Tools Runtime Client bulk deploy process, you must perform the following steps:
- 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.
- Remove the remove
pdq.jarandpdq.propertiesentries from the CLASSPATH environment variable. - 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
Was this topic helpful?
Document Information
Modified date:
08 July 2021
UID
swg27042303