Toad for DB2 Installation Guide -...

48
Toad ® for IBM ® DB2 ® 6.5 Installation Guide

Transcript of Toad for DB2 Installation Guide -...

Page 1: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Toad® for IBM® DB2® 6.5

Installation Guide

Page 2: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

© 2017 Quest Software Inc.ALL RIGHTS RESERVED.

This guide contains proprietary information protected by copyright. The software described in this guide isfurnished under a software license or nondisclosure agreement. This software may be used or copied only inaccordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmittedin any form or by any means, electronic or mechanical, including photocopying and recording for any purposeother 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 Software products. No license, expressor implied, by estoppel or otherwise, to any intellectual property right is granted by this document or inconnection with the sale of Quest Software products. EXCEPT AS SET FORTH IN THE TERMS ANDCONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST SOFTWAREASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORYWARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTYOFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENTSHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE,SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OFPROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE ORINABILITY TO USE THIS DOCUMENT, EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES. Quest Software makes no representations or warranties with respect to theaccuracy or completeness of the contents of this document and reserves the right to make changes tospecifications and product descriptions at any time without notice. Quest Software does not make anycommitment to update the information contained in this document.

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

Quest Software Inc.Attn: LEGAL Dept4 Polaris WayAliso Viejo, CA 92656

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

Patents

Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product.For the most current information about applicable patents for this product, please visit our website atwww.quest.com/legal.

Trademarks

Quest, Quest Software, Benchmark Factory,Spotlight, SQL Navigator, vWorkspace, Toad, and the Quest logoare trademarks of Quest Software Inc. in the U.S.A. and other countries. For a complete list of Quest Softwaretrademarks, please visit our website at www.quest.com/legal. Microsoft, Windows, Windows Server, WindowsVista, Visual Studio, SharePoint, Access and Excel are either registered trademarks or trademarks of MicrosoftCorporation in the United States and/or other countries. Oracle is a trademark or registered trademark of Oracleand/or its affiliates in the United States and other countries. Citrix® and XenApp™ are trademarks of CitrixSystems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent andTrademark Office and in other countries. IBM and DB2 are registered trademarks of International BusinessMachines Corporation. Subversion is a trademark of the Apache Software Foundation. All other trademarks,servicemarks, registered trademarks, and registered servicemarks are property of their respective owners.

Toad for IBM DB2 6.5Installation GuideMonday, January 15, 2018

Page 3: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Contents

Contents 3

Installation 5System Requirements 5Client Requirements 5Server Requirements 6Virtualization Support 6User Requirements 6Requirements for Full Access to Toad for DB2 z/OS Functionality 7Compile and Debug Requirements for Stored SQL Procedures 8

Install Toad 10Specify Application Data Directory Location 10Install Toad Silently 11Silent Installation Prerequisites 11Silent Installation Using the Executable 11

Install Other Toad Components 13Toad for IBM DB2 z/OS Components 13Toad for IBM DB2 LUW Agent 13SQLOptimizer for DB2 LUW 14SQLOptimizer for DB2 z/OS 14

Install Toad on Citrix® Systems 14Upgrade Toad 14Upgrade Automation Scripts and Scheduling Tasks 15Upgrade Automation Scripts to Newer Version of Toad 15Migrate Scheduling Tasks to Newer Version of Toad 15

Files Migrated During Upgrades 16Uninstall Toad 18Licensing 18Notes for Toad for IBM DB2Users 18

Create and Troubleshoot Connections 20Understand Toad Connections 20ToadOpen Connections 20Sharing a Connection AmongWindows 20

Configure DB2Client Connections 21Configure DB2Client Connections 21Maintain DB2Client Connections 25

Configure DB2 LDAP Support 26Create Toad Connection Profiles for DB2 27Connection Using a Custom Connection String 27Create Connection Profiles 27

Toad for IBMDB2 6.5 Installation GuideContents

3

Page 4: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Manage Connections 28Create a Connection to Intelligence Central 29Troubleshoot DB2 LUW Issues 31Installation Issues 31Connection Issues 32Other Issues 33

Troubleshoot DB2 z/OS Issues 33Installation Issues 33Connection Issues 34Other Issues 34

Configure Version Control 36About Version Control 36Prerequisites 36

Version Control for Toad Files 37Configure Version Control for Objects 40ManageObjects under Version Control 41Troubleshoot Version Control 44Troubleshoot Upgrades 44Troubleshoot Other Issues 44

About Us 46Wearemore than just a name 46Our brand, our vision. Together. 46Contact Quest 46Technical Support Resources 46

Index 47

Toad for IBMDB2 6.5 Installation GuideContents

4

Page 5: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Installation

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

Client RequirementsBefore installing Toad, ensure that your client system meets the following minimum hardware and softwarerequirements:

Requirement Details

Platform 2 GHz processor (recommended minimum)

Memory 4 GB of RAM minimum, 16 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 Disk Space 162MB to run ToadNote: The disk space required may vary based on the edition of Toad selected forinstallation.

Operating System Windows Vista® Service Pack 2 (32-bit or 64-bit)Windows Server® 2008 Service Pack 2 (32-bit or 64-bit)Windows Server® 2008 R2 Service Pack 1 (64-bit)Windows Server® 2012Windows Server® 2012 R2Windows Server® 2016Windows® 7 (32-bit or 64-bit)Windows® 8 (32-bit or 64-bit)Windows® 8.1 (32-bit or 64-bit)Windows® 10

.NET Framework Microsoft® .NET Framework 4.5.1

Database Client When connecting to a DB2 database/subsystem, ensure that you have a DB2 Client orIBM Data Server Driver installed. Toad supports DB2 Client versions 9.7.6 through11.1.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, 10.5.3, and 11.1.0.

1

Toad for IBMDB2 6.5 Installation GuideInstallation

5

Page 6: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Requirement Details

AdditionalRequirements

Web BrowserMicrosoft® Internet Explorer® 7.0 or laterScreenToad supports screen resolutions up to 3200 x 1800 and display DPI settings up to150%

Server RequirementsBefore installing Toad, ensure that your server meets the following minimum hardware and softwarerequirements:

Requirement Details

Database Server IBM DB2 for LUW 9.5, 9.7, 10.1, 10.5, 10.5.0.5, 11.1IBM DB2 for z/OS 9, 10, 11, 12Note: Toad may support IBM DB2 Express and SWE in addition to listed above servers,but note that no testing was performed on it.Note:Windows 8, 10 and Windows Server 2012 require the following Fix Pack in orderto ensure registration of DLLs in Global Assembly Cache:

IBM DB2 LUW 10.5 Fix Pack 4IBM DB2 LUW 10.1 Fix Pack 4IBM DB2 LUW 9.7 Fix Pack 10

Virtualization SupportRequirement Details

ApplicationVirtualization

When deploying Toad Data Point in a virtualization environment, for best results ensurethe system accurately reflects the applicable client hardware and softwarerequirements listed in this document.Toad Data Point has been developed using Microsoft guidelines (see Remote DesktopServices programming guidelines) and can be deployed and operated in virtualizationenvironments such as Citrix XenApp, Microsoft App-V, and VirtualBox.See "Install Toad on Citrix® Systems" on page 14 for more information.

User Requirements

User Requirements to Install ToadOnly 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 Windowslimitation because Vista does not support Power User mode.

l 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 menuitems with any user—a Power User, Restricted User, Vista standard user—on the computer.

Toad for IBMDB2 6.5 Installation GuideInstallation

6

Page 7: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 aworkaround, Restricted Users can create a shortcut to Toad from the install directory and place theshortcut on their desktop.

