Toad for DB2 Installation Guide · 2015. 12. 1. · ToadforIBMDB2InstallationGuide TableofContents...

Toad™ for IBM® DB2® 6.1

Installation Guide

© 2015 Dell Inc.ALL RIGHTS RESERVED.

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

The information in this document is provided in connection with Dell products. No license,express or implied, by estoppel or otherwise, to any intellectual property right is granted bythis document or in connection with the sale of Dell products. EXCEPT AS SET FORTH INTHE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FORTHIS PRODUCT, DELL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMSANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITSPRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL DELL BE LIABLE FOR ANY DIRECT,INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESSINTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE ORINABILITY TO USE THIS DOCUMENT, EVEN IF DELL HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES. Dell makes no representations or warranties withrespect to the accuracy or completeness of the contents of this document and reserves theright to make changes to specifications and product descriptions at any time without notice.Dell 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:

Dell Inc.Attn: LEGAL Dept5 Polaris WayAliso Viejo, CA 92656

Refer to our web site (software.dell.com) for regional and international office information.

Trademarks

Dell, the Dell logo, Quest, Benchmark Factory,Spotlight, SQL Navigator, vWorkspace, andToad are trademarks of Dell Inc. and/or its affiliates. Microsoft, Windows, Windows Server,Windows Vista, Visual Studio, SharePoint, Access and Excel are either registered trademarksor trademarks of Microsoft Corporation in the United States and/or other countries. Oracle isa trademark or registered trademark of Oracle and/or its affiliates in the United States andother countries. Citrix® and XenApp™ are trademarks of Citrix Systems, Inc. and/or one ormore of its subsidiaries, and may be registered in the United States Patent and TrademarkOffice and in other countries. IBM and DB2 are registered trademarks of InternationalBusiness Machines Corporation. Subversion is a trademark of the Apache SoftwareFoundation. Other trademarks and trade names may be used in this document to refer to eitherthe entities claiming the marks and names or their products. Dell disclaims any proprietaryinterest in the marks and names of others.

http://www.software.dell.com/

Toad for IBM DB2 6.1Installation GuideThursday, June 25, 2015

Table of Contents

Installation 6

System Requirements 6

Client Requirements 6

Server Requirements 7

Virtualization Support 7

User Requirements 7

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

Compile and Debug Requirements for Stored SQL Procedures 10

Install Toad 12

Specify Application Data Directory Location 12

Install Toad Silently 13

Determine Which Installer to Use 13

Silent Installation Prerequisites 14

Silent Installation Using the Executable 14

Silent Installation Using the Microsoft Installer 16

Install Other Toad Components 20

Toad for IBM DB2 z/OS Components 20

Toad for IBM DB2 LUW Agent 21

SQL Optimizer for DB2 LUW 21

SQL Optimizer for DB2 z/OS 21

Install Toad on Citrix® Systems 22

Upgrade Toad 22

Upgrade Automation Scripts and Scheduling Tasks 22

Upgrade Automation Scripts to Newer Version of Toad 23

Migrate Scheduling Tasks to Newer Version of Toad 24

Files Migrated During Upgrades 25

Toad for IBM DB2 Installation GuideTable of Contents

4

Uninstall Toad 27

Licensing 27

Notes for Toad for IBM DB2 Users 28

Create and Troubleshoot Connections 29

Understand Toad Connections 29

Toad Open Connections 29

Sharing a Connection Among Windows 29

Configure DB2 Client Connections 30

Configure DB2 Client Connections 30

Maintain DB2 Client Connections 36

Configure DB2 LDAP Support 38

Create Toad Connection Profiles for DB2 39

Create Connection Profiles 39

Manage Connections 41

Troubleshoot DB2 LUW Issues 42

Installation Issues 42

Connection Issues 43

Other Issues 44

Troubleshoot DB2 z/OS Issues 45

Installation Issues 45

Connection Issues 45

Other Issues 47

Configure Version Control 48

About Version Control 48

Prerequisites 48

Configure Version Control 49

Manage Objects under Version Control 51

Toad for IBM DB2 Installation GuideTable of Contents

5

Troubleshoot Version Control 55

Troubleshoot Upgrades 55

Troubleshoot Other Issues 55

About Dell 57

Contact Dell 57

Technical Support Resources 57

Toad Community 58

Index 59

Installation

System RequirementsReview the following client and database server requirements for Toad™ for IBM® DB2®.

Client Requirements

Before installing Toad, ensure that your client system meets the following minimum hardwareand software requirements:

Platform 1 GHz minimum

Memory 512 MB of RAM minimum, 1 GB recommendedNote: 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 DiskSpace

212 MB to run ToadAllocate additional space for the following components as needed(provided with Xpert Editions):

l If installing Dell™ SQL Optimizer for IBM® DB2® z/OS orDell™ SQL Optimizer for IBM® DB2® LUW, see the SQLOptimizer Release Notes for disk space requirements.

Note: The disk space required may vary based on the edition of Toadselected for installation.

OperatingSystem

Windows Vista® Service Pack 2 (32-bit or 64-bit)Windows Server® 2008 Service Pack 2 (32-bit or 64-bit)Windows Server® 2012Windows® 7 Service Pack 1 (32-bit or 64-bit)Windows® 8 (32-bit and 64-bit)Windows® 8.1 (32-bit and 64-bit)

.NETFramework

.NET 4.5

1

Toad for IBM DB2 Installation GuideInstallation

7

DatabaseClient

DB2® ClientToad requires that a DB2 Client version 9.7.6 through 10.5 beinstalled as default.Toad has been tested with the following versions of the DB2 Client:9.7.6, 9.7.9 ,10.1.0, 10.1.2, 10.1.3, 10.5.0, 10.5.2, and 10.5.3.

AdditionalRequirements

Web BrowserMicrosoft® Internet Explorer® 8.0 or laterNote: Toad may support other internet browsers but note that notesting was performed on it.

Server Requirements

Before installing Toad, ensure that your server meets the following minimum hardware andsoftware requirements:

DatabaseServer

IBM DB2 for LUW 9.1, 9.5, 9.7, 10.1, 10.5, 10.5.0.5IBM DB2 for z/OS 9, 10, 11Note: Toad may support IBM DB2 Express and SWE in addition tolisted above servers, but note that no testing was performed on it.

Virtualization Support

ApplicationVirtualization

