TIBCO ActiveMatrix Adapter for

Database
Installation
Software Release 6.2
January 2012

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.
This document contains confidential information that 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 Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Adapter SDK, TIBCO Administrator, TIBCO
Database Drivers Supplement, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Rendezvous,
and TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCO Software Inc. in the United States
and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems,
Inc. in the U.S. and other countries.
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.
Copyright 1999-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information

| iii

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
TIBCO ActiveMatrix Adapter for Database Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

xii
xii
xii
xii

Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installation Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installation Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installer Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installer Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
System Memory Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Adapter Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Supported Databases and Drivers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ODBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Pre-installation Worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Adapter Machine Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 2 Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

TIBCO ActiveMatrix Adapter for Database Installation

iv

| Contents
Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 3 Post-installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Post-installation Tasks on Microsoft Windows Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Additional Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Post-installation Tasks on UNIX Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 4 Installation FAQs and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Setting the DISPLAY Variable on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
JRE and JVM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Cannot Install the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

TIBCO ActiveMatrix Adapter for Database Installation

Tables v

Tables

Table 1

General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Table 2

Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Table 3

Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Table 4

TIBCO Adapter Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Table 5

ODBC Driver Supported Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Table 6

Adapter Machine Information Worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Table 7

Database Information Worksheet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

TIBCO ActiveMatrix Adapter for Database Installation

vi

| Tables

TIBCO ActiveMatrix Adapter for Database Installation

| vii

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. Please see the readme file for the availability of this software version on a
specific operating system platform.
TIBCO ActiveMatrix Adapter for Database software is a bidirectional gateway between
databases and applications configured for the TIBCO environment. The adapter supports
publication, subscription, and request-response interactions.

Topics

Changes from the Previous Release of this Guide, page viii

Related Documentation, page ix

Typographical Conventions, page x

Connecting with TIBCO Resources, page xii

TIBCO ActiveMatrix Adapter for Database Installation

viii

| Changes from the Previous Release of this Guide

Changes from the Previous Release of this Guide
This section itemizes the major changes from the previous release of this guide.
TIBCO Universal Installer
TIBCO Universal Installer is used in this release. This document introduces this new
installer.
Support for Teradata Database
This release adds support for Teradata database. See Supported Databases and Drivers on
page 10 and Post-installation Tasks on page 23 for more details about installation.

TIBCO ActiveMatrix Adapter for Database Installation

Preface ix

Related Documentation
This section lists documentation resources you may find useful.

TIBCO ActiveMatrix Adapter for Database Documentation

The following documents form the TIBCO ActiveMatrix Adapter for Database
documentation set:

TIBCO ActiveMatrix Adapter for Database Concepts Read this manual to gain an
understanding of adapters in general that you can apply to the various tasks you may
undertake.

TIBCO ActiveMatrix Adapter for Database Installation Read this manual to learn
how to install TIBCO ActiveMatrix Adapter for Database.

TIBCO ActiveMatrix Adapter for Database Configuration and Deployment This

manual explains how to create and configure adapter projects. Information on
deploying adapter projects is also included.

TIBCO ActiveMatrix Adapter for Database Examples Read this manual to work
through the examples provided with the adapter.

TIBCO ActiveMatrix Adapter for Database Release Notes Read this manual for
additional information about new features, closed and open issues.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO products:

TIBCO Adapter SDK

TIBCO Administrator

TIBCO ActiveMatrix BusinessWorks

TIBCO Database Drivers Supplement

TIBCO Designer

TIBCO Enterprise Message Service

TIBCO Hawk

TIBCO Rendezvous

TIBCO Runtime Agent

TIBCO ActiveMatrix Adapter for Database Installation

| Typographical Conventions
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention

Usetr

TIBCO_HOME

Many TIBCO products must be installed within the same home directory. This
directory is referenced in documentation as TIBCO_HOME. The default value of
TIBCO_HOME depends on the operating system. For example, on Windows systems,
the default value is C:\tibco.

TIB_ADADB_HOME
ENV_NAME
CONFIG_HOME

Other TIBCO products are installed into an installation environment. Products

installed into different installation environments do not share components.
Incompatible products and multiple instances of the same product must be installed
into different installation environments. An installation environment consists of the
following properties:

Name Identifies the installation 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. This directory is
referenced in documentation as ENV_HOME.

Path The directory into which the product is installed. This directory is
referenced in documentation as TIBCO_HOME. TIBCO ActiveMatrix Adapter
for Database installs into a directory within TIBCO_HOME. This directory is
referenced in documentation as TIB_ADADB_HOME. The default value of
TIB_ADADB_HOME depends on the operating system. For example, on Unix
systems, the default value is TIBCO_HOME/adapter/adadb/version.

A TIBCO configuration folder stores configuration data generated by TIBCO

products. Configuration data can include sample scripts, session data, configured
binaries, logs, and so on. This folder is referenced in documentation as
CONFIG_HOME. The default location of the folder is
USER_HOME/ENV_NAME/tibco/cfgmgmt/product_name. For example, on Windows, the
default location is C:\Documents and Settings\user_name\Application
Data\ENV_NAME\tibco\cfgmgmt\product_name.
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.

TIBCO ActiveMatrix Adapter for Database Installation

Preface xi

Table 1 General Typographical Conventions (Contd)

Convention

Usetr

bold code font

Bold code font is used in the following ways:

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]

italic font

Key combinations

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 names separated by a plus sign indicate keys pressed simultaneously. For
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.

TIBCO ActiveMatrix Adapter for Database Installation

xii

| Connecting with TIBCO Resources

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident
experts. It is a place to share and access the collective experience of the TIBCO
community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To
register, go to http://www.tibcommunity.com.

How to Access TIBCO Documentation

You can access TIBCO documentation here:
http://docs.tibco.com

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO
Support as follows:

For an overview of TIBCO Support, and information about getting started with
TIBCO Support, visit this site:
http://www.tibco.com/services/support

If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a username and password. If you do not have a username,
you can request one.

TIBCO ActiveMatrix Adapter for Database Installation

|1
Chapter 1

Introduction

This chapter explains installation modes, requirements, and other options you should be
aware of before starting the installation. Before you install the adapter, read this chapter
and fill out the Pre-installation Worksheets on page 12.

Topics

Installation Overview, page 2

Installation Requirements, page 5

Adapter Components, page 9

Supported Databases and Drivers, page 10

Pre-installation Worksheets, page 12

TIBCO ActiveMatrix Adapter for Database Installation

| 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 that allow 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 or Custom.

The Profile installation type installs all the software for a specific profile.

The Custom installation type allows you to 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. You must 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.
TIBCO ActiveMatrix Adapter for Database Installation

Installation Overview 3

