Tibco Hawk Database Adapter: Installation

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 35

TIBCO Hawk® Database Adapter

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.

Copyright © 1999-2019. TIBCO Software Inc. All Rights Reserved.


| iii

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

TIBCO Hawk® Database Adapter Installation


iv
| Contents

Appendix A JDBC Drivers Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19


Database Types and JDBC Drivers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

TIBCO Hawk® Database Adapter Installation


|v

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.

TIBCO Hawk® Database Adapter extends the TIBCO Hawk® monitoring


environments to monitor relational databases.

Topics

• Related Documentation, page vi


• Typographical Conventions, page vii
• TIBCO Product Documentation and Support Services, page x

TIBCO Hawk® Database Adapter Installation


vi
| Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Hawk Database Adapter Documentation


The following documents form the TIBCO Hawk Database Adapter
documentation set:
• TIBCO Hawk Database Adapter Installation: Read this book first. It contains
step-by-step instructions for installing TIBCO Hawk Database Adapter
software on various operating system platforms.
• TIBCO Hawk Database Adapter User’s Guide: Read this manual for instructions
on using the product.
• TIBCO Hawk Database Adapter Release Notes: Read this document for a
summary of features and description of any issues that may affect installing or
using the adapter.

Other TIBCO Product Documentation


You may find it useful to read the documentation for the following TIBCO
products:
• TIBCO Hawk®
— TIBCO Hawk Installation, Configuration, and Administration
— TIBCO Hawk Concepts Guide
— TIBCO Hawk Programmer’s Guide
• TIBCO Rendezvous™
— TIBCO Rendezvous Concepts
— TIBCO Rendezvous Administration
— TIBCO Rendezvous Configuration Tools
• TIBCO Enterprise Message Service™
— TIBCO Enterprise Message Service Installation
— TIBCO Enterprise Message Service User’s Guide

TIBCO Hawk® Database Adapter Installation


Preface vii
|

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General 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.

bold code Bold code font is used in the following ways:


font
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

TIBCO Hawk® Database Adapter Installation


viii
| Typographical Conventions

Table 1 General Typographical Conventions (Cont’d)

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.

Table 2 Syntax Typographical Conventions

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

TIBCO Hawk® Database Adapter Installation


Preface ix
|

Table 2 Syntax Typographical Conventions

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}

TIBCO Hawk® Database Adapter Installation


x
| TIBCO Product Documentation and Support Services

TIBCO Product Documentation and Support Services

For information about this product, you can read the documentation, contact
TIBCO Support, or join TIBCO Community.

How to Access TIBCO Documentation


Documentation for TIBCO products is available on the TIBCO Product
Documentation website mainly in the HTML and PDF formats.
The TIBCO Product Documentation website is updated frequently and is more
current than any other documentation included with the product. To access the
latest documentation, visit https://docs.tibco.com.
Documentation for TIBCO Hawk Database Adapter is available on the TIBCO
Hawk Database Adapter Product Documentation page.

How to Contact TIBCO Support


You can contact TIBCO Support in the following ways:
• For an overview of TIBCO Support, visit
https://www.tibco.com/services/support.
• For accessing the Support Knowledge Base and getting personalized content
about products you are interested in, visit the TIBCO Support portal at
https://support.tibco.com.
• For creating a Support case, you must have a valid maintenance or support
contract with TIBCO. You also need a user name and password to log in to
https://support.tibco.com. If you do not have a user name, you can request
one by clicking Register on the website.

How to Join TIBCO Community


TIBCO Community is the official channel for TIBCO customers, partners, and
employee subject matter experts to share and access their collective experience.
TIBCO Community offers access to Q&A forums, product wikis, and best
practices. It also offers access to extensions, adapters, solution accelerators, and
tools that extend and enable customers to gain full value from TIBCO products. In
addition, users can submit and vote on feature requests from within the TIBCO
Ideas Portal. For a free registration, go to https://community.tibco.com.

TIBCO Hawk® Database Adapter Installation


|1

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, page 2


• Installation Requirements, page 4

TIBCO Hawk® Database Adapter Installation


2
| Chapter 1 Introduction

Installation Overview

This section gives an overview of the installer.

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.

TIBCO Hawk® Database Adapter Installation


Installation Overview 3
|

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.

Installer Log File


The installer log file, tibco_universal_installer.username_install.log, is
written to the .TIBCO/install_timestamp folder of the user’s home directory. To
change the location of the installer log file, specify the option -V
logFile="myLogFile" when you run the installer.

