You are on page 1of 47

Toad® for DB2 4.

Installation Guide
© 2010 Quest Software, Inc.

ALL RIGHTS RESERVED.

This guide contains proprietary information protected by copyright. The software described in
this guide is furnished under a software license or nondisclosure agreement. This software
may be used or copied only in accordance with the terms of the applicable agreement. No
part of this guide may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying and recording for any purpose other than the
purchaser’s personal use without the written permission of Quest Software, Inc.

The information in this document is provided in connection with Quest products. No


license, express or implied, by estoppel or otherwise, to any intellectual property right is
granted by this document or in connection with the sale of Quest products. EXCEPT AS
SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE
AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY
WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY
WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR
ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL
DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF
THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations
or warranties with respect to the accuracy or completeness of the contents of this document
and reserves the right to make changes to specifications and product descriptions at any
time without notice. Quest does not make any commitment to update the information
contained in this document.

If you have any questions regarding your potential use of this material, contact:

Quest Software World Headquarters


LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656

www.quest.com
email: legal@quest.com

Refer to our Web site for regional and international office information.

Trademarks

Quest, Quest Software, the Quest Software logo, Toad, T.O.A.D., Toad World, and vToad are
trademarks and registered trademarks of Quest Software, Inc in the United States of America
and other countries. Other trademarks and registered trademarks used in this guide are
property of their respective owners.

Toad for DB2 4.6

Installation Guide

January 2010
Table of Contents
Installation 4
System Requirements 4
Install Toad 11
Install Toad Silently 12
Install Toad on Citrix Systems 19
Upgrade Toad 20
Register Toad 22
Uninstall Toad 22
Install Other Toad Components 22
Configuration 25
Understand Toad Connections 25
Configure DB2 Client Connections 26
Configure DB2 LDAP Support 35
Create Toad Connection Profiles for DB2 36
Troubleshoot DB2 LUW Issues 40
Troubleshoot DB2 z/OS Issues 42
Appendix: Contact Quest 45
Contact Quest Support 45
Contact Quest Software 45
About Quest Software 45
Index 46
1
Installation

System Requirements

Client Requirements
Ensure that the client computer meets the following minimum requirements:

Component Requirement

Platform 1 GHz minimum

Hard Disk 212 MB to run Toad


Space Allocate the following additional space as needed:
l If installing ToadSQL Tuning for DB2 z/OS, allocate an
additional 45 MB.
l If installing Toad SQL Analysis for DB2 LUW, allocate an
 additional 47 MB.
l If installing the Quest SQL Optimizer for DB2 LUW, see the
SQL Optimizer Release Notes for disk space requirements.

Memory 512 MB of RAM minimum, 1 GB recommended


Note: The memory required may vary based on the following:
l Applications that are running on your system when using Toad
l Size and complexity of the database
l Amount of database activity
l Number of concurrent users accessing the database

Operating Windows Server 2003 (32-bit)


System Windows XP Professional (32-bit)
Windows Vista (32-bit)
Windows Server 2008 (32-bit )
Windows 7 (32-bit)
Note: The Toad SQL Analysis for DB2 LUW client is not supported
on Windows Vista, Windows Server 2008, or Windows 7.
Toad for DB2 Installation Guide 5
Installation

Component Requirement

.NET Microsoft .NET Framework 3.5 (Service Pack 1)


Framework Note: The following conditions apply:
l The .NET Framework Client Profile is not supported.
l To run Toad, the .NET security policy must be set to
unrestricted. See "User Requirements and Restrictions for
Running Toad" (page 8) for more information.

Additional Web Browser


Requirements Microsoft Internet Explorer 6.0 or later
Existing DB2 Client Support
Toad installs a DB2 9.7 client as part of the installation process. The
DB2 9.7 client can co-exist with an existing DB2 8 client; however, it
is incompatible with a DB2 7 client. If a DB2 7 client is already
installed on the system, the Toad installation stops and cannot
complete. You must first upgrade to the DB2 8 client. Then restart the
Toad installation to avoid losing functionality in some DB2 native
tools.
Toad for DB2 Installation Guide 6
Installation

Server Requirements
Ensure that the server meets the following minimum requirements:

Component Requirement

Operating DB2 for z/OS


System
l z/OS (V1R6 Base Services [5694-A01] or later)
DB2 for LUW
l IBM AIX 5.1, 5.2, 5.3, 6.1
l HP-UX 11i 1.5, 2 (32-bit or 64-bit)
l Red Hat Enterprise Linux AS release 3 and 4 (32-bit or 64-bit)
l Solaris 7, 8, 9, 10 (32-bit or 64-bit)
l SuSE 7, 8, 9
l Windows 2000, 2003,(including 64-bit), 2008, XP, Vista,
Windows 7

Database l IBM DB2 for LUW 8.1.5 or later, 9.1 or later


Support
l IBM DB2 for z/OS 8 and 9
Notes:
l To run RUNSTATS and the native REORG utility on
tablespaces and indexes in DB2 for LUW, Toad
supports DB2 for LUW 8.2.2 or later.
l At this time, Toad SQL Analysis for DB2 LUW does
not support DB2 for LUW 9.7.
l Toad supports DB2 8 for z/OS running in Full Function
mode, but does not support DB2 8 for z/OS running in
Compatibility mode.

Operating Toad requires that the Toad for DB2 Agent reside on each DB2 for
System LUW server on which you intend to execute scripts server-side (using
Platforms for the Toad LUW Remote Script Execution feature) or to collect SQL
Toad for DB2 using Toad SQL Analysis for DB2 LUW.
Agent The agent supports servers running in any of these operating systems:
l Microsoft Windows 2000, Windows 2003 (32-bit), Windows
XP (32-bit)
l Sun Solaris 7 or later
l IBM AIX 4.3 or later
l SuSE Linux Enterprise Server 8 and 9 for zLinux
l SuSE Linux Enterprise Server 8 and 9 United Linux for Intel
x86
Toad for DB2 Installation Guide 7
Installation

Component Requirement

l SuSE Linux (2.6 Kernel) on AMD64 (x86_24)


l RedHat Enterprise Linux AS 3.0 and 4.0 zLinux (32-bit)
l RedHat Enterprise Linux AS 2.1, 3.0, and 4.0 for Intel x86
l RedHat Enterprise AS 4.0 (2.6 Kernel) on AMD64 (x86)
Note: The following additional requirements apply:
l In 64-bit zLinux environments, the Toad for DB2 Agent
supports only DB2 for LUW 9.1 or later.
l To collect SQL in a RedHat or SuSE Linux 2.6 environment
on an x86-64 (AMD64) server, Toad SQL Analysis requires a
minimum of DB2 for LUW 8.1 with FixPak 10 applied.
l Sun Solaris 7 servers must have Sun Solaris 7 patch 106327
 applied.
l RedHat 3.0 servers must have compatibility library
compatlibstdc++- 7.3-2.96.122.i386.rpm installed. This
package is available on Red Hat Advanced Server 3.0
installation CDs.
See the Toad for DB2 LUW Agent Installation Guide for complete
agent requirements and installation details.

Hard Disk For the Toad LUW Remote Script Execution component, 34.9 MB
Space for For Toad SQL Analysis services, 35 MB
Toad for DB2
Agent

Citrix Requirements
Limited testing has been performed for Citrix support on Windows Server 2003 Enterprise
Server (Service Pack 2) using the MetaFrame Presentation Server 5.0 and Citrix Presentation
Server Clients 10.2. See "Install Toad on Citrix Systems" (page 19) for more information.

User Requirements

User Requirements to Install Toad

Only Windows Administrators and Power Users can install Toad.

Note: The following exceptions exist for Power Users:

l A Power User cannot install Toad on a computer running Windows Vista Enterprise.
This is a Windows limitation because Vista does not support Power User mode.
l A Power User cannot install Toad if a DB2 for LUW version earlier than 8.1.7 already
exists on the computer. Only an Administrator can install Toad under this condition.
Toad for DB2 Installation Guide 8
Installation

However, if the computer has an existing DB2 for LUW 8.1.7 or later installation, a
Power User can install Toad as long as this user belongs to the DB2ADMNS or
DBUSERS group.