Installing on Microsoft Windows 2003 Terminal Server

There are two modes in Windows Terminal Server: Execute and Install. Users are logged
on by default in Execute mode, which allows them to run applications. To install an
adapter so that everyone can use it, log on as administrator in Install mode. When the
adapter is installed in the Install mode, the installation registry is maintained in
SystemDrive:\WINDOWS\.
Windows Terminal Server must be running in remote admin mode, not application sharing
mode. The adapter is not supported if installed on a machine that is using Windows
Terminal Server in application sharing mode.
The best way to install the adapter on Windows Terminal Server is to use the Add/Remove
Programs control panel applet. This automatically sets your mode to Install during the
installation and then back to Execute afterwards. Alternatively, you can manually change
your mode to Install before starting the installation by typing the following at a command
prompt:
C:\> change user /install

Change back to Execute mode after installation is complete by typing:

C:\> change user /execute

To check your current mode, type the following:

C:\> change user /query

UNIX
Any user can install this product.

Regular (non-root) user

Super-user (root).

While installing this product on UNIX platforms, ensure that the same installer account is
used to install all TIBCO Adapters products.
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 users 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:

TIBCO ActiveMatrix Adapter for Database Installation

| Chapter 1

Introduction

Installation environment details such as user that invoked the installer, host name,
Java home in the environment, operating system details, and so on.

List of assemblies installed.

Information related to the Ant scripts that are executed by the installer.

TIBCO ActiveMatrix Adapter for Database Installation

Installation Requirements 5

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 105 MB of disk space.
Temporary Disk Space Required by the Installer
The installer requires at least 85 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 will proceed 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 will then
give a failure message.
While performing installation, avoid running other processes that consume disk space in
the product home location.
Disk Space After Installation
The free space this product can consume under TIBCO_HOME is 200 MB on Microsoft
Windows platforms and 400 MB on UNIX platforms.

System Memory Requirements

A minimum of 256 MB of physical memory is required.

TIBCO ActiveMatrix Adapter for Database Installation

| Chapter 1

Introduction

Supported Platforms
The following table lists supported platforms.
Table 2 Supported Platforms
System

Platform

Hardware Platform

Microsoft Windows

Microsoft Windows XP Professional

x86

Microsoft Windows Server 2003, 2008, 2008 R2

(32 and 64 bit platforms)

Microsoft Windows Vista

Microsoft Windows 7
UNIX and Linux

Solaris 9

SPARC

Solaris 10

(32 and 64 bit platforms)

Solaris 10

x86
(32 and 64 bit platforms)

HP-UX 11i

PA-RISC
(32 and 64 bit platforms)

HP-UX 11.x Itanium (ia64)

Itanium
(64 bit platforms)

AIX 5.3, 6.1

POWER
(32 and 64 bit platforms)

Red Hat Enterprise Linux 4.x, 5.x, 6.x

x86

SUSE Enterprise Server Linux 10.x, 11.x

(32 and 64 bit platforms)

See the readme file for more details of the supported platforms and versions and required
patches.

Software Requirements
You can install the software on different machines and use them across the network. For
example, you can use TIBCO Designer on one machine to configure a TIBCO
ActiveMatrix Adapter for Database adapter on another machine.
Table 3, Software Requirements lists the required and optional software products. The
software products below are distributed and installed separately from this product. See the
readme file for the supported versions.

TIBCO ActiveMatrix Adapter for Database Installation

Installation Requirements 7

Table 3 Software Requirements

Software

Description

TIBCO Rendezvous

Required. If you are going to use TIBCO Runtime Agent 5.7.1, you need to
install TIBCO Rendezvous 8.3.x separately before installing TIBCO Runtime
Agent.

TIBCO Runtime Agent

Required by the adapter. TIBCO Runtime Agent includes TIBCO Designer

along with a number of TIBCO and third-party libraries used by the adapter
and other TIBCO products. You must install TIBCO Runtime Agent before
you install TIBCO ActiveMatrix Adapter for Database.

TIBCO Administrator

Required for deployment. TIBCO Administrator includes the following

modules:

User Management. Management of authentication, roles and users, that is,

connecting roles (groups) and users to access control lists (ACLs). This
includes security for server-based projects at design time and for deployed
applications at runtime.

Resource Management. Monitoring of machines and of all running

applications in a TIBCO administration domain. Alerts can be created, for
example, to notify an administrator if the number of processes or disk
usage exceeds a certain number.

Application Management. Uploading of Enterprise Archive (EAR) files,

creation, configuration, deployment, and monitoring of applications. This
console is also used to start and stop applications.

TIBCO Administrator is available as a separate installation and can be

installed after installing the adapter.
TIBCO Enterprise Message Service

Required. TIBCO Enterprise Message Service is used as the notification and

messaging backbone for TIBCO ActiveMatrix Adapter for Database. TIBCO
ActiveMatrix Adapter for Database is not necessarily installed on the machine
on which TIBCO Enterprise Message Service is installed.
Note that TIBCO Enterprise Message Service is also used by the TIBCO
ActiveMatrix SOAP and JMS binding types. The TIBCO ActiveMatrix
Adapter for Database license does not cover this usage of the included TIBCO
Enterprise Message Service software. You must separately license TIBCO
Enterprise Message Service or another supported JMS product for this usage
TIBCO Enterprise Message Service is available as a separate installation and
can be installed after the adapter is installed.

TIBCO Database Drivers Supplement

Optional. TIBCO Database Drivers Supplement provides the licensed

DataDirect database JDBC drivers that can be used with TIBCO ActiveMatrix
Adapter for Database.

TIBCO ActiveMatrix Adapter for Database Installation

| Chapter 1

Introduction

Table 3 Software Requirements (Contd)

Software

Description

TIBCO ActiveMatrix BusinessWorks

Optional. TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and

easy-to-use integration platform that allows you to develop integration
projects. TIBCO Adapters are typically part of integration projects created
using TIBCO ActiveMatrix BusinessWorks.
TIBCO ActiveMatrix BusinessWorks is available as a separate installation,
and can be installed after installing the adapter.

TIBCO ActiveMatrix Adapter for Database Installation

Adapter Components 9

Adapter Components
Table 4, TIBCO Adapter Components describes the components of the adapter installation
package.
Table 4 TIBCO Adapter Components
Component

Description

Runtime

This process does the actual work of passing and converting data to and
from the vendor application.

Design time

Adapter-specific GUI that is loaded in TIBCO Designer (see next

section for details) at configuration time.
This component includes the palette and samples that demonstrate how
TIBCO ActiveMatrix Adapter for Database interacts with TIBCO
ActiveMatrix BusinessWorks.

Documentation