User Requirements and Restrictions for Running ToadThe 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 addthe user to one of these groups, select Start | Control Panel | Administrative Tools | ComputerManagement | 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 VistaAdministrators group. Additionally, to enable full functionality in Toad when Vista’s User Access Controlsecurity feature is turned on, the standard user must run Toad as an administrator. (Right-click the Toadicon on the Vista desktop and select Run as administrator.)

l A Windows Power User or Restricted User does not have the authority to add or remove DB2 catalogentries using the Toad Client Configuration wizard. However, these users can use the Import Profilefunction 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 Toadconnection profile for each DB2 for LUW database connection requires the authorizations listed in thefollowing document:

ToadDB2LUWAuthorizations.xls

l As a minimum requirement to manage a DB2 for z/OS subsystem in Toad, the user ID defined in theToad connection profile for the subsystem must either have SYSADM privileges or SELECT privilegeson 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 whomaintains this table must have privileges to create, insert, update, and delete it. All other users need onlythe 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 AboutSetting Up Toad Security topic in the Toad online help. This topic explains how to add the Toad Securityicons to your toolbar and how to define Toad Security roles that apply to your current connection. (Theability 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/OSFunctionalityInstall 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 limited support for managingDB2 for z/OS subsystems. With the z/OS component installed, you have access to a full range ofToad functionality needed to manage DB2 subsystems.

See "Install Other Toad Components" on page 13 for more information.

Toad for IBMDB2 6.5 Installation GuideInstallation

7

Page 8: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

l If no Toad for IBM DB2 z/OS components are installed on your subsystem, see the Toad for IBMDB2 z/OS Components Installation Guide for installation requirements and instructions.

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

Notes:

l Toad requires SYSPROC.DSNUTILU to run DB2 utilities. For more information about thisstored procedure, see Appendix B of the IBM DB2 Universal Database for z/OS Utility Guideand 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 andLOADs of table data. Before executing these types of alterations, ensure that the Mask value defined forthe Toad dataset template that generates the Unload datasets includes the &SEQ variable. This variablecreates 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 UNLOADand 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 byboth the source and target subsystem.

Compile and Debug Requirements for Stored SQLProceduresToad requires the following to compile and debug stored SQL procedures in DB2.

l DB2 for LUWRequirements

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:

Component Requirements

Supported DB2 Versions DB2 for z/OS 9 to 11

Each DB2 Subsystem l IBM DB2 stored procedure SYSPROC.DSNTPSMP, installed andoperational (needed to compile stored procedures in Toad)

l IBM DB2 installation job DSNTIJSD, executed (needed to debugstored procedures)

l IBM SYSPROC.DBG_% procedures, installed and operational

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

1. Install and configure DB2UDSMD (the Debugger Session Manager).

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

Refer your systems administrator to the following link for instructions on

Toad for IBMDB2 6.5 Installation GuideInstallation

8

Page 9: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Component Requirements

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 continued debugging of SQLprocedures)

Toad for IBMDB2 6.5 Installation GuideInstallation

9

Page 10: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Install ToadToad for IBM DB2 is available in the following editions: Base, Professional and Xpert. DB Admin Module is anadd-on module that provides extended admin functionality and can be added to any Toad edition.

Note: Your Toad for IBM DB2 license key determines the edition and will enable Toad for IBM DB2 functionalityaccordingly. In many cases, if functionality is disabled within Toad for IBM DB2, you may not have anappropriate license to use it. When Toad is running, you can see which components are licensed by selectingHelp | 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 Quest Software Installer on Windows 7 64-bit, ProgramCompatibility Assistant may appear with “This program might not have installed correctly” message.Select This program installed correctly to continue installation.

Note: Check Prohibit saving passwords during the installation to prohibit users from saving theirpasswords in Toad.

Specify Application Data DirectoryLocationToad for IBM DB2 6.5 stores settings files in the user's Application Data directory. The default location cannot bemodified from within the application. Toad provides two methods to change the default location: by using aRegistry 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 thecommand 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 forIBM DB2\6.5), 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 copythe settings files from the default location (Roaming directory) to the new location (Local directory). Copy thesettings files BEFORE you add the Registry setting and BEFORE opening Toad.

Operating System Default LocationNew Location whenLOCALSETTINGS = 1

Windows VistaWindows Server 2008Windows 7

C:\Users\username\AppData\Roaming\QuestSoftware\Toad for IBM DB2 6.5

C:\Users\username\AppData\Local\Quest Software\ Toadfor IBM DB2 6.5

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"

Toad for IBMDB2 6.5 Installation GuideInstallation

10

Page 11: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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

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

Use a stand-alone installer to perform a silent install. Obtain your installer files at https://support.quest.com/.

Silent Installation PrerequisitesBefore you can perform a silent installation, the following software must be installed on every computer whereyou are installing Toad: 

l Microsoft .NET Framework 4.5.1

Silent Installation Using the ExecutableUse the executable file to perform a silent install to the default directory (or to a different directory) and to specifyoptions 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 islocated. (This file can be downloaded from the Quest Software Web site or can be found on the Toadinstallation 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 thefollowing 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 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 appendother options, such as x for debug (used in the previous example) or v for averbose log. See the log section at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information about additional loggingoptions.Also, substitute “C:\temp\installLog.txt” in the example with the fully qualifiedname of the log file. Enclose this value in double quotations. The installation

Toad for IBMDB2 6.5 Installation GuideInstallation

11

Page 12: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Option Description

process creates this 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 valuein double quotations.

Option Description

INSTALLDIR (Optional) Specify the absolute path for the directory in which youwant to install Toad. If you do not include this path, the installationprogram defaults to: C:\Program Files\Quest Software\Toad for IBMDB2 6.5.

ALLUSERS (Optional) Specify one of the following:

l For a per-machine installation, specify 1. This value allowsany user to use the Toad shortcut on the desktop after theinstallation 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 onthe target desktop. If USERNAME is omitted, only the user thatinstalled Toad sees the shortcut.

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

USERNAME (Optional) Specify the user that intends to use Toad on the targetcomputer.Notes:

l If ALLUSERS is omitted or defined with the empty string value(""), only the user specified here (and the user that installedToad) can see the Toad shortcut on the desktop after theinstallation completes.

l If ALLUSERS is omitted or defined with the empty string value("") and you omit the USERNAME option, only the user thatinstalled Toad sees the Toad shortcut on the desktop.

l If ALLUSERS is 1, the USERNAME value is ignored duringinstallation.

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

ALLOWPASSWORDS=FALSE (Optional) Set in order to prohibit users from saving their passwordsin Toad.

Notes:l All default installation option overrides are case-sensitive.

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

Toad for IBMDB2 6.5 Installation GuideInstallation

12

Page 13: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Install Other Toad ComponentsDepending on your Toad license type, additional Toad components might be available. See the followingsections for information about installing these components:

l Toad for IBM DB2 z/OS Components

l Toad for IBM DB2 LUW Agent

l SQL Optimizer for DB2 LUW - Included in Toad® for IBM® DB2® Xpert Edition.

l SQL Optimizer for DB2 z/OS - Included in Toad® for IBM® DB2® Xpert Edition.

Toad for IBM DB2 z/OS ComponentsThe Toad for IBM DB2 z/OS components enable you to take full advantage of Toad functionality on your DB2 forz/OS subsystem. If you do not have the z/OS components installed, Toad still provides some basic functionalityto 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 advancedalters, 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 usersbelonging to the RACF group

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

Toad for IBM DB2 LUW AgentLUWRemote Script Execution Wizard has been modified to generate scripts that can be executed natively inthe DB2 CLP on the database server. This eliminates the need for the Toad for IBM DB2 Agent which is nolonger shipped with Toad.

Toad for IBMDB2 6.5 Installation GuideInstallation

13

Page 14: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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

SQL Optimizer for DB2 z/OSSQL Optimizer for DB2 z/OS lets you tune the SQL used in the DDL for triggers, views, or materialized querytables and the SQL included in packages and plans. You can also tune the SQL on which you are working inthe Editor.

Install Toad on Citrix® SystemsToad must be installed on the Citrix server by the Citrix administrator. Users then connect to this instancethrough their Citrix login.

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 and click More Info. Thenselect 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 topublish 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 or downloaded 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 your settings the first time youstart Toad. The settings files include database connections, layout customizations, shortcut keys, and optionscustomized in the Options pages.

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

Toad for IBMDB2 6.5 Installation GuideInstallation

14

Page 15: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Upgrade Automation Scripts andScheduling TasksIf you upgrade to a newer version of Toad, Automation scripts created in a previous version must be upgradedbefore you can open them in the newer version. Toad prompts you to automatically upgrade a script when youattempt to open it in a newer version.

In addition, scheduled scripts are scheduled to run using the version of Toad in which they were created. Afterupgrading Toad, those previously-created, scheduled scripts will not execute in the newer version until youmigrate each script's scheduling task. Toad prompts you to migrate scheduling tasks when you initially launchthe application after installation.

Upgrade Automation Scripts to Newer Version of ToadAn automation script is compatible with the version of Toad in which the script was created. If you want to openand/or modify a script using a newer version of Toad, you must upgrade the script. Toad automatically promptsyou to upgrade the script the first time you open it in the 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 compatible with earlierversions of Toad.

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

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

<application data directory>\Automation\bak\

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

Migrate Scheduling Tasks to Newer Version of ToadEach scheduled Automation script uses a Windows scheduling task. The scheduling task specifies whichversion of Toad to use by specifying the version's application path. Toad provides you with two easy ways tomigrate your scheduled scripts' scheduling tasks when you upgrade Toad. First, Toad prompts you to migrate

Toad for IBMDB2 6.5 Installation GuideInstallation

15

Page 16: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

scheduling tasks upon initial launch of the application after installation. Next, you can migrate scheduling tasksat any time using the Job Manager.

Notes:

l If you upgrade a previously-created script by opening it in a newer version of Toad, you must alsomigrate 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 in the newer version).