The installer log file captures the following information:


• Installation environment details such as the user that invoked the installer,
host name, Java home in the environment, operating system details, and so on
• List of assemblies installed

TIBCO Hawk® Database Adapter Installation


4
| Chapter 1 Introduction

Installation Requirements

This section describes the disk space requirements, system memory requirements,
software requirements, and supported platforms for this product.

Disk Space Requirements


Before installing this product, extract the contents of the installation archive to a
temporary directory. The installer files consume up to 50 MB of disk space.

Temporary Disk Space Required by the Installer


The installer requires at least 50 MB of free space in the temporary directory. On
Microsoft Windows, the temporary directory typically is:
%SystemDrive%:\Documents and Settings\user_name\Local Settings\Temp.

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

where /new_temp has sufficient free disk space.


The installer calculates the disk space required in the product home location for
the selected components. The calculation is done before the actual installation
(copying of files to the system) begins. The installer proceeds only if sufficient free
disk space is available in the product home location.
However, if disk space is consumed by another process while the installer is
copying the files, and if the required disk space is thereby reduced, the installer
may fail and gives a failure message.
While performing the installation, avoid running other processes that consume
disk space in the product home location.

Disk Space after Installation


This product can consume 10 MB of free space under TIBCO_HOME.

System Memory Requirements


A minimum of 2 GB of physical memory is required.
The following system requirements are recommended. The actual requirements
depend on your application environment.

TIBCO Hawk® Database Adapter Installation


Installation Requirements 5
|

• Memory: 256MB RAM


• Disk Space: 60MB

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.

Table 3 Software Requirements

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.

TIBCO Rendezvous Optional. If you have already installed TIBCO Rendezvous


software on a network-wide basis and you want to use it as a
transport for TIBCO Hawk Database Adapter, you do not need
additional TIBCO Rendezvous licenses unless you are running
TIBCO Rendezvous Routing Daemon (RVRD) processes on a
particular machine.
In that case, you need a valid RVRD license in the tibrv.tkt file
for that machine.

TIBCO Hawk® Database Adapter Installation


6
| Chapter 1 Introduction

Table 3 Software Requirements (Cont’d)

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.

TIBCO Hawk® Database Adapter Installation


Installation 7
|

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

TIBCO Hawk® Database Adapter Installation


8
| Chapter 2 Installation

Installation

The following sections describe the installation process in the available


installation modes:
• Installing in GUI Mode, page 8
• Installing in Console Mode, page 10
• Installing in Silent Mode, page 10

Installing in GUI Mode


To install this product in GUI mode, do the following:
1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Navigate to the temporary directory.
4. Run TIBCOUniversalInstaller. You can do so in one of the following ways:
— Double-click the installer icon.
— On the command prompt, provide the absolute path of the installer file
without specifying any options. The installer defaults to GUI mode.
5. Click the Next button on the Welcome dialog.
6. Read through the license text when the License Agreement dialog appears,
select the I Accept The Terms of The License Agreement radio button and
then click the Next button.
7. Choose an installation environment on the TIBCO Installation Home dialog.
An installation environment isolates product installations. A product installed
into an installation environment does not access components in other

TIBCO Hawk® Database Adapter Installation


Installation 9
|

installation environments. An installation environment consists of a name and


path. You can choose a new environment or an existing environment.
— Create A New TIBCO_HOME To install the product into a new installation
environment, specify the following properties:
Directory The directory into which the product is installed. Type a path,
click Browse to specify the path, or accept the default location.
The path cannot contain special characters such as "*", "#", "?", ">", "<", "%",
"&", "$", "`", or "|". The path cannot be the same as the path of an existing
environment.
The name is appended to the name of Windows services created by the
installer and is a component of the path to the product in the Windows
Start > All Programs menu.
— Use An Existing TIBCO_HOME To install the product into an existing
installation environment, select the environment from the drop-down list.
In this case, select the Use An Existing TIBCO_HOME radio button to install
this product into the TIBCO_HOME directory where TIBCO Hawk is installed.
Click the Next button.
8. By default, TIBCO Universal Installer selects the Typical installation profile.
To customize the profile feature settings, select the Customize Installation
check box and use the feature tree on the right.
Click the Next button.
9. Verify the list of products selected for install in the Pre-Install Summary
dialog.
10. Click the Install button to start the installation process.
11. Review the information listed in the Post-Install Summary dialog.
12. Click the Finish button to complete the installation process and exit the
universal installer.
By default, the adapter is installed in the HAWK_DBHMA_HOME directory on the
adapter machine. If a different version of the adapter exists on this machine,
the installation program displays a prompt. Upon confirmation, the
installation program removes the existing version and installs the current
version. Back up any existing scripts and procedures before installing the
current version.