This component is required for context sensitive help.

ODBC drivers

TIBCO ActiveMatrix Adapter for Database software packages include

the required ODBC drivers. See ODBC Drivers on page 10.

The adapter installation package does not include JDBC drivers. For more information
about required JDBC drivers, see JDBC Drivers on page 11.

TIBCO ActiveMatrix Adapter for Database Installation

10

| Chapter 1

Introduction

Supported Databases and Drivers

One of the following databases must be installed and configured for your system before
installing TIBCO ActiveMatrix Adapter for Database. You must be able to connect to the
database before starting installation. On Oracle, both the Enterprise Edition and Standard
Edition are supported.
The adapter supports both 32-bit and 64-bit versions, where applicable, for the databases
listed below.
The supported databases can be hosted on any platform supported by the database vendor.

ODBC Drivers
TIBCO ActiveMatrix Adapter for Database uses ODBC to access your database during
runtime. The adapter supports the ODBC driver that is supplied with the adapter
installation package as well as ODBC driver that is provided separately by the database
vendor listed in Table 5, ODBC Driver Supported Platform, on page 10.
Connecting to Remote Databases
TIBCO ActiveMatrix Adapter for Database can remotely connect to databases running on
other machines or different platforms, including a DB2 database running on z/OS or
iSeries systems. See Connect to a DB2 z/OS Database on page 28 for details.
TIBCO ActiveMatrix Adapter for Database cannot be installed on an z/OS or iSeries
system.
ODBC Driver Documentation
The DataDirect documentation is available in the TIB_ADADB_HOME/odbc/help directory.
The following table shows the compatibility of the databases and the adapter supported
operating systems. Yes indicates that the adapter is supported on the operation system with
the databases listed. No indicates that the adapter is not supported on the operation system
with the databases listed.
Table 5 ODBC Driver Supported Platform
Adapter Supported Operating Systems
Database

Windows
x861

Solaris
SPARC

Solaris
x86

AIX
Power

Linux
x86

SUSE
x86

HP
PA-RISC

HPUX
IA

Oracle

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

TIBCO ActiveMatrix Adapter for Database Installation

Supported Databases and Drivers 11

Table 5 ODBC Driver Supported Platform

Adapter Supported Operating Systems
Database

Windows
x861

Solaris
SPARC

Solaris
x86

AIX
Power

Linux
x86

SUSE
x86

HP
PA-RISC

HPUX
IA

SQL Server

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Sybase ASE

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Sybase Anywhere

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

DB2 UDB

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

DB2 for z/OS2

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

DB2 for iSeries2

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

MySQL3

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Teradata4

Yes

Yes

Yes

Yes

Yes

No

Yes

Yes

1. Both vendor drivers included with the server installation and DataDirect drivers are supported.
2. Via remote connection only.
3. Only vendor drivers included with the server installation are supported.
4. Only vendor drivers are supported.

JDBC Drivers
TIBCO ActiveMatrix Adapter for Database uses JDBC to access your database during
design time. The adapter design-time palette supports the JDBC drivers included in
TIBCO Database Drivers Supplement, as well as the JDBC drivers that are provided
separately by the database vendors. When configuring the adapter, you specify the JDBC
URL and the correct driver is automatically loaded.
The JDBC URLs are documented in the TIBCO ActiveMatrix Adapter for Database
Configuration and Deployment.

TIBCO ActiveMatrix Adapter for Database Installation

12

| Chapter 1

Introduction

Pre-installation Worksheets
The most time-consuming part of an adapter installation is the collection of environment
information and parameters. This section helps you complete this process. Use these
forms to gather information from the various system administrators and other sources
within your organization before installing the adapter.

Adapter Machine Information, page 12

Database Information, page 13

Adapter Machine Information

The information below is required during installation of TIBCO ActiveMatrix Adapter for
Database.
If you are connecting to a DB2 for z/OS database, you will need additional information, as
described for Windows in Post-installation Tasks on Microsoft Windows Platform on
page 22, or for UNIX in Post-installation Tasks on UNIX Platform on page 37.
Table 6 Adapter Machine Information Worksheet
Adapter
Information

Description

Hostname

Name of the machine on which the adapter is being installed.

(Example: adapter1.tibco.com)

IP address

IP address of the machine on which the adapter is being

installed.

TIBCO home
directory path

This is the directory where TIBCO Runtime Agent was

installed. TIBCO Runtime Agent must be installed on each
machine where the adapter will be installed.
(By default, this is C:\tibco on Microsoft Windows)

Installer user
account

Account to log on to the machine with and run the installer. This
user must have write permission to the TIBCO home directory.
(Example: administrator)

Installer user
password

Password for the installer user account above.

Installer user
domain (Windows
only)

Network domain to which the user account above belongs.

(Example: ENGR2)

TIBCO ActiveMatrix Adapter for Database Installation

Value for Your Machine

Pre-installation Worksheets 13

Table 6 Adapter Machine Information Worksheet (Contd)

Adapter
Information

Description

Value for Your Machine

Adapter installation
package

Obtain the correct TIBCO ActiveMatrix Adapter for Database

installation package. This is available on CD, FTP, network
drive, or http://download.tibco.com as appropriate.

ODBC driver
version

The correct ODBC driver version for your database, see

Supported Databases and Drivers on page 10.

ODBC driver
directory path

The full path of the ODBC driver directory. Drivers are installed
with the adapter or can also be third-party, see Supported
Databases and Drivers on page 10.
(By default, TIB_ADADB_HOME\odbc\Drivers)

Database Information
Most supported databases require you to enter these parameters to configure the adapter.
The specific parameter names and the type of information required depends on the
database and driver you are using. Check with your database administrator to determine
exactly what information will be needed for your system.
If you are connecting to a DB2 for z/OS database, you will need additional information, as
described for Microsoft Windows in Post-installation Tasks on Microsoft Windows
Platform on page 22, or for UNIX in Post-installation Tasks on UNIX Platform on
page 37.
Table 7 Database Information Worksheet
Database
Information

Description

Data Source Name and

description

A name and description you create that identifies this

database configuration in the system.

Value for Your Database

(Example: Accounting)
Port Number

The port number of the database listener.

SID

The System Identifier that refers to the instance of the

database running on the server.
(Example: ORCL)

TIBCO ActiveMatrix Adapter for Database Installation

14

| Chapter 1

Introduction

Table 7 Database Information Worksheet (Contd)

Database
Information
Server (or Host)

Description
The name, IP address, client connection string, or other
identifier of the database server and database to which the
adapter will connect.
(Example: Oracleserver or 199.226.224.34)

Database administrator
account

Account that has database administration privileges and

can create users.