To migrate scheduling tasks upon initial launch

1. After upgrading Toad, and upon initial launch of the application, the Migrate Scheduled Tasksdialog opens.

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

3. Click OK to close the dialog.

4. Toad immediately prompts you for your Windows password. Enter your password to migrate thescheduled 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 Migrate ScheduledTasks dialog.

4. Toad immediately prompts you for your Windows password. Enter your password to migrate thescheduled tasks.

Manually Edit Scheduling TasksOn occasion you may need to modify the application path in a Windows scheduling task. You can do this bymanually editing the scheduling task using the following procedure.

To manually edit a scheduling task

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

2. To change the version of Toad used to run the script, in the Actions tab, change the folder name in thetoad.exe path.

Files Migrated During UpgradesWhen upgrading to a new version of Toad, the following files can be migrated from the previous version'sApplication 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, implementedfor 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 isautomatically sent to Quest Software on a periodic basis.

Toad for IBMDB2 6.5 Installation GuideInstallation

16

Page 17: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Connections.xml Contains all connections stored in the Connection Manager or the NewConnection 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 toFTP 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, Lookuptables, and hidden columns). You can share these options with other Toadusers in Tools | Options | Database | Cache.

Settings.xml Contains many of the global configuration settings.

ToadSupportBundle.zip Contains the last support bundle you generated.

Folder Description

Automation (temporaryfolder)

Used by automation when executing automation scripts.

Cache Used to spool cache database metadata to disk if enabled. The data is inbinary format and can always be recreated by fetching it from the database.

Context Contains settings that depend on the context within Toad including thefollowing:

l Adapter—Custom data editing statements.

l Filter—Unnamed filters defined in the Object Explorer or DatabaseExplorer.

l Named Filter—Named filters defined in the Object Explorer orDatabase Explorer.

l TYPE—Tabs that display on the right when you select an object in theObject Explorer or Database Explorer.

Document Recovery Contains backup copies of Editor, Query Builder, and Database Diagram filessaved 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 thatautomatically display in the Editor and column layouts for the Messages tab.

ModuleSettings Contains general settings for various components in Toad, such as whetherthe 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 toolwindow locations.

SQLFormatter Contains pre-set and user created templates for formatting SQL, and theSQL statement used to preview formatting changes in the Formatting Optionspage.

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:

l Code Templates—Templates used to define default values whencreating new objects in the Object Explorer or Database Browser.

Toad for IBMDB2 6.5 Installation GuideInstallation

17

Page 18: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 SQLscripts, 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 IBM DB2 by using the Windows install/uninstall programs feature.

To uninstall Toad

1. Open the Windows Control Panel and select Programs and Features. (In Windows XP, selectAdd/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 will enable the functionalityaccordingly. In many cases, if functionality is disabled within Toad, you may not have an appropriatelicense to use it. When Toad is running, you can see which components are licensed by selecting Help |About. For complete list of features shipped with your Toad edition see https://www.quest.com/.

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

Notes for Toad for IBM DB2 Users

Trial KeysThe commercial version of Toad for IBM 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.

Toad for IBMDB2 6.5 Installation GuideInstallation

18

Page 19: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

The trial license key remains active for the designated trial period, even after you enter your commercial licensekey (the splash screen may continue to indicate your application is a trial version). This is helpful if you arepreviewing 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.

Important: If you delete the Trial key, any advanced features not included in your purchased edition willbe disabled.

To delete a trial key

1. Select Help | Licensing.

2. In the Toad Licensing dialog, select the License tab for the trial license key and then click DeleteLicense to delete the trial key.

DB Admin Add-on and DBA Suite KeysDB Admin Add-on Module is included in Toad for DB2 DBA Suite or can be purchased with any commercialToad edition. It includes a large set of database administration tools. LUW DB Admin Add-on also enables Toadfor DB2 z/OS freeware functionality, while z/OS DB Admin Add-on enables Toad for DB2 LUW freewarefunctionality.

Toad for IBMDB2 6.5 Installation GuideInstallation

19

Page 20: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Create and Troubleshoot Connections

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

Toad Open ConnectionsIn Toad, an open connection in the Connection/Navigation Manager represents one or more actual connectionsto 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 you execute astatement) and for each Data tab in the Database Explorer (the first time you select the tab andquery data).

The connection associated with the window (or tab) remains open until you close the window. If awindow has an associated connection, but a statement is not currently executing, the connection is in aninactive state.

To view information for an open connection

l To view the number of actual database connections that exist for a Toad connection, including thenumber of active connections, place the cursor over the connection in the Connection/NavigationManager 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 the bottom of theToad application window. Click the executing progress bar to open the Background Processes pane.

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

Note: It is recommended that you cancel only your own processes, because terminating Toad activitiescould cause unexpected behavior.

Sharing a Connection Among WindowsYou can instruct Toad to share an open connection among windows. In this way, the Editor windows and Datatabs 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.

3. When this option is not selected, Toad attempts to use a single connection for any new windows or query

2

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

20

Page 21: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

execution. 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 single connection is in use when Toad attempts to execute it, the following occurs:

l If your database supports executing multiple queries simultaneously on a shared connection, thequery 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 dialogprompts you to either permanently associate the window with a new database connection, cancelthe previous operation, or add the query to a queue until the current operation completes, andthe execute it. If you 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 selected window only.

