Professional Documents
Culture Documents
Tibco Hawk Database Adapter: Installation
Tibco Hawk Database Adapter: Installation
Tibco Hawk Database Adapter: Installation
Installation
Software Release 6.2
December 2019
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE
LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED
IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS
AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN
AGREEMENT TO BE BOUND BY THE SAME.
ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDER SEPARATE
SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH, THESE SOFTWARE
ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITH TIBCO, INCLUDING ANY
TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES, AND INDEMNITIES. DOWNLOAD
AND USE OF THESE ITEMS IS SOLELY AT YOUR OWN DISCRETION AND SUBJECT TO THE LICENSE
TERMS APPLICABLE TO THEM. BY PROCEEDING TO DOWNLOAD, INSTALL OR USE ANY OF THESE
ITEMS, YOU ACKNOWLEDGE THE FOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO
PRODUCTS.
This document is subject to U.S. and international copyright laws and treaties. No part of this document may be
reproduced in any form without the written authorization of TIBCO Software Inc.
TIBCO, the TIBCO logo, the TIBCO O logo, Hawk, Rendezvous, TIBCO Runtime Agent, ActiveMatrix
BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO BusinessEvents, and BusinessConnect are either
registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle Corporation
and/or its affiliates.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
This software may be available on multiple operating systems. However, not all operating system platforms for
a specific software version are released at the same time. See the readme file for the availability of this software
version on a specific operating system platform.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE
IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's
Virtual Patent Marking document (https://www.tibco.com/patents) for details.
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO Hawk Database Adapter Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
TIBCO Product Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
How to Join TIBCO Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installation Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installation Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installer Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installer Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Memory Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Supported Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing in GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installing in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Postinstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Changing the Service Log on Account on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Configuring a New Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Uninstalling the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Uninstalling in the GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Uninstalling in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Starting and Stopping the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Preface
This software may be available on multiple operating systems. However, not all
operating system platforms for a specific software version are released at the
same time. See the readme file for the availability of this software version on a
specific operating system platform.
Topics
Related Documentation
Typographical Conventions
Convention Use
ENV_NAME TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in other
TIBCO_HOME
installation environments. Incompatible products and multiple instances of the
HAWK_DBHMA same product must be installed into different installation environments.
_HOME
An installation environment consists of the following properties:
• Name Identifies the installation environment. This name is referenced in
documentation as ENV_NAME. On Microsoft Windows, the name is
appended to the name of Windows services created by the installer and is a
component of the path to the product shortcut in the Windows Start > All
Programs menu.
• Path The folder into which the product is installed. This folder is referenced
in documentation as TIBCO_HOME.
• TIBCO Hawk Database Adapter installs into a directory within
TIBCO_HOME. This directory is referenced in documentation as
HAWK_DBHMA_HOME. The default value of HAWK_DB_HOME depends on
the operating system. For example on Windows systems, the default value is
C:\tibco\hawk\<version>\adapters\db.
code font Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.
Convention Use
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix
BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace.
For example: MyCommand PathName
Key Key name separated by a plus sign indicate keys pressed simultaneously. For
combinations example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.
Convention Use
[ ] An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
| A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
Convention Use
{ } A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
For information about this product, you can read the documentation, contact
TIBCO Support, or join TIBCO Community.
Chapter 1 Introduction
TIBCO Hawk Database Adapter allows you to perform Database monitoring and
adds database management capabilities to TIBCO Hawk. These capabilities
include getting and setting Database variables as well as sending and receiving
Database traps. In addition to the many built-in methods, TIBCO Hawk Database
Adapter provides a way to execute custom SQL (DDL, DML, and DCL)
statements including the execution of external stored procedures.
This chapter explains installation modes, requirements, and other options you
should be aware of before starting the installation.
Topics
Installation Overview
Installation Modes
Three installation modes are available: GUI, console, and silent.
GUI Mode
In the GUI mode, the installer presents panels enabling you to make choices about
product selection, product location, and so on. To invoke the installer in GUI
mode, double-click the executable.
Console Mode
Console mode allows you to run the installer from the command prompt or
terminal window. This is useful if your machine does not have a GUI
environment.
Silent Mode
Silent mode installs the product using either default or custom settings that are
saved in a response file. Silent mode installs the product without prompting you
for information.
Installation Types
Two installation types are available: Profile and Custom.
• The Profile installation type installs all the software for a specific profile.
• With the Custom installation type you can select components.
Installer Account
Microsoft Windows
You must have administrator privileges for the machine on which this product is
installed. If you do not have administrator privileges, the installer exits. Then log
out of the system and log in as a user with the required privileges, or request your
system administrator to assign the privileges to your account.
If you intend to install the product on a network drive, ensure that the account
used for installation has permission to access the network drive.
UNIX
Any user can install this product.
• Regular (non-root) user
• Super-user (root).
A graphic environment such as CDE or X Windows is required to run the installer
in GUI mode.
Installation Requirements
This section describes the disk space requirements, system memory requirements,
software requirements, and supported platforms for this product.
If your system does not have sufficient disk space in the default temporary area,
you can run the installer with a different temporary directory by using the
following option when starting the installer:
-is:tempdir /new_temp
Supported Platforms
Refer to the Readme file for the supported platforms, versions, and required
patches.
Software Requirements
The following software products are distributed and installed separately from this
product. See the Readme file for the supported versions.
For more information about the database types and their corresponding JDBC
drivers, refer to Appendix A, JDBC Drivers Reference.
Table 2 lists the required and optional software products.
Software Description
TIBCO Hawk Required. TIBCO Hawk is a tool for monitoring and managing
distributed applications and operating systems. The software is
designed specifically for monitoring distributed systems,
therefore there is no centralized console or frequent polling
across the network. With this structure, TIBCO Hawk software
is able to scale to multithousand node global networks without
the use of hierarchical managers and has the flexibility for
individual managed entities to be added or modified without
the need to reconfigure or restart any other parts of the system.
Software Description
TIBCO Enterprise Message Optional. You can use it to send messages from Hawk Database
Service Adapter in a format that conforms to the Java Messaging
Service (JMS) specification. Enterprise Message Service also
extends the JMS specification with a reliable delivery mode and
a no-acknowledge acknowledgement mode.
Java Runtime Environment (JRE) You can choose to use the Java Runtime Environment (JRE)
supplied with TIBCO Hawk.
(OR)
You can edit the required .tra and .cfg file to reflect the
accurate JRE location.
Chapter 2 Installation
This chapter explains how to install and uninstall the adapter. It contains
information about software requirements, installation and verification
procedures.
Topics
• Installation, page 8
• Postinstallation, page 12
• Uninstalling the Adapter, page 14
• Starting and Stopping the Adapter, page 16
Installation
The InstallShield also prompts you for the location of the JDBC driver.
If the JDBC driver path is a file or files with a .zip or .jar extension, instead of a
folder, type the file name after the folder is selected.
TIBCO does not distribute any JDBC drivers and they need to be downloaded
independently from appropriate authorized sources. TIBCO is not responsible for
any damages due to incorrect usage or unauthorized versions.
— Update ENV_NAME. TIBCO Hawk Database Adapter must use the same
ENV_NAME that TIBCO Hawk uses.
— Update features to install. Set the features that you want to install to true.
6. Run the following:
Windows TIBCOUniversalInstaller.cmd -silent -V
responseFile="myfilename.silent"
Postinstallation
It is recommended that you first start with the sample configuration files present
in the database’s samples directory of each database to get familiar with the
features of the adapter. Before starting the adapter, update the attribute values
associated with the TIBHAWK_AMI elements in the sample configuration files.
1. Ensure the following is set correctly in
{HAWK_DBHMA_HOME}/bin/tibhawkdbhma.tra/.
It is also recommended that you read the dbhma.dtd file as it contains important
information on grammar rules and descriptions for adapter configurations.
You must reboot the machine for the Microsoft Windows service configuration
changes to take effect.
The environment variable settings in the sample batch file have to be modified
before it can be used.
The TIBCO Universal Installer is used to uninstall TIBCO products. You can
uninstall in either GUI mode or console mode.
Microsoft Windows
Before starting the adapter for the first time, follow the configuration instructions
in Chapter 3, Getting Started of the TIBCO Hawk™ Database Adapter User’s Guide.
UNIX
This section contains reference information useful for installing Hawk Database
Adapter.
Topics
The following table lists the database types and the corresponding JDBC drivers.
Default User -
Default User -
Default User sa
Default User sa
Index
A Installation Requirements
Disk Space Requirements 4
adapter service, stopping (Windows) 17 Software Requirements 5
Supported Platforms 5
System Memory Requirements 4
Installation Steps 7
C Installation Type
Custom 2
changing the Service Log 12 Profile 2
changing the service log on account on Windows 12 Installer Account 2
Console Mode 2, 10 Installer Log File 3
customer support x installing a custom adapter 13
D S
Disk Space Requirements 4 Silent Mode 2, 10
Software Requirements 5
starting the adapter
UNIX 14
G starting the adapter (UNIX) 17
stopping the adapter on UNIX 17
GUI Mode 2, 8 stopping the adapter service (Windows) 17
support, contacting x
Supported Platforms 5
System Memory Requirements 4
I
Installation Modes
Console Mode 2 T
GUI Mode 2
Silent Mode 2 technical support x
Installation Procedure TIBCO support
Console Mode 10 TIBCOmmunity x
GUI Mode 8 TIBCO_HOME vii
Silent Mode 10