Toad for DB2 Installation Guidedev.toadfordb2.com/install_guide/Toad_InstallGuide_5.2.pdf ·...

Toad® for IBM DB2 5.2

Installation Guide

© 2012 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

email: [email protected]

Refer to our Web site (www.quest.com) for regional and international office information.

Trademarks

Quest, Quest Software, the Quest Software logo, Benchmark Factory, Spotlight, Simplicity at

Work, Toad, TOAD, T.O.A.D., and TOAD WORLD are trademarks and registered trademarks

of Quest Software, Inc. For a complete list of Quest Software’s trademarks, see

http://www.quest.com/legal/trademark-information.aspx. Other trademarks and registered

trademarks used in this guide are property of their respective owners.

Toad for DB2 5.2

Installation Guide

December 12, 2012

mailto:[email protected]

http://www.quest.com/

http://www.quest.com/legal/trademark-information.aspx

http://www.quest.com/legal/trademark-information.aspx

Table of Contents

Installation 6

System Requirements 6

Client Requirements 6

Server Requirements 7

Virtualization Support 8

User Requirements 9

Requirements for Full Access to Toad for DB2 z/OS Functionality 10

Compile and Debug Requirements for Stored SQL Procedures 11

Install Toad 13

Specify Application Data Directory Location 13

Install Toad Silently 15

Determine Which Installer to Use 15

Silent Installation Prerequisites 16

Silent Installation Using the Executable 16

Silent Installation Using the Microsoft Installer 18

Install Other Toad Components 22

Quest IBM DB2 z/OS Component 23

Toad for IBM DB2 LUW Agent 23

SQL Optimizer for DB2 LUW 23

SQL Tuning for DB2 z/OS 24

Install Toad on Citrix Systems 24

Upgrade Toad 24

Files Migrated During Upgrades 25

Uninstall Toad 27

Register Toad 27

Notes for Toad for DB2 Users 28

Toad for IBM DB2 Installation GuideTable of Contents

4

Create and Troubleshoot Connections 29

Understand Toad Connections 29

Share Database Connections 29

Configure DB2 Client Connections 30

Define DB2 Client Connections 30

Maintain DB2 Client Connections 37

Configure DB2 LDAP Support 39

Create Toad Connection Profiles for DB2 40

Create Connection Profiles 40

Manage Connections 43

Troubleshoot DB2 LUW Issues 44

Installation Issues 44

Connection Issues 45

Other Issues 46

Troubleshoot DB2 z/OS Issues 46

Installation Issues 46

Connection Issues 47

Other Issues 48

Configure Version Control 50

About Version Control 50

Prerequisites 50

Configure Version Control 51

Manage Objects under Version Control 53

Troubleshoot Version Control 56

Troubleshoot Upgrades 56

Troubleshoot Other Issues 56

Toad for IBM DB2 Installation GuideTable of Contents

5

Appendix: Contact Quest 58

Contact Quest Support 58

Toad Community 58

Contact Quest Software 58

About Quest Software 58

Index 60

Installation

System Requirements

Client Requirements

Before installing Toad, ensure that your client system meets the following minimum hardware

and software requirements:

Platform 1 GHz minimum

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

Hard Disk

Space212 MB to run Toad

Allocate additional space for the following components as needed

(provided with Xpert Editions):

l If installing Toad SQL Tuning for DB2 z/OS, allocate an

additional 45 MB.

l If installing the Quest SQL Optimizer for DB2 LUW, see the

SQL Optimizer Release Notes for disk space requirements.

Note: The disk space required may vary based on the edition of Toad

selected for installation.

Operating

System

Windows Server 2003 with SP2 or later

Windows Server 2003 R2

Windows XP Professional with SP3 (32-bit or 64-bit, except Starter

Edition)

Windows Vista with SP2 or later (32-bit or 64-bit, except Starter

Edition)

Windows Server 2008 with SP2 or later (32-bit or 64-bit)

Windows Server 2008 R2 (64-bit)

Windows 7 (32-bit or 64-bit)

Windows 8 (32-bit and 64-bit)

1

Toad for IBM DB2 Installation GuideInstallation

7

.NET

Framework

Microsoft .NET Framework 3.5 (SP1) and 4.0

Note: The .NET Framework Client Profile is not supported.

Database

Client

Existing DB2 Client Support

Toad installs a DB2 9.7 (fix pack 6) client as part of the installation

process. The DB2 9.7 client can co-exist with an existing DB2 8

client, but is incompatible with a DB2 7 client. If a DB2 7 client

already exists on your computer, the Toad installation stops and

cannot complete. To resolve, first upgrade to the DB2 8 client. Then

restart the Toad installation to avoid losing functionality in some DB2

native tools.

Requirements for 32-Bit and 64-Bit Environments

Toad provides a 32-bit and a 64-bit Toad DB2 client installer. The 32-

bit client installs in any Toad-supported Windows environment. The

64-bit client installs in a 64-bit environment only. Additionally, a 32-

bit and a 64-bit IBM DB2 client cannot exist on the same computer.

Based on this restriction, install the appropriate 32-bit or 64-bit Toad

DB2 client if another DB2 client already resides on your 64-bit

computer.

Additional

Requirements

Web Browser

Microsoft Internet Explorer 6.0 or later

Server Requirements

Before installing Toad, ensure that your server meets the following minimum hardware and

software requirements:

Database

Server

IBM DB2 for LUW 8.1.5, 8.2, 9.1, 9.5, 9.7, 10.1

IBM DB2 for z/OS 8, 9, 10

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 Toad may support IBM DB2 Express and SWE in addition to

listed above servers, but note that no testing was performed on

it.

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

System

Platforms for

Toad for DB2

Toad requires that the Toad for DB2 Agent reside on each DB2 for

LUW server on which you intend to execute scripts server-side (using

the Toad LUW Remote Script Execution feature).


8

Agent The agent supports servers running in any of these operating systems:

l Microsoft 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

l SuSE Linux Enterprise 10 on x86

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

l Red Hat Enterprise Linux AS 3.0 and 4.0 zLinux

l Red Hat Enterprise Linux AS 2.1, 3.0, and 4.0 on x86