Configure DB2 Client ConnectionsSetting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems that Toad will managerequires two main steps.

Step 1. Configure DB2 client connections - Before you can create a connection profile, each of thedatabases or subsystems must be cataloged on the DB2 client. This topic helps you with that process.

Step 2. Create connection profiles - Step 2 involves creating Toad connection profiles for the catalogedDB2 databases or subsystems. Each profile contains the information that Toad needs to connect to thesystem, such as the user ID and password, DB2 registry settings, and the default schema. See "CreateToad Connection Profiles for DB2" on page 27 for more information.

Configure DB2 Client ConnectionsUse one of the following methods to catalog each of the databases or subsystems on the DB2 client.

Transfer a Catalog Any Time After Initial SetupUse this method to transfer a catalog from another DB2 client on your machine to your default DB2 client.

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 DB2 client installed.

2. From the DB2 Client list, select the name of the DB2 client whose catalog you want to transfer to yourdefault DB2 client.

This list contains all current previously installed DB2 clients on your computer, including the default DB2client 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 Create Toad ConnectionProfiles for DB2.

Import a DB2 catalog previously exported to a file

To import an exported catalog profile1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down

list to open the Client Configuration wizard.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

21

Page 22: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 you want to import. Whenyou select the profile, its contents display in the text pane.

5. Complete the wizard.

Once you close the wizard, the Database alias drop-down list in the Connections window includes allthe 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 onthe 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 yourDB2 client catalog, you must manually catalog the databases. If these databases are local to yourcomputer, catalog them as remote databases. See "Manually catalog DB2 for LUW databases " on page22 for more information.

6. Proceed to catalog entries as needed. See "Create Toad Connection Profiles for DB2" on page 27 formore information.

Manually catalog DB2 for LUW databases

To manually catalog a DB2 for LUW database1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down

list to open the Client Configuration wizard. The Welcome page displays, showing the DB2 client'sexisting catalog configuration in a tree view.

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

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operatingsystem

Select the operating system for the server on which the DB2 for LUW instancecontaining the DB2 database you are cataloging resides. For a list of supportedserver platforms, see the release notes.

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

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

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

Specify anInstance

Description

Node name Enter a user-defined name for the DB2 instance containing the database you arecataloging.If you selected the node name from the tree on the Welcome page, thisinformation 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

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

22

Page 23: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 theauthentication method.

5. Complete the wizard.

The Database alias drop-down list in the Connections window shows the alias for the newly catalogeddatabase. To complete the Toad connection setup, you must create a Toad connection profile for thedatabase. See "Create Toad Connection Profiles for DB2" on page 27 for more information.

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 touse Sysplex, catalog an entry to a DB2 Connect gateway instead. See "Manually catalog DB2 Connectgateways " on page 24 for more information.

To manually catalog a DB2 for z/OS subsystem

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-downlist to open the Client Configuration wizard. The Welcome page displays, showing the DB2 client'sexisting 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 selectionpre-fills certain fields required later in the wizard process. If the host name is not listed, you must providethe necessary host information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operatingsystem

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 DB2subsystem resides.

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

Enable SOCKSsecurity

Select this checkbox to enable the SOCKS secure protocol to handle TCP trafficfor this connection. SOCKS adds an authentication mechanism for additionalsecurity.

Add a DB2Subsystem

Description

Location name Enter the location name of the DB2 subsystem as defined during the DB2installation.

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, aslong as it does not already exist in the list aliases in the DB2 client.

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 catalogedsubsystem. To complete the Toad connection setup, create a Toad connection profile for the database.See "Create Toad Connection Profiles for DB2" on page 27 for more information.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

23

Page 24: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 theDB2 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 bothcataloging 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 formore information.

2. In the Connections (or Create New Connection) window in Toad, click beside the Database aliasdrop-down list to open the Client Configuration wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

Add a Host Description

Operatingsystem

Select the operating system for the server on which the DB2 Connect gatewayresides.

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

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

Enable SOCKSsecurity

Select this checkbox to enable the SOCKS secure protocol to handle TCP trafficfor this connection. SOCKS adds an authentication mechanism for additionalsecurity.

Specify anInstance

Description

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

Instance name Enter a user-defined name for the gateway node or use the same value enteredin the Node name.Note: This name does not point to an actual node on the gateway system, but isneeded 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 Connectgateway.

Database alias Enter a unique, user-defined alias for the DB2 Connect gateway. You can use thesame alias you used in the previous Database name field, as long as it does notexist in the list of Toad for DB2 aliases.

Authentication Select the authentication method that matches the method specified for the DB2subsystem on the DB2 Connect gateway.

5. Complete the wizard.

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

Note: Toad for DB2 supports LDAP connections. See "Configure DB2 LDAP Support" on page 26 for moreinformation.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

24

Page 25: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Maintain DB2 Client ConnectionsAdditionally, Toad provides functionality to perform the following maintenance on the catalog you set up for thecurrent DB2 client:

Edit DB2 catalog entries

To edit a DB2 catalog entry1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down

list to open the Client Configuration wizard.

2. In the catalog configuration tree for the DB2 client, select the catalog entry for the DB2 database orsubsystem 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 thecatalog properties, see the following links:

l Manually catalog DB2 for LUW databases

l Manually catalog DB2 for z/OS subsystems

l Manually catalog DB2 Connect gateways 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 entrycompleted successfully.

Remove DB2 catalog entries

To remove a DB2 catalog entry1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down

list to open the Client Configuration wizard.

2. In the catalog configuration tree for the DB2 client, expand one or more nodes, and select the catalogentries 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 IBM DB2 provides functionality to export your current DB2 client catalog to a file, called an exportprofile. You can then import this profile to set up the catalog for another DB2 client. 

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

To export the DB2 client catalog1. In the Connections (or Create New Connection) window, click beside the Database alias

drop-down list.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

25

Page 26: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