Database administrator
password

Password for the database administrator account.

Service name

Name of the service to use when executing commands as

the database administrator.
(Example: adbsol27)

Database access
account

New account created by the database administrator during

configuration. The adapter uses this account to connect to
the database.
(Example: jsmith)

Database access
account password

Password for the database access account above.

TIBCO ActiveMatrix Adapter for Database Installation

Value for Your Database

| 15
Chapter 2

Installation Steps

This chapter explains how to install and uninstall this product.

Topics

Installation, page 16

Uninstallation, page 19

TIBCO ActiveMatrix Adapter for Database Installation

16

| Chapter 2

Installation Steps

Installation
The following sections describe the installation process in the available installation
modes:

GUI Mode, page 16

Console Mode, page 17

Silent Mode, page 18

GUI Mode
To install this product in GUI mode,
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 on 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. Select the Typical installation profile from the list on the left to install the following
features:
Runtime Includes the runtime tools for TIBCO ActiveMatrix Adapter for
Database.
Design Includes the palette and samples for TIBCO ActiveMatrix Adapter for
Database.
Documentation Includes the TIBCO ActiveMatrix Adapter for Database
documentation. The documentation is installed in the TIB_ADADB_HOME/doc
directory.
To customize the profile feature settings, check the Customize Installation checkbox
and use the feature tree on the right.
8. Click the Next button. The TIBCO Installation Home dialog displays.

TIBCO ActiveMatrix Adapter for Database Installation

Installation 17

An installation environment isolates product installations. A product installed into an

installation environment does not access components in other 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 or 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.
Name Identifies the installation environment. The name cannot contain special
characters such as "*", "?", ">", "<", ":", "|", "/", "\", or quotation marks(").

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 Use An Existing TIBCO_HOME radio button to install this product
into the TIBCO_HOME directory where TIBCO Rendezvous and TIBCO Runtime
Agent are installed.
9. Click the Next button.
10. Verify the list of products selected for install in the Pre-Install Summary dialog.
11. Click the Install button to start the installation process.
12. Review the information listed in the Post-Install Summary dialog.
13. Click the Finish button to complete the installation process and exit the universal
installer.

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 TIBCOUniversalInstaller -console.
5. Complete the installation by responding to the console window prompts.

TIBCO ActiveMatrix Adapter for Database Installation

18

| Chapter 2

Installation Steps

Silent Mode
In silent mode, the universal installer does not prompt for any inputs during installation.
Instead, the inputs are read from a response file that can be provided as a command-line
parameter. If no value is specified, the installer uses the default TIBCOUniversalInstaller.silent
file.
The TIBCOUniversalInstaller.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.silent file, its good practice to copy the file
to a different name and use that file for the silent install.
If errors occur during installation, they will be listed in the installation log file located in
the User_Home/.TIBCO directory.
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.silent file and rename the file.
5. Using a text editor, open the copied file and update the install location, ENV_NAME,
and features to install as follows:
Update the install location. TIBCO ActiveMatrix Adapter for Database must be
installed in the same directory where TIBCO Adapters is installed. For example,
update the directory as follows:
<entry key="installationRoot">C:\tibco</entry>

Update ENV_NAME. TIBCO ActiveMatrix Adapter for Database must use the same
ENV_NAME that TIBCO Adapters uses.
For example, update ENV_NAME as follows:
<entry key="createNewEnvironment">false</entry>
<entry key="environmentName">TIBCO_HOME</entry>

Update features to install. Set the features that you want to install to true as follows:
<entry key="feature_Adapter_adadb">true</entry>
<entry key="feature_Palette_adadb">true</entry>
<entry key="feature_Samples_adadb">true</entry>
<entry key="feature_ADB Documentation_adadb">true</entry>

6. Run the following:

Windows TIBCOUniversalInstaller.cmd -silent -V responseFile="myfilename.silent"
UNIX TIBCOUniversalInstaller.bin -silent -V responseFile="myfilename.silent"

TIBCO ActiveMatrix Adapter for Database Installation

Uninstallation 19

Uninstallation
This section describes how to uninstall this product in the GUI mode and the Console
mode.
GUI Mode
To uninstall this product:
1. Shut down all running TIBCO Adapters applications.
2. Navigate to TIBCO_HOME/tools/universal_installer and run TIBCOUniversalInstaller.
3. In the TIBCO Installation Manager page, perform the following steps:
Select the Uninstall Products From Selected TIBCO Home Location radio
button.
Select the TIBCO_HOME location from the TIBCO Home Location drop-down list.
4. The Welcome dialog appears. Click the Next button.
5. Choose an uninstallation option. The wizard provides two uninstallation options:
Custom Uninstall You can select the products to be removed.
Typical Uninstall The universal uninstaller removes all the products in this
TIBCO_HOME.
6. Click the Next button. Select the TIBCO ActiveMatrix Adapter for Database
checkbox, and click the Next button.
7. Review the Pre-Uninstall Summary and click the Uninstall button to start the
uninstallation process.
8. Review the Post-Uninstall Summary and click the Finish button to exit the uninstall
wizard.
Console Mode
To uninstall this product in Console mode, complete the following steps:
1. Using a command window, navigate to the TIBCO_HOME\tools\universal_installer directory.
2. Type the following command at the command prompt:
TIBCOUniversalInstaller.exe -console

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

TIBCO ActiveMatrix Adapter for Database Installation

20

| Chapter 2

Installation Steps

TIBCO ActiveMatrix Adapter for Database Installation

| 21
Chapter 3

Post-installation Tasks

This chapter explains the tasks to perform after installation.

Topics

Post-installation Tasks on Microsoft Windows Platform, page 22

Post-installation Tasks on UNIX Platform, page 37

TIBCO ActiveMatrix Adapter for Database Installation

22

| Chapter 3

Post-installation Tasks

Post-installation Tasks on Microsoft Windows Platform

Complete the following tasks to finish the installation process:

Task A, Configure the Database Account Used by the Adapter, page 22

Task B, Configure the Adapter in TIBCO Designer, page 23

Task C, Optionally Install Custom ODBC Drivers and Add to PATH, page 23

Task D, Configure the ODBC System Data Source, page 24

Task E, Install Additional TIBCO Software, page 35

Additional Tasks, page 35

Task A Configure the Database Account Used by the Adapter

SQL scripts are provided to set up the database account used by the adapter. The
TIB_ADADB_HOME\config directory contains subdirectories for supported databases. Each
subdirectory contains one or more scripts that are specific to that database vendor.
The create_user script creates a database user account with the necessary privileges required
for the adapter. If you are using Oracle and will be using the alerter, this user also needs
the privilege to access the alerter package.
1. Open a command window and change directory to your database directory. For
example, for Oracle:
cd TIB_ADADB_HOME\config\oracle