If an Administrator installs Toad, the Administrator can share the Toad shortcut icon on the
desktop and menu items with any user--a Power User, Restricted User, Vista standard user--on
the computer.

If a Power User installs Toad, a Restricted User cannot do the following:

l Associate file extensions.


l View the Toad shortcut icon on the desktop or the Toad menu options in the
Windows Start menu. As a workaround, Restricted Users can create a shortcut to Toad
from the install directory and place the shortcut on their desktop.

User Requirements and Restrictions for Running Toad

The following describes the requirements and restrictions for users who launch and run Toad:

l A Windows Power User or Restricted User must belong to the DB2ADMNS or


DB2USERS group. To add the user to one of these groups, select Start | Control
Panel | Administrative Tools | Computer Management | System Tools | Local Users
and Groups | Groups | DB2ADMNS or DB2USERS.
l A Windows Vista user must be either an administrator or a standard user that belongs
to an Vista Administrators group. Additionally, to enable full functionality in Toad
when Vista’s User Access Control security feature is turned on, the standard user must
run Toad as an administrator. (Right-click the Toad icon on the Vista desktop and
select Run as administrator.) See the Toad for DB2 Release Notes for a description
of the restrictions that are in place when the standard user does not run Toad as an
administrator.
l A Windows Power User or Restricted User does not have the authority to add or
remove DB2 catalog entries using the Toad Client Configuration wizard. However,
these users can use the Import Profile function in the Toad Client Configuration
wizard to import catalog entries to Toad.
l As a minimum requirement to manage a DB2 for z/OS subsystem in Toad, the user ID
defined in the Toad connection profile for the subsystem must either have SYSADM
privileges or SELECT privileges on the DB2 catalog tables.

l To run Toad, the .NET security policy must be set to Unrestricted. To modify the
security policy:

1. Select Control Panel from the Windows Start menu.


2. Double-click Administrative Tools.
3. Double-click Microsoft .NET Framework version Configuration.
4. Select My Computer, and then select the Runtime Security Policy node.
Toad for DB2 Installation Guide 9
Installation

5. Select Evaluate Assembly from the list of tasks in the right panel, and locate
and select Toad.exe in the File field.
6. Click Next and set the permission to Unrestricted.
l To create or modify the QuestSoftware.ToadSecurity table to enable Toad Security,
the user who maintains this table must have privileges to create, insert, update, and
delete it. All other users need only the ability to read the QuestSoftware.ToadSecurity
table to use Toad Security features.

Requirements for Full Access to Toad for DB2 z/OS


Functionality
Install the following components on each DB2 for z/OS subsystem:

l Quest IBM DB2 z/OS component

Notes:

l Without the z/OS component installed, Toad for DB2 provides limited support
for managing DB2 for z/OS subsystems. With the z/OS component installed,
you have access to a full range of Toad functionality needed to manage DB2
subsystems. See Install Other Toad Components (page 22) for a complete list of
features to which the z/OS component provides access.
l If no Quest IBM DB2 z/OS component is installed on your subsystem, see the
Quest IBM DB2 z/OS Installation Guide for installation requirements and
instructions.
l If you already have the Quest IBM DB2 z/OS component installed on
your subsystem, refer to the current Toad for DB2 Release Notes to
determine whether you need to perform an upgrade or a new installation of
the z/OS component.

l IBM stored procedure SYSPROC.DSNUTILU, installed and operational

Notes:

l Toad requires SYSPROC.DSNUTILU to run DB2 utilities. For more


information about this stored procedure, see Appendix B of the IBM DB2
Universal Database for z/OS Utility Guide and Reference.
l A 32K character-size limit exists for each utility statement executing
through DSNUTILU.
Toad for DB2 Installation Guide 10
Installation

Compile and Debug Requirements for Stored SQL


Procedures
Toad requires the following to compile and debug stored SQL procedures in DB2.

DB2 for LUW Requirements

The following is required to debug and compile stored SQL procedures on DB2 for
LUW databases:

Component Requirements

Supported DB2 DB2 for LUW 9 or later


Versions

Each DB2 Database IBM SYSPROC.DBG_% procedures, installed and


operational

Privileges On each DB2 database, EXECUTE authority on all


SYSPROC.DBG_% procedures

DB2 for z/OS Requirements

The following is required to debug and compile stored SQL procedures on DB2 for z/OS
subsystems:

Component Requirements

Supported DB2 DB2 for z/OS 8 or 9


Versions

Each DB2 l IBM DB2 stored procedure SYSPROC.DSNTPSMP,


Subsystem installed and operational (needed to compile stored
procedures in Toad)
l IBM DB2 installation job DSNTIJSD, executed (needed
to debug stored procedures)
l IBM SYSPROC.DBG_% procedures, installed and
operational

z/OS IBM Unified Debugger Session Manager, installed and


configured:
DB2 for z/OS 8
1. Apply PTF UK25860.
2. Install and configure DB2UDSMD (the Debugger
Session Manager).
3. Start task DB2UDSMD, using default port number 4553.
Toad for DB2 Installation Guide 11
Installation

Component Requirements

DB2 for z/OS 9


1. Install and configure DB2UDSMD (the Debugger
Session Manager).
2. Start task DB2UDSMD, using default port number 4553.
Refer your systems administrator to the following link for
instructions on installing and configuring DB2UDSMD:
http://www.ibm.com/developerworks/data/library/techarticle/dm-
0903debugdatastudio/

Privileges l On each DB2 subsystem, EXECUTE authority on all


SYSPROC.DBG_% procedures
l DEBUGSESSION system privilege (for continued
debugging of SQL procedures)

Install Toad
To install Toad

1. Run the ToadInstaller.exe from the CD or downloaded file.

2. Complete the wizard.


Toad for DB2 Installation Guide 12
Installation

Install Toad Silently


Silent installation provides a convenient method for deploying Toad to multiple machines.
With some customization, you can also deploy the license key and settings at the same time

Determine Which Installer to Use


Before performing a silent installation, review the following to determine which
installer to use:

Installer Advantages Disadvantages

Executable file Silent installation using an exe file Silent installation using an
(.exe) has the following advantages: exe file has the following
See "Install Toad disadvantages:
l Verifies whether the
Silently" (page prerequisite software is l Cannot deploy
12) for more installed, and if not, redirects custom Toad
information. you to the download settings files or
location. license keys.
l Verifies whether a version of l Installer
Toad already exists on the automatically exits
target computer. If so, the if the prerequisite
executable uninstalls the software is not
previous version and then installed.
installs the current version.
l Exports the previous DB2
catalog and then re-imports
it into the current version.

Microsoft Supports deployment of Toad Silent installation using an


Installer file settings files and license keys. msi file has the following
(.msi) disadvantages:
See "Install Toad l Requires manual
Silently" (page verification and
12) for more download of any
information. prerequisite
software.
l Requires a manual
uninstall of the
previous version of
Toad using
Add/Remove
Programs.
Toad for DB2 Installation Guide 13
Installation

Silent Installation Prerequisites


Before you perform a silent installation, the following software must be installed on every
computer on which you are installing Toad:

l Microsoft .NET Framework 3.5 (Service Pack 1)


l Toad installs a DB2 9.7 client as part of the installation process. The DB2 9.7 client
can co-exist with an existing DB2 8 client; however, it is incompatible with a DB2 7
client. If a DB2 7 client is already installed on the system, the Toad installation stops
and cannot complete. You must first upgrade to the DB2 8 client. Then restart the
Toad installation to avoid losing functionality in some DB2 native tools.

Silent Installation Using the Executable


Use the executable file to perform a silent install to the default directory (or to a different
directory) and to specify options such as logging installation messages.

To perform a silent install using the executable file

1. At a Windows command prompt, switch to the drive or directory where the


executable for Toad is located. (This file can be downloaded from the Quest web site
or can be found on the Toad installation CD-ROM.)

2. For a standard installation with all features enabled, enter the following command:
“ToadInstaller.exe” /S

For a read-only installation with create, alter, and drop functionality disabled, enter
the following command:
“ToadInstaller.exe” /S READONLY=TRUE

You can customize MSIEXEC command-line options and overrides for your
installation similar to the following command:
“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”
INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”
COMPANYNAME=”your_company” ApplicationUsers=”AllUsers”