TIBCO Hawk® Database Adapter Installation


10
| Chapter 2 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.

The adapter runs as a Microsoft Windows service. For instructions on starting


the service, see Changing the Service Log on Account on Microsoft Windows.
13. Restart the computer.

Installing in Console Mode


To install this product in console mode:
1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Using a console window, navigate to the temporary directory.
4. Run the following:
Windows TIBCOUniversalInstaller -console

UNIX TIBCOUniversalInstaller.bin -console

5. Complete the installation by responding to the console window prompts.

Installing in Silent Mode


In silent mode, the universal installer does not prompt for any inputs during
installation. Instead, the inputs are read from a configuration file that can be
provided as a command-line parameter. If no value is specified, the installer uses
the default TIBCOUniversalInstaller_hawkdbhma_<version>.silent file.
The TIBCOUniversalInstaller_hawkdbhma_<version>.silent file is packaged in
the directory that contains the universal installer. Edit the file with information for
your environment before launching the silent installation. The file includes
comments that describe the installation properties you can set. While you can use
the TIBCOUniversalInstaller_hawkdbhma_<version>.silent file, it is a good
practice to copy the file to a different name and use that file for the silent install.
If errors occur during installation, they are listed in the installation log file located
in the USER_HOME/.TIBCO directory.

TIBCO Hawk® Database Adapter Installation


Installation 11
|

To install in silent mode:


1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Using a console window, navigate to the temporary directory.
4. Make a copy of the
TIBCOUniversalInstaller_hawkdbhma_<version>.silent file and rename
the file.
5. Using a text editor, open the copied file. You may need to update the install
location, ENV_NAME, and features to install.
— Update the install location. TIBCO Hawk Database Adapter must be
installed in the same directory where TIBCO Hawk is installed. The default
location is:
<entry key="installationRoot">C:\tibco</entry>

— 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"

UNIX TIBCOUniversalInstaller.bin -silent -V


responseFile="myfilename.silent"

TIBCO Hawk® Database Adapter Installation


12
| Chapter 2 Installation

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/.

— The tibco.env.EMS_HOME and tibco.env.RV_HOME variables are


correctly set. If these TIBCO products are not in the same TIBCO_HOME,
post-install automated step would not have updated the correct installation
folders. You should manually update them.
— The correct JDBC driver path is updated for
tibco.env.HAWK_DBHMA_JDBC_HOME and an appropriate database JDBC
driver library or libraries are present in that folder.
2. Verify that you have selected the correct sample XML configuration for the
chosen Database Adapter and that you have specified the full path in the
value field of -xml_file variable in
{HAWK_DBHMA_HOME}/config/tibhawkdbhma.cfg.

It is also recommended that you read the dbhma.dtd file as it contains important
information on grammar rules and descriptions for adapter configurations.

Changing the Service Log on Account on Microsoft Windows


The adapter is configured to use the built-in system account. To use a different
account, create the account with administrator privileges and configure it to log
on as a service. Then, follow these steps to change the user account:
1. In Control Panel, open Services and click TIBCO Hawk <database> Database
Adapter > Startup.
2. In the Log On As panel, click This Account and type the new user account
and password.
3. Click OK.
4. Click Close to exit the Services dialog, then close the Control Panel.

You must reboot the machine for the Microsoft Windows service configuration
changes to take effect.

TIBCO Hawk® Database Adapter Installation


Postinstallation 13
|

Configuring a New Database


During installation, a default service for the chosen database is installed. This
instance of the adapter uses the default configuration files. However, it is possible
to install an instance of the adapter, which uses a custom configuration file, as a
Windows service. This can be done by using the sample batch files in the
<HAWK_DB_HOME>\examples directory.
For example, <database>_sample1.bat file can be used to start the
<database>_sample1 service.

The environment variable settings in the sample batch file have to be modified
before it can be used.

TIBCO Hawk® Database Adapter Installation


14
| Chapter 2 Installation

Uninstalling the Adapter

The TIBCO Universal Installer is used to uninstall TIBCO products. You can
uninstall in either GUI mode or console mode.

Uninstalling in the GUI Mode