2. Click Export Profile in the Welcome window of the Client Configuration wizard. (You might need to click

this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the profile in which to export thecurrent 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 aDB2 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 updatingother 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 completedsuccessfully.

Note: DB2 does not automatically export catalog entries for the local DB2 instance and its databasesinstalled on your computer unless these entries already exist in the catalog you are exporting. If you laterimport the export catalog to a DB2 client, you must manually catalog the missing local-node databasesas remote databases. See "Manually catalog DB2 for LUW databases " on page 22 for more information.

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

Configure DB2 LDAP SupportYou can create DB2 Lightweight Directory Access Protocol (LDAP) connections when the DB2 client installedwith Toad is configured for LDAP. Configuring the client consists of enabling LDAP support and specifying thehost name and port number of the LDAP server. Once the client is configured, Toad retrieves names from yourLDAP 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 anexisting DB2 client on the computer is already configured to support LDAP.

l Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toad does not supportthe 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 | CommandWindow.

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.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

26

Page 27: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 theConnections window. To complete the Toad connection setup, you must create a Toad connectionprofile for each database. See "Create Toad Connection Profiles for DB2" on page 27 for moreinformation.

Create Toad Connection Profiles for DB2Setting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems that Toad will managerequires two steps.

Step 1. Configure DB2 client connections - If you use a DB2 client each of the databases orsubsystems must be cataloged on the client. See Configure DB2 Client Connections to learn how tocatalog databases/subsystems.

Step 2. Create connection profiles - Step 2 involves creating Toad connection profiles for DB2databases or subsystems that were either cataloged in the DB2 client or imported from your Data ServerDriver configuration file. 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. If you use IBM DSDenvironment you can import your connection profile from a Data Server Driver configuration file.

Note: The default location of your Data Server Driver configuration file is in ...ProgramData\IBM\DB2\IBMDBCL1\cfg. The default config filename is db2dsdriver.cfg.

Note:When you connect using IBM Data Server Driver the Database button and the toolbar option in Tools |LUW Database Options will not be available.

Connection Using a Custom Connection StringYou can also connect to your DB2 database/subsystem using a custom connection string.

l Select Connect Using | Connection String in Connection Properties

l Enter Database alias, Host name, Login, and Password and the connection string will be automaticallyupdated according to what you enter

l You can save a connection created using a custom connection string in your Connection Manager

Create Connection ProfilesUse one of the following methods to create Toad connection profiles:

l Import Toad connection profiles previously exported to an XML file

(See "Export connection profiles to an XML file" on page 28 for more information about exporting aprofile that you can later import.)

Note: The connection profiles are not usable unless you have also created entries in the DB2 catalog forthe DB2 databases and subsystems to which these profiles correspond. See "Configure DB2 ClientConnections" on page 21 for more information.

To import connection profiles

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

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

27

Page 28: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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

3. Click Open.

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

The connections whose profiles you imported are listed on the Connections window.

l Manually define Toad connection profiles.

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

1. In the Connections (or Create New Connection) window, click on the toolbar (ALT+F+N).

2. Select DB2 from the Group list box.

3. Review the following for additional information:

Database alias Select the alias for the DB2 database or subsystem. This alias was definedwhen you cataloged this DB2 database or subsystem on the DB2 client.See "Configure DB2 Client Connections" on page 21 for more information ifthe alias does not display in the list.

Tip: Click to refresh the alias list. Normally, Toad caches the DB2 catalogthe first time you open this window in your Toad session and continues toread from cache each time you subsequently open this window. This buttonforces Toad to reread the DB2 catalog to list any new systems that mighthave been cataloged externally during the caching period.

Defaultschema/auth ID

Enter the SET SCHEMA value (DB2 for LUW) or the SET SCHEMA or SETCURRENT SQLID value (DB2 for z/OS) for this connection.

Category Select or create a category if you want to color code Editor tabs for aspecific connection. This can help differentiate between development andproduction databases. You can also set an option to color code the ObjectExplorer 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 Toadconnects to the DB2 database or subsystem.

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

or

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

Manage ConnectionsAfter you have completed both phases for configuring Toad connections to DB2 databases or subsystems, theConnections 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 anXML 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 " on page 27 for moreinformation.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

28

Page 29: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

To export connection profiles

1. In the Connections (or Create New Connection) window, select the connections whose profilesyou 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 DB2 client catalog or Data Server Driverconfiguration file but missing from your current list of Toad connections.

Note: Default location for Data Server Driver configuration files is in ...\IBM\DB2\IBMDBCL1\cfg.

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

To import missing connections

l In the Connections or Connections Manager window, click .

l Troubleshoot connection issues

Note: Click to open the Client Configuration Wizard. See "Configure DB2 Client Connections" on page 21for more information.

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

Create a Connection to Intelligence CentralToad allows you to create a connection to a Toad Intelligence Central server.

About Toad Intelligence Central ConnectionsTo create a new TIC connection, you must provide the TIC server name and then register with TIC by creating anew user account for yourself. The new user name and password will be used by TIC to identify you from amongthe group of TIC users and to manage the objects you create and are granted access to on the TIC server.

A TIC connection displays in the format: username@server. The username is the name of the new user youcreate when you create a new TIC connection.

To create an Intelligence Central connection

1. Click in the Toad Intelligence Central Object Explorer (View | Toad Intelligence Central).

2. Select the Register New User tab.

3. Register New User. Use this tab to register with Intelligence Central by creating your own account (username and password). Review the following for additional information:

Note: If you are creating a connection to a Intelligence Central instance for which you already have auser account, do not fill in this tab again. Skip ahead to the next step (Login tab).

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

29

Page 30: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Register NewUser

Use WindowsAuthentication

Select to create a new user account using your Windows credentials. Toadautomatically populates the fields with your account information.

Host Enter the name of the Intelligence Central host server. Click to display a listof Intelligence Central servers currently active on the network.

User Name Create a new user name for this connection.This is the name you will be logged in with. The objects you create will be linkedto this user name. All your TIC rights (like sharing) will be linked to this username. This user name will display in the format:username@serverNote: User names must be lower case only. When you enter a user name, allupper-case characters are automatically converted to lower-case.

Password Create a password.

Verify Password Re-enter the password to confirm.

Full Name Enter your full name.This name, along with your user name, displays on the Sharing tab of thePublishing dialog and in the Alter Visibility dialog. Your full name will help usersidentify you when they select users with which to share an object.

Email Address Enter your email address.

Port Enter the port number for the App Server.

4. Login as Existing User tab. Use this tab to create a new connection to a TIC server for which youalready have a user account. (When you open an existing connection, this tab displays your useraccount information.)

Login as ExistingUser

Host Enter the name of the Intelligence Central host server. Click to display a listof Intelligence Central servers currently active on the network.

User Enter an existing server user name.

Password Enter the existing password for the user name.

Data Source (Optional) Enter the name of a default data source to open upon connection.

Port Enter the port number for the App Server.

Category (Optional) Select an existing category or create a new one.

5. (Optional) Select Save Password to save your password with this connection.

6. Click Connect to connect immediately and save the connection information. Optionally, click Save tosave the connection without connecting.

To change your Intelligence Central user password

You can change your password for your Intelligence Central user account at any time.

Note: You cannot use this procedure to change the password for a Intelligence Central account that usesWindows Authentication.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

30

Page 31: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

1. In the Navigation Manager, right-click the Intelligence Central connection and select Change Password.

2. Enter the old password and then enter the new password. Enter the new password a secondtime to confirm.

To switch your TIC user account to a Windows Authentication account

You can switch your current Intelligence Central account to a Windows Authentication account if both accountshave the same user name.

1. In the Connection Manager, right-click your current TIC account connection and select Properties.

2. In the Register New User tab, select Use Windows Authentication. Toad prompts you to switchyour account.

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

Troubleshoot DB2 LUW IssuesReview the following solutions to help troubleshoot DB2 LUW issues pertaining to Toad installation anddatabase connections.

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

Issue Cause/Solution

System.IO.FileNotFoundException - Fileor assembly name DB2AdminWrapper, orone 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.

Error: "Could not load file or assembly'IBM.Data.DB2.9.1.0, Version=9.1.0.2,Culture=neutral,PublicKeyToken=7c307b91aa13d208' orone of its dependencies. The systemcannot find the file specified."

You installed a commercial version of Toad for DB2 afteruninstalling the freeware version.Solution:You must remove run time information for the freeware version ofToad 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 system.config file.

4. Open the system.config file in Notepad.

5. Locate the <runtime> tag delete everything between theruntime tags (including <runtime> and </runtime>).

6. Save the file.

7. Restart Toad.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

31

Page 32: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Issue Cause/Solution

When installing Toad on Windows 7 64-bit, Program Compatibility Assistant mayappear with “This program might not haveinstalled 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 IssuesIssue Cause/Solution

ERROR [08001] [IBM] SQL1336N Theremote host was not found.SQLSTATE=08001  

You are attempting to connect to a database version that is notsupported in Toad.Solution:Review the list of supported databases in the Release Notes orInstallation Guide.

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

Catalog entries have not been imported or defined for theconnection.Solution:See "Configure DB2 Client Connections" on page 21 for moreinformation to determine the best method for cataloging adatabase.

"The type initializer for'IBM.Data.DB2.DB2Connection' threw anexception."or"SUCCESS - unable to allocate anenvironment handle."

A settings file might be corrupt.Solution:Rename your local settings directory so a new one can berecreated.

To rename your local setting directory1. Exit Toad.

2. Navigate to the following settings directory:

l Windows XP, Windows Server 2003—C:\Documents and Settings\username\LocalSettings\Application Data\Quest Software

l Windows Vista, Windows Server 2008, Windows7—C:\Users\username\AppData\ Roaming\QuestSoftware\

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

4. Restart Toad and try to connect.

Notes:l Make sure you can view hidden folders in WindowsExplorer.

l To navigate to this directory quickly, click the ApplicationData Directory link in the About dialog (Help | About).

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

32

Page 33: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Other IssuesIssue Cause/Solution

Unable to capture Container Informationin DB2 for LUWMulti-Partition Databases

Certain Toad functions require that the DFT_MON_BUFPOOLdatabase manager configuration parameter be set to ON tocapture information on containers used in DB2 for LUWdatabases. Additionally, to capture container information acrossall partitions in a multi-partition database, the snapshot monitorrequires that all database partitions be active. To activate alldatabase partitions (and keep them active), execute the DB2command ACTIVATE DATABASE real_database_name on theserver before connecting Toad to the database. See your IBMDB2 for Linux, Unix, and Windows documentation for moreinformation about this command.

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

Installation IssuesIssue Cause/Solution

Error: "Could not load file or assembly'IBM.Data.DB2.9.1.0, Version=9.1.0.2,Culture=neutral,PublicKeyToken=7c307b91aa13d208' orone of its dependencies. The systemcannot find the file specified."

You installed a commercial version of Toad for DB2 afteruninstalling the freeware version.Solution:You must remove run time information for the freeware version ofToad 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 system.config file.

4. Open the system.config file in Notepad.

5. Locate the <runtime> tag delete everything between theruntime tags (including <runtime> and </runtime>).

6. Save the file.

7. Restart Toad.

When installing Toad on Windows 7 64-bit, Program Compatibility Assistant mayappear with “This program might not haveinstalled 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

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

33

Page 34: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Connection IssuesIssue Cause/Solution

ERROR [08001] [IBM] SQL1336N Theremote host was not found.SQLSTATE=08001  

You are attempting to connect to a database version that is notsupported in Toad.Solution:Review the list of supported databases in the Release Notes orInstallation Guide.

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

You do not have any catalog entries defined for the connection.Solution:See "Configure DB2 Client Connections" on page 21 for moreinformation to determine the best method for cataloging adatabase.

ERROR [42501] [IBM][DB2] SQL0551N"UserName" does not have the privilegeto perform operation "SELECT" on object"SYSIBM.SYSSTMT". SQLSTATE=42501

You do not have SYSADM privileges for the DB2 for z/OSsubsystem.Solution:Ensure that you are granted SELECT permissions on the DB2catalog tables.

ERROR [] [IBM] SQL1460N Theenvironment variable "SOCKS_NS"required for SOCKS server nameresolution is not defined or not valid.

When using the Time-Sharing Option (TSO) to connect, the userID, 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] SQL0969NThere is no message text correspondingto SQL error "-4700" in the message fileon this workstation.' when connecting tocompatibility mode database.-or-After connecting, some objects do notdisplay properly or some functionalitydoes not work as designed.