Use the following descriptions to customize the command-line options and overrides
for your installation.
Toad for DB2 Installation Guide 14
Installation

Command-Line Options

The following MSIEXEC command-line options are used in this example:

Option Description

/L “C:\temp\ (Optional) Write installation messages to the specified log.


installLog.txt” You can append other options, such as x for debug (used in
the previous example) or v for a verbose log. See the log
section at http://msdn2.microsoft.com/en-
us/library/aa367988.aspx for more information about
additional logging options.
Also, substitute “C:\temp\installLog.txt” in the example
with the fully qualified name of the log file. Enclose this
value in double quotations. The installation process creates
this file if it does not exist. Otherwise, the existing file is
overwritten

Toad Default Installation Option Overrides

You can specify the following values to override Toad’s default installation options.
Enclose each value in double quotations:

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory in


which you want to install Toad. If you do not include this
path, the installation program defaults to: C:\Program
Files\Quest Software\Toad for DB2 4.6.

USERNAME (Optional) Specify the user that intends to use Toad on


the target computer. Consider the following:
l If “OnlyCurrentUser” is defined for the
ApplicationUsers value (see description that
follows), only the user specified here (and the user
that installed Toad) can see the Toad shortcut on
the desktop after the installation completes.
l If “OnlyCurrentUser” is defined but USERNAME
is not included in the installation, only the user
that installed Toad sees the Toad shortcut on the
desktop.
l If “AllUsers” is defined for ApplicationUsers, the
USERNAME value is ignored during installation.

COMPANYNAME (Optional) Specify the name of the company that owns


this installation.
Toad for DB2 Installation Guide 15
Installation

Option Description

ApplicationUsers (Optional) Specify one of the following values:


l “AllUsers” allows any user to see the Toad
shortcut on the desktop after installation
completes.
l “OnlyCurrentUser” allows only the user specified
for USERNAME and the user that installed Toad
to see the Toad shortcut on the target desktop. If
USERNAME is not included in the installation,
only the user that installed Toad sees the shortcut.
Note: If you do not specify a value, the installation
program defaults to “AllUsers”.

Note: All default installation option overrides are case-sensitive.

Silent Installation Using the Microsoft Installer


You can create a Microsoft transform (.mst) file that deploys the license key, custom settings,
and connections for users when performing a silent install using the .msi file. You can also
use the .msi file to perform a basic silent install using the default directory or can install to a
different directory and specify command-line options and default installation overrides. See
"Perform Silent Installation Using MSI" (page 17) for more information if you are not creating
a transform file.

Note: Review the following information about the msi installer:

l The .msi file is located on the Toad installation CD or is available as a download


from SupportLink at https://support.quest.com/SUPPORT/index?page=home.
l The installer does not verify that system requirements have been met before installing.
If you do not want to manually verify system requirements, you should use the .exe
file for the silent install.

Create Transform Files

The following procedure uses the Wise Installer to create the transform file.

To create a transform file that includes custom Toad settings

1. Save and install the ToadInstaller.msi file on a computer where the Wise for Windows
Installer is installed. After customizing Toad settings, you will use the Wise Installer
to create the transform file.
Toad for DB2 Installation Guide 16
Installation

2. Open Notepad, and do the following:


a. Enter the license key in the first line.
b. Enter the site message in the second line. The file should look similar to the
following:

AAABBBBCCCCCCEDXDWLMV0WJ9-123-45678-B2

Quest Software

c. Save the file with license.key as the file name in the Toad install directory.
Make sure the file extension is .key not .txt.
3. Launch Toad. The application should open without prompting you to enter a
license key.

4. Select Tools | Configuration Wizard from the Toad menu and complete the
Configuration wizard. This wizard creates an initial settings file (Settings.xml).

5. Select Tools | Options from the menu in Toad to open the Options window.

6. Select each page in the window and set any options you want to deploy. These
options create a module settings folder and files.

7. Select View | Connection Manager from the menu in Toad to open the
Connection Manager.
8. Create any connections you want to deploy.

9. Exit Toad. Upon exiting, a Connections file is created.

10. Use the Wise for Windows Installer to create the Microsoft Transform file:
a. Select File | New.
b. Select Custom Templates under Categories, and then select the Transform
template in the New Installation File window.
c. Select the ToadInstaller.msi file in the Select the .MSI file to base this
transform on window.
d. Save the project.
e. Select Files from the Feature Details view.
f. Locate the following files and click Add to add them to the project:

File to Add Location

Settings.xml This file is located in the following directory:


C:\Documents and Settings\username\Application
Data\Quest Software\ Toad for DB2 4.6.
Toad for DB2 Installation Guide 17
Installation

File to Add Location

ModuleSettings This folder and related files are located in the


folder and files following directory: C:\Documents and
Settings\username\Application Data\Quest Software\
Toad for DB2 4.6\ModuleSettings.

Connections.xml This file is located in the following directory:


C:\Documents and Settings\username\Application
Data\Quest Software\Toad for DB2 4.6.

g. Save the project and compile it to create the transform (MST) file.


11. Perform a silent install. See "Perform Silent Installation Using MSI" (page 17) for more
information.

Perform Silent Installation Using MSI

To perform a silent install using msi

1. At a Windows command prompt, switch to the drive or directory where the msi
installer for Toad is located. This file is located on the Toad installation CD or is
available as a download from SupportLink at
https://support.quest.com/SUPPORT/index?page=home.

2. For a standard installation with all features enabled, enter the following command:
msiexec /i “ToadInstaller.msi” /q

For a read-only installation with create, alter, and drop functionality disabled, enter
the following command:
msiexec /i “ToadInstaller.msi” /q READONLY=TRUE

You can customize command-line options and overrides for your installation similar
to the following:
msiexec /i “ToadInstaller.msi” INSTALLDIR= “Drive:\your_install_
path” /q USERNAME=”someone” COMPANYNAME=”your_company”
ApplicationUsers=”AllUsers”
Toad for DB2 Installation Guide 18
Installation

Command-Line Options

The following MSIEXEC command-line options are used in this example:

Option Description

/i Run the installation.

/q Specify the user interface (UI) that displays during installation.


You can append other options, such as n to hide the UI or b
to hide the Cancel button during the installation.

Note: All command-line options are case-insensitive. See


http://msdn2.microsoft.com/en-us/library/aa367988.aspx for a complete list of
command-line options.

Toad Default Installation Option Overrides

You can specify the following values to override Toad’s default installation options.
Enclose each value in double quotations:

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory in


which you want to install Toad. If you do not include this
path, the installation program defaults to: C:\Program
Files\Quest Software\Toad for DB2 4.6.

USERNAME (Optional) Specify the user that intends to use Toad on


the target computer. Consider the following:
l If “OnlyCurrentUser” is defined for the
ApplicationUsers value (see description that
follows), only the user specified here (and the user
that installed Toad) can see the Toad shortcut on
the desktop after the installation completes.
l If “OnlyCurrentUser” is defined but USERNAME
is not included in the installation, only the user
that installed Toad sees the Toad shortcut on the
desktop.
l If “AllUsers” is defined for ApplicationUsers, the
USERNAME value is ignored during installation.

COMPANYNAME (Optional) Specify the name of the company that owns


this installation.
Toad for DB2 Installation Guide 19
Installation

Option Description

ApplicationUsers (Optional) Specify one of the following values:


l “AllUsers” allows any user to see the Toad
shortcut on the desktop after installation
completes.
l “OnlyCurrentUser” allows only the user specified
for USERNAME and the user that installed Toad
to see the Toad shortcut on the target desktop. If
USERNAME is not included in the installation,
only the user that installed Toad sees the shortcut.
Note: If you do not specify a value, the installation
program defaults to “AllUsers”.

Note: All default installation option overrides are case-sensitive.

Install Toad on Citrix Systems


To install Toad on a Citrix system

1. Connect to the Citrix Environment as an administrator.

2. Copy Toad to the Citrix server, if needed.

3. Install Toad.

4. During installation, select the Anyone who uses this computer checkbox when
prompted.

5. Repeat steps 2 through 4 for each server in the Citrix farm.

Note: Although you must install Toad on every server in the Citrix farm, you only
need to publish Toad once.