2. Using a text editor, change the create_user script to identify the account name and
password for the database user who will run the adapter. If you are using Oracle and
will be using the alerter, also provide the account name to use. For example, for
Oracle:
CREATE USER karlh IDENTIFIED BY adbuser;
GRANT CONNECT, RESOURCE TO karlh IDENTIFIED BY adbuser;
-- For Alerter use only
GRANT EXECUTE on DBMS_AQ to karlh;
GRANT EXECUTE on DBMS_AQADM to karlh;

This account is used to connect to the database and access tables created when
configuring an adapter. Note that a publication source table or subscription destination
table can belong to a different schema than the default specified in the create_user script.
For more information, see the TIBCO ActiveMatrix Adapter for Database
Configuration and Deployment.
3. Execute the create_user script as the database administrator. For example, for Oracle:
TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 23

sqlplus dba_user_id/dba_password@service @create_user.sql

4. If you are using Oracle and will be using the alerter, also execute the alerter.sql script.
This script sets up the tables used by the alerter. Use the database user account created
in step 2. For example:
sqlplus dba_user_id/dba_password@service @alerter.sql

Task B Configure the Adapter in TIBCO Designer

The step applies to MySQL and Teradata database only.

When configuring the adapter instance in TIBCO Designer, you need to add the JDBC
driver path to the variable tibco.env.CUSTOM_CP_EXT in the designer.tra file:
tibco.env.CUSTOM_CP_EXT jdbc_driver_path;other_library_file_path

For example:
For MySQL database:
tibco.env.CUSTOM_CP_EXT driver_install_path/mysql-connector-java-5.1.7-bin.jar

For Teradata database:

tibco.env.CUSTOM_CP_EXT driver_install_path/terajdbc4.jar

Also, you can put the driver file into ADB adapter installation library directory:
TIB_ADADB_HOME/lib

Task C Optionally Install Custom ODBC Drivers and Add to PATH

Perform the following procedure, only if you are using database drivers supplied by your
database vendor, instead of the database drivers provided by TIBCO.
If you are using Oracle with a non-wire protocol driver, you must provide the
ORACLE_HOME\bin location to the tibco.env.CUSTOM_PATH property in the adapter TRA
properties file: TIB_ADADB_HOME\bin\adbagent.tra.
If you are using Teradata, you must specify the shared ICU library path and Teradata client
utility (CLI) path in the adapter TRA properties file: TIB_ADADB_HOME\bin\adbagent.tra.
tibco.env.CUSTOM_PATH
TERADATA_HOME/Client/version/CLIv2;TERADATA_HOME/Client/version/Shared ICU Libraries for
Teradata/lib

1. Install the ODBC drivers according to the instructions provided by your database
vendor.
2. Add the location of your drivers to the PATH system variable according to the
instructions provided by your database vendor.
TIBCO ActiveMatrix Adapter for Database Installation

24

| Chapter 3

Post-installation Tasks

3. Continue with Task D, Configure the ODBC System Data Source.

Task D Configure the ODBC System Data Source
If you are using a DB2 z/OS database, proceed to Connect to a DB2 z/OS Database on
page 28. If you are using a Teradata database, proceed to Connect to a Teradata Database
on page 32. This task applies to all other databases.
You must define a System DSN, not a User DSN. If you define a User DSN, the adapter
will not be visible in the TIBCO Administrator GUI.
If your Microsoft Windows platform is a 64 bit one, you have to open the 32 bit ODBC
Administrator located at C:\WINDOWS\sysWOW64\odbcad32.exe to view and configure the 32 bit
ODBC driver data sources.
1. Navigate to the Control Panel window, then locate and double-click the Data Sources
(ODBC) icon.
2. Click the System DSN tab, then click the Add... button.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 25

3. Select an ODBC driver and click the Finish button.

TIBCO ActiveMatrix Adapter for Database Installation

26

| Chapter 3

Post-installation Tasks

4. In the ODBC Driver Setup dialog, click the General tab and type appropriate values
in the fields. Click the Help button for an explanation of each field.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 27

5. Click the Advanced tab, select the Procedure Returns Results checkbox. This is
necessary for the ODBC driver to return retrieved data from stored procedures for
Request-Reply operations.
Also, the Enable Timestamp with Timezone checkbox should be selected. For more
information, see TIBCO Activematrix Adapter for Database Configuration and
Deployment.
Fill in the other fields as required for your configuration, or accept the defaults.

TIBCO ActiveMatrix Adapter for Database Installation

28

| Chapter 3

Post-installation Tasks

6. Click the Apply button, then click the Test Connect button to test the connection.

7. In the ODBC Driver Setup dialog, click the OK button to save the object, then click
the OK button to exit.
Connect to a DB2 z/OS Database
The adapter can connect to a DB2 database running on z/OS. (The Adapter itself cannot
run on z/OS.)
In order to do so, you need to create ODBC and JDBC packages on the machine where
DB2 z/OS is running. Once the packages are created, they can be used by PUBLIC. The
packages can be used as long as you are using the TIBCO 5.00 DB2 Wire Protocol driver.
If you upgrade to a newer driver, you will need to repeat these procedures with the new
driver.
For this procedure, the z/OS system logon and password must have DB2 BIND authority.

For more information, see the section Configuring and Connecting to Data Sources in
Chapter 5, The DB2 Wire Protocol Driver in the Progress DataDirect Connect Series for
ODBC Users Guide, available in TIB_ADADB_HOME\odbc\help.
To create the ODBC packages on the machine where DB2 z/OS database is running:
1. On the machine where TIBCO ActiveMatrix Adapter for Database is installed,
navigate to the Control Panel, then locate and double-click the Data Sources
(ODBC) icon.
2. Click the System DSN tab, then click the Add... button.
TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 29

3. At the Create New Data Source dialog, select TIBCO 6.10 DB2 Wire Protocol and
click the Finish button.

TIBCO ActiveMatrix Adapter for Database Installation

30

| Chapter 3

Post-installation Tasks

4. Fill in the fields on the ODBC DB2 Wire Protocol Driver Setup dialog according to
the configuration of the machine where DB2 for z/OS is running. The dialog below
shows sample data. Click the Help button for the field descriptions.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 31

5. Click the Modify Bindings tab. Fill in the fields according to the configuration of the
machine where DB2 for z/OS is running. The dialog below shows sample data. Click
the Help button for field descriptions.