l Red Hat Enterprise 4.0 (2.6 Kernel) on x86_64

l Red Hat Enterprise Linux 5.0 on 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 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 media.

See the Toad for DB2 LUW Agent Installation Guide for complete

agent requirements and installation details.

Hard Disk

Space for

Toad for DB2

Agent

For the Toad LUW Remote Script Execution component, 34.9 MB

Virtualization Support

Application

Virtualization

Limited testing has been performed for Citrix XenApp 5.0 support on

Windows Server 2003.

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 24) for more information.


9

Desktop

Virtualization

(VDI)

Toad has been tested with Quest vWorkspace 7.6 running on

Windows Server 2008 R2 64-bit.

Note: Toad may work in virtualization environments other than the ones in which it was

tested.

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.

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


10

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 To take full advantage of Toad for DB2 LUW functionality, the user ID specified in

the Toad connection profile for each DB2 for LUW database connection requires the

authorizations listed in the following document:

ToadDB2LUWAuthorizations.xls

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. For a complete list of

authorizations (and corresponding GRANT statements) a user requires to take full

advantage of Toad for DB2 z/OS functionality, refer to the following document:

ToadDB2zOSAuthorizations.doc

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.

l For information about defining a RACF, Unix, or Linux group as a Toad Security role,

see the About Setting Up Toad Security topic in the Toad online help. This topic

explains how to add the Toad Security icons to your toolbar and how to define Toad

Security roles that apply to your current connection. (The ability to define RACF,

Unix, and Linux groups as Toad Security roles works with DB2 for LUW 9 or later

databases and DB2 for z/OS 8 or later subsystems.)

Requirements for Full Access to Toad for DB2 z/OSFunctionality

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 IBM 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 more information.

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.

http://dev.toadfordb2.com/releasenotes/latest/ToadDB2LUWAuthorizations.xls

http://dev.toadfordb2.com/releasenotes/latest//ToadDB2zOSAuthorizations.doc


11

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.

l Certain table alterations require that Toad perform advanced alters involving multiple

UNLOADs and LOADs of table data. Before executing these types of alterations,

ensure that the Mask value defined for the Toad dataset template that generates the

Unload datasets includes the &SEQ variable. This variable creates a unique name for

each Unload dataset. (The Unload dataset template is identified in Tools | Options |

Database | DB2 | z/OS | Load/Unload.)

l When Toad migrates data from one subsystem to another, Toad invokes the IBM

DB2 for z/OS UNLOAD and LOAD utilities. Ensure that the Reorg Unload

dataset template (identified in Tools | Options | Database | DB2 | z/OS | Reorg)

generates a dataset that resides on a pack (VOLSER) accessible by both the source

and target subsystem.

Compile and Debug Requirements for Stored SQLProcedures

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

l DB2 for LUW Requirements

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

LUW databases:

Component Requirements

Supported DB2

Versions

DB2 for LUW 9 or later

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

operational

Privileges On each DB2 database, EXECUTE authority on all

SYSPROC.DBG_% procedures

l DB2 for z/OS Requirements

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

subsystems:


12

Component Requirements

Supported DB2

Versions

DB2 for z/OS 8, 9, 10

Each DB2

Subsystem

l IBM DB2 stored procedure SYSPROC.DSNTPSMP,

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.

DB2 for z/OS 9


Session Manager).


DB2 for z/OS 10


Session Manager).


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)

http://www.ibm.com/developerworks/data/library/techarticle/dm-0903debugdatastudio/

http://www.ibm.com/developerworks/data/library/techarticle/dm-0903debugdatastudio/


13

Install ToadToad for DB2 is available in the following editions: Base, Professional and Xpert. DB Admin

Module is an add-on module that provides extended admin functionality and can be added to

any Toad edition.

Note: Your Toad for DB2 license key determines the edition and will enable Toad for DB2

functionality accordingly. In many cases, if functionality is disabled within Toad for DB2,

you may not have an appropriate license to use it. When Toad is running, you can see which

components are licensed by selecting Help | About.

To install Toad

1. Run the Installer. When installing Toad for IBM DB2 select the appropriate installer:

l ToadForDB2_version—Installs the Toad DB2 client on all Windows platforms.

l ToadForDB2_64bitClient_version—Installs the Toad DB2 client in 64-bit

environment.

Note: The 32-bit client installs in any Toad-supported Windows environment. The 64-

bit client installs in a 64-bit environment only. IBM DB2 restricts you from having a

DB2 32-bit client and DB2 64-bit client on the same computer. Therefore, the 32-bit

installer discontinues if it detects existing 64-bit DB2 client on the computer.

Likewise, the Toad DB2 64-bit installer discontinues if it detects a 32-bit client on

the computer.

2. Accept the License Agreement.

3. Select the products you want to install and click Install.

Caution!When installing Toad using Quest Installer on Windows 7 64-bit,

Program Compatibility Assistant may appear with “This program might not have

installed correctly” message. Select This program installed correctly to continue

installation.

.

Specify Application Data Directory LocationToad for DB2 5.2 stores settings files in the user's Application Data directory. The default

location cannot be modified from within the application. Toad provides two methods to

change the default location: by using a Registry setting or by using a command switch in a

Toad shortcut.

Use the Registry setting method to change the application data directory from Roaming to

Local. Use the command switch method to change the location to any new path.


14

To change Toad Application Data directory location from Roaming to Local

In the Registry under Toad for DB2 (Computer\HKEY_CURRENT_USER\Software\Quest

Software\Toad for DB2\5.2), add LOCALSETTINGS with a value of 1.

See the following table for default (Roaming) and resulting (Local) directory path.

Caution: All current Toad settings will be lost after applying this Registry setting unless you

manually copy the settings files from the default location (Roaming directory) to the new

location (Local directory). Copy the settings files BEFORE you add the Registry setting and

BEFORE opening Toad.

Oper-

ating

System

Default Location New Location when

LOCALSETTINGS = 1

Win-

dows XP

C:\Documents and

Settings\<user>\Application

Data\Quest Software\Toad for DB2

5.2

C:\Documents and