Limited testing has been performed for Citrix® XenApp™ 5.0 onWindows Server 2003 and Citrix XenApp 6.5 on Windows Server2008 R2.Limited testing has been performed for Citrix support on WindowsServer 2003 Enterprise Server (Service Pack 2) using the MetaFramePresentation Server 5.0 and Citrix Presentation Server Clients 10.2.See "Install Toad on Citrix® Systems" (page 22) for more information.

DesktopVirtualization(VDI)

Toad has been tested with vWorkspace™ 7.6 running on WindowsServer 2008 R2 64-bit.

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

User Requirements

User Requirements to Install Toad

Only Windows Administrators and Power Users can install Toad.


8

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 can install Toad as long as this user belongs to the DB2ADMNS orDBUSERS group.

If an Administrator installs Toad, the Administrator can share the Toad shortcut icon on thedesktop 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 theWindows Start menu. As a workaround, Restricted Users can create a shortcut to Toadfrom 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 orDB2USERS group. To add the user to one of these groups, select Start | ControlPanel | Administrative Tools | Computer Management | System Tools | Local Usersand Groups | Groups | DB2ADMNS or DB2USERS.

l A Windows Vista user must be either an administrator or a standard user that belongsto an Vista Administrators group. Additionally, to enable full functionality in Toadwhen Vista’s User Access Control security feature is turned on, the standard user mustrun Toad as an administrator. (Right-click the Toad icon on the Vista desktop andselect Run as administrator.)

l A Windows Power User or Restricted User does not have the authority to add orremove DB2 catalog entries using the Toad Client Configuration wizard. However,these users can use the Import Profile function in the Toad Client Configurationwizard to import catalog entries to Toad.

l To take full advantage of Toad for DB2 LUW functionality, the user ID specified inthe Toad connection profile for each DB2 for LUW database connection requires theauthorizations listed in the following document:

ToadDB2LUWAuthorizations.xls

l As a minimum requirement to manage a DB2 for z/OS subsystem in Toad, the user IDdefined in the Toad connection profile for the subsystem must either have SYSADMprivileges or SELECT privileges on the DB2 catalog tables. For a complete list ofauthorizations (and corresponding GRANT statements) a user requires to take fulladvantage of Toad for DB2 z/OS functionality, refer to the following document:

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


9

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, anddelete it. All other users need only the ability to read the QuestSoftware.ToadSecuritytable 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 topicexplains how to add the Toad Security icons to your toolbar and how to define ToadSecurity 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 laterdatabases 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 Toad for IBM DB2 z/OS Components

Notes:

l Without the z/OS components installed, Toad for IBM DB2 provides limitedsupport for managing DB2 for z/OS subsystems. With the z/OS componentinstalled, you have access to a full range of Toad functionality needed tomanage DB2 subsystems.

See "Install Other Toad Components" (page 20) for more information.

l If no Toad for IBM DB2 z/OS components are installed on your subsystem, seethe Toad for IBM DB2 z/OS Components Installation Guide for installationrequirements and instructions.

l IBM stored procedure SYSPROC.DSNUTILU, installed and operational.

Notes:

l Toad requires SYSPROC.DSNUTILU to run DB2 utilities. For moreinformation about this stored procedure, see Appendix B of the IBM DB2Universal Database for z/OS Utility Guide and Reference.

l A 32K character-size limit exists for each utility statement executingthrough DSNUTILU.

l Certain table alterations require that Toad perform advanced alters involving multipleUNLOADs and LOADs of table data. Before executing these types of alterations,ensure that the Mask value defined for the Toad dataset template that generates theUnload datasets includes the &SEQ variable. This variable creates a unique name foreach Unload dataset. (The Unload dataset template is identified in Tools | Options |Database | DB2 | z/OS | Load/Unload.)

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


10

l When Toad migrates data from one subsystem to another, Toad invokes the IBMDB2 for z/OS UNLOAD and LOAD utilities. Ensure that the Reorg Unloaddataset template (identified in Tools | Options | Database | DB2 | z/OS | Reorg)generates a dataset that resides on a pack (VOLSER) accessible by both the sourceand 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 forLUW databases:

Component Requirements

Supported DB2Versions

DB2 for LUW 9 or later

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

Privileges On each DB2 database, EXECUTE authority on allSYSPROC.DBG_% procedures

l DB2 for z/OS Requirements

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


Supported DB2Versions

DB2 for z/OS 9 to 11

Each DB2Subsystem

l IBM DB2 stored procedure SYSPROC.DSNTPSMP,installed and operational (needed to compile storedprocedures in Toad)

l IBM DB2 installation job DSNTIJSD, executed (neededto debug stored procedures)

l IBM SYSPROC.DBG_% procedures, installed andoperational

z/OS IBM Unified Debugger Session Manager, installed andconfigured:DB2 for z/OS


11


1. Install and configure DB2UDSMD (the DebuggerSession Manager).

2. Start task DB2UDSMD, using default port number 4553.

Refer your systems administrator to the following link forinstructions on installing and configuring DB2UDSMD:http://www.ibm.com/developerworks/data/library/techarticle/dm-0903debugdatastudio/

Privileges l On each DB2 subsystem, EXECUTE authority on allSYSPROC.DBG_% procedures

l DEBUGSESSION system privilege (for continueddebugging of SQL procedures)

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


12

Install ToadToad for IBM DB2 is available in the following editions: Base, Professional and Xpert. DBAdmin Module is an add-on module that provides extended admin functionality and can beadded to any Toad edition.

Note: Your Toad for IBM DB2 license key determines the edition and will enable Toad forIBM DB2 functionality accordingly. In many cases, if functionality is disabled within Toadfor IBM DB2, you may not have an appropriate license to use it. When Toad is running, youcan see which components are licensed by selecting Help | About.

To install Toad

1. Run the Installer.

2. Accept the License Agreement.

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

Note:When installing Toad using Dell Software Installer on Windows 7 64-bit,Program Compatibility Assistant may appear with “This program might not haveinstalled correctly” message. Select This program installed correctly to continueinstallation.

Specify Application Data Directory LocationToad for IBM DB2 6.1 stores settings files in the user's Application Data directory. Thedefault location cannot be modified from within the application. Toad provides two methodsto change the default location: by using a Registry setting or by using a command switch ina Toad shortcut.

Use the Registry setting method to change the application data directory from Roaming toLocal. Use the command switch method to change the location to any new path.