6. Click the Modify Bindings button to generate the ODBC packages on the machine
where DB2 for z/OS is running. You will need your z/OS system logon and password.
A status message displays when the packages are created.
To verify the packages, submit a SQL statement to execute in DB2 for z/OS using, for
example, SPUFI from TSO/ISPF or DB2 Command Center from NT. The following
statement uses the values shown in step 4 above; use values that are appropriate to your
configuration.
TIBCO ActiveMatrix Adapter for Database Installation

32

| Chapter 3

Post-installation Tasks

SELECT * FROM SYSIBM.SYSPACKAGE where name like DEF00% and COLLI = DATADIRECT00

If output similar to the following appears, the packages have been successfully created.
LOCATION
COLLID
NAME
CONTOKEN
---------+---------+---------+---------+---------+------DATADIRECT00
DEF00A .
DATADIRECT00
DEF00B .
DATADIRECT00
DEF00C .

To create the JDBC packages on the machine where DB2 for z/OS is running:
1. On the machine where TIBCO ActiveMatrix Adapter for Database is installed, start
TIBCO Designer and display the Connection tab for the adapter.
2. Enter the following JDBC driver and URL information:
JDBC Driver
JDBC URL

tibcosoftwareinc.jdbc.db2.DB2Driver

jdbc:tibcosoftwareinc:db2://server_name:port;

locationName=DB2_location_name;collectionName=DATADIRECT00;packageName=DEF00;createD
efaultPackage=true;embedded=true

3. Click Test Connection to generate the JDBC packages on the machine where DB2 for
z/OS is running. You will need your z/OS system logon and password.
When the packages are created, a Successful Connection message displays and three
packages are cataloged in DB2 for z/OS.
To verify the packages, submit a SQL statement to execute in DB2 for z/OS using, for
example, SPUFI from TSO/ISPF or DB2 Command Center from NT. The following
statement uses the values shown in step 2 above; use values that are appropriate to your
configuration.
SELECT * FROM SYSIBM.SYSPACKAGE where name like 'DEF00%' and COLLID =
'DATADIRECT00'

If output similar to the following appears, the packages have been successfully created.
LOCATION
COLLID
NAME
CONTOKEN
---------+---------+---------+---------+---------+------DATADIRECT00
DEF00A ..
DATADIRECT00
DEF00B ..
DATADIRECT00
DEF00C ..

Connect to a Teradata Database

1. Navigate to the Control Panel window, then locate and double-click the Data Sources
(ODBC) icon.
2. Click the System DSN tab, then click the Add... button.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 33

3. At the Create New Data Source dialog, select the Teradata item from the Name
column, and click the Finish button.

TIBCO ActiveMatrix Adapter for Database Installation

34

| Chapter 3

Post-installation Tasks

4. Fill in the fields on the ODBC Driver Setup For Teradata Database dialog according to
the configuration of the machine where Teradata database is running. You need to fill
the database name in the Default Database field. The dialog below shows sample data.
Click the Help button for the field descriptions.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on Microsoft Windows Platform 35

5. Click the Options >> button. On the Teradata ODBC Driver Options dialog, complete
the following:
a. Select the Run In Quiet Mode checkbox. This option controls whether message
boxes are displayed.
b. Select the Disable CALL To EXEC Conversion checkbox. This option
implements the CALL statement with an escape clause: CALL name (...).
c. Click the OK button.

6. Click the OK button to save the object, then click the OK button to exit.
Task E Install Additional TIBCO Software
If you will be using any of the following TIBCO products, install them now. These
products are not provided with TIBCO ActiveMatrix Adapter for Database.

TIBCO Administrator

TIBCO ActiveMatrix BusinessWorks

Additional Tasks
If using the SSL feature for ODBC drivers, the path to the driver libraries should be added
to the environment variable PATH.

TIBCO ActiveMatrix Adapter for Database Installation

36

| Chapter 3

Post-installation Tasks

For example, set PATH=TIB_ADADB_HOME\odbc\Drivers;%PATH%

TIBCO ActiveMatrix Adapter for Database is now installed. See the TIBCO Activematrix
Adapter for Database Configuration and Deployment for additional configuration tasks
and instructions for performing various procedures, including tutorials.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on UNIX Platform 37

Post-installation Tasks on UNIX Platform

After installation, perform the following tasks.

Task A, Set Environment Variables, page 37

Task B, Set Directory Permissions, page 37

Task C, Configure the Adapter in TIBCO Designer, page 38

Task D, Configure the ODBC System Data Source, page 38

Task E, Install Custom ODBC Drivers (Optional), page 39

Task F, Install Additional TIBCO Software, page 43

Task A Set Environment Variables

Certain changes to the environment variable settings are required before running TIBCO
ActiveMatrix Adapter for Database. Execute the appropriate file to automatically make
these changes.
When using the

Oracle non-wire protocol driver, ODBC_HOME/lib must always appear in

before any database vendor's lib directory, such as ORACLE_HOME/lib.

LD_LIBRARY_PATH

For csh, execute TIB_ADADB_HOME/bin/adbagent_env.csh, as shown:

% source adbagent_env.csh

For sh and ksh, execute TIB_ADADB_HOME/bin/adbagent_env.sh, as shown:

$ . adbagent_env.sh

The file modifies the following environment variables on UNIX platforms:

SHLIB_PATH

(on HP-UX only)

LD_LIBRARY_PATH

LIBPATH

(on Solaris, Red Hat Linux, SUSE Linux)

(on AIX only)

Task B Set Directory Permissions

Depending on whether a repository server is used, and whether TIBCO Administrator is
used to set access permissions, users may need a TIBCO Administrator account. See your
TIBCO Administrator guide for details.
Make sure that all adapter users have read and write permissions for the odbc.ini file. This
file is located in TIB_ADADB_HOME/odbc.

TIBCO ActiveMatrix Adapter for Database Installation

38

| Chapter 3

Post-installation Tasks

Make sure that all adapter users have read, write, and execute permissions for the
following directories where the adapter files and configuration information is stored:
TIB_ADADB_HOME/bin
TIB_ADADB_HOME/logs
TIB_ADADB_HOME/ledger
TIB_ADADB_HOME/sql
TIBCO_HOME/tra/TRA_version/logs
TIBCO_HOME/logs

For example, if you installed the adapter in /opt/tibco, you can make these directories
writable for all other users by executing the following commands:
% chmod a+w /opt/tibco/adapter/adadb/version/bin
% chmod a+w /opt/tibco/adapter/adadb/version/logs
% chmod a+w /opt/tibco/adapter/adadb/version/ledger
% chmod a+w /opt/tibco/adapter/adadb/version/sql
% chmod a+w /opt/tibco/tra/TRA_version/logs

Task C Configure the Adapter in TIBCO Designer

The step applies to MySQL and Teradata database only.