In general, Toad does not support a z/OS subsystem running inCompatibility mode.Solution:If possible, switch the subsystem's operating mode to FullFunction mode.If this is not possible, Toad now provides a message when youconnect to subsystem, informing you of that the subsystem isrunning in compatibility mode and that some features might notbe available.

Other IssuesIssue Cause/Solution

Poor performance when browsing DB2 forz/OS objects in Toad. Indexes arepopulated slowly.

User-defined indexes on specific system catalog tables canimprove performance when you are browsing DB2 for z/OSobjects in Toad. The following link contains the DDL for indexesthat can optimize Toad performance on your DB2 for z/OSsubsystem. Keep in mind that the creation of these indexes is arecommendation only. The indexes can have different results indifferent environments, depending on the number of DB2 objectsand the amount of data involved. To create these indexes, edit

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

34

Page 35: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Issue Cause/Solution

and run the DDL contained in the following file:ToadDB2zOSIndexes.txtAdditionally, if the schema drop-down lists in the ObjectMigration wizard populate slowly, consider creating an index onthe SCHEMA and CREATOR columns in the catalog table foreach 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 Abend whenrunning IBM DB2 z/10 subsystem inConversion mode with older versions ofToad.

This issue appears because the Toad z/OS Component tries toreference the QUEST.QC200ZPARM function.Solution:DROP the QUEST.QC200ZPARM function from your DB2 z/OS10 subsystem. This will eliminate the possibility of the functionbeing called into the WLM environment procedure and causingthe S378 abend.We do not recommend that you to just STOP theQUEST.QC200ZPARM function on the mainframe side, withoutactually dropping it, because that may case Toad or the batchprocess (QCEXEC – remote job execution) to hang. Droppingthe QUEST.QC200ZPARM function is recommended.

Toad for IBMDB2 6.5 Installation GuideCreate and Troubleshoot Connections

35

Page 36: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiple revisions of objects andSQL scripts . See "Configure Version Control for Objects" on page 40 for more information on configuringversion control in Toad.

For Version Control of your files handled by Toad see Version Control for Toad Files.

Important: See "Troubleshoot Version Control" on page 44 for more information about issues when upgradingversion control from a previous version.

Notes: 

l If you want to place database objects under version control, you must configure version control forobjects using the Object Explorer. Once configured, you can manage SQL scripts there. The mainadvantage of managing scripts in the Object Explorer is that you can easily share them with teammembers who have version control configured. See "Manage Objects under Version Control" on page41 for more information.

l If you rename a version controlled object, Toad drops the original object and its history from versioncontrol and prompts you to add the renamed object to version control. This newly renamed object doesnot have any history associated with it.

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

PrerequisitesYou must install a supported version control client on the computer where Toad is installed. The following tablelists the supported version control providers and the versions tested with Toad.

SupportedProvider Server Version Tested Client Version Tested

ApacheSubversion™

Subversion 1.7.5 onWindows

CollabNet Subversion Command-Line Client 1.7.5Note: Any Subversion client must have svn.exe in its installationdirectory to use version control in Toad.

Git Toad works only with the local repository. For commands such as clone, pull and push usean external tool.

TeamFoundationServer (TFS)

TFS 2008, 2010, 2012,2013

Visual Studio® (2008, 2010, 2012, 2013) Team Explorer Client

File systembased

Toad allows to utilize practically any version control system using the external client tool. Inthis case Toad Version Control tool works with the directories at local HDD while you commitchanges 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.

3

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

36

Page 37: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

The following objects can be added to Version Control:

ALIASDISTINCT TYPEINDEXMQ TABLESCHEMASEQUENCETABLETRIGGERUSERVIEWFUNCTIONPROCEDURESCRIPT

Details of Team Foundation Server support:

Visual Studio/Team Explorerversion

TFS 2013supportnotes

TFS 2012supportnotes

TFS 2010supportnotes

Visual Studio 2015 Supported(RTM orlatestupdate)

Supported(RTM orlatestupdate)

Supported(RTM orlatestupdate)

Visual Studio/Team Explorer2013

Supported(RTM orlatestupdate)

Supported(RTM orlatestupdate)

Supported(RTM orlatestupdate)

Visual Studio/Team Explorer2012

RequireslatestVisualStudio2012update.SupportsGit withVisualStudioTools forGitextension