Settings\<user>\Local

settings\Application Data\Quest

Software\Toad for DB2 5.2

Win-

dows 7

C:\Users\<user>-

\AppData\Roaming\Quest


C:\Users\<user>-

\AppData\Local\Quest


To change Toad Application Data directory location using a command-line switch

You can override the default Application Data directory by running Toad with the

command switch:

Toad.exe --datadir="YourNewDirPath"

To instruct Toad to always use the new directory path, add the command switch and the new

directory path to a Toad desktop shortcut. Then use the desktop shortcut when opening Toad.

1. To add the command switch, right-click the Toad shortcut and select Properties.

2. Enter the command switch and add the directory path in quotes (replace

"YourNewDirPath" with your directory path).


15

Install Toad SilentlySilent 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.

Note: To perform a silent install, you can use either stand-alone installer or extract the .msi

from the Quest Installer, provided with Toad Edition.

Determine Which Installer to Use

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

installer to use:

Installer Advantages Disadvantages

Executable file

(.exe)

Silent installation using the .exe file

has the following advantages:

l Verifies whether the

prerequisite software is

installed, and if not, redirects

you to the download

location.

Silent installation using the

.exe file has the following

disadvantages:

l Cannot deploy

custom Toad

settings files or

license keys.

l Installer

automatically exits

if the prerequisite

software is not

installed.


16

Installer Advantages Disadvantages

Microsoft

Installer file

(.msi)

Supports deployment of Toad

settings files and license keys.

Silent installation using the

.msi file has the following

disadvantages:

l Requires manual

verification and

download of any

prerequisite

software.

l Requires a manual

uninstall of the

previous version of

Toad using

Add/Remove

Programs.

Silent Installation Prerequisites

Before you perform a silent installation, you must install the following software on every

computer where you are installing Toad:

l Microsoft .NET Framework 3.5 (Service Pack 1)

l Microsoft .NET Framework 4.0

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, but is incompatible with a DB2 7 client. If

a DB2 7 client already exists on your computer, the Toad installation stops and

cannot complete. To resolve, 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

You can customize MSIEXEC command-line options and overrides for your

installation similar to the following command:


17

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”

INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”

COMPANYNAME=”your_company” ALLUSERS=1

Use the following descriptions to customize the command-line options and overrides

for your installation.

Command-Line Options

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

Option Description

/L “C:\temp\

installLog.txt”

(Optional) Write installation messages to the specified log.

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

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. This

value allows any user to use the Toad shortcut on

the desktop after the installation completes.

l For a per-user installation, enter the empty string

value (“”) This value 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 omitted, only the

user that installed Toad sees the shortcut.

Note: If you do not specify this property, the installation

http://msdn2.microsoft.com/en-us/library/aa367988.aspx



18

Option Description

program defaults to a per-user installation.

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

the target computer.

Notes:

l If ALLUSERS is omitted or defined with the

empty string value (""), only the user specified

here (and the user that installed Toad) can see the

Toad shortcut on the desktop after the installation

completes.


empty string value ("") and you omit the

USERNAME option, only the user that installed

Toad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value is

ignored during installation.

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

this installation.

Notes:

l All default installation option overrides are case-sensitive.

l Enclose all values (except for the ALLUSERS value) in double quotations.

Silent Installation Using the Microsoft Installer

If you purchased Toad Edition (any Bundle) wrapped with Quest Installer, extract the .msi

from the Quest Installer first.

Extract MSI file from Quest Installer

The Quest Installer can be launched in "extraction mode," which allows you to extract the

Toad for DB2 MSI installer.

Note: You do not need to install the Quest Installer on any of the computers where you

are silently installing Toad products. The Quest Installer is only used to extract the

required MSI files.

To launch the Quest Installer in extract mode

1. Run Toad from the command prompt and include the command-line switch "/extract".

"ToadInstaller.exe" /extract


19

2. The Quest Installer launches in extract mode. In the Extract Location page, specify a

target location for the extracted files by entering or browsing to a directory.

3. In the Product Selection page, select the products that you want to extract.

4. Click Extract to extract the files.

The Finish page has a link to the directory into which the files were extracted and a

link to the log file for the extraction process (Readme.txt). The extraction log contains

verification of the files that have been extracted along with the command-line

switches required for performing the default installation. You must run the installers in

the order specified.

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.

2. For a standard installation with all features enabled, enter the following command:

msiexec /i “ToadInstaller.msi” /q

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” ALLUSERS=1

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.




20

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

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. This

value allows any user to use the Toad shortcut on

the desktop after the installation completes.

l For a per-user installation, enter the empty string

value (“”) This value 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 omitted, only the

user that installed Toad sees the shortcut.

Note: If you do not specify this property, the installation

program defaults to a per-user installation.

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

the target computer.

Notes:


empty string value (""), only the user specified

here (and the user that installed Toad) can see the

Toad shortcut on the desktop after the installation

completes.


empty string value ("") and you omit the

USERNAME option, only the user that installed

Toad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value is

ignored during installation.

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

this installation.

Notes:

l All default installation option overrides are case-sensitive.

l Enclose all values (except for the ALLUSERS value) in double quotations.


21

Create Transform (MST) Files

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 install to a

different directory) and to specify command-line options and default installation overrides.

See "Perform Silent Installation Using MSI" (page 19) for more information if you are not

creating a transform file.

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad on

Windows Vista or 7 with UAC enabled, you can install a file that adds a "Run as

administrator" option when right-clicking the MSI

file: http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista.

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.

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.

http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista







22

10. Create the Microsoft Transform file, using any appropriate tool. The following steps

describe how to use the Wise for Windows Installer to create the 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 5.2.

ModuleSettings

folder and files

This folder and related files are located in the

following directory: C:\Documents and

Settings\username\Application Data\Quest Software\

Toad for DB2 5.2\ModuleSettings.

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

C:\Documents and Settings\username\Application

Data\Quest Software\Toad for DB2 5.2.

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 19) for more

information.

Install Other Toad ComponentsDepending 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 IBM DB2 LUW Agent (page 23)

l SQL Optimizer for DB2 LUW (page 23) - Included in Toad for IBM DB2 Xpert