Using the TIBCO Universal Installer, you can uninstall all products in a particular
TIBCO_HOME, or you can uninstall specific products that have been installed in
a TIBCO_HOME.
To uninstall in the GUI mode:
1. Run the universal uninstaller in one of the following ways:
— Navigate to the TIBCO_HOME/tools/universal_installer directory and
run the TIBCOUniversalInstaller program.
— (Windows) From the Start menu, navigate to Start > All Programs >
TIBCO > TIBCO_HOME > Universal Uninstaller.
2. Select the Uninstall Products from a TIBCO Home Location option.
3. In the TIBCO Home Location field, select the TIBCO_HOME in which the
product is installed, then click Next.
4. On the Welcome dialog, click Next.
5. On the Uninstallation Type dialog, do one of the following:
— To uninstall just this add-on (or any specific TIBCO products in this
TIBCO_HOME), click Custom Uninstall. Select the appropriate check
boxes, then click Next.
— To uninstall all TIBCO products that were installed using the universal
installer, click Typical Uninstall > Next. The Pre-Uninstall Summary
screen appears.
6. Review the products to be uninstalled, then click Uninstall.
7. To remove modified files, click Yes to All.
8. On the Post Uninstall Summary dialog, click Finish to exit the uninstall
wizard.
9. If you have uninstalled all the software in TIBCO_HOME, delete the folders in
the installation environment and user home.

TIBCO Hawk® Database Adapter Installation


Uninstalling the Adapter 15
|

Uninstalling in Console Mode


To uninstall in the console mode using the command line:
1. Open a command line and navigate to the directory:
TIBCO_HOME/tools/universal_installer
2. Run the TIBCOUniversalInstaller in console mode using the command:
TIBCOUniversalInstaller -console

3. Respond to the prompts on the command line.


When the uninstallation completes, press Enter to exit the Universal Installer.

TIBCO Hawk® Database Adapter Installation


16
| Chapter 2 Installation

Starting and Stopping the Adapter

Before starting the adapter:


Edit HAWK_DBHMA_HOME/config/tibhawkdbhma.cfg file by uncommenting the
appropriate "-xml_file" entry. This entry contains the name configuration file,
that is in XML format, of the required database type. For example, to use
mysqlDBHma_5.xml, you can uncomment the line
-xml_file
"C:/hkdb_test/hawk/<version>/adapters/db/examples/mysql/mysqlDBHma
_5.xml" by removing the ’#’ at the beginning.
For using multiple versions concurrently:
• It is possible to have more than one instances of TIBCO Hawk Database
Adapter instrumenting and monitoring different database types and versions
running concurrently. To do so, you should:
1. Make a copy of deployment folder structure. Copy TIBCO_HOME/adapter/db
to TIBCO_HOME/adapter/db1.
2. In the new folder structure, edit config/tibhawkdbhma.cfg and ensure
correct -xml_file entry is uncommented for the appropriate database type
and version.
3. Ensure all the .tra files have the correct path of the new folder structure
mentioned.
4. Execute tibhawkdbhma from the bin directory of the new folder created.

Microsoft Windows

Starting the Adapter Service


The adapter runs on Microsoft Windows as a service. During installation, the
service is configured to start manually. To begin using the adapter, start the
service.

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.

To start the service:


1. In Microsoft Windows Control Panel, open Services.
2. Click TIBCO Hawk <database> Database Adapter, then click Start.

TIBCO Hawk® Database Adapter Installation


Starting and Stopping the Adapter 17
|

The adapter service starts.

Stopping the Adapter Service


To stop the service:
1. In Microsoft Windows Control Panel, open Services.
2. Click TIBCO Hawk <database> Database Adapter, then click Stop.
The adapter service stops.
You can also use the default shutdown method to stop the adapter.

UNIX

Starting the Adapter


To start the adapter, execute HAWK_DBHMA_HOME/<version>/bin/tibhawkdbhma.

Stopping the Adapter


An instance of the adapter can be stopped by any one of the following ways:
• Using the default shutdown method from the TIBCO Hawk Display.
• Using the kill <pid> command, where <pid> is the process ID of the adapter
instance.

TIBCO Hawk® Database Adapter Installation


18
| Chapter 2 Installation

TIBCO Hawk® Database Adapter Installation


| 19

Appendix A JDBC Drivers Reference

This section contains reference information useful for installing Hawk Database
Adapter.

Topics

• Database Types and JDBC Drivers, page 20