To change Toad Application Data directory location from Roaming to Local

In the Registry under Toad for IBM DB2 (Computer\HKEY_CURRENT_USER\Software\Quest Software\Toad for IBM DB2\6.1), add LOCALSETTINGS with avalue 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 youmanually copy the settings files from the default location (Roaming directory) to the newlocation (Local directory). Copy the settings files BEFORE you add the Registry setting andBEFORE opening Toad.


13

Operating System Default Location New Location whenLOCALSETTINGS = 1

Windows VistaWindows Server 2008Windows 7

C:\Users\username\AppData\Roaming\QuestSoftware\Toad for IBMDB2 6.1

C:\Users\username\AppData\Local\QuestSoftware\ Toad for IBMDB2 6.1

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

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

Toad.exe --datadir="YourNewDirPath"

To instruct Toad to always use the new directory path, add the command switch and the newdirectory 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).

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 .msifrom the Dell Software Installer, provided with Toad Suite.

Determine Which Installer to Use

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

Installer Advantages Disadvantages

Executablefile (.exe)

Silent installation using the .exefile has the followingadvantages:

l Verifies whether theprerequisite software isinstalled, and if not,redirects you to thedownload location.

Silent installation using the .exefile has the followingdisadvantages:

l Cannot deploy customToad settings files orlicense keys.

l Installer automaticallyexits if the prerequisitesoftware is not installed.


14

Installer Advantages Disadvantages

MicrosoftInstaller file(.msi)

Supports deployment of Toadsettings files and license keys.

Silent installation using the .msifile has the followingdisadvantages:

l Requires manualverification anddownload of anyprerequisite software.

l Requires a manualuninstall of the previousversion of Toad usingAdd/Remove Programs.

Silent Installation Prerequisites

Before you perform a silent installation, you must install the following software on everycomputer where you are installing Toad:

l Microsoft .NET Framework 4.5

Silent Installation Using the Executable

Use the executable file to perform a silent install to the default directory (or to a differentdirectory) 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 theexecutable for Toad is located. (This file can be downloaded from the Dell SoftwareWeb 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 yourinstallation similar to the following command:

“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 overridesfor your installation.


15

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 inthe previous example) or v for a verbose log. See the logsection at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information aboutadditional logging options.Also, substitute “C:\temp\installLog.txt” in the examplewith the fully qualified name of the log file. Enclose thisvalue in double quotations. The installation process createsthis file if it does not exist. Otherwise, the existing file isoverwritten.

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 inwhich you want to install Toad. If you do not include thispath, the installation program defaults to: C:\ProgramFiles\Quest Software\Toad for IBM DB2 6.1.

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. Thisvalue allows any user to use the Toad shortcut onthe desktop after the installation completes.

l For a per-user installation, enter the empty stringvalue (“”) This value allows only the userspecified for USERNAME (and the user thatinstalled Toad) to see the Toad shortcut on thetarget desktop. If USERNAME is omitted, only theuser that installed Toad sees the shortcut.

Note: If you do not specify this property, the installationprogram defaults to a per-user installation.

USERNAME (Optional) Specify the user that intends to use Toad onthe target computer.Notes:

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


16

