WebSphere MQ Workflow Database Tools - Installation

Note: This document must be printed in landscape format!

The MQ Workflow database tools can make modifications to the MQ Workflow Runtime database that cannot be made using the usual API calls. Currently there are two database tools for MQ Workflow. You can find more information on the tools in the following documents:

Process Template Deletion Tool

Global Container Maintenance Tool

Follow these instructions to start one of the tools.

Getting started

Before you use the tools, it is recommended that you make a backup copy of your MQ Workflow Runtime database.

To run the database tools on your system, you must have installed and configured an MQ Workflow Server installation.

If you are running MQ Workflow with DB2 Universal Database on a UNIX or Windows platform, ensure that JDBC 2.0 is used. To switch to JDBC 2.0:

  1. Stop all MQ and DB2 services that are running on your machine.
  2. Call usejdbc2.bat.
    This file is located in the java12 subdirectory of your DB2 installation directory.
If you are running MQ Workflow on z/OS, ensure that JDBC support is installed for your DB2 database. Check that the db2j2classes.zip driver file exists in the classes subdirectory of your DB2 installation. Set up your DB2 subsystem to have a valid location name.

Setting up the tools

The tools consist of the fmcjdbt.jar and fmcoutil.jar files, which contain the Java code, and a JNI library (fmczptdt.dll on Windows, libfmczptdt.so on AIX and Sun Solaris, libfmczptdt.sl on HP-UX systems). For z/OS, a JNI library is not needed. A configuration file, dbTools.properties, and sample start scripts for all platforms are supplied.

Installation on UNIX and Windows systems

To install the tools:

  1. Unzip WC01.zip. 
  2. Include the fully-qualified path for fmcjdbt.jar and fmcoutil.jar in your CLASSPATH. The JDBC driver file, db2java.zip for DB2 or classes12.zip for Oracle, must also be part of the CLASSPATH. Also include the corresponding JNI library in your systems library search path.
    Because these files are not needed by any other MQ Workflow program, you can copy them into the working directory.
  3. Ensure that the configuration file, dbTools.properties, is in the directory from where you call the tools.

To avoid setting the environment variables each time you start the tool, it is recommended that you use a start script. Example scripts for all platforms can be found in the dbTools directory. Modify start_win.bat for Windows systems and start_unix.sh for UNIX systems.

Installation on z/OS

To install the tools:

  1. To install the tools on z/OS, unzip WC01.zip on your workstation and transfer fmcjdbt.jar, fmcoutil.jar, dbTools.properties and the start script sample via FTP to an HFS directory on z/OS. You do not need to transfer the subdirectories and their content.
  2. Include the fully-qualified path for fmcjdbt.jar and fmcoutil.jar in your CLASSPATH. The JDBC driver file db2j2classes.zip must also be part of the CLASSPATH. 
  3. Set your LIBPATH to the lib subdirectory of your DB2 installation. Set the environment variable STEPLIB to <DB2InstHLQ>.SDSNLOAD and <DB2InstHLQ>.SDSNLOD2 where <DB2InstHLQ> is the directory name of your DB2 installation.
  4. Edit your db2sqljjdbc.properties file and set the DB2SQLJSSID to your DB2 subsystem name (<DB2SSYSN>).
  5. Ensure that the configuration file, dbTools.properties, is in the directory from where you call the tools.

To avoid setting the environment variables each time you start the tool, it is recommended that you use a start script. An example of a start script for z/OS can be found in the dbTools directory. Modify start_zos.sh with the information described above.

Customizing the tools

You can control the behaviour of the tools by setting properties in the dbTools.properties file. This file must be in the directory from where you call the tools. If it is missing, the program exits with an error.

You can set the following properties:

  • Test mode control
    If Test_Mode=true is set, changes made to the database are rolled back so that the run-time database remains unchanged. This parameter is useful if you want to see how the deletion of the templates might affect your run-time database. The tool also reports additional information.

    If Test_Mode=false is set, the test mode is switched off and transactions are committed to the database.

    Global Container Maintenance Tool:
    If you use DB2, the rollback will be executed after exiting the Global Container Maintenance Tool. You will see the changes in the database as long as the tool is running. If you use Oracle, the rollback will be executed after every split or merge of the global container tables. You cannot see the changes in the database, but you get a message if the transaction completes successfully.

  • Log file name
    If Log_File_Name=<filename> is set, log output is written to the specified file. By default the log is written to the dbTools.log file in the current directory.

Trademark attributions and copyrights

© IBM Corporation 2003, 2004.
All rights reserved. 

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM Web site pages may contain other proprietary notices and copyright information which should be observed. 

The following terms are trademarks of the IBM Corporation in the United States, other countries, or both: AIX, DB2 Universal Database, IBM, WebSphere. 

Special attributions

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other company, product, and service names may be trademarks or service marks of others.

 

Subheadings









 
Notices


     (Back to the top)