6. Review the following considerations regarding licensing:

l A license supplied by an administrator always overrides a user-supplied license


in a Citrix environment.
l If you need to provide the same Toad functionality to all users, you can enter
the default license key for all users.
l If you have users with different license requirements (for example, some have
Standard licenses and others have Professional licenses), individual licenses
should be entered for each user. You should not enter the default license key
because it enables all functionality in Toad.
Toad for DB2 Installation Guide 20
Installation

Upgrade Toad
To upgrade Toad

1. Run the ToadInstaller.exe installation program from the CD or downloaded file.


2. Select Uninstall Toad and continue with install.

3. Complete the wizard.

If you are upgrading from a previous version of Toad, you are prompted to migrate
your settings the first time you start Toad. The settings files include database
connections, layout customizations, shortcut keys, and options customized in the
Options pages.

Files Migrated During Upgrades


When upgrading versions of Toad, the following files can be migrated from the previous
version's Application Data Directory (Help | About to select a link to navigate to the
location).

File Description

Action.log Tracks your usage within Toad. If you agree to share this
data, the file is automatically sent to Quest on a periodic
basis.

Connections.xml Contains all connections stored in the Connection


Manager or the New Connection window.

ConnectionTrace.log Contains the SQL Output connection trace log file if you
select Tools | SQL Trace from the menu.

ExceptionTrace.log Contains a log of all exceptions encountered while


running Toad.

FTPConnection.log Contains a log of exceptions encountered when attempting


to connect to FTP servers.

FTPConnections.xml Contains connections to FTP servers stored in the FTP


 Connections window.

Settings.xml Contains many of the global configuration settings.

ToadSupportBundle.zip Contains the last support bundle you generated.

Folder Description

Automation (temporary Used by automation when executing automation scripts.


folder)
Toad for DB2 Installation Guide 21
Installation

Cache Used to spool cache database metadata to disk if enabled.


The data is in binary format and can always be recreated
by fetching it from the database.

CNSScripter (temporary Used by Compare plug-ins, script generation for Alter


folder) object windows, and the Script tab in the Object Explorer.

Context Contains settings that depend on the context within Toad


including the following:
l Adapter—Custom data editing statements.
l Filter—Unnamed filters defined in the Object
Explorer or Database Explorer.
l Named Filter—Named filters defined in the Object
Explorer or Database Explorer.
l TYPE—Tabs that display on the right when you
select an object in the Object Explorer or Database
Explorer.

Keyboard Contains custom keyboard shortcut layouts.

Layouts Contains layouts for some areas in Toad, such as tool


windows that automatically display in the Editor and
column layouts for the Messages tab.

ModuleSettings Contains general settings for various components in Toad,


such as whether the data grid defaults to read-only,
displays not null indicators, etc.

Plugins Used by Toad plugin components.

Session Contains desktop configurations, including toolbar


customizations and tool window locations.

SQLFormatter Contains pre-set and user created templates for formatting


SQL, and the SQL statement used to preview formatting
changes in the Formatting Options page.

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:


l Code Templates—Templates used to define default
values when creating new objects in the Object
Explorer or Database Browser.
l Scripts—Startup scripts to run when connecting.
l Snippets—Code Snippet entries.
Toad for DB2 Installation Guide 22
Installation

Register Toad
You should register Toadto ensure that all the features you purchased are available.

To register Toad

1. Select Help | Licensing from the menu.


2. Use the information provided by sales or support to complete the fields.

Uninstall Toad
If you uninstall Toad, it may not uninstall completely. When you use Toad, you create new
files such as SQL scripts, data output, or temp files. The following types of files are not
removed when you uninstall:

l Any new files you create


l Any copies of files you make for backup purposes

To uninstall Toad

1. Run the ToadInstaller.exe installation program from the CD or downloaded file.


2. Select Uninstall Toad only.
3. Complete the wizard.

Install Other Toad Components


Depending on your Toad license type, additional Toad components might be available. See
the following sections for information about installing these components:

l Quest IBM DB2 z/OS Component (page 23)


l Toad for DB2 Agent (page 23)
l Quest SQL Optimizer for DB2 LUW (page 24)
l Toad SQL Tuning for DB2 z/OS (page 24)
l Toad SQL Analysis for DB2 LUW (page 24)
Toad for DB2 Installation Guide 23
Installation

Quest IBM DB2 z/OS Component


The Quest IBM DB2 z/OS component enables you to take full advantage of Toad
functionality on your DB2 for z/OS subsystem. If you do not have the z/OS component
installed, Toad still provides some basic functionality to manage your DB2 for z/OS
subsystems. However, with the z/OS component installed on your DB2 subsystem, you can
perform these additional functions in Toad:

l Bind and rebind packages and plans


l Invoke DB2 for z/OS utilities and commands within scripts that Toad for DB2
generates for advanced alters, migrations, and data and object synchronizations
l Run stand-alone DB2 for z/OS utilities and commands available with UIs in Toad
l Run DB2 for z/OS commands from the Editor
l Execute remote DB2 for z/OS scripts
l Create, alter, or drop dataset templates
l Use Toad UIs to run DISPLAY, START, and STOP commands on DB2 for z/OS
databases, tablespaces, and indexes
l Access accurate buffer-pool information for the DB2 subsystem
l View volumes available for defining a storage group
l View dataset information for tablespace and indexes
l Access information about the current threads connected to the DB2 subsystem
l Assign a RACF group to a Toad Security role to control the Toad features available to
all users belonging to the RACF group

The z/OS component is installed on each subsystem that you wantToad to manage. For a
complete description of system requirements and installation instructions for this component,
refer the Quest IBM DB2 z/OS Component Installation Guide. This guide is available from
the Windows Start menu under Program Files | Quest Software | Toad for DB2 |
Documentation.

Toad for DB2 Agent


The Toad for DB2 Agent enables you to perform the following functions on DB2 for
LUW servers:

l Run remote scripts using the Toad LUW Remote Script Execution feature
l Collect and analyze SQL using Toad SQL Analysis for DB2 LUW

l Monitor SMS tablespaces using Spotlight on DB2

Note: The agent is required for DB2 for LUW 8.x servers only.
Toad for DB2 Installation Guide 24
Installation

See the Toad for DB2 Agent LUW Installation Guide for requirements and installation
instructions. This guide is available from the Windows Start menu under Program Files |
Quest Software | Toad for DB2 | Documentation.

Quest SQL Optimizer for DB2 LUW


Quest SQL Optimizer for DB2 LUW lets you tune the SQL used in the DDL for triggers,
views, or materialized query tables and the SQL included in packages. You can also tune the
SQL on which you are working in the Editor. See the Quest SQL Optimizer for IBM DB2
LUW Installation Guide for requirements and installation instructions.

Toad SQL Tuning for DB2 z/OS


Toad SQL Tuning for DB2 z/OS lets you tune the SQL used in the DDL for triggers, views,
or materialized query tables and the SQL included in packages and plans. You can also tune
the SQL on which you are working in the Editor.

To install SQL Tuning for DB2 z/OS, use your web browser to locate the self-extracting
installation file for this product from http://support.quest.com (SupportLink). Download the
installation file, and execute it.

Toad SQL Analysis for DB2 LUW


Toad SQL Analysis for DB2 LUW collects and analyzes SQL executing against your DB2
for LUW databases. The product requires the following:

l The SQL Analysis client installed on the same computer as your Toad DB2 client

To install the SQL Analysis client, use your web browser to locate the self-extracting
installation file for this product from http://support.quest.com (SupportLink).
Download the installation file, and execute it.

l The Toad for DB2 Agent installed on each database server on which you intend to
collect SQL

For instructions about installing the Toad for DB2 Agent, see the Toad for DB2 LUW Agent
Installation Guide. This guide is available from the Windows Start menu under Program
Files | Quest Software | Toad for DB2 | Documentation.

Note: Do not run both the Toad for DB2 Agent and the Quest Central for DB2 Agent on the
same computer.
2
Configuration

Understand Toad Connections


In Toad, a connection represents one or more actual connections to the database. Toad creates
an initial database connection for general usage. It also creates a separate database connection
for each Editor (the first time you execute a statement) and a separate database connection for
each Data tab in the Database Explorer (the first time you select the tab and data is queried).
The database connection for each Editor and Data tab remain open until you close the
associated window; however, the connections remain in an inactive state if a statement is not
currently executing.