Option Description

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specifiedhere (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

l If ALLUSERS is omitted or defined with theempty string value ("") and you omit theUSERNAME option, only the user that installedToad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value isignored during installation.

COMPANYNAME (Optional) Specify the name of the company that ownsthis 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

For Toad purchased with the Suite you should extract the .msi from the Dell SoftwareInstaller first.

Extract MSI file from Dell Software Installer

The Dell Software Installer can be launched in "extraction mode," which allows you toextract the Toad for IBM DB2 MSI installer.

Note: You do not need to install the Dell Software Installer on any of the computers whereyou are silently installing Toad products. The Dell Software Installer is only used to extractthe required MSI files.

To launch the Dell Software Installer in extract mode

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

"ToadInstaller.exe" /extract

2. The Dell Software 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.


17

The Finish page has a link to the directory into which the files were extracted and alink to the log file for the extraction process (Readme.txt). The extraction log containsverification of the files that have been extracted along with the command-lineswitches required for performing the default installation. You must run the installers inthe 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 msiinstaller 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 similarto 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 bto hide the Cancel button during the installation.

Note: All command-line options are case-insensitive. Seehttp://msdn2.microsoft.com/en-us/library/aa367988.aspx for a complete list ofcommand-line options.

Toad Default Installation Option Overrides

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

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory inwhich you want to install Toad. If you do not include thispath, the installation program defaults to: C:\ProgramFiles\Quest Software\Toad for IBM DB2 6.1.

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


18

Option Description

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. Thisvalue allows any user to use the Toad shortcut onthe desktop after the installation completes.

l For a per-user installation, enter the empty stringvalue (“”) This value allows only the userspecified for USERNAME (and the user thatinstalled Toad) to see the Toad shortcut on thetarget desktop. If USERNAME is omitted, only theuser that installed Toad sees the shortcut.

Note: If you do not specify this property, the installationprogram defaults to a per-user installation.

USERNAME (Optional) Specify the user that intends to use Toad onthe target computer.Notes:

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specifiedhere (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

l If ALLUSERS is omitted or defined with theempty string value ("") and you omit theUSERNAME option, only the user that installedToad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value isignored during installation.

COMPANYNAME (Optional) Specify the name of the company that ownsthis installation.

Notes:

l All default installation option overrides are case-sensitive.

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

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 alsouse the .msi file to perform a basic silent install using the default directory (or install to adifferent directory) and to specify command-line options and default installation overrides.See "Perform Silent Installation Using MSI" (page 17) for more information if you are notcreating a transform file.


19

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad onWindows Vista or 7 with UAC enabled, you can install a file that adds a "Run asadministrator" option when right-clicking the MSIfile: 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 WindowsInstaller is installed. After customizing Toad settings, you will use the Wise Installerto 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.

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 alicense key.

4. Select Tools | Configuration Wizard from the Toad menu and complete theConfiguration 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. Theseoptions create a module settings folder and files.

7. Select View | Connection Manager from the menu in Toad to open theConnection Manager.

8. Create any connections you want to deploy.

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

10. Create the Microsoft Transform file, using any appropriate tool. The following stepsdescribe 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 Transformtemplate in the New Installation File window.

c. Select the ToadInstaller.msi file in the Select the .MSI file to base thistransform on window.

d. Save the project.

e. Select Files from the Feature Details view.

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


20

f. Locate the following files and click Add to add them to the project:

File to Add Windows Server 2003 Windows Vista,Windows Server 2008,Windows 7, Windows 8

Settings.xml C:\Documents andSettings\username\ApplicationData\Quest Software\Toad for IBM DB2 6.1.

C:\Users\username\AppData\Roaming\Quest Software\Toad forIBM DB2 6.1.

ModuleSettingsfolder and files

C:\Documents andSettings\username\ApplicationData\Quest Software\Toad for IBM DB26.1\ModuleSettings.

C:\Users\username\AppData\Roaming\Quest Software\Toad forIBM DB26.1\ModuleSettings.

Connections.xml C:\Documents andSettings\username\ApplicationData\QuestSoftware\Toad for IBMDB2 6.1.

C:\Users\username\AppData\Roaming\Quest Software\Toad forIBM DB2 6.1.

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

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

Install Other Toad ComponentsDepending on your Toad license type, additional Toad components might be available. Seethe following sections for information about installing these components:

l Toad for IBM DB2 z/OS Components (page 20)

l Toad for IBM DB2 LUW Agent (page 21)

l SQL Optimizer for DB2 LUW (page 21) - Included in Toad™ for IBM® DB2® XpertEdition.

l SQL Optimizer for DB2 z/OS (page 21) - Included in Toad™ for IBM® DB2®Xpert Edition.

Toad for IBM DB2 z/OS Components

The Toad for IBM DB2 z/OS components enable you to take full advantage of Toadfunctionality on your DB2 for z/OS subsystem. If you do not have the z/OS componentsinstalled, Toad still provides some basic functionality to manage your DB2 for z/OS


21

subsystems. However, with the z/OS component installed on your DB2 subsystem, you canperform 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 DB2generates 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/OSdatabases, 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 toall users belonging to the RACF group

The z/OS components should be installed on each subsystem that you wantToad to manage.For a complete description of system requirements and installation instructions for thiscomponent, refer the Toad forIBM DB2 z/OS Components Installation Guide.

Toad for IBM DB2 LUW Agent

LUW Remote Script Execution Wizard has been modified to generate scripts that can beexecuted natively in the DB2 CLP on the database server. This eliminates the need for theToad for IBM DB2 Agent which is no longer shipped with Toad.

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 theSQL on which you are working in the Editor. See the SQL Optimizer for IBM DB2 LUWInstallation Guide for requirements and installation instructions.

SQL Optimizer for DB2 z/OS

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


22

Install Toad on Citrix® SystemsToad must be installed on the Citrix server by the Citrix administrator. Users then connect tothis instance through their Citrix login.

Note: Limited testing has been performed for Citrix XenApp™ 5.0 support on WindowsServer® 2003 and for Citrix XenApp 6.5 on Windows Server 2008 R2.

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 IBM DB2 andclick 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 onlyneed 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) from the DVD ordownloaded file.

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

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

To migrate the settings again, remove or rename the current version's Application Data folderand migrate the files from the previous version's Application Data folder.

Upgrade Automation Scripts and SchedulingTasksIf you upgrade to a newer version of Toad, Automation scripts created in a previous versionmust be upgraded before you can open them in the newer version. Toad prompts you to


23

automatically upgrade a script when you attempt to open it in a newer version.

In addition, scheduled scripts are scheduled to run using the version of Toad in which theywere created. After upgrading Toad, those previously-created, scheduled scripts will notexecute in the newer version until you migrate each script's scheduling task. Toad promptsyou to migrate scheduling tasks when you initially launch the application after installation.

Upgrade Automation Scripts to Newer Version of Toad

An automation script is compatible with the version of Toad in which the script was created.If you want to open and/or modify a script using a newer version of Toad, you must upgradethe script. Toad automatically prompts you to upgrade the script the first time you open it inthe newer version.

To upgrade an Automation script

1. Open the script in Toad. Toad prompts you to upgrade the script.

2. To upgrade the script, select Yes.

Caution: If you upgrade an automation script, it will no longer be compatiblewith earlier versions of Toad.

3. Select No (and do not elect to save the script), to keep the script compatible with theprevious version.

4. If you selected Yes, Toad upgrades your script and saves a backup copy of theoriginal script in the following location:

\Automation\bak\

5. If the script you upgraded is also scheduled, you must migrate the scheduling task,otherwise the upgraded script will fail to run.


24

Migrate Scheduling Tasks to Newer Version of Toad

Each scheduled Automation script uses a Windows scheduling task. The scheduling taskspecifies which version of Toad to use by specifying the version's application path. Toadprovides you with two easy ways to migrate your scheduled scripts' scheduling tasks whenyou upgrade Toad. First, Toad prompts you to migrate scheduling tasks upon initial launch ofthe application after installation. Next, you can migrate scheduling tasks at any time usingthe Job Manager.

Notes:

l If you upgrade a previously-created script by opening it in a newer version of Toad,you must also migrate the scheduling task to the newer version.

l If you install the newer version of Toad side-by-side with the older version,previously-created, scheduled scripts will continue to execute using the older version,until you migrate the scheduling tasks (provided that you do not open the scripts inthe newer version).

To migrate scheduling tasks upon initial launch

1. After upgrading Toad, and upon initial launch of the application, the MigrateScheduled Tasks dialog opens.

2. Select the scheduled tasks (scheduled Automation scripts) to migrate to the newversion of Toad.

3. Click OK to close the dialog.

4. Toad immediately prompts you for your Windows password. Enter your password tomigrate the scheduled tasks.

To migrate scheduling tasks using the Job Manager

1. Select Tools | Administer | Job Manager.

2. Click on the Job Manager toolbar.

3. Select the scheduled tasks to migrate and click OK.

Note: Only currently-scheduled tasks (enabled or disabled) are listed in the MigrateScheduled Tasks dialog.

4. Toad immediately prompts you for your Windows password. Enter your password tomigrate the scheduled tasks.

Manually Edit Scheduling Tasks

On occasion you may need to modify the application path in a Windows scheduling task.You can do this by manually editing the scheduling task using the following procedure.


25

To manually edit a scheduling task

1. In the Job Manager (Tools | Administer | Job Manager), right-click a task andselect Edit Task.

2. To change the version of Toad used to run the script, in the Run and Start in fields,change the folder name in the toad.exe path.

Files Migrated During UpgradesWhen upgrading to a new version of Toad, the following files can be migrated from theprevious version's Application Data Directory (click the Application Data Directory link inHelp | About to open the directory).

Caution! Migrating settings from a previous version of Toad may overwrite new settingsfiles, 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 sharethis data, the file is automatically sent to Dell on aperiodic basis.

Connections.xml Contains all connections stored in the ConnectionManager or the New Connection window.

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

ExceptionTrace.log Contains a log of all exceptions encountered whilerunning Toad.

FTPConnection.log Contains a log of exceptions encountered whenattempting to connect to FTP servers.

FTPConnections.xml Contains connections to FTP servers stored in theFTP Connections window.

Quest.PersistentCache.xml Contains the private object annotation cache options(object notes, Lookup tables, and hidden columns). Youcan 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 (temporaryfolder)

Used by automation when executing automation scripts.

Cache Used to spool cache database metadata to disk ifenabled. The data is in binary format and can always berecreated by fetching it from the database.

Context Contains settings that depend on the context withinToad including the following:

l Adapter—Custom data editing statements.

l Filter—Unnamed filters defined in the ObjectExplorer or Database Explorer.

l Named Filter—Named filters defined in theObject Explorer or Database Explorer.

l TYPE—Tabs that display on the right when youselect an object in the Object Explorer orDatabase Explorer.

Document Recovery Contains backup copies of Editor, Query Builder, andDatabase Diagram files saved if you have enabledDocument Recovery in Tools | Options | Environment |General.

Keyboard Contains custom keyboard shortcut layouts.

Layouts Contains layouts for some areas in Toad, such as toolwindows that automatically display in the Editor andcolumn layouts for the Messages tab.

ModuleSettings Contains general settings for various components inToad, 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 toolbarcustomizations and tool window locations.

SQLFormatter Contains pre-set and user created templates forformatting SQL, and the SQL statement used to previewformatting changes in the Formatting Options page.

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:

l Code Templates—Templates used to define


27

default values when creating new objects in theObject 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 newfiles such as SQL scripts, data output, or temp files, etc. The following types of files are notremoved 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 IBM DB2 by using the Windows install/uninstallprograms feature.

To uninstall Toad

1. Open the Windows Control Panel and select Programs and Features. (In WindowsXP, select Add/Remove Programs.)

2. Select the product that you want to uninstall.

3. Click Uninstall.

LicensingTo enter your license key

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.

Note: Your license key determines the edition of Toad (Pro, Xpert, etc.) and willenable the functionality accordingly. In many cases, if functionality is disabled withinToad, you may not have an appropriate license to use it. When Toad is running, you


28

can see which components are licensed by selecting Help | About. For complete list offeatures shipped with your Toad edition see http://software.dell.com/.

Note: The license is provided for all products and Toad components purchased withinToad for IBM DB2 Edition.

Notes for Toad for IBM DB2 Users

Trial Keys

The commercial version of Toad for IBM DB2 comes pre-installed with a trial license key foryour convenience. This allows you to use the application while waiting for your commercialkey to be delivered.

The trial license key remains active for the designated trial period, even after you enter yourcommercial license key (the splash screen may continue to indicate your application is a trialversion). 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 candelete the trial key.

Important: If you delete the Trial key, any advanced features not included in your purchasededition will be disabled.

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 clickDelete License to delete the trial key.

DB Admin Add-on and DBA Suite Keys

DB Admin Add-on Module is included in Toad for DB2 DBA Suite or can be purchasedwith any commercial Toad edition. It includes a large set of database administration tools.LUW DB Admin Add-on also enables Toad for DB2 z/OS freeware functionality, while z/OSDB Admin Add-on enables Toad for DB2 LUW freeware functionality.

http://software.dell.com/

Create and Troubleshoot Connections

Understand Toad ConnectionsReview this topic to learn about open database connections in Toad.

Toad Open Connections

In Toad, an open connection in the Connection/Navigation Manager represents one or moreactual connections to the database. When you open a database connection in Toad:

l Toad creates an initial database connection for general use.

l Toad also creates a separate database connection for each Editor (the first time youexecute a statement) and for each Data tab in the Database Explorer (the first time youselect the tab and query data).

The connection associated with the window (or tab) remains open until you close thewindow. If a window has an associated connection, but a statement is not currentlyexecuting, the connection is in an inactive state.

To view information for an open connection

l To view the number of actual database connections that exist for a Toad connection,including the number of active connections, place the cursor over the connection inthe Connection/Navigation Manager pane or in the connection drop-down list.

To use the Background Processes pane

l When a statement is executing, a progress bar displays in the Status bar located at thebottom of the Toad application window. Click the executing progress bar to open theBackground Processes pane.

l To cancel statement execution, use the Background Processes pane.

Note: It is recommended that you cancel only your own processes, becauseterminating Toad activities could cause unexpected behavior.

Sharing a Connection Among Windows

You can instruct Toad to share an open connection among windows. In this way, the Editorwindows and Data tabs can share the same connection when the connection is inactive.

To share a database connection among windows in Toad

1. Select Tools | Options | Editor | General.

2. Clear the checkbox for the Use individual connection for each open editor option.

Toad for IBM DB2 Installation GuideCreate and Troubleshoot Connections

30

3. When this option is not selected, Toad attempts to use a single connection for anynew windows or query execution. For example, if you share a database connection,you can execute a query in the Editor, execute another query in a new Editor, andthen select the Data tab from the same connection.

If the single connection is in use when Toad attempts to execute it, thefollowing occurs:

l If your database supports executing multiple queries simultaneously on ashared connection, the query is placed in a queue and executes as soon as thecurrent operation completes.

l If your database does not support executing multiple queries on a sharedconnection, a dialog prompts you to either permanently associate the windowwith a new database connection, cancel the previous operation, or add thequery to a queue until the current operation completes, and the execute it. Ifyou place multiple queries in the queue, each one executes in the order that itwas added to the queue.

Note: Although you can share a database connection, any commits apply to the selectedwindow only.

Configure DB2 Client ConnectionsSetting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems thatToad will manage requires two main steps.

Step 1. Configure DB2 client connections - Before you can create a connectionprofile, each of the databases or subsystems must be cataloged on the DB2 client. Thistopic helps you with that process.

Step 2. Create connection profiles - Step 2 involves creating Toad connectionprofiles for the cataloged DB2 databases or subsystems. Each profile contains theinformation that Toad needs to connect to the system, such as the user ID andpassword, DB2 registry settings, and the default schema. See "Create Toad ConnectionProfiles for DB2" (page 39) for more information.

Configure DB2 Client Connections

Use one of the following methods to catalog each of the databases or subsystems onthe DB2 client.

Transfer a Catalog Any Time After Initial Setup

Use this method to transfer a catalog from another DB2 client on your machine to yourdefault DB2 client.


31

To transfer a catalog any time after initial setup

1. In the Connection Manager, click in the toolbar.

Note: If the Client Configuration Wizard opens, Toad found only one DB2client installed.

2. From the DB2 Client list, select the name of the DB2 client whose catalog you wantto transfer to your default DB2 client.

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

3. Click OK.

4. To create a connection in Toad for any of the transferred catalog entries, see CreateToad Connection Profiles for DB2 (page 39).

Import a DB2 catalog previously exported to a file

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.

5. Complete the wizard.

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

Note: DB2 does not automatically export catalog entries for the local DB2 instanceand its databases on the computer from which the export is run (unless these entriesalready exist in the catalog). Therefore, the profile you are importing might notinclude these node entries. To add the missing entries to your DB2 client catalog, youmust 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 31) for more information.

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