Supported(RTM orlatestupdate).SupportsGit withVisualStudioTools forGitextension

Supported(RTM orlatestupdate).SupportsGit withVisualStudioTools forGitextension

Note: Additional functionality and compatibility with older clients is possible but out of scope of what we areable to test.

Version Control for Toad FilesToad can integrate with your existing version control system allowing you to maintain multiple versions of Toadfiles. After you integrate Toad with your version control system, you can perform version control tasks directlyfrom within Toad, such as commit file changes and retrieve revisions.

Toad supports the following version control systems for managing Toad files:

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

37

Page 38: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

l Apache Subversion™—Toad has been tested with Subversion 1.7.5 and 1.8.

The following types of files can be managed using version control from within Toad: Editor (.tef, .sql, .txt), QueryBuilder (.tsm), ER Diagram (.ter), and Automation (.tas).

Toad supports version control for database objects, as well as files. Version control for objects is configuredseparately from version control for files. For more information about version control for objects, see ConfigureVersion Control for Objects.

To configure version control for Toad files

1. Ensure that an Apache Subversion client is installed on the same computer as Toad.

2. In Toad, open one of the supported file types. Then right-click the document window tab and select FileVersion Control | Version Control Wizard. This action opens the Version Control Wizard which allowsyou to configure Toad for your version control system.

Note: Even if you previously configured version control for objects, you must run the Version ControlWizard again to configure version control for files.

3. Use the wizard to provide information about your version control system to Toad. Review the followingfor additional information:

Field/Button

Version Control System Page

Type Select Subversion.

Properties Click the Properties button and enter the path to the Subversionexecutable (svn.exe) on the client computer. For example, if usingTortoiseSVN, the path might be:C:\Program Files\TortoiseSVN\bin

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

Server Enter the URL for the Subversion repository on the Subversionserver.

Login and Password Enter the user name and password for your Subversion account.

Default Version ControlSettings Page

Version Control Folder Select the folder on the Subversion server where you want tocheck in files.If you currently have files under version control, select the folder onthe server where these files are located.

Working Folder Select a folder on the client computer to use as the root workingfolder. This is the location into which you will check out files.If you currently have files under version control, select yourexisting working folder.

To add a file to version control

1. After configuring version control for files, you can start adding files to version control from within Toad.Right-click a document window tab and select File Version Control | Add file to working folder.

2. Select a location in your working folder in which to save the file. Click Save.

3. In the Commit dialog, enter a comment and click OK to add the file to version control.

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

38

Page 39: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

To browse the repository

1. Right-click the document window tab (of one of the supported file types) and select File Version Control| Repository Browser.

2. In the Repository Browser you can right-click a file to perform one of the following actions. Availableactions depend on the file's status.

Action Description

Open Open the file in Toad.

Commit Commit your changes. Available for Modified or Untracked files.

Undo Changes Discards your changes and reverts to the previous revision of the file(previous commit). Available when the file status is Modified.

Get Latest Version Check out the latest revision from the remote repository. Available whenthe file status is OutOfDate.

To commit your changes

l After modifying a file, right-click the document window tab and select File Version Control | Commit.

To compare revisions (Editor files only)

l After modifying and saving an Editor file, you might want to compare your changes to the remote copy(last commit) before committing your changes. Right-click the document tab and select File VersionControl | Diff with latest revision.

l You can compare two revisions of an Editor file (.tef, .sql, or .txt) by using the History dialog.

1. To open a file's History dialog, right-click the document tab and select File Version Control |Show history.

2. Select two revisions to compare. Then right-click the revisions and select Compare revisions.

3. For an OutOfDate file, right-click the latest revision in the History dialog and select Compare withworking copy to compare the remote file to your working copy.

To check file status

l The status of a currently open file displays in the status bar of the document window. You can also placethe cursor over the document tab to display status.

l You can check the status of one or more files by using the Repository Browser. To update file status inthe Repository Browser, right-click a folder and select Update folder.

l Review the following file status definitions.

File Status Definition

Untracked The file has not been added to version control. Right-click the file in the RepositoryBrowser and select Commit to add it to version control.

UpToDate The file in your working folder is synchronized with the file in the remoterepository. No changes are detected. No action is required.

Modified The working copy of this file was modified. The changes are stored in the workingfolder only. Commit this file to add the changes to the remote repository.

OutOfDate A more recent revision of this file exists in the remote repository. To update yourworking copy, check out the latest revision from the remote repository (right-clickthe file and selectGet Latest Version).

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

39

Page 40: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

File Status Definition

Unknown The file is under version control, but its status cannot be determined.

Deleted The file was under version control, but it was dropped or renamed in the workingfolder and exists only in the remote repository.

Additional Actions

l To open the folder where a file is located, open the file and then right-click the document tab and selectFile Version Control | Open in Windows Explorer.

Configure Version Control for ObjectsTo configure version control for files, see Version Control for Toad Files.

To configure version control for Objects

1. Ensure that a supported version control client is installed on the computer where Toad is installed. See"About Version Control" on page 36 for more information about tested version control clients andsupported versions.

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

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

3. Review the following for additional information:

Version ControlSystem Page

Description

Type Select the version control system name:

l Apache Subversion™Note: The version number beside Subversion is an internal filedefinition used by Toad to check if an update for this file is available. Itis not the actual version number for the version control provider.

l Git

l Team Foundation ServerNote: If you select TFS, you must specify the workspace name for theprovider in the Team Foundation Server Properties window thatdisplays.

l File system based

Properties (Subversion only) Click this button (beside the Type field) and complete thebinary path. Enter the path where the Subversion client that contains svn.exeis installed. For example, if you installed the CollabNet Subversion Client,you would enter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.

Server Select one of the following:

l Subversion—Specify the existing working folder for the versioncontrol repository or specify the server string (for example:

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

40

Page 41: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

svn://MyServer).

l TFS—Specify the server where your version control provider isinstalled and the port number (default is 8080) to use in the followingformat:

o http://MyServer:Port for TSF 2008

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

l File System Based—Specify a directory at your local machine.

Repository Settings Set your local Working Folder and your Version Control Folder will beautomatically filled.

User name/Password

Enter your Subversion command-line user name and password and clickLogin.Note: For TFS only, if you leave the user name and password fields blank,Toad uses your default Windows credentials.

Version ControlGeneral OptionsPage

Description

Prompt to Commit onClose

You will be asked to commit your changes before each version controlled fileis closed

Store GrantStatements with DDL

Grant statements will be stored and tracked along with DDL scriptNote: IBM DB2 only

Version ControlConfigurationsOptions Page

Description

Version controlfolder

Select the folder on the version control server where you want to checkobjects and scripts in.If you already have objects or scripts under version control, select the folderon the server where these objects or scripts are located.Note: Version control automatically checks out objects or scripts in this folderand any subfolders to the location you specify in theWorking folder field.

Working folder Select the root repository folder on the client computer to use as the defaultworking folder for checking objects and SQL scripts out. If you already haveobjects or SQL scripts under version control, select the existing workingfolder for these.

4. Manage object and scripts using Version Control. See "Manage Objects under Version Control" on page41 for more information.

Manage Objects under Version ControlNote: Version Control should be configured in Toad before you start managing objects. See "Configure VersionControl for Objects" on page 40 for more information.

To add objects and scripts under version control

» Right-click an object or script and select Commit.

Tips:

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

41

Page 42: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

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 versioncontrol and prompts you to add the renamed object to version control This newly renamed object doesnot have any history associated with it.

l You can create and version control SQL scripts for current database using the Scripts node in the ObjectExplorer. Click to create the new script.

To manage objects and scripts under version control

1. Determine object's version control status. Hover a mouse over the object in the Object Explorer to see itsstatus. Review the following for additional information:

Version Control status Description

Uninitialized The object status is undetermined yet. This is a temporary status that isissued for all objects during version control status processing.

Untracked The object is not added to version control.

Ignored The object is added to ignore list and excluded from version control.

UpToDate The object is under version control and is synchronized with versioncontrol 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 besynchronized with version control repository.

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

42

Page 43: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Version Control status Description

Merge The object is under version control and has been modified in bothlocal database and version control repository.Note:: Toad's Version Control feature does not allow to merge objectscripts.

OutOfDate The object is under version control and has been modified in versioncontrol repository.

Unknown The object is under version control but for some reason its statuscannot be determined (for example, you created a script in your localdatabase while the script with the same name already exists in versioncontrol repository, or you upgraded to a higher version of Toad andconfigured version control for the same repository while you havesome uncommitted changes in the database).Tip: If you are sure that the object is up to date but is listed asunknown, commit the object in version control system to resolveunknown status.

Deleted The object was under version control, but it was dropped or renamedin 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. Onceyou commit changes in Controlled objects pane, the object with allhistory will be deleted from version control repository.

NotInView The object is under version control and exists in version controlrepository only.

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

Use To...

Show perspective Select to review all controlled objects for current configuration.

Diff Select to review differences between the object script in your localdatabase 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 localdatabase 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, thelatest revision was 5. Yesterday your colleague worked with the same object and committed changesin 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 thefollowing:

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

Get latest revision Select to apply object's changes from the version control repository toyour local database. The synchronization script is generated to updateselected object to the latest revision.

Commit Select to apply object's changes from your local database to the

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

43

Page 44: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Use To...

version control repository.Note: You should write a comment when committing changes.

Undo changes Select to rollback changes in your local database. The synchronizationscript is generated to revert object to the revision which was a appliedlast time.

Update status Select to compare a script in your local database with the script in therepository. New status will be issued according to the comparisonresults.

Add to ignore list Select to exclude object from the version control. Ignored objects arenot listed in Controlled Objects pane, Commit and Get latest revisionare 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 UpgradesFor this release, the back-end of version control has been rewritten. If you previously used version control inToad, the following may occur:

l Version control settings are not migrated from the previous version of Toad, so you have to reconfigureversion 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 fromversion control repository (The objects have Unknown status). If the object in your database is current,you should commit it into version control.

Troubleshoot Other IssuesReview the following to help troubleshoot issues with version control:

ApacheSubversion™Issues

Description

Systemcannot findfile

If a message stating that, “The system cannot find the file specified” displays, this usuallymeans that the Subversion executable cannot be found in the path you specified in theBinaryPath field of the Command Based Version Control Properties window. Verify thatsvn.exe exists in the directory you specified in this field.

Commandexecution

When executing Subversion commands, user input is not allowed. This presents an issuewhen the user is using Subversion with the SSH method and must enter a password toestablish the Secure Shell.Workaround:Generate identity keys that automatically authenticate between the client and the server

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

44

Page 45: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

when connecting with SSH.

OutOfMemoryexceptionwhen addinga largenumber ofobjects

When adding a large number of objects, Subversion may encounter OutOfMemoryexception.Workaround:Commit objects in several steps.

SVN ismissing in thelist ofavailableproviders

If Subversion is missing in the list of available version control providers, it means thatSubversion.xml was removed or corrupted.Workaround:Contact Support to get a new Subversion.xml and place it under <Toad installpath>/Templates/Version Control/.

Object Issues Description

Addingmultipleobjects failed

When you add multiple objects to version control, the objects are grouped and added inbatches (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 ofthe objects are added.

Script Issues Description

Canceledcheck-in

SQL scripts remain checked out if a change was made to the text, but check-in wascanceled 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 thesource repository; click Cancel to cancel the prompt.

Toad for IBMDB2 6.5 Installation GuideConfigure Version Control

45

Page 46: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

We are more than just a nameWe are on a quest to make your information technology work harder for you. That is why we build community-driven software solutions that help you spend less time on IT administration and more time on businessinnovation. We help you modernize your data center, get you to the cloud quicker and provide the expertise,security and accessibility you need to grow your data-driven business. Combined with Quest’s invitation to theglobal community to be a part of its innovation, and our firm commitment to ensuring customer satisfaction, wecontinue to deliver solutions that have a real impact on our customers today and leave a legacy we are proud of.We are challenging the status quo by transforming into a new software company. And as your partner, we worktirelessly to make sure your information technology is designed for you and by you. This is our mission, and weare in this together. Welcome to a new Quest. You are invited to Join the Innovation.

Our brand, our vision. Together.Our logo reflects our story: innovation, community and support. An important part of this story begins with theletter Q. It is a perfect circle, representing our commitment to technological precision and strength. The space inthe Q itself symbolizes our need to add the missing piece—you—to the community, to the new Quest.

Contact QuestFor sales or other inquiries, visit www.quest.com/contact.

Technical Support ResourcesTechnical support is available to Quest customers with a valid maintenance contract and customers who havetrial versions. You can access the Quest Support Portal at https://support.quest.com.

The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hoursa day, 365 days a year. The Support Portal enables you to:

l Submit and manage a Service Request

l View Knowledge Base articles

l Sign up for product notifications

l Download software and technical documentation

l View how-to-videos

l Engage in community discussions

l Chat with support engineers online

l View services to assist you with your product

About Us

Toad for IBMDB2 6.5 Installation GuideAbout Us

46

Page 47: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

Aagent, Toad for DB2

installation 13

application virtualization 6

automation

migrate scheduled tasks 16

upgrade scripts 15

CCitrix

install 14

requirements 6

client requirements 5

connections

configure DB2 client 21

create DB2 27

create Toad Intelligence Central 29

DB2 LDAP support 26

share for all session windows 20

troubleshoot DB2 LUW 31

troubleshoot DB2 z/OS 33

understand 20

corporate deployment 11

DDB2

create connections 27

troubleshoot LUW issues 31

troubleshoot z/OS issues 33

desktop virtualization 6

Iinstall 10

Citrix 14

Citrix support 6

client requirements 5

debugging requirements on client andsubsystem 8

silent 11

SQL Optimizer for DB2 LUW 13-14

Toad for DB2 Agent 13

Toad IBM DB2 z/OS components 13

Intelligence Central

create connections 29

LLDAP

DB2 support 26

license keys 18

Mmanage objects under Version Control 41

Rrequirements

Citrix 6

client 5

SQL procedure debugging 8

virtualization 6

Sserver virtualization 6

silent install 11

prerequisites 11

SQL Optimizer for DB2 LUW, installation 13-14

Index

Toad for IBMDB2 6.5 Installation GuideIndex

47

Page 48: Toad for DB2 Installation Guide - Questsupport-public.cfm.quest.com/43875_ToadforIBMDB2_6.5_InstallationGuide.pdfToad®forIBM®DB2®6.5 InstallationGuide ©2017QuestSoftwareInc. ...

SQL Optimizer for DB2 z/OS, installation 14

Subversion, configure 40

system requirements 5

TTeam Foundation Server, configure 40

TFS, configure 40

Toad for DB2 Agent

installation 13

Toad IBM DB2 z/OS components, installation 13

troubleshoot

DB2 LUW connections 31

DB2 z/OS connections 33

version control 44

Uuninstall 18

VVersion Control

about 36

configure Subversion 40

configure TFS 40

File system based 40

manage objects 41

troubleshoot 44

virtualization support 6

Toad for IBMDB2 6.5 Installation GuideIndex

48