TIBCO Hawk® Database Adapter Installation


20
| Appendix A JDBC Drivers Reference

Database Types and JDBC Drivers

The following table lists the database types and the corresponding JDBC drivers.

Table 4 Database Types and Corresponding JDBC Drivers

Database Versions Parameter Value

Oracle 11g, 11.1.x Driver oracle.jdbc.driver.OracleDriver

For more information on Oracle JDBC drivers, refer


to:
http://www.oracle.com/technetwork/topics/jdbc-f
aq-090281.html

Standard Driver ojdbc5.jar (JRE 5.x)


Library
ojdbc6.jar (JRE 6.x, 7.x)

Access URL jdbc:oracle:thin:@<HOST>:<PORT>:<SID>

Default User -

Default Port 1521

12c 12.1.x, Driver oracle.jdbc.driver.OracleDriver


12c RAC
12.1.x Standard Driver ojdbc6.jar (JRE 6.x)
Library
ojdbc7.jar (JRE 7.x and 8.x)

Access URL jdbc:oracle:thin:@<HOST>:<PORT>:<SID>

Default User -

Default Port 1521

TIBCO Hawk® Database Adapter Installation


Database Types and JDBC Drivers 21
|

Table 4 Database Types and Corresponding JDBC Drivers

Database Versions Parameter Value

Microsoft 2012 R2, Driver com.microsoft.sqlserver.jdbc.SQLServerDriver


SQL Server
2014,
For more information on Microsoft SQL Server
2016
drivers, refer to:
https://docs.microsoft.com/en-us/sql/connect/jdb
c/system-requirements-for-the-jdbc-driver

Standard Driver sqljdbc41.jar (JRE 1.7)


Library
sqljdbc42.jar (JRE 1.8)

Access URL jdbc: sqlserver://<HOST>:<PORT>

Default User sa

Default Port 1433

SYBASE ASE-15.5.x Driver com.sybase.jdbc4.jdbc.SybDriver


and
ASE-15.7.x Standard Driver jconn4.jar
Library

Access URL jdbc:sybase:Tds:<HOST>:<PORT>?CHARSET=iso_1

Default User sa

Default Port 5000

MySQL 5.6.x and Driver com.mysql.jdbc.Driver


5.7.x
Standard Driver mysql-connector-java-5.1.7-bin.jar
Library

Access URL jdbc:mysql://localhost:3306/information_schema

Default User root

Default Port 3306

TIBCO Hawk® Database Adapter Installation


22
| Appendix A JDBC Drivers Reference

Table 4 Database Types and Corresponding JDBC Drivers

Database Versions Parameter Value

IBM DB2 v10.x+ Driver com.ibm.db2.jcc.DB2Driver

For more information on IBM DB2 drivers, refer to:


https://www.ibm.com/support/knowledgecenter/
en/SSEPGG_10.1.0/com.ibm.db2.luw.apdv.java.doc
/src/tpc/imjcc_cjvintro.html

Standard Driver db2jcc4.jar and


Library
db2jcc_license_cu.jar

Access URL jdbc:db2://localhost:50000/<DB>

Default User db2admin

Default Port 446 or


6789 or
50000

TIBCO Hawk® Database Adapter Installation


Database Types and JDBC Drivers 23
|

Table 4 Database Types and Corresponding JDBC Drivers

Database Versions Parameter Value

IBM DB2 v10.x+ Driver com.ibm.db2.jcc.DB2Driver


(Type 2 Driver with IBM DB2 Client Software)

Standard Driver db2jcc4.jar


Library

Access URL jdbc:db2://localhost:50000/<DB>

Default User db2admin

Default Port 446 or


6789 or
50000

v10.x+ Driver com.ibm.db2.jdbc.net.DB2Driver


(Type 3 Driver with IBM DB2 Client Software)

Standard Driver db2jcc4.jar / db2jcc.jar


Library

Access URL jdbc:db2://localhost:50000/<DB>

Default User db2admin

Default Port 446 or


6789 or
50000

PostgreSQL v9.4+ Driver org.postgresql.Driver

Standard Driver postgresql-42.2.8.jar


Library

Access URL jdbc:postgresql://localhost:5432/

Default User postgres

Default Port 5432

TIBCO Hawk® Database Adapter Installation


24
| Appendix A JDBC Drivers Reference

TIBCO Hawk® Database Adapter Installation


| 25

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

TIBCO Hawk® Database Adapter Installation

You might also like