Manually catalog DB2 for LUW databases


32

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 Welcomepage displays, showing the 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 thetree, select them. These selections pre-fill certain fields required later in the wizardprocess. If these names are not listed, you must provide the necessary host and nodeinformation later in the wizard.

3. Click Add Catalog Entry.


Add a Host Description

Operatingsystem

Select the operating system for the server on which the DB2for LUW instance containing the DB2 database you arecataloging 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 serveron which the DB2 database resides.

Port number Enter the port number for the server on which the DB2database resides.

Security type Select a secure protocol to handle TCP traffic for thisconnection.

Specify anInstance

Description

Node name Enter a user-defined name for the DB2 instance containingthe database you are cataloging.If you selected the node name from the tree on the Welcomepage, this information is pre-filled (but you can update it asneeded).

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


33

system.

Authentication Select the authentication method that is required to connectto the database.

Targetprincipal

Enter the service account name for server's service where thedatabase resides.Note: This option is available only when Kerberos isselected as the authentication method.


The Database alias drop-down list in the Connections window shows the alias for thenewly cataloged database. To complete the Toad connection setup, you must create aToad connection profile for the database. See "Create Toad Connection Profiles forDB2" (page 39) for more information.


34

Manually catalog DB2 for z/OS subsystems

Note: If you connect directly to a DB2 for z/OS subsystem, you cannot take advantage ofSysplex. If you want to use Sysplex, catalog an entry to a DB2 Connect gateway instead. See"Manually catalog DB2 Connect gateways " (page 35) 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 Welcomepage displays, showing the 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. Ifthe host name is not listed, you must provide the necessary host information later inthe wizard.