When configuring the adapter instance in TIBCO Designer, you need to add the JDBC
driver path to the variable tibco.env.CUSTOM_CP_EXT in the designer.tra file:
tibco.env.CUSTOM_CP_EXT jdbc_driver_path;other_library_files_path

For example:
For MySQL database:
tibco.env.CUSTOM_CP_EXT MySQL_driver_path/mysql-connector-java-5.1.7-bin.jar

For Teradata database:

tibco.env.CUSTOM_CP_EXT Teradata_driver_path/terajdbc4.jar

Also, you can put the driver file into the ADB adapter installation library directory:
TIB_ADADB_HOME/lib

Task D Configure the ODBC System Data Source

Note that this step applies to DataDirect database drivers only.

The data source on UNIX systems is configured using the odbc.ini file. This file is located in
TIB_ADADB_HOME/odbc.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on UNIX Platform 39

See the ODBC driver documentation for information on configuring your system data
sources.
For Oracle, the EnableTimestampWithTimeZone parameter in the odbc.ini file should be set
to 1. For more information, see TIBCO ActiveMatrix Adapter for Database Configuration
and Deployment.
The adapter can connect to a DB2 database running on z/OS. (TIBCO ActiveMatrix
Adapter for Database itself cannot run on z/OS.)
In order to connect to the database, you need to create ODBC and JDBC packages on the
machine where DB2 for z/OS is running. Once the packages are created, they can be used
by PUBLIC. The packages can be used as long as you are using the TIBCO 5.30 DB2
Wire Protocol driver. If you upgrade to a newer driver, you will need to repeat these
procedures with the new driver.
To connect to a DB2 for z/OS database, follow the instructions in the section Configuring
and Connecting to Data Sources in Chapter 5, The DB2 Wire Protocol Driver in Progress
DataDirect Connect Series for ODBC Users Guide, available at
TIB_ADADB_HOME/doc/help.
For this procedure, the z/OS system logon and password must have DB2 BIND authority.

Task E Install Custom ODBC Drivers (Optional)

Note that this step applies to vendor ODBC driver on UNIX only.
The current version of the adapter only supports MySQL and Teradata ODBC drivers.
If you are using a MySQL database, proceed to Connect to a MySQL Database on
page 39. If you are using a Teradata database, proceed to Connect to a Teradata Database
on page 42.
Connect to a MySQL Database
To set up the vendor ODBC driver, follow these steps:

TIBCO ActiveMatrix Adapter for Database Installation

40

| Chapter 3

Post-installation Tasks

1. Install unixODBC
a. Download unixODBC source code from http://www.unixodbc.org.
b. Compile and generate unixODBC libraries and programs as follows:
Unzip the source code tar.gz file to a folder, for example:
/home/adb/odbc/installation/unixODBC-2.2.14

Enter into the folder and run the ./Configure command. By default the files are
installed into the /usr/local directory. As is usual with configure, this location can be
changed by altering the prefix option to configure.
./configure --prefix=/home/adb/unixODBC --enable-gui=no

Run the make command

Run the make install command
The /home/adb/unixODBC folder is generated, and referenced as unixODBC_HOME in
the following section. In this folder, there are lib, bin, include, and etc folders.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on UNIX Platform 41

2. Install the MySQL ODBC driver. The following are sample steps for installing the
ODBC driver from MySQL on UNIX.
a. Download MySQL ODBC driver from http://www.mysql.com.
b. Unzip the tar.gz file into a folder, for example:
/home/adb/odbc/installation/mysql/mysql-connector-odbc-5.1.5-linux-x86-32bit

c. Enter the lib directory of this folder, you will find the MySQL ODBC driver
library, libmyodbc5.so, and the MySQL ODBC setup library for ODBCConfig GUI
tool of unixODBC, libmyodbc3S.so.
Use odbcinst tool of unixODBC to register the MySQL ODBC driver.
Go to the $unixODBC_HOME/bin directory, and you will find the odbcinst command
there.
Create an odbcinst_mysql.ini template file for MySQL ODBC driver. For example:
[MySQL ODBC 5.1 Driver]
Description = MySQL 5.1 Driver for Linux
Driver = /home/adb/odbc/installation/mysql/mysql-connector-odbc-5.1.5-linux-x86-32bit/lib/libmyodbc5.so
SETUP =
/home/adb/odbc/installation/mysql/mysql-connector-odbc-5.1.5-linux-x86-32bit/lib/libmyodbc3S.so

Run the following command:

./odbcinst -i -d -f <Path of odbcinst_mysql.ini>

The args to odbcinst are as follows:

-i install
-d driver
-f name of template file
d. Use odbcinst tool of unixODBC to add a DSN for MySQL.
Create an odbc_mysql.ini template file for MySQL ODBC driver. For example:
[MySQL-test]
Description = MySQL test database
Driver = MySQL ODBC 5.1 Driver
SERVER = localhost
USER = ODBC
PASSWORD =
PORT = 3306
DATABASE = test
option = 0
initstmt =
socket =
sslca =

TIBCO ActiveMatrix Adapter for Database Installation

42

| Chapter 3

Post-installation Tasks

sslcapath =
sslcert =
sslcipher =
sslkey =
charset =
sslverify =
readtimeout =
writetimeout =

Run the following command:

/odbcinst -i -s -h -f path_of_odbc_mysql.ini

The args to odbcinst are as follows:

-i install
-s

data source

-h

user dsn

-f

name of template file

3. Test the DSN connection

There are many ways to test the DSN connection. Here list two ways: Use
DataManager GUI tool provided by unixODBC.
Use isql command tool provided by unixODBC:
./isql dsn user password

Both of them are in the $unixODBC_HOME/bin directory.

4. Set up the environment for the adapter.
After finish Task A, Set Environment Variables, on page 37, run the following
commands:
export LD_LIBRARY_PATH=unixODBC_HOME/lib:$LD_LIBRARY_PATH
export ODBCINI=path_of_odbc_mysql.ini

Make the following changes in the adapter TRA properties file:

TIB_ADADB_HOME/bin/adbagent.tra
tibco.env.ODBCINI /home/adb/unixODBC/dsn_template/MySQL_dsn_template.ini
tibco.env.CUSTOM_LIB_PATH unixODBC_HOME/lib%PSP%%TIB_ADADB_HOME%/odbc/lib

Connect to a Teradata Database

To set up the vendor ODBC driver, follow these steps:
1. Download the Teradata ODBC driver from http://www.teradata.com.
2. Install the Teradata ODBC driver.

TIBCO ActiveMatrix Adapter for Database Installation

Post-installation Tasks on UNIX Platform 43

3. Set up the environment for the adapter.