Tips:

l To view the number of actual database connections that exist for a Toad connection
and how many of those database connections are active, place the cursor over the
connection in the Connection Manager or the Connection toolbar.

l You can view the progress of statements executing in the background in a progress
bar located on the lower right side of the status bar. To cancel a script's execution,
click the progress bar to display the Background Processes window.

Share Database Connections


Editors and Data tabs can share the same database connection when the connection is
inactive if you clear the Use specific connection for each open editor checkbox in Tools |
 Options | Editor | General. Any new executions or windows attempt to use this
connection first. For example; if you share a database connection, you can execute a query
in the Editor, execute another query in a new Editor, and then select the Data tab from the
same connection. If the connection is in use and you attempt to execute it, one of the
following occurs:

l (DB2 and Oracle only) If your database supports executing multiple queries
simultaneously on a shared connection, the query is placed in a queue and executes as
soon as the current operation completes.
l If your database does not support executing multiple queries on a shared connection, a
dialog prompts you to either permanently associate the window with a new database
connection, cancel the previous operation, or add the query to a queue until the
current operation completes, and the execute it. If you place multiple queries in the
queue, each one executes in the order that it was added to the queue.

Note: Although you can share a database connection, any commits apply to the selected
window only.
Toad for DB2 Installation Guide 26
Configuration

Configure DB2 Client Connections


Toad for DB2 requires two phases to set up connections to the DB2 for LUW databases and
DB2 for z/OS subsystems that you want Toad to manage.

The first phase is to catalog each of these databases or subsystems on the DB2 client installed
with Toad. Toad provides three methods for cataloging the systems:

l Transfer an existing catalog from another DB2 client on your computer

You can transfer the catalog of an existing DB2 client on your local computer to the
new Toad DB2 client during initial setup or at any time later.

Transfer a Catalog During Initial Setup


When you first launch Toad for DB2 after installation, Toad provides an opportunity
to transfer the catalog of an existing DB2 client on your local computer to your new
Toad DB2 client. (In other words, Toad exports and imports the catalog for you.)

Toad makes this option available only when all of these conditions exist:

l You are launching Toad for the first time since installation.

l This installation is a first-time Toad for DB2 installation on your


computer, or it is an upgrade from a previous Toad for DB2 version
already on your computer.

l Toad detects other DB2 clients installed on your computer. These can include
the DB2 clients laid down with other installations.

If you choose not to transfer an existing catalog at this point, you can transfer a
catalog later. See "Transfer a Catalog Any Time After Initial Setup" (page 28) for more
information.
Toad for DB2 Installation Guide 27
Configuration

To migrate an existing DB2 catalog

1. Open Toad for DB2 after installation is complete.

2. If Toad displays the Settings Migration Utility window, select whether to


migrate from your previously installed Toad for DB2. (These settings include
Toad connection profiles.)

l If you migrate settings, the window showing the option to transfer a


catalog displays once the migration completes.

l If you do not migrate settings, Toad steps you through its Configuration
wizard before displaying the Connections window. When you select to
create a connection, the window showing the option to transfer a
catalog displays.

If the Settings Migration Utility window does not display, go to step 3.

3. On the window showing the option to transfer a catalog, locate the DB2
Client list, and select the name of the existing DB2 client whose catalog you
want to transfer to your newly installed Toad for DB2.

This list contains all current previously installed DB2 clients on your
computer, including the default DB2 client instance and other Toad for DB2
client installations.

4. Click OK to proceed with the catalog transfer.

When the transfer completes, the Connections window displays. The Database
alias drop-down list now includes all the DB2 databases and subsystems
whose catalog entries you transferred.

Note: During the transfer process, DB2 does not automatically export catalog
entries for the local DB2 instance and its databases installed on your computer
unless these entries already exist in the catalog you are transferring. To include
local node entries in your Toad DB2 client catalog, you must manually catalog
these databases.

5. Proceed to Create Toad Connection Profiles for DB2 (page 36) for the DB2
databases and subsystems whose connection profiles you did not migrate (in
step 2). For those profiles you migrated, simply select the connection in the
Connections window, and provide the login ID and password to start the
connection.
Toad for DB2 Installation Guide 28
Configuration

Transfer a Catalog Any Time After Initial Setup


To transfer a catalog any time after initial setup

1. In the Connection Manager or on the Connections window, click in


the toolbar.

2. From the DB2 Client list, select the name of the existing DB2 client whose
catalog you want to transfer to your newly installed Toad for DB2.

This list contains all current previously installed DB2 clients on your
computer, including the default DB2 client instance and other Toad for DB2
client installations.

3. Click OK.
4. Create Toad Connection Profiles for DB2 (page 36) for any of the transferred
catalog entries as needed.
l Import a DB2 Catalog previously exported to a file

Toad for DB2 provides functionality to import an existing DB2 client catalog to your
Toad DB2 client, saving you the effort of manually creating individual catalog entries
on the Toad DB2 client. This feature executes the DB2 Connectivity Configuration
Import Tool command db2cfimp, which imports an export profile containing the
catalog exported the from a local or remote DB2 client or a local Toad DB2 client.
Either of these functions export DB2 catalogs:

l Export Profile feature in the Toad Configuration wizard (for exporting your
current Toad DB2 client catalog only). See Export the Catalog for the Current
DB2 Client.

l DB2 Connectivity Configuration Export Tool Command db2cfexp. For more


information, see the following IBM
documentation:
http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/
com.ibm.db2.udb.doc/core/r0002442.htm.

Note: Do not attempt to manually import catalog entries from the IBM CLP window
provided with Toad. If you have any DB2 ODBC entries, db2cfimp will override your
existing ODBC system with DSN entries and can cause previously configured DB2
ODBC connections to stop working.

To import an exported catalog profile

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list to open the Client Configuration wizard.

2. On the Welcome page, select Import Profile.

3. Click Next.
Toad for DB2 Installation Guide 29
Configuration

4. Click in the Profile name field to browse for and select the exported profile
you want to import. When you select the profile, its contents display in the
text pane.

5. Complete the wizard.

Once you close the wizard, the Database alias drop-down list in the
Connections window includes all the DB2 databases and subsystems whose
catalog entries you imported.

Note: DB2 does not automatically export catalog entries for the local DB2
instance and its databases on the computer from which the export is run (unless
these entries already exist in the catalog). Therefore, the profile you are
importing might not include these node entries. To add the missing entries to
your Toad DB2 client catalog, you must manually catalog the databases. If
these databases are local to your computer, catalog them as remote databases.
See "Manually catalog DB2 for LUW databases" (page 29) for more
information.

6. Proceed to catalog entries as needed. See "Create Toad Connection Profiles for
DB2" (page 36) for more information.

l Manually catalog DB2 for LUW databases

To manually catalog a DB2 for LUW database

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list to open the Client Configuration wizard. The
Welcome page displays, showing the Toad DB2 client's existing catalog
configuration in a tree view.

2. If the host and node names for the database you want to configure are listed in
the tree, select them. These selections pre-fill certain fields required later in the
wizard process. If these names are not listed, you must provide the necessary
host and node information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operating Select the operating system for the server on which


system the DB2 for LUW instance containing the DB2
database you are cataloging resides. For a list of
supported server platforms, see the release notes.

Host name Enter the TCP/IP address or the system name for the
server on which the DB2 database resides.
Toad for DB2 Installation Guide 30
Configuration

Port number Enter the port number for the server on which the
DB2 database resides.

Enable Select this checkbox to enable the SOCKS secure


SOCKS protocol to handle TCP traffic for this connection.
security SOCKS adds an authentication mechanism for
additional security.

Specify an Description
Instance

Node name Enter a user-defined name for the DB2 instance


containing the database you are cataloging.
If you selected the node name from the tree on the
Welcome page, this information is pre-filled (but you
can update it as needed).

Instance name Enter the real name of the DB2 instance.

Comment Enter a descriptive comment for the instance, if


needed.

Add a Database Description

Database name Enter the real name of the DB2 database.

Database alias Enter a unique nickname to identify the database on