Operatingsystem

Select z/OS for the server operating system.

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

Portnumber

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

EnableSOCKSsecurity

Select this checkbox to enable the SOCKS secure protocol tohandle TCP traffic for this connection. SOCKS adds anauthentication mechanism for additional security.

Add a DB2Subsystem

Description

Locationname

Enter the location name of the DB2 subsystem as defined duringthe DB2 installation.

Databasealias

Enter a unique, user-defined alias to identify the DB2 subsystemon your system. You can use the same name you used in theprevious Location name field, as long as it does not alreadyexist in the list aliases in the DB2 client.


35

5. Complete the wizard. A message informs you whether the entry was addedsuccessfully.

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

Manually catalog DB2 Connect gateways

In order to connect to a DB2 for z/OS subsystem, you need to catalog two entries. First, youneed to catalog the DB2 subsystem on the DB2 Connect gateway. During this process, youdefine an alias for the DB2 subsystem. Second, you need to catalog this DB2 subsystem aliasin 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/OSdocumentation 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.




Operatingsystem

Select the operating system for the server on which the DB2Connect gateway resides.

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

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

EnableSOCKSsecurity

Select this checkbox to enable the SOCKS secure protocolto handle TCP traffic for this connection. SOCKS adds anauthentication mechanism for additional security.

Specify anInstance

Description

Node name Enter an alias for the user-defined node name you specify inthe Instance name field.

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


36

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

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 theDB2 Connect gateway.

Database alias Enter a unique, user-defined alias for the DB2 Connectgateway. You can use the same alias you used in theprevious Database name field, as long as it does not existin the list of Toad for DB2 aliases.

Authentication Select the authentication method that matches the methodspecified for the DB2 subsystem on the DB2 Connectgateway.


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

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

Maintain DB2 Client Connections

Additionally, Toad provides functionality to perform the following maintenance on thecatalog you set up for the current DB2 client:

Edit DB2 catalog entries

To edit a DB2 catalog entry


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

3. Click Edit Catalog Entry.


37

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

l Manually catalog DB2 for LUW databases (page 31)

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

l Manually catalog DB2 Connect gateways (page 35)

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 thecatalog entry completed successfully.

Remove DB2 catalog entries

To remove a DB2 catalog entry