Edition.

l SQL Tuning for DB2 z/OS (page 24) - Included in Toad for IBM DB2 Xpert Edition.


23

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 IBM DB2

generates for advanced alters, migrations, and data and object synchronization

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 should be 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 IBM DB2 LUW Agent

The Toad for IBM DB2 LUW Agent allows you to run remote scripts using the Toad LUW

Remote Script Execution feature.

See the Toad for DB2 LUW Agent 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.

SQL Optimizer for DB2 LUW

SQL Optimizer for IBM 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


24

SQL on which you are working in the Editor. See the SQL Optimizer for IBM DB2 LUW

Installation Guide for requirements and installation instructions.

SQL Tuning for DB2 z/OS

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.

Note: Do not run both the Toad for DB2 Agent and the Quest Central for DB2 Agent on the

same computer.

Install Toad on Citrix SystemsToad must be installed on the Citrix server by the Citrix administrator. Users then connect to

this instance through their Citrix login.

Note: Limited testing has been performed for Citrix XenApp 5.0 support on Windows

Server 2003.

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. Start the Toad installation process.

4. During installation, on the Product Selection page, select Toad for DB2 and click

More Info. Then select the Install for everyone checkbox.

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 Individual licenses should be entered for each user.

Upgrade ToadTo upgrade Toad

1. Run appropriate Toad installer (ToadForDB2_version or ToadForDB2_64bitClient_

version) from the DVD or downloaded file.

2. Select the products you want to install and click Install.


25

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.

To migrate the settings again, remove or rename the current version's Application Data folder

and migrate the files from the previous version's Application Data folder.

Files Migrated During UpgradesWhen upgrading to a new version of Toad, the following files can be migrated from the

previous version's Application Data Directory (click the Application Data Directory link in

Help | About to open the directory).

Caution! Migrating settings from a previous version of Toad may overwrite new settings

files, implemented for the current release (for example, updated reports templates,

layouts, etc).

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

Quest.PersistentCache.xml Contains the private object annotation cache options

(object notes, Lookup tables, and hidden columns). You

can share these options with other Toad users in Tools

| Options | Database | Cache.

Settings.xml Contains many of the global configuration settings.

ToadSupportBundle.zip Contains the last support bundle you generated.


26

Folder Description

Automation (temporary

folder)

Used by automation when executing automation scripts.

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.

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.

Document Recovery Contains backup copies of Editor, Query Builder, and

Database Diagram files saved if you have enabled

Document Recovery in Tools | Options | Environment |

General.

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:


27

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.

l Reports—Report entries.

Uninstall ToadIf 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, etc. 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

l Settings files

You can uninstall Toad for DB2 by using the Quest Installer or by using the Windows

Add/Remove Programs (or Uninstall a program) feature. Quest Installer is the preferred way to

uninstall Toad for DB2.

To uninstall Toad using Quest Installer

1. Select Start | All Programs| Quest Software | Uninstall Quest Products. The Quest

Installer opens.

2. Select the product that you want to uninstall.

3. Click Uninstall.

Register ToadTo register Toad

1. Select Help | Licensing from the menu (ALT+H+L).

2. Review the following for additional information:

Authorization

key

Enter the license key for Toad.

Site message Enter the site message included with the license key.


28

Notes for Toad for DB2 Users

Trial Keys

The commercial version of Toad for DB2 comes pre-installed with a trial license key for your

convenience. This allows you to use the application while waiting for your commercial key

to be delivered.

The trial license key remains active for the designated trial period, even after you enter your

commercial license key (the splash screen may continue to indicate your application is a trial

version). This is helpful if you are previewing an upgrade or an advanced module.

If you entered your commercial license key and do not require the trial version, you can

delete the trial key.

To delete a trial key

1. Select Help | Licensing.

2. In the Toad Licensing dialog, find the License tab for the trial license key and click

Delete License to delete the trial key.

Note: The license is provided for all products and Toad components purchased within Toad

for DB2 Edition.

Create and Troubleshoot Connections

Understand Toad ConnectionsIn 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. It is

recommended to cancel only your own processes, as terminating Toad activities may

lead to unexpected behavior.

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 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 IBM DB2 Installation GuideCreate and Troubleshoot Connections

30

Configure DB2 Client ConnectionsToad 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.

Define DB2 Client Connections

The first phase is to catalog each of these databases or subsystems on the DB2 client installed

with Toad. Toad provides the following methods for cataloging the systems:

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 32) for more information.


31

To transfer 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 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. See "Create Toad Connection Profiles

for DB2" (page 40) for more information.


32

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 40) for any of the transferred catalog

entries as needed.

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"

(page 38) for more information.

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 theDatabase alias drop-down list to open the Client Configuration wizard.

2. On the Welcome page, select Import Profile.

3. Click Next.

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

http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/com.ibm.db2.udb.doc/core/r0002442.htm



33

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 33) for more information.

6. Proceed to catalog entries as needed. See "Create Toad Connection Profiles for DB2"


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


Add a Host Description

Operating

system

Select the operating system for the server on which 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.

Port number Enter the port number for the server on which the DB2

database resides.

Enable Select this checkbox to enable the SOCKS secure protocol


34

SOCKS

security

to handle TCP traffic for this connection. SOCKS adds an

authentication mechanism for additional security.

Specify an

Instance

Description

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

principal

Enter the service account name for server's service where the

database resides.

Note: This option is available only when Kerberos is

selected as the authentication method.


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 40) for more information.


35

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 36) for more information.

To manually catalog a DB2 for z/OS subsystem

1. In the Connections (or Create New Connection) window, click beside theDatabase 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.




Operating

system

Select z/OS for the server operating system.

Host name Enter the TCP/IP address or the system name for the server on

which the DB2 subsystem resides.

Port

number

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

Enable

SOCKS

security

Select this checkbox to enable the SOCKS secure protocol to

handle TCP traffic for this connection. SOCKS adds an


Add a DB2

Subsystem

Description

Location

name

Enter the location name of the DB2 subsystem as defined during

the DB2 installation.

Database

alias