your system.

Authentication Select the authentication method that is required to


connect to the database.

Target Enter the service account name for server's service


principal where the database resides.
Note: This option is available only when Kerberos is
selected as the authentication method.

5. Complete the wizard.

The Database alias drop-down list in the Connections window shows the alias
for the newly cataloged database. To complete the Toad connection setup, you
must create a Toad connection profile for the database. See "Create Toad
Connection Profiles for DB2" (page 36) for more information.
Toad for DB2 Installation Guide 31
Configuration

l Manually catalog DB2 for z/OS subsystems

Note: If you connect directly to a DB2 for z/OS subsystem, you cannot take
advantage of Sysplex. If you want to use Sysplex, catalog an entry to a DB2 Connect
gateway instead. See "Manually catalog DB2 Connect gateways" (page 32) for more
information.

To manually catalog a DB2 for z/OS subsystem

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list to open the Client Configuration wizard. The
Welcome page displays, showing the Toad DB2 client's existing catalog
configuration in a tree view.

2. If the host name for the DB2 subsystem you want to configure is listed in the
tree, select it. This selection pre-fills certain fields required later in the wizard
process. If the host name is not listed, you must provide the necessary host
information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Description
Host

Operating Select z/OS for the server operating system.


system

Host Enter the TCP/IP address or the system name for the server
name on which the DB2 subsystem resides.

Port Enter the port number of the service for the DB2
number subsystem.

Enable Select this checkbox to enable the SOCKS secure


SOCKS protocol to handle TCP traffic for this connection. SOCKS
security adds an authentication mechanism for additional security.

Add a DB2 Description


Subsystem

Location Enter the location name of the DB2 subsystem as defined


name during the DB2 installation.

Database Enter a unique, user-defined alias to identify the DB2


alias subsystem on your system. You can use the same name
you used in the previous Location name field, as long as
it does not already exist in the list aliases in the Toad
DB2 client.
Toad for DB2 Installation Guide 32
Configuration

5. Complete the wizard. A message window informs you whether the entry was
added successfully.

The Database alias drop-down list in the Connections window shows the alias
for the newly cataloged subsystem. To complete the Toad connection setup,
create a Toad connection profile for the database. See "Create Toad Connection
Profiles for DB2" (page 36) for more information.

l Manually catalog DB2 Connect gateways

In order to connect to a DB2 for z/OS subsystem, you need to catalog two entries.
First, you need to catalog the DB2 subsystem on the DB2 Connect gateway. During
this process, you define an alias for the DB2 subsystem. Second, you need to
catalog this DB2 subsystem alias in Toad. The procedure below describes both
cataloging events.

To manually catalog an entry to a DB2 Connect gateway

1. Catalog the DB2 subsystem on the DB2 Connect gateway. See the IBM DB2
for z/OS documentation for more information.

2. In the Connections (or Create New Connection) window in Toad, click


beside the Database alias drop-down list to open the Client
Configuration wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operating Select the operating system for the server on which


system the DB2 Connect gateway resides.

Host name Enter the TCP/IP address or the system name for the
server on which the DB2 Connect gateway resides.

Port number Enter the port number of the service for the DB2
Connect gateway.

Enable Select this checkbox to enable the SOCKS secure


SOCKS protocol to handle TCP traffic for this connection.
security SOCKS adds an authentication mechanism for
additional security.

Specify an Description
Instance

Node name Enter an alias for the user-defined node name you
specify in the Instance name field.
Toad for DB2 Installation Guide 33
Configuration

Instance name Enter a user-defined name for the gateway node or


use the same value entered in the Node name.
Note: This name does not point to an actual node on
the gateway system, but is needed to continue the
cataloging process.

Add a Database Description

Database name Enter the database alias name for the DB2 subsystem.
Note: This alias name must match the alias cataloged
on the DB2 Connect gateway.

Database alias Enter a unique, user-defined alias for the DB2


Connect gateway. You can use the same alias you
used in the previous Database name field, as long as
it does not exist in the list of Toad for DB2 aliases.

Authentication Select the authentication method that matches the


method specified for the DB2 subsystem on the DB2
Connect gateway.

5. Complete the wizard.

The Database alias drop-down list in the Connections window shows the
name for the newly cataloged DB2 subsystem. To complete the Toad
connection setup, you must create a Toad connection profile for the subsystem.
See "Create Toad Connection Profiles for DB2" (page 36) for more information.

Note: Toad for DB2 supports LDAP connections. See "Configure DB2 LDAP Support" (page
35) for more information.

Additionally, Toad provides functionality to perform the following maintenance on the


catalog you set up for the current Toad DB2 client:

l Edit DB2 Catalog Entries

To edit a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the Toad DB2 client, select the catalog
entry for the DB2 database or subsystem that you want to edit.

3. Click Edit Catalog Entry.


Toad for DB2 Installation Guide 34
Configuration

4. On the Edit Catalog Entry page, update the catalog properties as needed. For a
description of the catalog properties, see the following links:

l Manually catalog DB2 for LUW databases (page 29)

l Manually catalog DB2 for z/OS subsystems (page 31)


l Manually catalog DB2 Connect gateways (page 32)
5. Click Next to open the Catalog Script Review window.

6. Review and modify the script in the preview pane as needed.

7. Click Finish. A message window displays, informing you whether the updates
to the catalog entry completed successfully.

l Remove DB2 Catalog Entries

To remove a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the Toad DB2 client, expand one or more
nodes, and select the catalog entries that you want to remove. (Press
CTRL+click to select multiple entries.)

Note: You can remove a node by selecting all database entries for that node.

3. Click Remove Catalog Entry.

4. On the Catalog Script Review page, modify the script in the preview
pane as needed.

5. Click Finish. A message window displays, informing you whether the


removals completed successfully.

l Export the Catalog for the Current DB2 Client

Toad for DB2 provides functionality to export your current Toad DB2 client catalog
to a file, called an export profile. You can then import this profile to set up the
catalog for another Toad DB2 client.

To create the export profile containing the current Toad DB2 client catalog, Toad
executes the DB2 Connectivity Configuration Export Tool command db2cfexp. If
you want to export the catalog of a remote or local DB2 client (other than your
current Toad DB2 client), you must manually execute this command. For more
information, see the following IBM documentation:
http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/
com.ibm.db2.udb.doc/core/r0002442.htm.
Toad for DB2 Installation Guide 35
Configuration

To export the Toad DB2 client catalog

1. In the Connections (or Create New Connection) window, click beside the
Database alias drop-down list.

2. Click Export Profile in the Welcome window of the Client Configuration


