Installing the WebSphere MQ File Transfer Edition stand-alone database logger

Follow these instructions to install and configure the stand-alone database logger.

About this task

For more information about the stand-alone database logger, see the topic Configuring a WebSphere MQ File Transfer Edition logger.
Note: You cannot run a JEE database logger at the same time as a stand-alone database logger, unless these database loggers are using separate instances of the database.

Procedure

  1. Install your database software using the documentation for your database. If JDBC support is an optional component for your database, you must install this component.
  2. Create a database using the tools provided by your database. The database must have a tablespace and bufferpool page size of at least 8K. The default schema name is FTELOG. If you use a schema name other than FTELOG, you must edit the provided SQL file appropriate to your database, ftelog_tables_db2.sql or ftelog_tables_oracle.sql, to reflect this before proceeding to the next step. For more information, see wmqfte.database.schema in
  3. Create the required database tables using your database's tools. On distributed platforms, the files ftelog_tables_db2.sql and ftelog_tables_oracle.sql contain SQL commands that you can run to create the tables.
    On z/OS®, the file that you need to run depends on the version of DB2® for z/OS that you are using:
    • For Db2 z/OS V9.0 and earlier, run the file ftelog_tables_zos.sql to create the tables. This file creates the tables using an INTEGER data type for fields which denote the sizes of files that are transferred and the table ID associated with each transfer.
    • For Db2 z/OS V9.1 and later, run the file ftelog_tables_zos_bigint.sql to create the tables. This file creates the tables using a BIGINT data type for fields which denote the sizes of files that are transferred and the table ID associated with each transfer.
  4. Install the stand-alone database logger.
    • On distributed platforms, install the stand-alone database logger as part of the WebSphere® MQ File Transfer Edition Remote Tools and Documentation installation. You can either choose to install just the stand-alone database logger or install the stand-alone database logger with the other WebSphere MQ File Transfer Edition tools.
    • On z/OS, install the stand-alone database logger from the tape.
      Add the following Db2 data sets to the STEPLIB environment variable in the order shown:
      • SDSNEXIT
      • SDSNLOAD
      • SDSNLOD2
  5. Create the stand-alone database logger queues. The stand-alone database logger uses two queues on the coordination queue manager. The first queue is a command queue where messages to control the operation of the stand-alone database logger are placed. The default name of this command queue is SYSTEM.FTE.DATABASELOGGER.COMMAND. The second queue is a reject queue. Because the stand-alone database logger never discards log messages, if the logger encounters a message that it cannot handle, it places the message on the reject queue for examination, and possible reprocessing. You are not recommended to use the queue manager's dead letter queue for this purpose, because rejected messages do not have a DLH header and because rejected messages should not be combined with messages put to the dead letter queue for other reasons. The default name for the reject queue is SYSTEM.FTE.DATABASELOGGER.REJECT. These two queues are defined in the MQSC file generated by the fteSetupCoordination command in WebSphere MQ File Transfer Edition Version 7.0.1 or later. If you defined your coordination queue manager configuration using an earlier version, you create these two queues manually.
  6. Choose a user and configure permissions
  7. Configure the stand-alone database logger by editing the databaselogger.properties file. This file is a Java™ properties file that consists of key=value pairs. The databaselogger.properties file is in the config_directory/coordination_qmgr_name directory. If you install the Remote Tools and Documentation on z/OS or if you skip the configuration steps, the databaselogger.properties file is not created during installation. Manually create the file in the config_directory/coordination_qmgr_name directory. You must complete some properties for the stand-alone database logger to operate. You only need to use some other properties if you want to override built-in defaults. The minimum set of properties you must use is as follows:
    1. wmqfte.queue.manager - set this property to the name of the coordination queue manager that you want the database loader to connect to.
    2. wmqfte.database.name - set this property to the name of the database that holds the WebSphere MQ File Transfer Edition log tables.
    3. wmqfte.database.driver - set this property to the fully qualified file name of the .jar file that provides your database's JDBC driver. For example: /opt/IBM/db2/V9.5/java/db2jcc.jar. On Windows specify the path separator as a forward slash character (/) for example, C:/Program Files/IBM/SQLLIB/java/db2jcc.jar. If your database driver consists of multiple jar files (for example, Db2 V9.1 requires a driver jar file and a license jar file), include all these jar files in this property. Separate multiple file names using the classpath separator for your platform, that is, the semicolon character (;) on Windows and the colon character (:) on other platforms. See Database logger configuration properties for a description of all the properties in the file databaselogger.properties .
    4. If you are using an Oracle database you must set this property, wmqfte.database.user - set this property to the user that connects to the database.
    5. If you are using an Oracle database you must set this property, wmqfte.database.password - set this property to the password associated with the user specified by the preceding property.
    6. If you are using an Oracle database you must set this property, wmqfte.database.type - set this property to oracle to override the default of db2.
    7. If the native library path is not already available on the system path, you must set this property, wmqfte.database.native.library.path - set this to the full name of the directory that contains the WebSphere MQ native libraries.
  8. If your WebSphere MQ system does not already include transaction support, configure this now. For more information about how to set up transaction support, see Configuring transaction support - distributed systems only
  9. Optional: If you are using a Windows system, you can run the stand-alone database logger as a Windows service. Run the fteModifyDatabaseLogger command with the -s parameter. For more information, see the topic fteModifyDatabaseLogger (run a WebSphere MQ File Transfer Edition database logging application as a Windows service).
  10. Start the stand-alone database logger using the fteStartDatabaseLogger command. By default, the stand-alone database logger runs in the background and the stand-alone database logger places output into a file in the logs directory. If you want to run the stand-alone database logger in the foreground and produce output to the console as well as to the log file, add the -F parameter to the fteStartDatabaseLogger command.

    If you carried out the previous step and used the fteModifyDatabaseLogger command with the -s parameter on Windows, the stand-alone database logger starts as a Windows service.


Task Task

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/dl_install_standalone.htm