Enter a unique, user-defined alias to identify the DB2 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.


36

5. Complete the wizard. A message 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"


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 theDatabase alias drop-down list to open the Client Configuration wizard.




Operating

system

Select the operating system for the server on which 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

SOCKS

security

Select this checkbox to enable the SOCKS secure protocol

to handle TCP traffic for this connection. SOCKS adds an


Specify an

Instance

Description

Node name Enter an alias for the user-defined node name you specify in

the Instance name field.

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


37

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.


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 40) for more information.

Note: Toad for DB2 supports LDAP connections. See "Configure DB2 LDAP Support" (page

39) for more information.

Maintain DB2 Client Connections

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

catalog you set up for the current Toad DB2 client:

Edit DB2 catalog entries

To edit a DB2 catalog entry


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.

4. On the Edit Catalog Entry page, update the catalog properties as needed. For a

description of the catalog properties, see the following links:


38

l Manually catalog DB2 for LUW databases (page 33)

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

l Manually catalog DB2 Connect gateways (page 36)

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.

Remove DB2 catalog entries

To remove a DB2 catalog entry


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.

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.

To export the Toad DB2 client catalog

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

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

(You might need to click




39

this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the profile inwhich 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 33) 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 40) for more information.

Configure DB2 LDAP SupportYou 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.

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.


40

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 40) for more information.

Create Toad Connection Profiles for DB2Toad 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 30) 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.

Create Connection Profiles

Use these methods to create Toad connection profiles:

l Migrate existing connection profiles from another Toad for DB2 installation on your

computer (available during initial Toad setup only)


41

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

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 30) 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 30) for more information.

l Import Toad connection profiles previously exported to an XML file

(See "Export connection profiles to an XML file" (page 43) for more information

about 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 30) for more information.

To import connection profiles

1. In the Connections (or Create New Connection) window, click on thetoolbar, and select Connection file.


42

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 thetoolbar (ALT+F+N).

2. Select DB2 from the Group list box.


Database

alias

Select the alias for the DB2 database or subsystem. This

alias was defined when you cataloged this DB2 database

or subsystem on the Toad DB2 client. See "Configure

DB2 Client Connections" (page 30) for more information

if the alias does not display in the list.

Tip: Click to refresh the alias list. Normally, Toadcaches the Toad DB2 catalog the first time you open this

window in your Toad session and continues to read from

cache each time you subsequently open this window. This

button forces Toad to reread the DB2 catalog to list any

new systems that might have been cataloged externally

during the caching period.

Default

schema/auth

ID

Enter the SET SCHEMA value (DB2 for LUW) or the

SET SCHEMA or SET CURRENT SQLID value (DB2 for

z/OS) for this connection.

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

Click here to view a video of this feature.

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

http://toadforsqlserver.com/entry.jspa?externalID=4370&categoryID=686


43

database.

or

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

Manage Connections

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 41) 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 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.

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 .

l Troubleshoot connection issues


44

Troubleshoot DB2 LUW IssuesReview 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 -

File or assembly name

DB2AdminWrapper, or one of its

dependencies was not found

You are not a member of the DB2ADMIN or

DB2USERS group. To install Toad, you must

be a member of either group.

Solution:

Ensure that you have been added to one of

these groups.

Cannot access IBM DB2 native tools

after installing Toad for DB2 2.0 with

previous install of DB2 client v7.

Error: "SQL10007N Message "-1390"

could not be retrieved. Reason code:

"2"."

Toad is bundled with the IBM DB2 v9 client.

IBM does not support direct client migration

from v7 to v9, so installing Toad on a system

that has an existing v7 client may cause errors.

Solution:

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

assembly 'IBM.Data.DB2.9.1.0,

Version=9.1.0.2, Culture=neutral,

PublicKeyToken=7c307b91aa13d208'

or one of its dependencies. The

system cannot find the file specified."

You installed a commercial version of Toad

for DB2 after uninstalling the freeware version.

Solution:

You must remove run time information for the

freeware version of Toad from the .NET

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


45


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.

When installing Toad using Quest

Installer on Windows 7 64-bit,

Program Compatibility Assistant may

appear with “This program might not

have installed correctly” message.

Solution:

Select This program installed correctly to

continue installation. For more information,

see http://windows.microsoft.com/en-

PH/windows7/Program-Compatibility-

Assistant-frequently-asked-questions

Connection Issues


ERROR [08001] [IBM]

SQL1336N The remote host was

not found. SQLSTATE=08001

You are attempting to connect to a database version

that is not supported in Toad.

Solution:

Review the list of supported databases in the

Release Notes or Installation Guide.

ERROR [58031] [IBM]

SQL1031N The database

directory cannot be found on the

indicated file system.

SQLSTATE=58031

Catalog entries have not been imported or defined

for the connection.

Solution:

See "Configure DB2 Client Connections" (page 30)

for more information to determine the best method

for cataloging a database.

"The type initializer for

'IBM.Data.DB2.DB2Connection'

threw an exception."

or

"SUCCESS - unable to allocate

an environment handle."

A settings file might be corrupt.

Solution:

Rename your local settings directory so a new one

can be recreated.

To rename your local setting directory

1. Exit Toad.

2. Navigate to the following settings directory:

C:\Documents and Settings\

UserName\Local

http://windows.microsoft.com/en-PH/windows7/Program-Compatibility-Assistant-frequently-asked-questions








46


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.

Other Issues


Unable to capture Container

Information in DB2 for LUW

Multi-Partition Databases

Certain Toad functions require that the DFT_

MON_BUFPOOL database manager configuration

parameter be set to ON to capture information on

containers used in DB2 for LUW databases.

Additionally, to capture container information

across all partitions in a multi-partition database,

the snapshot monitor requires that all database

partitions be active. To activate all database

partitions (and keep them active), execute the DB2

command ACTIVATE DATABASE real_

database_name on the server before connecting

Toad to the database. See your IBM DB2 for Linux,

Unix, and Windows documentation for more

information about this command.

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

Installation Issues


Error: "Could not load file or

assembly 'IBM.Data.DB2.9.1.0,

Version=9.1.0.2, Culture=neutral,