wizard. (You might need to click this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the
profile in which to export the current Toad DB2 client catalog.

5. Select the type of profile you want to create:

l Template to create a profile used as a template for other DB2 clients


(default for exporting a Toad DB2 catalog)

l Backup to create a profile used to back up a DB2 database instance

l Maintain to create a profile that contains only database or node


information required for updating other instances

For more information about these profile types, see the IBM
documentation (as cited previously) describing the db2cfexp command.

6. Complete the wizard. A message window displays, informing you whether the
export completed successfully.

Note: DB2 does not automatically export catalog entries for the local DB2
instance and its databases installed on your computer unless these entries
already exist in the catalog you are exporting. If you later import the export
catalog to a Toad DB2 client, you must manually catalog the missing local-
node databases as remote databases. See "Manually catalog DB2 for LUW
databases" (page 29) for more information.

After you have set up the catalog on the current Toad DB2 client, you can proceed to the
second phase of the Toad connection setup. This phase involves creating Toad connection
profiles for the cataloged DB2 databases or subsystems. See "Create Toad Connection Profiles
for DB2" (page 36) for more information.

Configure DB2 LDAP Support


You can create DB2 Lightweight Directory Access Protocol (LDAP) connections when the
DB2 client installed with Toad is configured for LDAP. Configuring the client consists of
enabling LDAP support and specifying the host name and port number of the LDAP server.
Once the client is configured, Toad retrieves names from your LDAP server and displays
them in the Database Alias list in the Connections window.
Toad for DB2 Installation Guide 36
Configuration

Notes:

l You must configure LDAP support for the DB2 client installed with Toad
regardless of whether an existing DB2 client on the computer is already configured
to support LDAP.

l Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toad
does not support the management of these entries.

To configure the DB2 client for LDAP

1. Open the Command Window for the DB2 client installed with Toad by selecting
Start | All Programs | IBM DB2 | <ToadCom, ToadEval, or ToadFree> |
Command Line Tools | Command Window.

2. Enter the following command to enable LDAP support:


db2set DB2_ENABLE_LDAP=YES

3. Enter the following command to specify the TCP/IP host name and port number of the
LDAP server:
db2set DB2LDAPHOST=<hostname[:port]>

The port number defaults to 389 (default LDAP port) if you leave the port
number blank.

4. Exit the Command window.

5. Launch Toad and open the Connections window.

Databases on the LDAP server should be available from the Database alias drop-
down list in the Connections window. To complete the Toad connection setup, you
must create a Toad connection profile for each database. See "Create Toad Connection
Profiles for DB2" (page 36) for more information.

Create Toad Connection Profiles for DB2


Toad for DB2 requires two phases to set up connections to the DB2 for LUW databases and
DB2 for z/OS subsystems that you want Toad to manage.

Tip: Connections are stored in the connections.xml file and can be found by clicking the
Application Data Directory link in Help | About.

The first phase is to catalog each of these databases or subsystems on the DB2 client installed
with Toad. See "Configure DB2 Client Connections" (page 26) for more information.

The second phase involves creating Toad connection profiles for the cataloged DB2
databases or subsystems. Each profile contains the information that Toad needs to connect to
the system, such as the user ID and password, DB2 registry settings, and the default schema.
This topic describes the three methods for setting up the profiles:
Toad for DB2 Installation Guide 37
Configuration

l Migrate existing connection profiles from another Toad for DB2 installation on your
computer (available during initial Toad setup only)

When you first launch Toad for DB2 after installation, Toad provides an opportunity
to migrate the settings of an existing Toad for DB2 installation on your local
computer to your new Toad for DB2 installation. These settings include, among other
configuration parameters, the Toad connection profiles defined on the earlier
installation. (Toad exports and imports these connection profiles for you.)

Toad makes this option available only when both of these conditions exist:

l You are launching Toad for the first time since installation.

l Toad detects earlier versions of Toad for DB2 on your computer.

If you choose not to migrate the connection profiles at this point, you can perform the
migration later using the Connection Managers' Import Connections and Export
Connections features.

To migrate Toad connection profiles

1. Open Toad for DB2 after installation is complete. Toad displays the Settings
Migration Utility window if the conditions described previously exist.

2. Select the Toad for DB2 installation whose connection profiles you want to
migrate to your new Toad installation, and click Migrate.

After the migration completes, Toad provides the option to transfer a local
DB2 catalog to your new Toad DB2 client.

3. Select to transfer a DB2 catalog or to manually catalog entries later. See


"Configure DB2 Client Connections" (page 26) for more information.

Note: The connection profiles you migrated are not usable unless you also
transfer the DB2 catalog containing the corresponding entries for these profiles
(or until you manually create these catalog entries later).

After the catalog transfer is complete, your Toad connection setup is complete
for all those connections that have both a catalog entry on the Toad DB2
client and a Toad connection profile. For any connection that does not have a
corresponding DB2 catalog entry, create an entry. See "Configure DB2 Client
Connections" (page 26) for more information.

l Import Toad connection profiles previously exported to an XML file

(See "Export Connection Profiles to an XML File" (page 39) for more
informationabout exporting a profile that you can later import.)

Note: The connection profiles are not usable unless you have also created entries in
the DB2 catalog for the DB2 databases and subsystems to which these profiles
correspond. See "Configure DB2 Client Connections" (page 26) for more information.
Toad for DB2 Installation Guide 38
Configuration

To import connection profiles

1. In the Connections (or Create New Connection) window, click on the


toolbar, and select Connection file.

2. From the Import Connections window, browse for and select the XML file
containing the connection profiles you want to import.

3. Click Open.

4. Select DB2 and click OK to complete the import.

The connections whose profiles you imported are listed on the


Connections window.

l Manually define Toad connection profiles.

To create a Toad connection profile for a DB2 database or subsystem

1. In the Connections (or Create New Connection) window, click on the


toolbar (ALT+F+N).

2. Select DB2 from the Group list box.

3. Review the following for additional information:

Database Select the alias for the DB2 database or subsystem. This
alias alias was defined when you cataloged this DB2 database
or subsystem on the Toad DB2 client. See "Configure
DB2 Client Connections" (page 26) for more information
if the alias does not display in the list.

Default Enter the SET SCHEMA value (DB2 for LUW) or the SET
schema/auth SCHEMA or SET CURRENT SQLID value (DB2 for z/OS) for
ID this connection.

Name Edit the nickname you want to display for this connection
throughout Toad (for example, in the Connections
window, document windows, Connection toolbar, and
status bar). If this field is blank, the name defaults to:
database_alias (login)

Category Select or create a category if you want to color code


Editor tabs for a specific connection. This can help
differentiate between development and production
databases. You can also set an option to color code the
Object Explorer pane and object editor windows (Create,
Alter, Drop, etc.).
Toad for DB2 Installation Guide 39
Configuration

4. Select the Advanced tab to define special register values that are then in effect
each time Toad connects to the DB2 database or subsystem.

5. Click Connect to save the connection and immediately connect to the


database.

or

Click Save to save the connection without connecting to the database.

After you have completed both phases for configuring Toad connections to DB2 databases or
subsystems, the Connections window lists all the configured connections, allowing you to
perform the following:

l Connect to and manage a DB2 database or subsystem through Toad

l Export Connection Profiles to an XML File

Toad for DB2 provides functionality to export one or more of your current Toad
connection profiles to an XML file. You can then import these exported connection
profiles into another Toad for DB2 installation. See "Import Toad connection profiles
previously exported to an XML file " (page 37) for more information.

To export connection profiles

1. In the Connections (or Create New Connection) window, select the


connections whose profiles you want to export.

2. Click on the toolbar, and select Connection file.

3. On the Export Connections window, review the selected connections,


and click OK.

4. Browse for and select the path for the file in which to export the
selected profiles.

l Import connection profiles from an XML file

l Import missing connections defined on the Toad client.

You can import all connection entries currently defined in the Toad DB2 client
catalog but missing from your current list of Toad connections.See "Create Toad
Connection Profiles for DB2" (page 36) for more information.

Note: The imported connection entries might be associated with incorrect or missing
DB2 catalog or Toad connection profile information, making them currently invalid.
To re-instate any of these connections, you might need to provide accurate DB2
catalog and Toad profile information.

To import missing connections

» In the Connections or Connections Manager window, click .


Toad for DB2 Installation Guide 40
Configuration

l Troubleshoot connection issues for DB2 for LUW databases or DB2 for z/OS
subsystems

Troubleshoot DB2 LUW Issues


Review the following solutions to help troubleshoot DB2 LUW issues pertaining to Toad
installation and database connections.

Installation Issues
The following table describes issues related to installing Toad for DB2.

Issue Cause/Solution

System.IO.FileNotFoundException - You are not a member of the DB2ADMIN or


File or assembly name DB2USERS group. To install Toad, you must
DB2AdminWrapper, or one of its be a member of either group.
dependencies was not found Solution:
Ensure that you have been added to one of
these groups.

Cannot access IBM DB2 native tools Toad is bundled with the IBM DB2 v9 client.
after installing Toad for DB2 2.0 with IBM does not support direct client migration
previous install of DB2 client v7. from v7 to v9, so installing Toad on a system
Error: "SQL10007N Message "-1390" that has an existing v7 client may cause errors.
could not be retrieved. Reason code: Solution:
"2"."
Upgrade the IBM DB2 v7 client to the v8
client. If you upgrade the client after installing
Toad, you do not have to uninstall or reinstall
Toad.

Error: "Could not load file or You installed a commercial version of Toad
assembly 'IBM.Data.DB2.9.1.0, for DB2 after uninstalling the freeware version.
Version=9.1.0.2, Culture=neutral, Solution:
PublicKeyToken=7c307b91aa13d208'
You must remove run time information for the
or one of its dependencies. The
freeware version of Toad from the .NET
system cannot find the file specified."
system.config file.

To remove run time information


1. Exit Toad.
2. Navigate to the following .NET
framework directory:
C:\WINDOWS\Microsoft.NET\
Framework\v2.0.50727\
CONFIG
3. Create a backup copy of the
Toad for DB2 Installation Guide 41
Configuration

Issue Cause/Solution

system.config file.
4. Open the system.config file in Notepad.
5. Locate the <runtime> tag delete
everything between the runtime tags
(including <runtime> and </runtime>).
6. Save the file.
7. Restart Toad.

Connection Issues

Issue Cause/Solution

ERROR [08001] [IBM] You are attempting to connect to a database version


SQL1336N The remote host was that is not supported in Toad.
not found. SQLSTATE=08001 Solution:
Review the list of supported databases in the
Release Notes or Installation Guide.

ERROR [58031] [IBM] Catalog entries have not been imported or defined
SQL1031N The database for the connection.
directory cannot be found on the Solution:
indicated file system.
See Configure DB2 Client Connections to
SQLSTATE=58031
determine the best method for cataloging a
database.

"The type initializer for A settings file might be corrupt.


'IBM.Data.DB2.DB2Connection' Solution:
threw an exception."
Rename your local settings directory so a new one
or
can be recreated.
"SUCCESS - unable to allocate
an environment handle." To rename your local setting directory
1. Exit Toad.
2. Navigate to the following settings directory:
C:\Documents and Settings\
UserName\Local
Settings\ApplicationData\Quest Software
3. Rename the Toad for DB2 version# folder to
"Toad for DB2 OLD".
4. Restart Toad and try to connect.
Note: Make sure you can view hidden folders in
Windows Explorer.
Toad for DB2 Installation Guide 42
Configuration

Troubleshoot DB2 z/OS Issues


Review the following solutions to help troubleshoot DB2 z/OS issues in Toad.

Installation Issues

Issue Cause/Solution

Error: "Could not load file or You installed a commercial version of Toad
assembly 'IBM.Data.DB2.9.1.0, for DB2 after uninstalling the freeware version.
Version=9.1.0.2, Culture=neutral, Solution:
PublicKeyToken=7c307b91aa13d208'
You must remove run time information for the
or one of its dependencies. The
freeware version of Toad from the .NET
system cannot find the file specified."
system.config file.

To remove run time information


1. Exit Toad.
2. Navigate to the following .NET
framework directory:
C:\WINDOWS\Microsoft.NET\
Framework\v2.0.50727\
CONFIG
3. Create a backup copy of the
system.config file.
4. Open the system.config file in Notepad.
5. Locate the <runtime> tag delete
everything between the runtime tags
(including <runtime> and </runtime>).
6. Save the file.
7. Restart Toad.
Toad for DB2 Installation Guide 43
Configuration

Connection Issues

Issue Cause/Solution

ERROR [08001] [IBM] You are attempting to connect to a database version


SQL1336N The remote host was that is not supported in Toad.
not found. SQLSTATE=08001 Solution:
Review the list of supported databases in the
Release Notes or Installation Guide.

ERROR [58031] [IBM] You do not have any catalog entries defined for the
SQL1031N The database connection.
directory cannot be found on the Solution:
indicated file system.
See Configure DB2 Client Connections to
SQLSTATE=58031
determine the best method for cataloging a
database.

ERROR [42501] [IBM][DB2] You do not have SYSADM privileges for the DB2
SQL0551N "UserName" does for z/OS subsystem.
not have the privilege to perform Solution:
operation "SELECT" on object
Ensure that you are granted SELECT permissions
"SYSIBM.SYSSTMT".
on the DB2 catalog tables.
SQLSTATE=42501

ERROR [] [IBM] SQL1460N When using the Time-Sharing Option (TSO) to


The environment variable connect, the user ID, port number, or IP address
"SOCKS_NS" required for entered may be incorrect.
SOCKS server name resolution is Solution:
not defined or not valid.
Ensure that you use the following for TSO
connections:
l DB2 user ID for the DB2 subsystem
l Port number that DB2 listens on, for remote
connections, via the DB2 DDF address
space
l IP address for the z/OS subsystem
Toad for DB2 Installation Guide 44
Configuration

Issue Cause/Solution

ERROR [56038] [IBM][DB2] In general, Toad does not support a z/OS subsystem
SQL0969N There is no message running in Compatibility mode.
text corresponding to SQL error Solution:
"-4700" in the message file on
If possible, switch the subsystem's operating mode
this workstation.' when
to Full Function mode.
connecting to compatibility
mode database. If this is not possible, Toad now provides a message
when you connect to subsystem, informing you of
-or-
that the subsystem is running in compatibility mode
After connecting, some objects and that some features might not be available.
do not display properly or some
functionality does not work as
designed.

Other Issues

Issue Cause/Solution

[IBM][CLI Driver][DB2] The SQL script that you attempted to execute


SQL0104N An unexpected contains commented text delimited by characters
token "/*" was found following that DB2 for z/OS 8 or earlier does not support.
"". Expected tokens may include: Solution:
"FROM INTO".
Set an option in Toad that removes comments
SQLSTATE=42601
automatically from a script before you execute it.

To have Toad remove comments automatically


from SQL before execution
1. Select Tools | Options | Database | DB2 |
General.
2. Select Remove comments from SQL
statements prior to execution.
Appendix: Contact Quest

Contact Quest Support


Quest Support is available to customers who have a trial version of a Quest product or who
have purchased a commercial version and have a valid maintenance contract. Quest Support
provides around the clock coverage with SupportLink, our web self-service. Visit
SupportLink at:
http://support.quest.com

From SupportLink, you can do the following:

l Quickly find thousands of solutions (Knowledgebase articles/documents).


l Download patches and upgrades.
l Seek help from a Support engineer.
l Log and update your case, and check its status.

View the Global Support Guide for a detailed explanation of support programs, online
services, contact information, and policy and procedures. The guide is available at:
http://support.quest.com/pdfs/Global Support Guide.pdf

Contact Quest Software


Email info@quest.com

Quest Software, Inc.


World Headquarters
Mail 5 Polaris Way
Aliso Viejo, CA 92656
USA

Web site www.quest.com

See our web site for regional and international office information.

About Quest Software


Now more than ever, organizations need to work smart and improve efficiency. Quest
Software creates and supports smart systems management products—helping our customers
solve everyday IT challenges easier and faster. Learn more at www.quest.com.
troubleshoot z/OS issues 42

Index I

installation 11
;
Citrix 7, 19
;installation
client requirements 4
Toad SQL Analysis for DB2 LUW 22
debugging requirements on client 10
and subsystem
A
Quest IBM DB2 z/OS component 22
agent, Toad for DB2
Quest SQL Optimizer for DB2 22
installation 22 LUW

server requirements 6
C
silent 12
Citrix
Toad for DB2 Agent 22
installation 19
Toad SQL Tuning for DB2 z/OS 22
requirements 7
user privilege requirements 7
client requirements 4

connections L
configure DB2 client 26 LDAP
create DB2 36 DB2 support 35
DB2 LDAP support 35
Q
share for all session windows 25
Quest IBM DB2 z/OS component, installation22
troubleshoot DB2 LUW 40
Quest SQL Optimizer for DB2 LUW, installation22
troubleshoot DB2 z/OS 42

understand 25 R

contact support 45 register Toad 22

corporate deployment 12 requirements

Citrix 7
D
client 4
DB2
server 6
create connections 36
SQL procedure debugging 10
troubleshoot LUW issues 40
Toad for DB2 Installation Guide
47
Index

user privilege 7

server requirements 6

silent installation 12

create transform file 15

determine installer to use 12

executable 13

Microsoft installer (MSI) 15

prerequisites 13

SQL Analysis for DB2 LUW, installation22

SQL Optimizer for DB2 LUW, installation22

SQL Tuning for DB2 z/OS, installation22

system requirements 4

Toad for DB2 Agent

installation 22

Toad SQL Analysis for DB2 LUW, installation22

Toad SQL Tuning for DB2 z/OS, installation22

transform file 15

troubleshoot

DB2 LUW connections 40

DB2 z/OS connections 42

uninstall Toad 22

user privilege requirements 7

You might also like