2. In the catalog configuration tree for the DB2 client, expand one or more nodes, andselect the catalog entries that you want to remove. (Press CTRL+click to selectmultiple 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 removalscompleted successfully.

Export the catalog for the current DB2 client

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

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

To export the DB2 client catalog

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

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


38

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

(You might need to click this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the profile inwhich to export the current 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 (defaultfor exporting a 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 informationrequired for updating other instances

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

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

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

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

Configure DB2 LDAP SupportYou can create DB2 Lightweight Directory Access Protocol (LDAP) connections when theDB2 client installed with Toad is configured for LDAP. Configuring the client consists ofenabling 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 displaysthem in the Database Alias list in the Connections window.

Notes:

l You must configure LDAP support for the DB2 client installed with Toadregardless of whether an existing DB2 client on the computer is already configuredto support LDAP.


39

l Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toaddoes 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 selectingStart | All Programs | IBM DB2 | |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 theLDAP server:

db2set DB2LDAPHOST=

The port number defaults to 389 (default LDAP port) if you leave the portnumber 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, youmust create a Toad connection profile for each database. See "Create Toad ConnectionProfiles for DB2" (page 39) for more information.

Create Toad Connection Profiles for DB2Setting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems thatToad will manage requires two main steps.

Step 1. Configure DB2 client connections - Before you can create a connectionprofile, each of the databases or subsystems must be cataloged on the DB2 client. SeeConfigure DB2 Client Connections (page 30) to learn how to catalogdatabases/subsystems.

Step 2. Create connection profiles - Step 2 involves creating Toad connectionprofiles for the cataloged DB2 databases or subsystems. Each profile contains theinformation that Toad needs to connect to the system, such as the user ID andpassword, DB2 registry settings, and the default schema. This topic helps you createconnection profiles.

Create Connection Profiles

Use one of the following methods to create Toad connection profiles:


40

l Import Toad connection profiles previously exported to an XML file

(See "Export connection profiles to an XML file" (page 41) for more informationabout exporting a profile that you can later import.)

Note: The connection profiles are not usable unless you have also created entries inthe DB2 catalog for the DB2 databases and subsystems to which these profilescorrespond. 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.

2. From the Import Connections window, browse for and select the XML filecontaining 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 theConnections 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.


Databasealias

Select the alias for the DB2 database or subsystem. Thisalias was defined when you cataloged this DB2 databaseor subsystem on the DB2 client. See "Configure DB2Client Connections" (page 30) for more information if thealias does not display in the list.

Tip: Click to refresh the alias list. Normally, Toadcaches the DB2 catalog the first time you open thiswindow in your Toad session and continues to read fromcache each time you subsequently open this window. Thisbutton forces Toad to reread the DB2 catalog to list anynew systems that might have been cataloged externallyduring the caching period.

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


41

schema/authID

SET SCHEMA or SET CURRENT SQLID value (DB2 forz/OS) for this connection.

Category Select or create a category if you want to color codeEditor tabs for a specific connection. This can helpdifferentiate between development and productiondatabases. You can also set an option to color code theObject 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 effecteach time Toad connects to the DB2 database or subsystem.

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

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 orsubsystems, the Connections window lists all the configured connections, allowing you toperform 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 Toadconnection profiles to an XML file. You can then import these exported connectionprofiles into another Toad for DB2 installation. See "Import Toad connection profilespreviously exported to an XML file " (page 40) for more information.

To export connection profiles

1. In the Connections (or Create New Connection) window, select theconnections 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 theselected profiles.

l Import missing connections defined on the Toad client

You can import all connection entries currently defined in the DB2 client catalog but

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


42

missing from your current list of Toad connections.

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

To import missing connections

» In the Connections or Connections Manager window, click .

l Troubleshoot connection issues

Note: Click to open the Client Configuration Wizard. See "Configure DB2 ClientConnections" (page 30) for more information.

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

Troubleshoot DB2 LUW IssuesReview the following solutions to help troubleshoot DB2 LUW issues pertaining to Toadinstallation 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 nameDB2AdminWrapper, or one of itsdependencies was not found

You are not a member of the DB2ADMIN orDB2USERS group. To install Toad, you mustbe a member of either group.Solution:Ensure that you have been added to one ofthese groups.

Error: "Could not load file orassembly 'IBM.Data.DB2.9.1.0,Version=9.1.0.2, Culture=neutral,PublicKeyToken=7c307b91aa13d208'or one of its dependencies. Thesystem cannot find the file specified."

You installed a commercial version of Toadfor DB2 after uninstalling the freeware version.Solution:You must remove run time information for thefreeware version of Toad from the .NETsystem.config file.

To remove run time information

1. Exit Toad.


43


2. Navigate to the following .NETframework directory:C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG

3. Create a backup copy of thesystem.config file.

4. Open the system.config file in Notepad.

5. Locate the tag deleteeverything between the runtime tags(including and ).

6. Save the file.

7. Restart Toad.

When installing Toad on Windows 764-bit, Program CompatibilityAssistant may appear with “Thisprogram might not have installedcorrectly” message.

Solution:Select This program installed correctly tocontinue 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 wasnot found. SQLSTATE=08001

You are attempting to connect to a database versionthat is not supported in Toad.Solution:Review the list of supported databases in theRelease Notes or Installation Guide.

ERROR [58031] [IBM]SQL1031N The databasedirectory cannot be found on theindicated file system.SQLSTATE=58031

Catalog entries have not been imported or definedfor the connection.Solution:See "Configure DB2 Client Connections" (page 30)for more information to determine the best methodfor cataloging a database.

"The type initializer for'IBM.Data.DB2.DB2Connection'threw an exception."or

A settings file might be corrupt.Solution:Rename your local settings directory so a new onecan be recreated.

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


44


"SUCCESS - unable to allocatean environment handle."

To rename your local setting directory

1. Exit Toad.

2. Navigate to the following settings directory:

l Windows XP, Windows Server2003—C:\Documents andSettings\username\LocalSettings\Application Data\QuestSoftware

l Windows Vista, Windows Server2008, Windows 7—C:\Users\username\AppData\Roaming\Quest Software\

3. Rename the Toad for DB2 version# folder to"Toad for DB2 OLD".

4. Restart Toad and try to connect.

Notes:

l Make sure you can view hidden folders inWindows Explorer.

l To navigate to this directory quickly, clickthe Application Data Directory link in theAbout dialog (Help | About).

Other Issues


Unable to capture ContainerInformation in DB2 for LUWMulti-Partition Databases

Certain Toad functions require that the DFT_MON_BUFPOOL database manager configurationparameter be set to ON to capture information oncontainers used in DB2 for LUW databases.Additionally, to capture container informationacross all partitions in a multi-partition database,the snapshot monitor requires that all databasepartitions be active. To activate all databasepartitions (and keep them active), execute the DB2command ACTIVATE DATABASE real_database_name on the server before connectingToad to the database. See your IBM DB2 for Linux,Unix, and Windows documentation for moreinformation about this command.


45

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

Installation Issues


Error: "Could not load file orassembly 'IBM.Data.DB2.9.1.0,Version=9.1.0.2, Culture=neutral,PublicKeyToken=7c307b91aa13d208'or one of its dependencies. Thesystem cannot find the file specified."

You installed a commercial version of Toadfor DB2 after uninstalling the freeware version.Solution:You must remove run time information for thefreeware version of Toad from the .NETsystem.config file.

To remove run time information

1. Exit Toad.

2. Navigate to the following .NETframework directory:C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG

3. Create a backup copy of thesystem.config file.

4. Open the system.config file in Notepad.

5. Locate the tag deleteeverything between the runtime tags(including and ).

6. Save the file.

7. Restart Toad.

When installing Toad on Windows 764-bit, Program CompatibilityAssistant may appear with “Thisprogram might not have installedcorrectly” message.

Solution:Select This program installed correctly tocontinue installation. For more information,see http://windows.microsoft.com/en-PH/windows7/Program-Compatibility-Assistant-frequently-asked-questions

Connection Issues


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

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


46


SQL1336N The remote host wasnot found. SQLSTATE=08001

that is not supported in Toad.Solution:Review the list of supported databases in theRelease Notes or Installation Guide.

ERROR [58031] [IBM]SQL1031N The databasedirectory cannot be found on theindicated file system.SQLSTATE=58031

You do not have any catalog entries defined for theconnection.Solution:See "Configure DB2 Client Connections" (page 30)for more information to determine the best methodfor cataloging a database.

ERROR [42501] [IBM][DB2]SQL0551N "UserName" doesnot have the privilege to performoperation "SELECT" on object"SYSIBM.SYSSTMT".SQLSTATE=42501

You do not have SYSADM privileges for the DB2for z/OS subsystem.Solution:Ensure that you are granted SELECT permissionson the DB2 catalog tables.

ERROR [] [IBM] SQL1460NThe environment variable"SOCKS_NS" required forSOCKS server name resolution isnot defined or not valid.

When using the Time-Sharing Option (TSO) toconnect, the user ID, port number, or IP addressentered may be incorrect.Solution:Ensure that you use the following for TSOconnections:

l DB2 user ID for the DB2 subsystem

l Port number that DB2 listens on, for remoteconnections, via the DB2 DDF addressspace

l IP address for the z/OS subsystem

ERROR [56038] [IBM][DB2]SQL0969N There is no messagetext corresponding to SQL error"-4700" in the message file onthis workstation.' whenconnecting to compatibilitymode database.-or-After connecting, some objectsdo not display properly or somefunctionality does not work asdesigned.

In general, Toad does not support a z/OS subsystemrunning in Compatibility mode.Solution:If possible, switch the subsystem's operating modeto Full Function mode.If this is not possible, Toad now provides a messagewhen you connect to subsystem, informing you ofthat the subsystem is running in compatibility modeand that some features might not be available.


47

Other Issues


Poor performance whenbrowsing DB2 for z/OS objectsin Toad. Indexes are populatedslowly.

User-defined indexes on specific system catalogtables can improve performance when you arebrowsing DB2 for z/OS objects in Toad. Thefollowing link contains the DDL for indexes thatcan optimize Toad performance on your DB2 forz/OS subsystem. Keep in mind that the creation ofthese indexes is a recommendation only. Theindexes can have different results in differentenvironments, depending on the number of DB2objects and the amount of data involved. To createthese indexes, edit and run the DDL contained inthe following file:ToadDB2zOSIndexes.txtAdditionally, if the schema drop-down lists in theObject Migration wizard populate slowly, considercreating an index on the SCHEMA and CREATORcolumns in the catalog table for each object type.Here is a list of some of the object-type tables:

SYSIBM.SYSSYNONYMSSYSIBM.SYSSEQUENCESSYSIBM.SYSROUTINESSYSIBM.SYSTABLESSYSIBM.SYSDATATYPESSYSIBM.SYSINDEXESSYSIBM.SYSTRIGGERSSYSIBM.INDEXES

Encountering the S378 Abendwhen running IBM DB2 z/10subsystem in Conversion modewith older versions of Toad.

This issue appears because the Toad z/OSComponent tries to reference theQUEST.QC200ZPARM function.Solution:DROP the QUEST.QC200ZPARM function fromyour DB2 z/OS 10 subsystem. This will eliminatethe possibility of the function being called into theWLM environment procedure and causing the S378abend.We do not recommend that you to just STOP theQUEST.QC200ZPARM function on the mainframeside, without actually dropping it, because that maycase Toad or the batch process (QCEXEC – remotejob execution) to hang. Dropping theQUEST.QC200ZPARM function is recommended.

http://dev.toadfordb2.com/releasenotes/latest/ToadDB2zOSIndexes.txt

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiplerevisions of objects and SQL scripts . See "Configure Version Control" (page 49) for moreinformation on configuring version control in Toad.

Important: See "Troubleshoot Version Control" (page 55) for more information about issueswhen 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, 10.5 andIBM DB2 z/OS 9, 10. 11

l If you want to place database objects under version control, you must configureversion control for objects using the Object Explorer. Once configured, you canmanage SQL scripts there. The main advantage of managing scripts in the ObjectExplorer is that you can easily share them with team members who have versioncontrol configured. See "Manage Objects under Version Control" (page 51) for moreinformation.

l If you rename a version controlled object, Toad drops the original object and itshistory from version control and prompts you to add the renamed object to versioncontrol. 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 isinstalled. The following table lists the supported version control providers and the versionstested with Toad.

SupportedProvider

Server VersionTested

Client Version Tested

ApacheSubversion™

Subversion 1.7.5on Windows

CollabNet Subversion Command-Line Client1.7.5Note: Any Subversion client must have svn.exe inits installation directory to use version control inToad.

3

Toad for IBM DB2 Installation GuideConfigure Version Control

49

SupportedProvider

Server VersionTested

Client Version Tested

TeamFoundationServer (TFS)

TFS 2008, 2010,2012

Visual Studio® (2008, 2010, 2012) Team ExplorerClient

File systembased

Toad allows to utilize practically any version control system using theexternal client tool. In this case Toad Version Control tool works withthe directories at local HDD while you commit changes to therepository with version control client tool.

Note: Toad connects to your version control system based on login information includedin the configuration. Your version control client does not need to run for Toad toconnect.

The following objects can be added to Version Control:

ALIASDISTINCT TYPEINDEXMQ TABLESCHEMASEQUENCETABLETRIGGERUSERVIEWFUNCTIONPROCEDURESCRIPT

Configure Version ControlTo configure version control

1. Ensure that a supported version control client is installed on the computer where Toadis installed. See "About Version Control" (page 48) for more information about testedversion control clients and supported versions.

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

Toad for IBM DB2 Installation GuideConfigure Version Control

50

Note: Versi

Date post:	02-Feb-2021
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times