PublicKeyToken=7c307b91aa13d208'

or one of its dependencies. The

system cannot find the file specified."

You installed a commercial version of Toad

for DB2 after uninstalling the freeware version.

Solution:

You must remove run time information for the

freeware version of Toad from the .NET

system.config file.

To remove run time information


47


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.

When installing Toad using Quest

Installer on Windows 7 64-bit,

Program Compatibility Assistant may

appear with “This program might not

have installed correctly” message.

Solution:

Select This program installed correctly to

continue installation. For more information,

see http://windows.microsoft.com/en-

PH/windows7/Program-Compatibility-

Assistant-frequently-asked-questions

Connection Issues


ERROR [08001] [IBM]

SQL1336N The remote host was

not found. SQLSTATE=08001

You are attempting to connect to a database version

that is not supported in Toad.

Solution:

Review the list of supported databases in the

Release Notes or Installation Guide.

ERROR [58031] [IBM]

SQL1031N The database

directory cannot be found on the

indicated file system.

SQLSTATE=58031

You do not have any catalog entries defined for the

connection.

Solution:

See "Configure DB2 Client Connections" (page 30)

for more information to determine the best method

for cataloging a database.

ERROR [42501] [IBM][DB2]

SQL0551N "UserName" does

not have the privilege to perform

You do not have SYSADM privileges for the DB2

for z/OS subsystem.

Solution:









48


operation "SELECT" on object

"SYSIBM.SYSSTMT".

SQLSTATE=42501

Ensure that you are granted SELECT permissions

on the DB2 catalog tables.

ERROR [] [IBM] SQL1460N

The environment variable

"SOCKS_NS" required for

SOCKS server name resolution is

not defined or not valid.

When using the Time-Sharing Option (TSO) to

connect, the user ID, port number, or IP address

entered may be incorrect.

Solution:

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

ERROR [56038] [IBM][DB2]

SQL0969N There is no message

text corresponding to SQL error

"-4700" in the message file on

this workstation.' when

connecting to compatibility

mode database.

-or-

After connecting, some objects

do not display properly or some

functionality does not work as

designed.

In general, Toad does not support a z/OS subsystem

running in Compatibility mode.

Solution:

If possible, switch the subsystem's operating mode

to Full Function mode.

If this is not possible, Toad now provides a message

when you connect to subsystem, informing you of

that the subsystem is running in compatibility mode

and that some features might not be available.

Other Issues


[IBM][CLI Driver][DB2]

SQL0104N An unexpected

token "/*" was found following

"". Expected tokens may include:

"FROM INTO".

SQLSTATE=42601

The SQL script that you attempted to execute

contains commented text delimited by characters

that DB2 for z/OS 8 or earlier does not support.

Solution:

Set an option in Toad that removes comments

automatically from a script before you execute it.

To have Toad remove comments automatically

from SQL before execution

1. Select Tools | Options | Database | DB2 |


49


General.

2. Select Remove comments from SQL

statements prior to execution.

Poor performance when

browsing DB2 for z/OS objects

in Toad. Indexes are populated

slowly.

User-defined indexes on specific system catalog

tables can improve performance when you are

browsing DB2 for z/OS objects in Toad. The

following link contains the DDL for indexes that

can optimize Toad performance on your DB2 for

z/OS subsystem. Keep in mind that the creation of

these indexes is a recommendation only. The

indexes can have different results in different

environments, depending on the number of DB2

objects and the amount of data involved. To create

these indexes, edit and run the DDL contained in

the following file:

ToadDB2zOSIndexes.txt

Additionally, if the schema drop-down lists in the

Object Migration wizard populate slowly, consider

creating an index on the SCHEMA and CREATOR

columns in the catalog table for each object type.

Here is a list of some of the object-type tables:

SYSIBM.SYSSYNONYMS

SYSIBM.SYSSEQUENCES

SYSIBM.SYSROUTINES

SYSIBM.SYSTABLES

SYSIBM.SYSDATATYPES

SYSIBM.SYSINDEXES

SYSIBM.SYSTRIGGERS

SYSIBM.INDEXES

Encountering the S378 Abend

when running IBM DB2 z/10

subsystem in Conversion mode

with older versions of Toad.

This issue appears because Quest z/OS Component

tries to references QUEST.QC200ZPARM function.

Solution:

DROP QUEST.QC200ZPARM function from your

DB2 z/OS 10 subsystem. This will eliminate the

possibility of the function being called into the

WLM environment procedure and causing the S378

abend.

We do not recommend you to just STOP

QUEST.QC200ZPARM function on the mainframe

side, without actually dropping it, because that may

case Toad or batch process (QCEXEC – remote job

execution) hang. Dropping QUEST.QC200ZPARM

function is recommended.

http://toadfordb2.com/jiveHome/themes/toadfordb2/sbin/releasenotes/latest/ToadDB2zOSIndexes.txt

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiple

revisions of objects. See "Configure Version Control" (page 51) for more information on

configuring version control in Toad.

Important: See "Troubleshoot Version Control" (page 56) for more information about issues

when upgrading version control from a previous version.

Notes:

l Version Control can be configured for IBM DB2 LUW 9.1, 9.5, 9.7, 10.1 and IBM

DB2 z/OS 9, 10.

l If you want to place database objects under version control, you must configure

version control for objects using the Object Explorer. See "Manage Objects under

Version Control" (page 53) for more information.

l If you rename a version controlled object, Toad drops the original object and its

history from version control and prompts you to add the renamed object to version

control. This newly renamed object does not have any history associated with it.

l Currently, CLR objects are not supported by version control.

Prerequisites

You must install a supported version control client on the computer where Toad is

installed. The following table lists the supported version control providers and the versions

tested with Toad.

Supported

Provider

Server Version

Tested

Client Version Tested

Subversion Subversion 1.5.6

on Windows

Note: Toad only

supports

Subversion 1.5.6

or later.

CollabNet Subversion Command-Line Client 1.5.6

Notes:

l Toad only supports Subversion 1.5.6 or

later.

l Any Subversion client must have svn.exe in

its installation directory to use version

control in Toad.

l Tortoise SVN is no longer supported in