After completing Task A, Set Environment Variables, on page 37, run the following
commands:
export
LD_LIBRARY_PATH=TERADATA_HOME/teradata_version/client/odbc_32/lib:$LD_LIBRARY_PAT
H
export ODBCINI=path_of_odbc_tera.ini

Make the following changes in adapter TRA properties file:

TIB_ADADB_HOME/bin/adbagent.tra
tibco.env.ODBCINI path_of_odbc_tera.ini
tibco.env.CUSTOM_LIB_PATH
TERADATA_HOME/teradata_version/client/odbc_32/lib:path_of_other

library files

On HP-UX IA platform, the adapter uses 64 bit driver, so for all the ODBC driver paths,
you must point to the odbc_64 directory instead of odbc_32.
Task F Install Additional TIBCO Software
If you will be using any of the following TIBCO products, install them now. These
products are not provided with TIBCO ActiveMatrix Adapter for Database.

TIBCO Administrator

TIBCO ActiveMatrix BusinessWorks

TIBCO ActiveMatrix Adapter for Database Installation

44

| Chapter 3

Post-installation Tasks

TIBCO ActiveMatrix Adapter for Database Installation

| 45
Chapter 4

Installation FAQs and Troubleshooting

This section lists some common installation errors along with their causes and solutions.

Topics

Setting the DISPLAY Variable on UNIX, page 46

JRE and JVM, page 47

Cannot Install the Adapter, page 48

TIBCO ActiveMatrix Adapter for Database Installation

46

| Chapter 4

Installation FAQs and Troubleshooting

Setting the DISPLAY Variable on UNIX

The installer on UNIX usually opens an additional window for graphics when operating in
GUI mode. The DISPLAY environment variable tells the installer on which computer to
open the window. If this variable is not set, the installer will either wait or abort after
displaying the following output:
InstallShield Wizard
Initializing InstallShield Wizard...
Preparing Java(tm) Virtual Machine...
...................................
...................................
........

You set the DISPLAY variable to the IP address or name of the computer on which the
installer graphics window are to be displayed, followed by a screen address, which can be
:0.0. For example:
# Bourne shell
DISPLAY=ip_address:0.0; export DISPLAY
# Korn shell
export DISPLAY=ip_address:0.0
# C-shell
setenv DISPLAY ip_address:0.0

For example, consider a scenario where you need to install the adapter on a remote
HP-UX machine (named itaska). Because you have a Solaris 5.6 machine (named alaska) that
has a video card and monitor installed, you can run an X-window application on it. So you
decide to telnet to itaska from alaska.
When you telnet to itaska, you will not get access to itaska's monitor and will be unable to
display an X-window application. That is why you must set the DISPLAY variable, which
instructs the X-server to redirect all windows to the computer set in the variable. Before
doing so, the computer (specified in the DISPLAY variable) must give permissions to share
its monitor.
alaska> xhost + # give permission for all to its share monitor
alaska> telnet itaska
Welcome to HP-UX itaska 11.00
User:
Password:
itaska> export DISPLAY=alaska:0.0 # set display on alaska
itaska> installation_package

TIBCO ActiveMatrix Adapter for Database Installation

JRE and JVM 47

JRE and JVM

What should I do if JVM crashes when I run the installer?
The installer first extracts the bundled JVM into a temporary area and then uses it to
launch itself. If the JVM crashes, you can still run the installer using another JVM,
preferably JVM 1.5 or higher. The syntax is shown below.

For Windows:
installation_package -s -a -is:javahome C:\j2sdk1.6.0

For UNIX (using Solaris 8 as an example):

installation_package -is:javahome /opt/jre160

The javahome directory must contain bin/java.exe or bin/java.

The installer will use your JRE to launch itself.

TIBCO ActiveMatrix Adapter for Database Installation

48

| Chapter 4

Installation FAQs and Troubleshooting

Cannot Install the Adapter

On HP-UX and AIX platforms, even though the correct version of TIBCO Runtime Agent
version is already installed on the system, installation of an adapter that depends on
TIBCO Runtime Agent may fail in the dependency resolution.
The TIBCO product installer maintains the registry information in the
vpd.properties.tibco.system_name file. The value for system_name is determined by
InetAddress.getLocalHost().getHostName(). However, the method getHostName(), returns different
values based on the JRE versions used. For example, on AIX, JRE 1.3.1 returns only
system_name, whereas JRE 1.4.0 returns system_name.domain_name. Because of this, the
installer is not able to load the correct registry file.
Resolution
On UNIX platforms, the installer registry file vpd.properties.tibco.system_name is located in the
user's home directory.
Case 1: If the vpd.properties.tibco.system_name file exists:
$ cd user's_home_directory
$ ln -s vpd.properties.tibco.system_name

vpd.properties.tibco.system_name.domain_name

For example:
$ cd ~
$ ln -s vpd.properties.tibco.upside vpd.properties.tibco.upside.tibco.com

where upside is system_name, and tibco.com is domain_name

Case 2: If the vpd.properties.tibco.system_name.domain_name file exists:
$ cd user's_home_directory
$ ln -s vpd.properties.tibco.system_name.domain_name vpd.properties.tibco.system_name

For example:
$ cd ~
$ ln -s vpd.properties.tibco.upside.tibco.com vpd.properties.tibco.upside

where upside is system_name, and tibco.com is domain_name.

TIBCO ActiveMatrix Adapter for Database Installation

| 51

Index

changes from the previous release of TIBCO

Installation viii
CONFIG_HOME x
Configure
adapter database account 24
ODBC system data source 25, 40
Connect
remote database 30
Console Mode 2, 17, 20
create_user.sql script 24
customer support xii

Installation Modes
Console Mode 2
GUI Mode 2
Silent Mode 2
Installation Procedure
Console Mode 17
GUI Mode 16
Silent Mode 18
Installation Requirements
Disk Space Requirements 5
Software Requirements 6
Supported Platforms 6
System Memory Requirements 5
Installation Steps 15
Installation Type
Custom 2
Profile 2
Installer Account 2
Installer Log File 4

D
Disk Space Requirements 5

E
ENV_NAME x

O
ODBC drivers documentation 10, 10

G
GUI Mode 2, 16, 20

S
scripts
create_user.sql 24
Silent Mode 2, 18
Software Requirements 6
support, contacting xii
Supported Platforms 6
System Memory Requirements 5
TIBCO ActiveMatrix Adapter for Database Installation

52

| Index
T
technical support xii
TIB_ADADB_HOME x
TIBCO_HOME x
Typical 16

U
Uninstallation
Console Mode 20
GUI Mode 20
Uninstallation Procedure 20

TIBCO ActiveMatrix Adapter for Database Installation