Toad because it no longer includes svn.exe

in its installation directory.

Toad for IBM DB2 Installation GuideConfigure Version Control

51

Supported

Provider

Server Version

Tested

Client Version Tested

Team

Foundation

Server

(TFS)

TFS 2008, 2010 Visual Studio (2008, 2010) Team Explorer Client

File system

based

Toad allows to utilize practically any version control system using the

external client tool. In this case Toad Version Control tool works with

the directories at local HDD while you commit changes to the repository

with version control client tool.

Note: Toad connects to your version control system based on login information included

in the configuration. Your version control client does not need to run for Toad to

connect.

The following objects can be added to Version Control:

ALIAS

DISTINCT TYPE

INDEX

MQ TABLE

SCHEMA

SEQUENCE

TABLE

TRIGGER

USER

VIEW

FUNCTION

PROCEDURE

Configure Version ControlTo configure version control

1. Ensure that a supported version control client is installed on the computer where Toad

is installed. See "About Version Control" (page 50) for more information about tested

version control clients and supported versions.

2. Right-click one or more objects in the Object Explorer and select Version Control |

Version Control Wizard.

Note: Version control is configured for entire LUW database or z/OS subsystem.



52

Version Control

System Page

Description

Type Select the version control system name:

l Subversion

Note: The version number beside Subversion is an

internal file definition used by Toad to check if an

update for this file is available. It is not the actual

version number for the version control provider.

l Team Foundation Server

Note: If you select TFS, you must specify the

workspace name for the provider in the Team

Foundation Server Properties window that

displays.

l File system based

Properties (Subversion only) Click this button (beside the Type

field) and complete the binary path. Enter the path where

the Subversion client that contains svn.exe is installed.

For example, if you installed the CollabNet Subversion

Client, you would enter:

C:\Program Files\CollabNet Subversion Client

Note: Do not include svn.exe in the path.

Server Select one of the following:

l Subversion—Specify the existing working folder

for the version control repository or specify the

server string (for example: svn://MyServer).

l TFS—Specify the server where your version

control provider is installed and the port number

(default is 8080) to use in the following format:

o http://MyServer:Port for TSF 2008

o http://MyServer:Port/TFS for TFS 2010

l File System Based—Specify a directory at your

local machine.

User name/

Password

Enter your Subversion command-line user name and

password and click Login.

Note: For TFS only, if you leave the user name and

password fields blank, Toad uses your default Windows

credentials.

Default Version

Control Settings

Page

Description


53

Version control

folder

Select the folder on the version control server where you

want to check objects in.

If you already have objects under version control, select

the folder on the server where these objects are located.

Note: Version control automatically checks out objects in

this folder and any subfolders to the location you specify

in the Working folder field.

Working folder Select the root repository folder on the client computer to

use as the default working folder for checking objects

out. If you already have objects under version control,

select the existing working folder for these.

4. Manage object and scripts using Version Control. See "Manage Objects under Version

Control" (page 53) for more information.

Manage Objects under Version ControlNote: Version Control should be configured in Toad before you start managing objects. See

"Configure Version Control" (page 51) for more information.

To add objects under version control

» Right-click an object and select Commit.

Tips:

l The objects under version control are marked with sign at the top right corner of

the object's icon.

l If you rename a version controlled object, Toad drops the original object and its

history from version control and prompts you to add the renamed object to version

control This newly renamed object does not have any history associated with it.

To manage objects under version control

1. Determine object's version control status. Hover a mouse over the object in the Object

Explorer to see its status. Review the following for additional information:

Version Control

status

Description

Uninitialized The object status is undetermined yet. This is a

temporary status that is issued for all objects during

version control status processing.

Untracked The object is not added to version control.


54

Version Control

status

Description

Ignored The object is added to ignore list and excluded from

version control.

UpToDate The object is under version control and is synchronized

with version control repository. No changes are

detected.

Modified The object is under version control and has been

modified by user. The changes are stored in local

database only and need to be synchronized with version

control repository.

Merge The object is under version control and has been

modified in both local database and version control

repository.

Note:: Toad's Version Control feature does not allow to

merge object scripts.

OutOfDate The object is under version control and has been

modified in version control repository.

Unknown The object is under version control but for some reason

its status cannot be determined (for example, you

created a script in your local database while the script

with the same name already exists in version control

repository).

Deleted The object was under version control, but it was

dropped or renamed in local database and exists only in

version control repository.

Tip: You can see deleted objects in the Controlled

objects pane only. To access it right-click any object

and select Show perspective. Once you commit changes

in Controlled objects pane, the object with all history

will be deleted from version control repository.

NotInView The object is under version control and exists in version

control repository only.

2. Right-click an object and select one of the following actions:

Use To...

Show perspective Select to review all controlled objects for current

configuration.


55

Use To...

Diff Select to review differences between the object script in

your local database and the object's revision that was

applied to it.

Note: Diff is unavailable for File System Based

configuration.

Diff with latest

revision

Select to review differences between the object script in

your local database and the latest revision in the version

control repository.

Example: You got the latest object revision from the repository 2 days ago. By

the time you did it, the latest revision was 5. Yesterday your colleague worked

with the same object and committed changes in the repository, which are now

marked as revision 6.

Today you altered the object's script and want to see the differences. You can

select one of the following:

l Diff—To compare the object in your local database with revision 5.

l Diff with latest revision—To compare the object in your local database

with revision 6.

Show history Select to review all commits for selected object.

Tip: Select Show history on database to review all

commits.

Note: Show History is unavailable for File System

Based configuration.

Get latest revision Select to apply object's changes from the version control

repository to your local database. The synchronization

script is generated to update selected object to the latest

revision.

Commit Select to apply object's changes from your local

database to the version control repository.

Note: You should write a comment when committing

changes.

Undo changes Select to rollback changes in your local database. The

synchronization script is generated to revert object to

the revision which was a applied last time.

Update status Select to compare a script in your local database with

the script in the repository. New status will be issued

according to the comparison results.

Add to ignore list Select to exclude object from the version control.


56

Use To...

Ignored objects are not listed in Controlled Objects

pane, Commit and Get latest revision are disabled.

Remove from ignore

list

Select to set object status as Untracked and add it to

version control.

Open in Windows

Explorer

Select to navigate to the file in the Windows Explorer.

Tip: You can enable, disable, or delete a version control configuration under Tools |

Options | Version Control | Configurations.

Troubleshoot Version Control

Troubleshoot Upgrades

For this release, the back-end of version control has been rewritten. If you previously used

version control in Toad, the following may occur:

l Version control settings are not migrated from the previous version of Toad, so you

have to reconfigure version control in Toad.

l In previous releases, the method Toad used to generate the script was different than

the current method. After upgrading Toad and reconfiguring version control, the local

revision of the objects differs from version control repository (The objects have

Unknown status). If the object in your database is current, you should commit it into

version control.

Troubleshoot Other Issues

Review the following to help troubleshoot issues with version control:

Subversion

Issues

Description

System cannot

find file

If a message stating that, “The system cannot find the file specified”

displays, this usually means that the Subversion executable cannot

be found in the path you specified in the BinaryPath field of the

Command Based Version Control Properties window. Verify that

svn.exe exists in the directory you specified in this field

Command

execution

When executing Subversion commands, user input is not allowed.

This presents an issue when the user is using Subversion with the

SSH method and must enter a password to establish the Secure

Shell.


57

Workaround:

Generate identity keys that automatically authenticate between the

client and the server when connecting with SSH.

OutOfMemory

exception

when adding

a large

number of

objects

When adding a large number of objects, Subversion may encounter

OutOfMemory exception.

Workaround:

Commit objects in several steps.

TFS issues Description

Cannot

configure

version

control on

TFS 2008

with Team

Explorer

Client 2008

installed.

To run version control on TFS 2008 Toad requires Visual Studio

2010 Team Explorer Client to be installed on your computer. You

do not need to install any other Visual Studio 2010 components.

Object Issues Description

Adding

multiple

objects failed

When you add multiple objects to version control, the objects are

grouped and added in batches (for example, all the tables for a

particular schema are added at once). If an error (for example, failure

to support Korean characters) causes this command to fail, none of

the objects are added.

Script Issues Description

Canceled

check-in

SQL scripts remain checked out if a change was made to the text,

but check-in was canceled during the prompt for a check-in

comment. This behavior is by design—that is; the user can either

undo the checkout or check in the script.

Note: If you alter the object again, you receive a prompt to use the

“locally changed” script. Click Yes to use the locally changed

copy; click No to refresh the local copy from the source repository;

click Cancel to cancel the prompt.

Appendix: Contact Quest

Contact Quest SupportQuest Support is available to customers who have a trial version of a Quest product or who

have purchased a Quest product and have a valid maintenance contract. Quest Support

provides unlimited 24x7 access to our Support Portal at www.quest.com/support.

From our Support Portal, you can do the following:

l Retrieve thousands of solutions from our online Knowledge Base

l Download the latest releases and service packs

l Create, update and review Support cases

View the Global Support Guide for a detailed explanation of support programs, online

services, contact information, policies and procedures. The guide is available at:

www.quest.com/support.

Toad Community

Get the latest product information, find helpful resources, and join a discussion with the Toad

for DB2 team and other community members. Join the Toad for DB2 community at

http://toadfordb2.com/index.jspa.

Contact Quest Software

Email [email protected]

Mail

Quest Software, Inc.

World Headquarters

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 SoftwareEstablished in 1987, Quest Software (Nasdaq: QSFT) provides simple and innovative IT

management solutions that enable more than 100,000 global customers to save time and

http://support.quest.com/

http://support.quest.com/

http://toadfordb2.com/index.jspa

mailto:[email protected]


Toad for IBM DB2 Installation GuideContact Quest Support

59

money across physical and virtual environments. Quest products solve complex IT challenges

ranging from database management, data protection, identity and access management,

monitoring, user workspace management to Windows management. For more information,

visit www.quest.com.

http://www.quest.com/database-management/

http://www.quest.com/database-management/

http://www.quest.com/data-protection/

http://www.quest.com/data-protection/

http://www.quest.com/identity-management/




http://www.quest.com/foglight/

http://www.quest.com/workspace/



http://www.quest.com/windows-management/

http://www.quest.com/windows-management/


Index

A

agent, Toad for DB2

installation 22

application virtualization 8

C

Citrix

install 24

requirements 8

client requirements 6

connections

configure DB2 client 30

create DB2 40

DB2 LDAP support 39

share for all session windows 29

troubleshoot DB2 LUW 44

troubleshoot DB2 z/OS 46

understand 29

contact support 58

corporate deployment 15

D

DB2

create connections 40

troubleshoot LUW issues 44

troubleshoot z/OS issues 46

desktop virtualization 8

I

install 13

Citrix 24

Citrix support 8

client requirements 6

debugging requirements on client

and subsystem 11

Quest IBM DB2 z/OS

component 22

Quest SQL Optimizer for DB2

LUW 22-23

silent 15

Toad for DB2 Agent 22

L

LDAP

DB2 support 39

license keys 27

M

manage objects under Version

Control 53

mst file 21

Q

Quest IBM DB2 z/OS component,

installation 23

R

requirements

Citrix 8

client 6

SQL procedure debugging 11

virtualization 8

Toad for IBM DB2 Installation GuideIndex

61

S

server virtualization 8

silent install 15

create transform file 21

Microsoft installer (MSI) 18

prerequisites 16

SQL Optimizer for DB2 LUW,

installation 22-23

Subversion, configure 51

system requirements 6

T

Team Foundation Server, configure 51

TFS, configure 51

Toad for DB2 Agent

installation 23

Toad SQL Tuning for DB2 z/OS,

installation 24

transform file 21

troubleshoot

DB2 LUW connections 44

DB2 z/OS connections 46

version control 56

U

uninstall 27

V

Version Control

about 50

configure Subversion 51

configure TFS 51

File system based 51

manage objects 53

troubleshoot 56

virtualization support 8

Date post:	15-Jul-2020
Category:	Documents
Upload:	others
View:	3 times
Download:	0 times