ToadforDataAnalysts_31_InstallGuide

Toad® for Data Analysts 3.1

Installation Guide

© 2012 Quest Software, Inc.

ALL RIGHTS RESERVED.

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

The information in this document is provided in connection with Quest products. Nolicense, express or implied, by estoppel or otherwise, to any intellectual property right isgranted by this document or in connection with the sale of Quest products. EXCEPT ASSET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSEAGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITYWHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORYWARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO,THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULARPURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FORANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTALDAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OFPROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OFTHE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEENADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representationsor warranties with respect to the accuracy or completeness of the contents of this documentand reserves the right to make changes to specifications and product descriptions at anytime without notice. Quest does not make any commitment to update the informationcontained in this document.

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

Quest Software World HeadquartersLEGAL Dept5 Polaris WayAliso Viejo, CA 92656

www.quest.comemail: [email protected]

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

Trademarks

Quest, Quest Software, the Quest Software logo, Benchmark Factory, Toad, T.O.A.D.,Toad World, and vToad are trademarks and registered trademarks of Quest Software, Incin the United States of America and other countries. For a complete list of QuestSoftware’s trademarks, please see http://www.quest.com/legal/trademark-information.aspx.Other trademarks and registered trademarks used in this guide are property of theirrespective owners.

Toad for Data Analysts 3.1Installation GuideFebruary 29, 2012

http://www.quest.com/

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

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

Table of Contents

Installation 7

System Requirements 7

Client Requirements 7

Server Requirements 9

Virtualization Support 12

User Requirements 12

Install Toad 14

Specify Application Data Directory Location 14

Read-Only Installation 16

Install Toad Silently 17

Determine Which Installer to Use 17

Silent Installation Prerequisites 18

Silent Installation Using the Executable 18

Silent Installation Using the Microsoft Installer 20

Install Toad on Citrix Systems 24

Upgrade Toad 25

Files Migrated During Upgrades 25

Uninstall Toad 27

Register Toad 28

Configure Toad Layouts 28

Create Connections 32

Understand Toad Connections 32

Share Database Connections 32

Configure Oracle LDAP Support 33

Create Oracle Connections 34

Configure the Oracle Instant Client 35

Toad for Data Analysts Installation GuideTable of Contents

4

Create an Oracle Connection 35

Create Oracle Business Intelligence Connections 37

Configure DB2 Client Connections 39

Define DB2 Client Connections 39

Maintain DB2 Client Connections 47

Configure DB2 LDAP Support 49

Create Toad Connection Profiles for DB2 50

Create Connection Profiles 51

Manage Connections 53

Create Access Connections 54

Create Business Objects Connections 55

Create Excel Connections 57

Create MySQL Connections 60

Create ODBC Connections 61

Create Salesforce.com Connections 63

Create SQL Server and SQL Azure Connections 64

Create Sybase Connections 67

Create Teradata Connections 68

Troubleshoot Connections 71

Troubleshoot Access Issues 71

Missing Functionality and Object Information 71

Other Issues 71

Troubleshoot Excel Issues 71

Excel Connections 72

Opening Excel Files in Toad Document Window 74

Troubleshoot DB2 LUW Issues 74

Installation Issues 74


5

Connection Issues 76

Other Issues 77

Troubleshoot DB2 z/OS Issues 78

Installation Issues 78


Missing Functionality or Object Information 80

Other Issues 81

Troubleshoot Informix Issues 82

Troubleshoot MySQL Issues 82



Troubleshoot Oracle Issues 84


Missing Functionality and Object Information 84

Troubleshoot SQL Server Issues 85

Troubleshoot Sybase Issues 86



Other Issues 87

Configure Version Control 88

About Version Control 88

Prerequisites 88

Configure TFS or VSS 89

Configure CVS 91

Configure Subversion 93

Troubleshoot Version Control 95

Troubleshoot Upgrades 95

Troubleshoot Other Issues 95


6

Appendix: Contact Quest 97

Contact Quest Support 97

Toad Community 97

Contact Quest Software 97

About Quest Software 98

Index 99

Installation

System Requirements

Client Requirements

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

Platform 1 GHz Processor (recommended minimum)

Memory 512 MB of RAM minimum, 1 GB recommendedNote: The memory required may vary based on the following:

l Applications that are running on your system when using Toad

l Size and complexity of the database

l Amount of database activity

l Number of concurrent users accessing the database

Hard DiskSpace

1.33 GB to install Toad

475 MB to run Toad Professional edition, 350 MB to run Toad BaseeditionNote: The disk space required may vary based on the edition of Toadselected for installation.

OperatingSystem

Windows Server 2003Windows XP Professional (32-bit or 64-bit)Windows Vista (32-bit or 64-bit)Windows Server 2008 (32-bit or 64-bit)Windows 7 (32-bit or 64-bit)

.NETFramework

Microsoft .NET Framework 3.5 (Service Pack 1)Note: The following conditions apply:

l If you have the .NET Framework 4.0 installed, you must stillinstall the .NET Framework 3.5 (Service Pack 1).

l The .NET Framework Client Profile is not supported.

l To run Toad, the .NET security policy must be set tounrestricted. See "User Requirements and Restrictions forRunning Toad " for more information.

1

Toad for Data Analysts Installation GuideInstallation

8

Teradata .NET Data ProviderYou must install the Teradata .NET Data Provider (13.10 or later) touse a Teradata native connection in Toad.Note: To use a Teradata connection in a cross-connection query, youmust also install a Teradata (13.10 or later) ODBC driver.

DatabaseClient

Existing DB2 Client Support (DB2 native provider only)Toad installs a DB2 9.7 (Fix Pack 4) client as part of the installationprocess. The DB2 9.7 client can co-exist with an existing DB2 8client, but is incompatible with a DB2 7 client. If a DB2 7 clientalready exists on your computer, the Toad installation stops andcannot complete. To resolve, first upgrade to the DB2 8 client. Thenrestart the Toad installation to avoid losing functionality in some DB2native tools.Existing 64-bit DB2 Client (DB2 native provider only)If you have a 64-bit DB2 client installed, you must install Toad usingthe ToadforDataAnalysts_64bit_Client.exe.Oracle ClientToad can connect to Oracle using Direct Connect (no need for anOracle Client) or can connect using an Oracle Client or Oracle InstantClient. However, if you want to use LDAP, you must install an OracleClient. Toad supports 9i or later Oracle Clients and Oracle InstantClients.Notes:

l You cannot use Oracle Direct Connection in a cross-connection query.

l To use an Oracle connection in a cross-connection query, youmust install an Oracle Client (full install) or you must installthe Oracle Instant Client plus the Oracle ODBC driver.

AdditionalRequirements

Web BrowserMicrosoft Internet Explorer 6.0 or laterSpatial Data TypesTo work with spatial data types used in SQL Server 2008, you mustinstall SQL Server 2008 Client Tools or SQL Server ManagementStudio 2008.


9

Server Requirements

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

OperatingSystem

Oracle Native Database ProviderIBM AIX 5.1, 5.2, 5.3HP-UX 11i 1.5, 2 (32-bit or 64-bit)Red Hat Enterprise Linux AS release 3 and 4 (32-bit or 64-bit)Solaris 7, 8, 9, 10 (32-bit or 64-bit)SuSE 7, 8, 9Windows 2003 (32-bit or 64-bit)Windows XPSQL Server Native Database ProviderWindows Server 2000 Service Pack 4 or laterWindows 2000 Professional Edition Service Pack 4 or laterWindows XP (32-bit with Service Pack 2 or later and 64-bit)Windows Server 2003 (32-bit or 64-bit) Service Pack 1 or laterWindows Vista (32-bit or 64-bit)Windows Server 2008 (32-bit or 64-bit)Windows Server 2008 R2 (64-bit)Windows 7 (32-bit or 64-bit)DB2 for z/OS Native Database Providerz/OS (V1R6 Base Services [5694-A01] or later)DB2 for LUW Native Database ProviderIBM AIX 5.1, 5.2, 5.3, 6.1HP-UX 11i 1.5, 2 (32-bit or 64-bit)Red Hat Enterprise Linux AS release 3 and 4 (32-bit or 64-bit)Solaris 7, 8, 9, 10 (32-bit or 64-bit)SuSE 7, 8, 9Windows 2000, 2003 (including 64-bit), 2008, XP, Vista, Windows 7MySQL Native Database Provider

Windows 2003Windows Server 2000 Service Pack 4 or laterWindows 2000 Professional Edition Service Pack 4 or laterWindows XP (32-bit with Service Pack 2 or later and 64-bit)Windows Server 2003 (32-bit or 64-bit) Service Pack 1 or laterWindows Vista (32-bit or 64-bit)Windows Server 2008 (32-bit or 64-bit)Windows Server 2008 R2 (64-bit)


10

Windows 7 (32-bit or 64-bit)Sybase Native Database ProviderWindows Server 2000 Service Pack 4 or laterWindows 2000 Professional Edition Service Pack 4 or laterWindows XP (32-bit with Service Pack 2 or later and 64-bit)Windows Server 2003 (32-bit or 64-bit) Service Pack 1 or laterWindows Vista (32-bit or 64-bit)Windows Server 2008 (32-bit or 64-bit)Windows Server 2008 R2 (64-bit)Windows 7 (32-bit or 64-bit)

NativeDatabaseServer

Toad supports the following databases:Oracle 9i, 10g, 11g, 11g R2Toad has been tested on Oracle Exadata 2.0 running Oracle database11g R2.SQL Server 2000 (Service Pack 3 or later)SQL Server 2005 (Service Pack 2 or later) and SQL Server 2005ExpressSQL Server 2008 and SQL Server 2008 ExpressSQL Server 2008 R2 and SQL Server 2008 R2 ExpressNote: SQL Server Compact Edition is not supported.IBM DB2 for LUW 8.1.5 or laterIBM DB2 for LUW 9.1 or laterIBM DB2 for z/OS 8IBM DB2 for z/OS 9IBM DB2 for z/OS 10Notes:

l To run RUNSTATS and the native REORG utility ontablespaces and indexes in DB2 for LUW, Toad supports DB2for LUW 8.2.2 or later.

l Toad may support IBM DB2 Express and SWE in addition tolisted above servers, but note that no testing was performed onit.

l Toad supports DB2 8 for z/OS running in Full Function mode,but does not support DB2 8 for z/OS running in Compatibilitymode.

MySQL 4.1, 5.0, 5.1 Sybase ASE 12.5, 15.0.2, 15.0.3, 15.5Sybase IQ 15Sybase SQL Anywhere 12Teradata 12.0, 13.0, 13.10


11

Access 2003, 2007, 2010Excel 2003, 2007, 2010

ODBCDatabaseServer

Toad for Data Analysts allows you to create a connection to adatabase that supports an ODBC 3.0 or later driver. ODBCconnectivity provides basic querying capability, but may not be asfull-featured as a native connection in Toad. Toad has been tested onthe following databases, using an ODBC connection:

l DB2 for i5/OS V5R4 and IBM i 6.1

l Informix Dynamic 10.00, 11.0 (limited testing)

l Ingres Community Edition 2006 R2 on Windows 32-bit(limited testing)

l Netezza Data Warehouse Appliance 4.6.6, 6.0

l PostgreSQL 8.3.4

l Vertica 4.1, 5.0, 5.1 (with 4.0, 4.1 ODBC driver)

Note: For a list of databases that are not supported, see Known Issuesin the Release Notes.

CloudDatabaseService

Oracle databases running on Amazon EC2SQL AzureNote: To connect to SQL Azure, you must have read access to themaster database.SQL Server databases running on Amazon EC2Toad can manage Amazon RDS and any other cloud or serviceoffering compatible with MySQL.

Quest DataServices -PremiumConnections

Toad has been tested with, and supports, the following BusinessIntelligence / Cloud platforms:

l Business Objects XI 3.0, 3.1

l Oracle Business Intelligence Enterprise Edition 11g (limitedtesting, not fully-certified)

l Salesforce.com


12

Virtualization Support

ApplicationVirtualization

Limited testing has been performed for Citrix XenApp 5.0 support onWindows Server 2003.See "Install Toad on Citrix Systems" (page 24) for more information.

DesktopVirtualization(VDI)

Toad has been tested with Quest vWorkspace 7.0 running onWindows XP Professional 32-bit (Service Pack 2).

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

User Requirements

User Requirements to Install Toad

Only Windows Administrators and Power Users can install Toad.

Note: The following exceptions exist for Power Users:

l A Power User cannot install Toad on a computer running Windows Vista Enterprise.This is a Windows limitation because Vista does not support Power User mode.

l (DB2 only) A Power User cannot install Toad if a DB2 for LUW version earlier than8.1.7 already exists on the computer. Only an Administrator can install Toad underthis condition. However, if the computer has an existing DB2 for LUW 8.1.7 or laterinstallation, a Power User can install Toad as long as this user belongs to theDB2ADMNS or DBUSERS group.

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

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

l Associate file extensions.

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

User Requirements and Restrictions for Running Toad

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

l (DB2 only) A Windows Power User or Restricted User must belong to theDB2ADMNS or DB2USERS group. To add the user to one of these groups, selectStart | Control Panel | Administrative Tools | Computer Management | SystemTools | Local Users and Groups | Groups | DB2ADMNS or DB2USERS.


13

l (DB2 only) A Windows Vista user must be either an administrator or a standard userthat belongs to an Vista Administrators group. Additionally, to enable fullfunctionality in Toad when Vista’s User Access Control security feature is turned on,the standard user must run Toad as an administrator. (Right-click the Toad icon on theVista desktop and select Run as administrator.)

l (DB2 only) A Windows Power User or Restricted User does not have the authority toadd or remove DB2 catalog entries using the Toad Client Configuration wizard.However, these users can use the Import Profile function in the Toad ClientConfiguration wizard to import catalog entries to Toad.

l (DB2 only) To take full advantage of Toad for DB2 LUW functionality, the user IDspecified in the Toad connection profile for each DB2 for LUW database connectionrequires the authorizations listed in the following document:

ToadDB2LUWAuthorizations.xls

l (DB2 only) As a minimum requirement to manage a DB2 for z/OS subsystem in Toad,the user ID defined in the Toad connection profile for the subsystem must either haveSYSADM privileges or SELECT privileges on the DB2 catalog tables. For a completelist of authorizations (and corresponding GRANT statements) a user requires to takefull advantage of Toad for DB2 z/OS functionality, refer to the following document:

ToadDB2zOSAuthorizations.doc

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

1. Select Control Panel from the Windows Start menu.

2. Double-click Administrative Tools.

3. Double-click Microsoft .NET Framework version Configuration.

4. Select My Computer, and then select the Runtime Security Policy node.

5. Select Evaluate Assembly from the list of tasks in the right panel, and locateand select Toad.exe in the File field.

6. Click Next and set the permission to Unrestricted.

l To create or modify the QuestSoftware.ToadSecurity table to enable Toad Security,the user who maintains this table must have privileges to create, insert, update, anddelete it. All other users need only the ability to read the QuestSoftware.ToadSecuritytable to use Toad Security features.

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

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


14

Install ToadStarting with 3.1, Toad for Data Analysts is available in three editions: Base, Professional,and Premium. See "Toad for Data Analysts Features" in the online help for more information.

Note:If you received Toad for Data Analysts with your purchase of Toad for Oracle, note thatby installing Toad for Data Analysts you agree to use the software solely on the seat forwhich Toad for Oracle was purchased.

To install Toad

1. Run the ToadInstaller.exe.

Notes:

l DB2 restricts you from having a DB2 32-bit client and DB2 64-bit client onthe same computer. The Toad for Data Analysts regular Installer installs a DB232-bit client. If you have a 64-bit environment with a 64-bit DB2 clientinstalled, you must install Toad for Data Analysts using theToadforDataAnalysts_64bit_Client.exe

l During installation, you can select to install Toad as Read-only. See "Read-Only Installation" for more information.

2. Complete the wizard.

Note: During installation, if the user overrides the default installation directory location, thedirectory path cannot contain Unicode characters. This is due to the fact that we install aDB2 LUW client in the user specified Toad Installation directory and the DB2 installationdoes not support such characters.

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

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

To change Toad Application Data directory location from Roaming to Local

In the Registry under Toad for Data Analysts (Computer\HKEY_CURRENT_USER\Software\Quest Software\Toad for Data Analysts\3.1), add LOCALSETTINGS with avalue of 1.


15

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

Caution: All current Toad settings will be lost after applying this Registry setting unless youmanually copy the settings files from the default location (Roaming directory) to the newlocation (Local directory). Copy the settings files BEFORE you add the Registry setting andBEFORE opening Toad.

OperatingSystem

Default Location New Location whenLOCALSETTINGS = 1

Windows XP C:\Documents andSettings\<user>\Application Data\QuestSoftware\Toad for Data Analysts 3.1

C:\Documents andSettings\<user>\Localsettings\Application Data\QuestSoftware\Toad for Data Analysts 3.1

Windows 7 C:\Users\<user>\AppData\Roaming\QuestSoftware\Toad for Data Analysts 3.1

C:\Users\<user>\AppData\Local\QuestSoftware\Toad for Data Analysts 3.1

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

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

Toad.exe --datadir="YourNewDirPath"

To instruct Toad to always use the new directory path, add the command switch and the newdirectory path to a Toad desktop shortcut. Then use the desktop shortcut when opening Toad.

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

2. Enter the command switch and add the directory path in quotes (replace"YourNewDirPath" with your directory path).


16

Read-Only InstallationDuring installation, you can select an option to install Toad as a read-only application. Thislets you query data and view objects using Toad, but all actions that can impact the database(Create, Alter, Drop, Insert, Update, etc.,) are disabled or hidden. This ensures that you canuse Toad without worrying about committing a change to a sensitive production instance.The following image shows an example of the differences between a typical and a read-onlyinstallation:


17

To install a read-only version of Toad for Data Analysts

1. During installation, select the Read-only option.

To change an existing installation to read-only

1. Reinstall Toad and select Read-only Install on the Install Type page.

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

Note:

Determine Which Installer to Use

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

Installer Advantages Disadvantages

Executable file(.exe)

Silent installation using the .exe filehas the following advantages:

l Verifies whether theprerequisite software isinstalled, and if not, redirectsyou to the downloadlocation.

Silent installation using the.exe file has the followingdisadvantages:

l Cannot deploycustom Toadsettings files orlicense keys.

l Installerautomatically exitsif the prerequisitesoftware is notinstalled.

MicrosoftInstaller file(.msi)

Supports deployment of Toadsettings files and license keys.

Silent installation using the.msi file has the followingdisadvantages:


18

Installer Advantages Disadvantages

l Requires manualverification anddownload of anyprerequisitesoftware.

l Requires a manualuninstall of theprevious version ofToad usingAdd/RemovePrograms.

Silent Installation Prerequisites

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

l Microsoft .NET Framework 3.5 (Service Pack 1)

l (DB2 native provider only) Toad installs a DB2 9.7 client as part of the installationprocess. The DB2 9.7 client can co-exist with an existing DB2 8 client, but isincompatible with a DB2 7 client. If a DB2 7 client already exists on your computer,the Toad installation stops and cannot complete. To resolve, first upgrade to the DB28 client. Then restart the Toad installation to avoid losing functionality in some DB2native tools.

Silent Installation Using the Executable

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

To perform a silent install using the executable file

1. At a Windows command prompt, switch to the drive or directory where theexecutable for Toad is located. (This file can be downloaded from the Quest web siteor can be found on the Toad installation CD-ROM.)

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

“ToadInstaller.exe” /S

For a read-only installation with create, alter, and drop functionality disabled, enterthe following command:

“ToadInstaller.exe” /S READONLY=TRUE

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


19

installation similar to the following command:

“ToadInstaller.exe” /S /Lx “C:\temp\installLog.txt”INSTALLDIR=”Drive:\your_install_path” USERNAME=”some_user”COMPANYNAME=”your_company” ALLUSERS=1

Use the following descriptions to customize the command-line options and overridesfor your installation.

Command-Line Options

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

Option Description

/L “C:\temp\installLog.txt”

(Optional) Write installation messages to the specified log.You can append other options, such as x for debug (used inthe previous example) or v for a verbose log. See the logsection at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information aboutadditional logging options.Also, substitute “C:\temp\installLog.txt” in the examplewith the fully qualified name of the log file. Enclose thisvalue in double quotations. The installation process createsthis file if it does not exist. Otherwise, the existing file isoverwritten.

Toad Default Installation Option Overrides

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

Option Description

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

ALLUSERS (Optional) Specify one of the following:

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

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

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



20

Option Description

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

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

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

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

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

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

Notes:

l All default installation option overrides are case-sensitive.

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

Silent Installation Using the Microsoft Installer

Create Transform (MST) Files

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

Note: (MSI installs on Windows Vista and 7) If you are using MSI to install Toad onWindows Vista or 7 with UAC enabled, you can install a file that adds a "Run asadministrator" option when right-clicking the MSIfile: http://www.symantec.com/connect/downloads/msi-run-administrator-context-menu-vista.

Note: The installer does not verify that system requirements have been met before installing.If you do not want to manually verify system requirements, you should use the .exe file forthe silent install.

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







21

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

To create a transform file that includes custom Toad settings

1. Save and install the ToadInstaller.msi file on a computer where the Wise for WindowsInstaller is installed. After customizing Toad settings, you will use the Wise Installerto create the transform file.

2. Open Notepad, and do the following:

a. Enter the license key in the first line.

b. Enter the site message in the second line. The file should look similar to thefollowing:

AAABBBBCCCCCCEDXDWLMV0WJ9-123-45678-B2

Quest Software

c. Save the file with license.key as the file name in the Toad install directory.Make sure the file extension is .key not .txt.

3. Launch Toad. The application should open without prompting you to enter alicense key.

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

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

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

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

8. Create any connections you want to deploy.

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

10. Create the Microsoft Transform file, using any appropriate tool. The following stepsdescribe how to use the Wise for Windows Installer to create the file.

a. Select File | New.

b. Select Custom Templates under Categories, and then select the Transformtemplate in the New Installation File window.

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

d. Save the project.

e. Select Files from the Feature Details view.


22

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

File to Add Location

Settings.xml This file is located in the following directory:C:\Documents and Settings\username\ApplicationData\Quest Software\ Toad for Data Analysts 3.1.

ModuleSettingsfolder and files

This folder and related files are located in thefollowing directory: C:\Documents andSettings\username\Application Data\Quest Software\Toad for Data Analysts 3.1\ModuleSettings.

Connections.xml This file is located in the following directory:C:\Documents and Settings\username\ApplicationData\Quest Software\Toad for Data Analysts 3.1.

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

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

Perform Silent Installation Using MSI

To perform a silent install using msi

1. At a Windows command prompt, switch to the drive or directory where the msiinstaller for Toad is located.

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

msiexec /i “ToadInstaller.msi” /q

For a read-only installation with create, alter, and drop functionality disabled, enterthe following command:

msiexec /i “ToadInstaller.msi” /q READONLY=TRUE

You can customize command-line options and overrides for your installation similarto the following:

msiexec /i “ToadInstaller.msi” INSTALLDIR= “Drive:\your_install_path” /q USERNAME=”someone” COMPANYNAME=”your_company” ALLUSERS=1


23

Command-Line Options

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

Option Description

/i Run the installation.

/q Specify the user interface (UI) that displays during installation.You can append other options, such as n to hide the UI or bto hide the Cancel button during the installation.

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

Toad Default Installation Option Overrides

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

Option Description

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

ALLUSERS (Optional) Specify one of the following:

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

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

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

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

l If ALLUSERS is omitted or defined with theempty string value (""), only the user specified




24

Option Description

here (and the user that installed Toad) can see theToad shortcut on the desktop after the installationcompletes.

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

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

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

Notes:

l All default installation option overrides are case-sensitive.

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

Note: During installation, if the user overrides the default installation directory location, thedirectory path cannot contain Unicode characters. This is due to the fact that we install aDB2 LUW client in the user specified Toad Installation directory and the DB2 installationdoes not support such characters.

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

Note: Limited testing has been performed for Citrix XenApp 5.0 support on WindowsServer 2003.

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, select the Anyone who uses this computer checkbox whenprompted.


25

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

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

6. Review the following considerations regarding licensing:

l A license supplied by an administrator always overrides a user-supplied licensein a Citrix environment.

l If you need to provide the same Toad functionality to all users, you can enterthe default license key for all users.

Upgrade ToadTo upgrade Toad

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

2. Select Uninstall Toad and continue with install.


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

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

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

Caution! Migrating settings from a previous version of Toad may overwrite new settingsfiles, implemented for the current release (for example, updated reports templates,layouts, etc).

File Description

Action.log Tracks your usage within Toad. If you agree to sharethis data, the file is automatically sent to Quest on aperiodic basis.

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

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


26

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

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

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

Quest.PersistentCache.xml Contains the private object annotation cache options(object notes, Lookup tables, and hidden columns). Youcan share these options with other Toad users in Tools| Options | Database | Cache.

Settings.xml Contains many of the global configuration settings.

SqlServerPlanPrefs.xml Used to generate SQL Server execution plans.

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 ifenabled. The data is in binary format and can always berecreated by fetching it from the database.

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

l Adapter—Custom data editing statements.

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

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

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

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

Keyboard Contains custom keyboard shortcut layouts.

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


27

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

ModuleSettings Contains general settings for various components inToad, such as whether the data grid defaults to read-only, displays not null indicators, etc.

Plugins Used by Toad plugin components.

Session Contains desktop configurations, including toolbarcustomizations and tool window locations.

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

SQLRecall Contains the SQL statements saved by SQL Recall.

Templates Contains the following templates:

l Code Templates—Templates used to definedefault values when creating new objects in theObject Explorer or Database Browser.

l Scripts—Startup scripts to run when connecting.

l Snippets—Code Snippet entries.

l Reports—Report entries.

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

l Any new files you create

l Any copies of files you make for backup purposes

l Settings files

You can uninstall Toad for Data Analysts by using the Installer or by using the WindowsAdd/Remove Programs (or Uninstall a program) feature. Using the Installer is the preferredway to uninstall Toad for Data Analysts.

To uninstall Toad

1. Run the ToadInstaller.exe.

2. Select Uninstall Toad for Data Analysts only.



28

Register ToadIf you received Toad for Data Analysts with your purchase of Toad for Oracle, note that byinstalling Toad for Data Analysts you agree to use the software solely on the seat for whichToad for Oracle was purchased.

To register Toad

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

2. Review the following for additional information:

Authorizationkey

Enter the license key for Toad.

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

Note: For users with an existing license key, your license key will enable the Base edition ofToad for Data Analysts. If you upgrade to the Professional edition, you must request aProfessional edition license key.

Configure Toad LayoutsUse the Configuration wizard to customize the look and feel of Toad to match Toad forOracle, SQL Navigator, or your native database tools. In addition, you can specify somewindow layout and window grouping options, as well as default windows to open on startupand connection.

Note: This topic focuses on information that may be unfamiliar to you. It does not include allstep and field descriptions.

To configure Toad layouts

1. Select Tools | Configuration Wizard (ALT+T+F).

2. Complete the wizard. Review the following for additional information:

Use thispage...

To....

Layout andSettings

Set one of the following:

l Toad for Data Analysts 3.0—Applies shortcut keys usedby Toad for Data Analysts, opens default windows, andadds the Wizard toolbar.


29

Use thispage...

To....

l Toad for Oracle—Applies shortcut keys used by Toad forOracle and automatically opens the Project Manager,Editor, SQL Recall, and Output windows.

l MS Query Analyzer—Applies shortcut keys used byQuery Analyzer and automatically opens the ObjectExplorer, Code Snippets, and Editor windows.

l MS Management Studio—Applies shortcut keys used byManagement Studio and automatically opens theConnection Manager and Editor windows.

l SQL Navigator—Applies shortcut keys used by SQLNavigator and automatically opens the NavigationManager, Object Explorer, Editor, and Code Snippetswindows.

l Toad for Data Analysts (Original)—Applies shortcut keysused by Toad for Data Analysts, opens default windows,and adds the Document Grouping and Wizard toolbars.

l Custom—Applies shortcut keys used by Toad for DataAnalysts, and lets you specify layout settings on theremaining pages.

Tip: You can set or modify individual keyboard shortcuts inKeyboard Options in Tools | Options | Environment| Keyboard.Note: If you select a new layout, you may need to restart Toad tosee the changes to the Grouping and Wizard toolbars.

Look andFeel

Set one of the following:

l Skin—Applies the skin style you select to documentwindows, tool windows, and modal dialogs.

l Grid style—Applies the grid style you select to the datagrid only.

When selecting an option, the current wizard page, including thesample data grid, provides a preview of the change.

DatabaseExplorerStyle

Specify how objects display in the Object Explorer window.

QuickGuide

Display a Quick Start Guide that lets you quickly launchfrequently used features and tutorials until you are more familiarwith the application.Tips:


30

Use thispage...

To....

l To view this window at anytime, select View | QuickGuide from the menu.

l To hide this window when starting Toad, select the Donot show on start up checkbox at the bottom of theQuick Guide window.

GroupDocuments

Specify the following options:

l Use document groups—Displays a Grouping toolbar thatcategorizes features into logical workgroups.

l Hide windows per group—Displays only those windowsthat are associated with the selected group. For example,if the Query group is selected and a Query Builderwindow is open, it will be hidden when you select theReport group.Note: Unless the Hide windows per connection checkboxis selected, any connections that have a window open forthis group display.

l Hide windows per connection—Displays only thosewindows for the current connection that are associatedwith the selected group.

Tip: To hide the Grouping toolbar, select Tools | Customizefrom the menu, and then clear the Grouping checkbox in theToolbar tab of the Customize window.

GroupDocumentDefaults

Select a default window to open for each connection whenselecting a group from the Grouping toolbar.Understand

l Database Diagram—Easily identify relationships betweentables via foreign keys.

l Database Explorer—Drill-down to details for each object.

Query

l Query Builder—Quickly create complex queries andsubqueries using a graphical interface.

l SQL Editor—Powerful editor for writing SQL queries andscripts.

Report

l Excel—Automatically export query results and open themin Excel.


31

Use thispage...

To....

l Toad Report—Send query results to the Toad Data Reportwizard.

Wizard Bar Select to display the Wizard bar, a toolbar containing frequently-used actions for the currently open window. It displays along thebottom of the Toad window.

ConnectionDocuments

Specify which type of new document to automatically openwhen a new database connection is created.

AdditionalSettings

Specify whether to automatically add files to the ProjectManager when saving, executing, or sending the files to a report.This option can help you locate and manage your work.

Create Connections

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

Tips:

l To view the number of actual database connections that exist for a Toad connectionand how many of those database connections are active, place the cursor over theconnection in the Connection Manager or the Connection toolbar (illustrated in thefollowing example).

l You can view the progress of statements executing in the background in a progressbar located on the lower right side of the status bar. To cancel a script's execution,click the progress bar to display the Background Processes window. It isrecommended to cancel only your own processes, as terminating Toad activities maylead to unexpected behavior.

Share Database Connections

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

l (DB2 and Oracle only) If your database supports executing multiple queriessimultaneously on a shared connection, the query is placed in a queue and executes as

2

Toad for Data Analysts Installation GuideCreate Connections

33

soon as the current operation completes.

l If your database does not support executing multiple queries on a shared connection, adialog prompts you to either permanently associate the window with a new databaseconnection, cancel the previous operation, or add the query to a queue until thecurrent operation completes, and the execute it. If you place multiple queries in thequeue, each one executes in the order that it was added to the queue.

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

Configure Oracle LDAP SupportYou can create Oracle Lightweight Directory Access Protocol (LDAP) connections whenyour Oracle client is configured for LDAP. Once the client is configured, Toad retrievesnames from your LDAP server and displays them in the Database Name list in the CreateNew Connection window.

Notes:

l To connect using LDAP, you must install an Oracle client on the computer.

l Toad supports a 9i, 10g, and 11 client and the Oracle Instant client. If you want to usethe instant client, you must configure it to work with Toad. See "Configure the OracleInstant Client" (page 35) for more information.

To configure the Oracle client for LDAP

1. Obtain the LDAP.ORA file from your database administrator.

2. Copy the LDAP.ORA file to the folder where the SQLNET.ORA file for your Oracleclient is located. The default folder is: ORACLE_HOME\network\admin

3. Open the SQLNET.ORA file and enter "(LDAP)" as the value for theNAMES.DIRECTORY_PATH as follows:

NAMES.DIRECTORY_PATH= (LDAP)

Note: If you are using multiple naming methods, add the (LDAP) value to existingparameter values. For example, if you are using both the TNSNAMES and LDAPnaming methods, add LDAP to TNSNAMES as follows:

NAMES.DIRECTORY_PATH= (TNSNAMES, LDAP)

4. Save the SQLNET.ORA file.

5. Launch Toad and select File | New | Connection.

6. Create an LDAP connection following the procedure in Create OracleConnections (page 34). In step 3, select a database on the LDAP server from theDatabase Name list.


34

Create Oracle ConnectionsYou can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot Oracle Issues" (page 84) for more information abouttroubleshooting connection issues.

Click here to view a video about creating connections in Toad for Data Analysts

Tip: You can configure Toad for Data Analysts to accept connection information from Toadfor Oracle. See "Add Connection Parameters to Open from Toad for Oracle" in the onlinehelp for more information.

You can connect to your database using a native Oracle database provider in Toad using oneof the following methods:

Connection Method Advantages Disadvantages

Client connection(Client tab)—Uses aninstalled Oracle Client orOracle Instant Client toestablish a connection tothe database from Toad.

l Supports LDAP (See"Configure OracleLDAP Support" (page33) for moreinformation aboutconfiguring theOracle client to useLDAP.)

l Requires an OracleclientNote: Toadsupports Oracleclients and OracleInstant clientsusing version 9i orlater.

Direct connection(Direct Connect tab)—Uses TCP/IP to connectdirectly to the database.

l Does not require anOracle Client to beinstalled

l Recommended forconnecting to Oracle8i databases

l Only supportscommon datatypes. Someadvanced Oracleobject types cannotbe retrieved whenconnecting usingthis method.

l Does not supportLDAP (To connectusing LDAP, usethe ClientConnection methodinstead.)

Note: Quest recommends using one of the methods described in this table to connect toOracle rather than an ODBC driver. Because ODBC connectivity is generic, it is not full-featured and may not be as robust as the fully exploited native database provider.

http://toadworld.com/Portals/0/assets_ifs/flashdemos/TDADataConnections/index.htm


35

Configure the Oracle Instant Client

The Oracle Instant client installs only those files needed to connect to your database usingOCI. Because this client does not write to the registry (no ORACLE_HOMES) or add to theenvironmental path, you must manually set environment variables so the client can be usedwith Toad.

To configure the Oracle Instant Client to work with Toad

1. Save the Oracle Instant Client files in any location on the computer where Toad isinstalled.

2. On your Windows desktop, right-click My Computer and select Properties.

3. Select the Advanced tab and click Environment Variables.

4. Click New under System Variables and complete the following:

Variablename

Variable Value

PATH <Path where Instant Client is installed>;%PATH%For Example: C:\Program Files\OracleInstantClient;%PATH%

TNS_ADMIN

<Path where tnsnames.ora file is installed>

Notes:

l If you are using the Oracle Instant Client, you must also install an Oracle ODBCdriver before using this connection in a cross-connection query. (The Oracle Clientfull install does include an ODBC driver.)

l You cannot use Oracle Direct Connection in a cross-connection query.

Create an Oracle Connection

To create an Oracle connection

1. Click on the toolbar (ALT+F+N).

2. Select Oracle from the Group list box.


Login Tab Description

Databasename

Select the alias to use when connecting. This list displaysaliases from LDAP as well as any local tnsnames.ora file.Note: If you do not select a database, Toad uses the ORACLE_


36

SID for the selected home. If an ORACLE_SID value does notexist and you do not specify a database, you cannot connect.

Password Enter the password to use when connecting.Tip: After connecting, you can set a master password to furthersecure your connection in Tools | Options| Environment |Security.

Connect as Select whether to connect as either SYSDBA or SYSOPER ifyou have the appropriate permissions. Otherwise, use thedefault.

Schema Select a schema if you frequently work in a different schemathan the one associated with your user name.

Explainplan table

(Optional) Specify the location of an existing explain plan tableto use instead of Toad automatically creating one for you whenyou execute a statement. This is useful if you do not havenecessary permissions to create explain plan tables or want touse an existing table.

Category Select or create a category if you want to color code Editor tabsfor a specific connection. This can help differentiate betweendevelopment and production databases. You can also set anoption to color code the Object Explorer pane and object editorwindows (Create, Alter, Drop, etc.). Click here to view avideo of this feature.

Savepassword

Select this checkbox if you plan to use Automation to generatereports.

OracleClient Tab

Description

Currenthome

Modify the Oracle home to use, if needed.

TNSNamesEditor

Click this button to edit your local TNSNames file.Tip: You can press CTRL+F to open the Find/Replace windowto locate entries in the TNS Names Editor. Pressing F3 locatesthe next entry that matches your criteria.

SQLNETEditor

Click this button to edit SQLNET.ORA parameters. Beforeediting this file, you should create a backup copy. SeeSQLNET.ORA Profile Parameters in the Oracle documentationfor more information.

Direct Tab Description

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


37

SID Enter the ORACLE_SID value for the database. This value isspecified in the registry under each installed home.

AdvancedTab

Description

ODBCdriver

If an Oracle Client is installed, the default is the Oracle ODBCdriver.If no Oracle Client is installed, the default is the MicrosoftAccess ODBC driver.Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options| Database | Oracle.

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

or

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

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

Create Oracle Business Intelligence ConnectionsUsing Quest Data Services connectivity, Toad provides the ability to connect to thepresentation layer of Oracle Business Intelligence Enterprise Edition (OBIEE).

Note: This feature is only available in the Toad for Data Analysts Premium Edition.

To create an Oracle Business Intelligence Enterprise connection

1. Click on the Connections toolbar (ALT+F+N).

2. Select Quest Data Services from the Group list.

3. Select Oracle BI Enterprise from the Connection Type list.

4. Enter the connection information in the Create New Connection dialog. Review thefollowing for additional information:

URL Enter the Oracle Business Intelligence Enterprise URL to whichyou want to connect.Note: You must include the port number in the URL as in thefollowing examples:

format—http://<server path>:<port>/analytics/saw.dllexample—http://server01.mycompany.com:80/analytics/saw.dll


38

Subject Area Enter the name of the subject area with which you want towork.


Row Limit Select a row limit to enforce for query results.default = 500,000

Category Select an existing category or create a new one.

Note: In Quest Data Services connections, Toad automatically saves the password inthe connections.xml file as obfuscated text and in Toad. To add additional passwordsecurity, use Toad's Master Password feature.

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

Note: Click Save to save the connection without connecting.

6. Immediately upon creating an initial new connection, Toad analyzes thetables/dimensions available in the presentation layer and maps them to Toad. Whenthis process is finished (the process may run a few minutes or more), the TableObject Mapping dialog displays. Select the tables to map for this connection andclick Execute.

Notes:

l In the Table Object Mapping dialog, you can modify the Mapped Name of atable. This is the name that Toad will display in Object Explorer for this table.You cannot have spaces in a mapped name.

l After creating the connection, you can click in the Object Explorer toolbarto add or remove tables from the connection's table map.

Important Information about Oracle BI Connections

You must incorporate the port into the OBIEE database connection URL in thefollowing format:

http://<server name>:<port>/analytics/saw.dll

An example URL is http://server01.mycompany.com:80/analytics/saw.dll

Considerations and Limitations with Oracle BI Connections

Review the following limitations and OBIEE behaviors before using an OBIEE connection.


39

Consideration/Limitation Description

Tables vs OBIEEdimensions

What you see represented in Toad as tables are actuallyOBIEE dimensions in the presentation layer, and they donot have exposed keys. The relationships between thesource data are managed in the background by Oracle.

Table representation inQuery Builder

After dragging a table to the Query Builder diagrampane, you will notice that there are no key icons torepresent key columns and no connectors to represent therelationships between tables. The relationships betweentables are managed through the Oracle back end. Whenyou execute a query, the joins between source data arehandled by Oracle in the background. So, you do notneed to draw a relationship between tables beforebuilding a query.

Using ORDER BY on"sort order" configuredcolumns

Some OBIEE columns may have a “sort order” configuredin the server. When querying this type of configuredcolumn using ORDER BY, the resulting order is basedon the configured column’s “sort order.”

Max character limit There is a maximum character limit of 255.

Tips:

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

l You can specify a proxy server to use for Quest Data Services connections at Tools |Options | Database |Quest Data Services.

l Oracle Business Intelligence connections are read-only.

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

Define DB2 Client Connections

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

Transfer an existing catalog from another DB2 client on your computer

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


40

Transfer a Catalog During Initial Setup

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

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

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

l This installation is a first-time Toad installation on your computer, or it is an upgradefrom a previous Toad version already on your computer.

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

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

To transfer an existing DB2 catalog

1. Open Toad after installation is complete.

2. If Toad displays the Settings Migration Utility window, select whether tomigrate from your previously installed Toad. (These settings include Toadconnection profiles.)

l If you migrate settings, the window showing the option to transfer a catalogdisplays once the migration completes.

l If you do not migrate settings, the window showing the option to transfer acatalog displays when you select to create the first connection.

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

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


41

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

4. Click OK to proceed with the catalog transfer.

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

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

5. Proceed to create Toad connection profiles for the DB2 databases and subsystemswhose connection profiles you did not migrate (in step 2). For those profiles youmigrated, simply select the connection in the Connections window, and provide thelogin ID and password to start the connection. See "Create Toad Connection Profilesfor DB2" (page 50) for more information.


42

Transfer a Catalog Any Time After Initial Setup

To transfer a catalog any time after initial setup

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

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

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

3. Click OK.

4. Create Toad Connection Profiles for DB2 (page 50) for any of the transferred catalogentries as needed.

Import a DB2 catalog previously exported to a file

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

l Export Profile feature in the Toad Configuration wizard (for exporting your currentToad DB2 client catalog only). See " Export the catalog for the current DB2 client"(page 48) for more information.

l DB2 Connectivity Configuration Export Tool Command db2cfexp. For moreinformation, see the following IBMdocumentation:http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/com.ibm.db2.udb.doc/core/r0002442.htm.

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

To import an exported catalog profile

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

2. On the Welcome page, select Import Profile.

3. Click Next.

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



43

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


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

Note: DB2 does not automatically export catalog entries for the local DB2 instanceand its databases on the computer from which the export is run (unless these entriesalready exist in the catalog). Therefore, the profile you are importing might notinclude these node entries. To add the missing entries to your Toad DB2 clientcatalog, you must manually catalog the databases. If these databases are local to yourcomputer, catalog them as remote databases. See "Manually catalog DB2 for LUWdatabases " (page 43) for more information.

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

Manually catalog DB2 for LUW databases

To manually catalog a DB2 for LUW database

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

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

3. Click Add Catalog Entry.


Add a Host Description

Operatingsystem

Select the operating system for the server on which the DB2for LUW instance containing the DB2 database you arecataloging resides. For a list of supported server platforms,see the release notes.

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


44

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

EnableSOCKSsecurity

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

Specify anInstance

Description

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

Instance name Enter the real name of the DB2 instance.

Comment Enter a descriptive comment for the instance, if needed.

Add a Database Description

Database name Enter the real name of the DB2 database.

Database alias Enter a unique nickname to identify the database on yoursystem.

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

Targetprincipal

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


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


45

Manually catalog DB2 for z/OS subsystems

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

To manually catalog a DB2 for z/OS subsystem

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

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




Operatingsystem

Select z/OS for the server operating system.

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

Portnumber

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

EnableSOCKSsecurity

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

Add a DB2Subsystem

Description

Locationname

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

Databasealias

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


46

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

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

Manually catalog DB2 Connect gateways

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

To manually catalog an entry to a DB2 Connect gateway

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

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




Operatingsystem

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

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

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

EnableSOCKSsecurity

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

Specify anInstance

Description

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

Instance name Enter a user-defined name for the gateway node or use thesame value entered in the Node name.


47

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

Add a Database Description

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

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

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


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

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

Maintain DB2 Client Connections

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

Edit DB2 catalog entries

To edit a DB2 catalog entry


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

3. Click Edit Catalog Entry.


48

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

l Manually catalog DB2 for LUW databases (page 43)

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

l Manually catalog DB2 Connect gateways (page 46)

5. Click Next to open the Catalog Script Review window.

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

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

Remove DB2 catalog entries

To remove a DB2 catalog entry


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

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

3. Click Remove Catalog Entry.

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

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

Export the catalog for the current DB2 client

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

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




49

To export the Toad DB2 client catalog

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

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

(You might need to click this button.)

3. Click Next.

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

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

l Template to create a profile used as a template for other DB2 clients (defaultfor exporting a Toad DB2 catalog)

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

l Maintain to create a profile that contains only database or node informationrequired for updating other instances

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

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

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

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

Configure DB2 LDAP SupportYou can create DB2 Lightweight Directory Access Protocol (LDAP) connections when theDB2 client installed with Toad is configured for LDAP. Configuring the client consists ofenabling LDAP support and specifying the host name and port number of the LDAP server.Once the client is configured, Toad retrieves names from your LDAP server and displaysthem in the Database Alias list in the Connections window.


50

Notes:

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

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

To configure the DB2 client for LDAP

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

2. Enter the following command to enable LDAP support:

db2set DB2_ENABLE_LDAP=YES

3. Enter the following command to specify the TCP/IP host name and port number of theLDAP server:

db2set DB2LDAPHOST=<hostname[:port]>

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

4. Exit the Command window.

5. Launch Toad and open the Connections window.

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

Create Toad Connection Profiles for DB2Toad requires two phases to set up connections to the DB2 for LUW databases and DB2 forz/OS subsystems that you want Toad to manage.



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

The second phase involves creating Toad connection profiles for the cataloged DB2databases or subsystems. Each profile contains the information that Toad needs to connect tothe system, such as the user ID and password, DB2 registry settings, and the default schema.



51

Create Connection Profiles

Use these methods to create Toad connection profiles:

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

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

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

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

l Toad detects earlier versions of Toad on your computer.

If you choose not to migrate the connection profiles at this point, you can perform themigration later using the Connection Managers' Import Connections feature.

To migrate Toad connection profiles

1. Open Toad after installation is complete. Toad displays the Settings MigrationUtility window if the conditions described previously exist.

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

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

3. Select to transfer a DB2 catalog or to manually catalog entries later. See"Configure DB2 Client Connections" (page 39) for more information.

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

After the catalog transfer is complete, your Toad connection setup is completefor all those connections that have both a catalog entry on the Toad DB2client and a Toad connection profile. For any connection that does not have acorresponding DB2 catalog entry, create an entry. See "Configure DB2 ClientConnections" (page 39) for more information.

l Import Toad connection profiles previously exported to an XML file

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


52

Note: The connection profiles are not usable unless you have also created entries inthe DB2 catalog for the DB2 databases and subsystems to which these profilescorrespond. See "Configure DB2 Client Connections" (page 39) for more information.

To import connection profiles

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

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

3. Click Open.

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

The connections whose profiles you imported are listed on theConnections window.

l Manually define Toad connection profiles.

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

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

2. Select DB2 from the Group list box.


Databasealias

Select the alias for the DB2 database or subsystem. Thisalias was defined when you cataloged this DB2 databaseor subsystem on the Toad DB2 client. See "ConfigureDB2 Client Connections" (page 39) for more informationif the alias does not display in the list.

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

Defaultschema/authID

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

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


53

Editor tabs for a specific connection. This can helpdifferentiate between development and productiondatabases. You can also set an option to color code theObject Explorer pane and object editor windows (Create,Alter, Drop, etc.).

Click here to view a video of this feature.

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

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

or


Manage Connections

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

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

l Export connection profiles to an XML file

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

To export connection profiles

1. In the Connections (or Create New Connection) window, select theconnections whose profiles you want to export.

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

3. On the Export Connections window, review the selected connections,and click OK.

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

l Import missing connections defined on the Toad client

You can import all connection entries currently defined in the Toad DB2 clientcatalog but missing from your current list of Toad connections.



54

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

To import missing connections

» In the Connections or Connections Manager window, click .

l Troubleshoot connection issues

Create Access ConnectionsAlthough this connection uses the ODBC driver, it is easier and faster to connect using thismethod. See "Troubleshoot Access Issues" (page 71) for more information abouttroubleshooting connection issues.

Notes:

l The Toad Sample Database and established connection that comes pre-loaded inToad for Data Analysts is an Access database. The connection information for thisdatabase is:

Database file = C:\Program Files\QuestSoftware\ToadInstallDirectory\Plugins\Odbc\Sample Database\Quest_Stage.mdb

Additional sample files for this database are available in the Project Manager.

To create an Access connection


2. Select Access from the Group list box.


Database file Select the database to use when connecting.

MDW file Select the MDW file that is linked to the database.


Category Select or create a category if you want to color code Editor tabsfor a specific connection. This can help differentiate betweendevelopment and production databases. You can also set anoption to color code the Object Explorer pane and object editor


55



or




Create Business Objects ConnectionsUsing Quest Data Services connectivity, Toad provides the ability to connect directly toBusiness Objects.


To create a Business Objects connection



3. Select Business Objects from the Connection Type list.


URL Enter the Business Objects URL to which you want to connect.This is the URL to the Query as a Web Service component ofthe Business Objects installation. See "Important Informationabout Business Objects Connections" (page 56) for moreinformation.Note: The URL should be in the following format:

http://<server>:<port>/dswsbobje/gaawsservices






56


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


6. Immediately upon creating an initial new connection, Toad analyzes the queriesavailable and maps them to Toad. When this process is finished (the process may runa few minutes or more), the Table Object Mapping dialog displays. Select the tablesto map for this connection.

7. If a query has a parameter, you must enter the default value for the parameter.

8. Click Execute.

Notes:

l In the Table Object Mapping dialog, you can modify the Mapped Name of atable. This is the name that Toad will display in Object Explorer for this table.


Important Information about Business Objects Connections

To create a Business Objects connection in Toad, you must connect to the Query as a WebService component in Business Objects. The connection URL should have the format:

http://<server>:<port>/dswsbobje/gaawsservices

Where <server> corresponds to your web server address, and <port> corresponds tothe port where you set up in your web server. (dswsbobje is the default name of theQuery as a Web Service web application.)

An example URL is http://server01:8080/dswsbobje/gaawsservices.

For more information about the Business Objects component, Query as a Web Service, seethe documentation at http://help.sap.com/businessobject/product_guides/xir2PP/en/qaaws.pdf.

http://help.sap.com/businessobject/product_guides/xir2PP/en/qaaws.pdf

http://help.sap.com/businessobject/product_guides/xir2PP/en/qaaws.pdf


57

Considerations with Business Objects Connections

Consideration Description

Tables vs Business Objectsqueries

What you see represented in Toad as tables areactually Business Objects queries.

Table representation in QueryBuilder

The representative tables you see in Query Builder dohave exposed keys. You can join tables, but you mustcreate the relationship in the Query Builder diagrampane.

Max character limit There is a maximum character limit of 255.

Tips:



l Business Objects connections are read-only.

Create Excel ConnectionsConnecting to an Excel file is easy. To create the connection, simply open the Excel file fromthe Create New Connection dialog .

To create an Excel connection

1. Click on the Navigation or Connection Manager toolbar.

2. Select Excel from the Group list.

3. Browse to and select the Excel File name.

4. Complete the Create New Connection dialog. Review the following for additionalinformation:

General Tab Description

Category Select a category if you want to color code your connection.Tip: The color is applied in the Connection Manager andother connection dialogs. You can also create a new categoryfor your connection.

Advanced Tab Description


58

Enable importmode

Select this checkbox to set IMEX=1 in the connection string,which converts intermixed data to text.

Show systemtables

Select to display worksheets as system tables. Toad uses theworksheet name suffixed with a dollar sign ($).

Automaticallycreate ranges

Select this option if you want Toad to automatically createnamed ranges. Toad creates one named range in eachworksheet (unless the Toad name, AutoRange_<worksheetname>, already exists).Note: Toad does not overwrite the user defined namedranges. The Toad-created named ranges and the user definednamed ranges are both visible in the Object Explorer afterconnecting.Deselect this option if the Excel file contains user definednamed ranges and you do not want Toad to create additionalnamed ranges.Important: If you deselect this option, and your Excel filedoes not contain named ranges, Toad is unable to createtables from your data.The feature is selected by default.

Hide namedranges

Select the named ranges to hide.Note: Named ranges are not displayed until after aconnection is created (in the Connections or ConnectionProperties dialog). In Excel 2007 files, named ranges are notdisplayed for active connections.

Open inExcel

Click to open the selected file in Excel. This is useful if youwant to modify your file or define named ranges beforeconnecting.


or


Understand how Toad creates data tables from an Excel file

Toad uses Excel named ranges (regions) to define the data to include in a table. Therefore,any data that you want to display and easily query in Toad must be included in an Excelnamed range (region).

You can create named ranges using one of the following methods:

l Preferred method: You can ask Toad to automatically create named ranges when youcreate the connection to the Excel file. Toad creates one table from each worksheetand includes the contents of every formatted cell.


59

l If you do not want to include a worksheet's entire contents in one named range, or ifa worksheet contains more than one table, then define the named ranges ahead oftime in Excel.

To create a named range in Excel

1. In the Excel file, select the data that you want to include in the table (includingcolumn headings). Then define a named range.

» In Excel 2003, select Insert | Name | Define.

» In Excel 2007, right-click the data and select Name a Range.

2. Save your Excel file. In Toad, create a new connection to the file. In the NewConnection dialog, deselect Automatically create ranges.

To allow Toad to automatically create named ranges

» When creating a new connection to the Excel file, in the New Connection dialog,select Automatically create ranges. Toad creates one named range for each worksheetand includes the contents of every formatted cell.

Tip: For an Excel file with an existing connection, in the Navigation Manger, right-click thefile and select Properties. On the Advanced tab, select Automatically create ranges. Toadcreates the named ranges the next time you reconnect to this file.

To hide named ranges

You can hide an Excel file's named ranges so that they do not display as tables in theObject Explorer.

1. In the Navigation Manager, right-click an Excel file connection and select Properties.

Note: In Excel 2007 files, the connection must be inactive for the namedranges to display.

2. On the Advanced tab, select the named ranges to hide.

To view or modify connection properties

To view an Excel connection's properties, do one of the following:

l Right-click an Excel file connection in the Navigation or Connection Manager andselect Properties.

l Select on the Connections toolbar to open the Connections dialog. Select the Excelfile connection in the left pane to view the connection properties in the right pane.





60

See "Troubleshoot Excel Issues" (page 71) for more information about troubleshooting Excelconnection issues.

Create MySQL ConnectionsYou can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot MySQL Issues" (page 82) for more information abouttroubleshooting connection issues.


To create a MySQL connection


2. Select MySQL from the Group list box.



Connectiontype

Select the protocol to use when connecting.

Host Enter the name of the host computer where the database isinstalled.


Connectiontimeout

Enter the number of seconds to wait when connecting beforethe application times out. The default is 15 seconds.

SSL If you selected SSL as the connection type, review thefollowing for additional information:

l Private key—browse to the location of the SSL key fileto use when connecting.

l CA cert—browse to the location of the trusted certificateauthority to use when connecting.

l Cert—browse to the location of the SSL certificate fileto use when connecting.


61

Compress Select this checkbox to compress the value of any strings andreturn binary values.

UseMySQLlibraries

Select this checkbox to use an embedded MySQL libraryinstead of the MySQL .NET provider.Note: If you select this option, you must specify libMySQL.dllin the path.


AdvancedTab

Description

ODBCdriver

Select an ODBC driver to use when executing cross-connectionqueries using this connection.Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options| Database | MySQL.


or




Create ODBC ConnectionsThe purpose of the ODBC provider is to offer basic connection and querying capabilities toany database that supports an ODBC 3.0 or later driver. For a list of databases tested with theODBC provider, see the Release Notes. This form of connectivity allows connections todatabases such as Netezza, IBM iSeries, Ingres, and Vertica. Because this form of connectivityis generic, it is not full-featured and may not be as robust as the fully exploited providers fordatabases that use a native provider.

To create an ODBC connection

1. Click on the toolbar (ALT+F+N+O).

2. Select ODBC from the Group list box.




62

3. Click in the Data Source Name field.4. Click Add.

5. Select an ODBC driver from the list, and click Finish.

Note: If creating an Oracle ODBC connection, select the ODBC driver provided byOracle. The Microsoft ODBC for Oracle driver has less functionality than the driverprovided by Oracle.

6. Specify the configuration properties required for the database in the windowsconfiguration dialog.

Notes:

l If you have an Oracle database with Unicode data, make sure to select ForceSQL_WCHAR Support on the Workarounds tab of the windows Oracle ODBCConfiguration dialog. If you do not, you will not be able to see the data.

l If creating a MySQL ODBC connection to use in a cross-connection query,you must specify a database in the windows MySQL ODBC Configurationdialog. See "Troubleshoot MySQL Issues" (page 82) for more information.

7. Specify the connection properties in the Create New Connection dialog. Review thefollowing for additional information:

Use datasource name

Select to display the Data source names.Deselect to display the driver names.

Data sourcename

Select the driver or data source name you added in the previoussteps.

User Enter the user name to use when connecting.


Database Specify the location of the database schema. Click to create atemporary connection and display available schemas in the drop-down list.

Information

DataSourceName

Displays the selected driver or data source name.

Driver Displays the ODBC driver associated with the data source.

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


63



or




Create Salesforce.com ConnectionsUsing Quest Data Services connectivity, Toad provides the ability to connect directly toSalesforce.com.


To create a Salesforce.com connection



3. Select Salesforce from the Connection Type list.


URI Enter the Salesforce.com URL to which you want to connect.Note: An example is https://login.salesforce.com.

Username Enter your email login.Note: You must have an email login to connect toSalesforce.com from Toad. Toad does not support single sign-onfor Salesforce.com at this time.


Securitytoken

Enter your Security Token provided by Salesforce.Note: You must have a Salesforce security token to create aSalesforce.com connection from Toad. See "Important Notesabout Salesforce.com Connections" (page 64) for moreinformation.




64



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


6. Immediately upon creating an initial new connection, Toad analyzes the tablesavailable and maps them to Toad. When this process is finished (the process may runa few minutes or more), the Table Object Mapping dialog displays. Select the tablesto map for this connection and click Execute.

Notes:

l In the Table Object Mapping dialog, you can modify the Mapped Name of atable. This is the name that Toad will display in Object Explorer for this table.


Important Notes about Salesforce.com Connections

l A Security Token is required to log on to Salesforce from Toad.

l For information on how to generate a new security token, see the Salesforcedocumentation at https://login.salesforce.com/help/doc/en/user_security_token.htm.

Considerations and Limitations with Salesforce.com Connections

l Toad does not show the native table relationships for Salesforce tables at this time.

l There is a maximum character limit of 255.

Tips:



l Salesforce.com connections are read-only.

Create SQL Server and SQL Azure ConnectionsYou can create a new connection, or connect to an existing connection from the Create NewConnection window. See "Troubleshoot SQL Server Issues" (page 85) for more informationabout troubleshooting connection issues.

https://login.salesforce.com/help/doc/en/user_security_token.htm




65


Note: For SQL Azure connections:

l You must be given explicit read-access to the master database.

l You can login to Windows Azure Platform by selecting Tools | Cloud Computing |SQL Azure Portal and providing your credentials.

l Make sure that no Azure firewall rule restricts your IP address from having access toAzure server. See "Create and Alter Azure Firewall Rules" in the online help for moreinformation.

To create a new connection


2. Select SQL Server from the Group list box.



Servername

Enter the name of the server to use when connecting.Click to display any servers running SQL Server that arecurrently active on the network.Notes:

l For SQL Azure connections, enterInstanceName.database.windows.net in this field.

l For named instances, enter theMachineName\InstanceName in this field.



AdvancedTab

Description

OBDCdriver

Select an ODBC driver to use for this connection when creating




66

cross-connection queries.Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options| Database | SQL Server.


or



To connect to server via Central Management Server


1. Connect to the server, where the CMS is registered.

2. Right-click a connection and select Connect to Central Management Server.

3. Expand CMS Connections list.

4. Double-click the server to connect to it.

Notes:

l CMS is available on Microsoft SQL Server 2008 only.

l User should have an appropriate login (Windows Authentication and grant to connectto selected server are required) created on the server to which he connects via CMS.


67

Create Sybase ConnectionsYou can create a new Sybase IQ, Sybase SQL Anywhere, or Sybase ASE connection, orconnect to an existing connection from the Create New Connection window. See"Troubleshoot Sybase Issues" (page 86) for more information about troubleshootingconnection issues.



To create a Sybase connection


2. Select a connection type from the Group list box.

3. Enter the login information. Review the following for additional information:


Host Enter the host name for the connection.Note: This field is only available when you select a Sybase IQor Sybase SQL Anywhere connection.


CharSet Enter the client character set such as UTF-8 in this field if itdiffers from the default character set. This helps you avoidconnection issues.Notes:

l This field is not case sensitive.

l This field is only available when you select a SybaseASE connection.


Advanced Description




68

Tab

ODBCdriver

Select an ODBC driver to use for this connection when creatingcross-connection queries.Tip: You can specify the ODBC driver to use for allconnections for this database provider in Tools | Options| Database | Oracle.


or



Create Teradata ConnectionsToad allows you to create a full-featured, native Teradata connection. This type ofconnection provides complete Query Builder, Query Editor, and Database Explorerfunctionality.

Notes:

l You must have a Teradata .NET Data Provider installed before you can create aTeradata connection.

l To use a Teradata connection in a cross-connection query, you must have a TeradataODBC driver installed.

l In the Base edition of Toad for Data Analysts, to use a Teradata connection in a cross-connection query, you must use a Teradata ODBC connection instead of a nativeconnection.

To install the Teradata data provider

» Download and install the Teradata .NET Data Provider from the Teradata Web site.

To create a Teradata connection


2. Select Teradata from the Group list.


Login

Server name Enter the name of the server hosting the database to which


69

you want to connect.

Use SingleSign On

Select if the user is using a single sign-on authenticationsystem.

Password Enter the password to use when connecting.Tip: After connecting, you can set a master password tofurther secure your connection in Tools| Options| Environment | Security.

Session mode Displays the session mode, which is always Teradata in aToad Teradata connection.

Defaultdatabase

(Optional) Enter a default Teradata database for theconnection.


Advanced

Mechanism (Optional) Select an authentication mechanism from the list.

Parameter (Optional) Enter the parameters required by the selectedauthentication mechanism. See your system administrator forthese values.

Account string (Optional) Enter a new account string.

Character set Select a character set.Note:When querying or viewing data in a column definedwith GRAPHIC or CHARACTER SET GRAPHIC data type,you must specify a Character set of UTF-16 for the session.

Use dataencryption

Select if using data encryption.


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


To install a Teradata ODBC driver

» Download and install a Teradata ODBC driver from the Teradata Web site. For a listof supported Teradata ODBC drivers, please see the Release Notes for your version ofToad for Data Analysts.


70

Notes:

l Toad does not support the Teradata multi-statement request.

l You can specify which Teradata Data Directory views to use, X views or Non-Xviews, in Tools | Options | Database | Teradata.

Troubleshoot Connections

Troubleshoot Access IssuesReview the following solutions to help troubleshoot Access issues pertaining to missingfunctionality and object information and other problems in Toad.

Missing Functionality and Object Information

Issue Cause/Solution

Some queries display in theView tab of the Object Explorer,but do not display in the Querytab.

The Access ODBC driver handles saved queries inthe following manner:

l If the stored query does not containparameters, it is treated as a view anddisplays in the View tab.

l If the stored query contains parameters, it istreated as a stored procedure and displays inthe Query tab.

Primary key information isunavailable.

The Microsoft Access ODBC driver does not returnprimary key information for databases. However, insome cases, Toad can obtain this informationthrough additional methods.

Other Issues


A delay occurs between writinga value to a database via oneconnection and seeing theupdated value via anotherconnection.

This delay is the default when you are writing andreading data between two different Jet connections.The delay occurs even if the two connections residein the same client process.Solution:Use a single connection when updating data.

Troubleshoot Excel IssuesReview the following to help troubleshoot and solve issues involving Excel files.

Toad for Data Analysts Installation GuideTroubleshoot Connections

72

Excel Connections


Tables are limited to256 columns and65536 rows.

This is a known limitation with Excel worksheets.

Column names longerthan 64 characters aretruncated and theremaining charactersdisplay as null.

This is a known limitation with Excel worksheets.

Columns that includetext values or specialcharacters as part of anumeric value, as wellas entries with straightnumeric values, resultin one of the value setsdisplaying as null.

When you connect to Excel, the driver automatically scansthe first eight rows in a column and applies the data typeused in a majority of those rows to all rows in the column.Any rows that do not meet the majority data type display asnull values.Solution 1: Reformat worksheet column and values as text.

1. Open the worksheet in Excel.

2. Format the column that contains mixed data types asText.

3. You can now connect to this spreadsheet from Toadwithout any null values displayed.

Solution 2: Create an ODBC connection.You can force the ODBC driver to read all rows as Text toavoid null values; however, this can result in issues if youattempt to insert data.

1. Open the Create New Connection window and selectODBC from the Group list.

2. Complete the fields as described in Create ODBCConnections.

3. Enter "IMEX=1", in quotations, in theExtraParameters field.

4. Click Connect.

Column names thatcontain an exclamationpoint (!) are notsupported.

The exclamation point character has a special meaning inExcel. If a column name contains an exclamation point, it isinternally converted to a dollar sign ($) character.

Tables cannot bealtered.

Tables cannot be altered when the Excel connection is Read-Only.Solution: Deselect Read-Only Connection in the Connection


73


Properties dialog.

The Primary Keys andForeign Keys tabs areblank in the DatabaseExplorer.

Excel is a spreadsheet, and does not support primary andforeign keys so these tabs are always blank.

Indexes cannot becreated or dropped.

The Excel ODBC driver does not support this functionality.

Unable to query Excelfiles without namedranges (regions).

The worksheet you are querying does not have named ranges(regions) defined.Solution:You can query the worksheet from the Editor by entering adollar sign ($) followed by a cell range to limit the resultssimilar to the following statement: Select * from (MyWorksheet$A1:C10)

You can also query the entire worksheet by entering a dollarsign ($) after the worksheet name. However, this may alsoreturn the worksheet's empty rows and columns.

Attempting to connectto or create a newExcel connectionresults in No usertables could be foundmessage.

The Excel file does not have named ranges (regions) defined.If you click OK to close the message, the new connection iscreated, but no user tables display in Object Explorer.(System tables are displayed, if you selected to show these.)Solution 1: In the Excel file, create named ranges.Solution 2: Ask Toad to automatically create named ranges.

1. Disconnect from the file.

2. In Navigation Manager, right-click the file and selectProperties | Advanced.

3. Select Automatically create ranges.The next time you connect, Toad automaticallycreates named ranges, which are then displayed astables.

See "Create Excel Connections" (page 57) for moreinformation.

Unable to query datausing an empty stringor null value.

The underlying data format cannot differentiate between anempty string and null data, so a query with a searchcondition that contains an empty string does not match anyempty strings in the table. This occurs because the emptystring is treated as a null value, and a null value nevermatches anything, not even another null value.


74


Unable to update ordelete rows in a table.

The Excel ODBC driver does not support this functionality.While it is possible to update values, DELETE statements donot remove a row from a table. Basically, you can only insertdata in a table.

Attempting to insertdata results in Cannotexpand named rangeerror.

This error occurs if you have more than one named range(region) in the same worksheet, and the named ranges are notseparated by blank rows.Solution 1: You must add blank rows between named ranges.Add as many blank rows as you have new records to insert.Solution 2: Include only one named range in each worksheet.

Opening Excel Files in Toad Document Window


Excel menus do not display whenyou open Excel files in a Toaddocument window.

The Toad document window cannot display allExcel menus.Solution:Right-click the Excel toolbar and add theequivalent toolbar for the missing menu orfunctionality.

When two or more instances ofExcel are open in Toad documentwindows, toolbars are active foronly one instance.

Toad document windows support one Excelinstance at a time. Opening more than one Excelfile disables the Excel toolbars for the additionalfiles.Solution:Open only one Excel file at a time.

Troubleshoot DB2 LUW IssuesReview the following solutions to help troubleshoot DB2 LUW issues pertaining to Toadinstallation and database connections.

Installation Issues

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


System.IO.FileNotFoundException -File or assembly name

You are not a member of the DB2ADMIN or


75


DB2AdminWrapper, or one of itsdependencies was not found

DB2USERS group. To install Toad, you mustbe a member of either group.Solution:Ensure that you have been added to one ofthese groups.

Cannot access IBM DB2 native toolsafter installing Toad for DB2 2.0 withprevious install of DB2 client v7.Error: "SQL10007N Message "-1390"could not be retrieved. Reason code:"2"."

Toad is bundled with the IBM DB2 v9 client.IBM does not support direct client migrationfrom v7 to v9, so installing Toad on a systemthat has an existing v7 client may cause errors.Solution:Upgrade the IBM DB2 v7 client to the v8client. If you upgrade the client after installingToad, you do not have to uninstall or reinstallToad.

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

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

To remove run time information

1. Exit Toad.

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

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

4. Open the system.config file in Notepad.

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

6. Save the file.

7. Restart Toad.


76

Connection Issues


ERROR [08001] [IBM]SQL1336N The remote host wasnot found. SQLSTATE=08001

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

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

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

"The type initializer for'IBM.Data.DB2.DB2Connection'threw an exception."or"SUCCESS - unable to allocatean environment handle."

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

To rename your local setting directory

1. Exit Toad.

2. Navigate to the following settings directory:C:\Documents and Settings\UserName\LocalSettings\ApplicationData\Quest Software

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

4. Restart Toad and try to connect.

Note: Make sure you can view hidden folders inWindows Explorer.


77

Other Issues


Unable to capture ContainerInformation in DB2 for LUWMulti-Partition Databases

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


78

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

Installation Issues


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

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

To remove run time information

1. Exit Toad.

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

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

4. Open the system.config file in Notepad.

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

6. Save the file.

7. Restart Toad.


79

Connection Issues


ERROR [08001] [IBM]SQL1336N The remote host wasnot found. SQLSTATE=08001

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

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

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

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

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

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

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

l DB2 user ID for the DB2 subsystem

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

l IP address for the z/OS subsystem


80


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

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

Missing Functionality or Object Information


Unable to browse databases inDB2 for z/OS 8 or later.

The DB2 installation job DSNTISG defines a set ofDB2 procedures that the ODBC driver uses. Theinstallation assigns these procedures (namely, thosebeginning with SYSIBM.SQL*) to a specific WorkLoad Manager (WLM) environment, whichcurrently might not exist or be defined properly.Solution:Be sure that you have correctly set up and enabledthe WLM environment to which the proceduredefinitions point.

Cannot edit data incompatibility mode.

In compatibility mode, the ODBC driver does notreturn enough information for the CommandBuilderto correctly generate update or insert statements.Solution:No solution exists. However, when you connect toa subsystem running in compatibility mode, Toadnow provides a message, informing you of thiscondition and warning you that some featuresmight not be available.


81

Other Issues


[IBM][CLI Driver][DB2]SQL0104N An unexpectedtoken "/*" was found following"". Expected tokens may include:"FROM INTO".SQLSTATE=42601

The SQL script that you attempted to executecontains commented text delimited by charactersthat DB2 for z/OS 8 or earlier does not support.Solution:Set an option in Toad that removes commentsautomatically from a script before you execute it.

To have Toad remove comments automaticallyfrom SQL before execution

1. Select Tools | Options | Database | DB2 |General.

2. Select Remove comments from SQLstatements prior to execution.

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

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

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

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


82

Troubleshoot Informix IssuesReview the following solutions to help troubleshoot Informix issues in Toad.


Unable to view all availabledatabases.

The InformixODBC driver does not returninformation about every available database.

Troubleshoot MySQL IssuesReview the following solutions to help troubleshoot MySQL connection issues pertaining todatabase connections and missing functionality or object information in Toad.

Connection Issues


"InvalidCastException" errorwhen connecting to MYSQL4.1.14-nt database

This is a known issue in MySQL.Solution:Review the known issue and download a patchfrom: http://bugs.mysql.com/bug.php?id=12771

"System.IO.DirectoryNotFoundException"error occurseach time you attempt toconnect after installing Toadinto a directory other than thedefault directory.

Solution:

1. Exit Toad.

2. Locate the MySQL.xml file in theC:\Documents and Settings\username\LocalSettings\ Application Data\Quest Software\Toad for MySQLversion\ ModuleSettings

3. Rename or delete the MySQL.xml file.

4. Restart Toad.

http://bugs.mysql.com/bug.php?id=12771


83



Views tab in Object Explorer isunavailable when connecting toMySQL using the ODBC driver

You are attempting to connect using the 3.51ODBC driver. This driver is hard-coded to replythat the database does not support views because itneeds to connect to MySQL databases prior toversion 5.Solution:Use the native MySQL provider included in Toad.

Using a MySQL ODBCconnection in a cross-connectionquery results in an error

Attempting to execute a cross-connection queryusing a MySQL ODBC connection (not a nativeconnection) results in the following error: "Thetable <table name> can not be mapped."Solution:To use a MySQL ODBC connection in a cross-connection query, you must specify a database forthe connection.

To specify a database for an existing MySQLODBC connection

1. In the Connection/Navigation Manager,right-click the existing MySQL ODBCconnection and select Properties.

2. Click beside the Data source namedrop-down list. The ODBC Data SourceAdministrator dialog opens.

3. On the User DSN tab, select (highlight) theconnection's MySQL ODBC driver and thenclick Configure. The MySQL ODBCConfiguration dialog displays.

4. Select a database from the Database list.

Notes:

l Specifying a database using the ConnectionProperties Database field does not result ina solution. You must follow the procedureabove.

l You can repeat this procedure at any time tospecify a different database.


84

Troubleshoot Oracle IssuesReview the following solutions to help troubleshoot Oracle connection issues pertaining todatabase connections and missing functionality and object information in Toad.

Connection Issues

Review the following to help troubleshoot Oracle:


Attempting to connect whenOracle Instant Client is installedresults in aSystem.NullReferenceExceptionerror

Solution:In order to connect using the Oracle Instant Client,the directory for the Instant Client must be includedin the environmental path, or you must copy theclient files for the instance to the root installdirectory of Toad for Data Analysts.You can also connect to the database without usingan Oracle client or TNSNames file by selecting theDirect tab in the Create New Connection window.

Unable to select a 64-bit Oracleclient from the Current homefield in the Oracle Client tab

Toad runs as a 32-bit application, even wheninstalled on a 64-bit O/S. Because it is a 32-bitapplication, Toad is not compatible with 64-bitOracle clients.

An error occurs when attemptingto connect to Oracle Rdb usingan ODBC driver.

Toad does not support Oracle Rdb at this time.

Missing Functionality and Object Information


Some schemas are not availablefrom the Schema drop-down listin the Object Explorer.

The Oracle ODBC driver cannot display schemasthat do not have any tables.

Unable to view table data on theData tab; SQLFetch generates anaccess violation.

The Oracle ODBC driver is accessing unallocatedmemory.Solution:Update the Oracle ODBC driver:

l For 9i drivers, update to 9.2.0.7.0 or later.

l For 10g drivers, update to 10.1.0.3.0 or later.


85

Troubleshoot SQL Server IssuesReview the following solutions to help troubleshoot SQL Server connection issues in Toad.


Cannot specify a portnumber whenconnecting

Currently, Toad does not have a separate field for specifyinga port number.Solution:You can connect if you know the port number for theinstance by entering the following in the Server name fieldon the New Connection window:ServerName,PortorIPAddress,Port

For example:10.1.29.129,1234 (where 1234 is the port number of theinstance)

Cannot connect to aremote instance in SQLServer 2005

Remote connections may not be enabled in SQL Server2005. Also, named instances are configured to use dynamicports and select an available port once the SQL ServerService starts. If you are connecting to a named instancethrough a firewall, configure the Database Engine to listenon a specific port, so that the appropriate port is opened inthe firewall.Note: Remote connections are disabled by default in theExpress and Developer editions of SQL Server 2005.Solution:To enable remote connections, see "How to configure SQLServer 2005 to allow remote connections" at:http://support.microsoft.com/kb/914277

"Path is not of a legalform" error messagewhen connectingor"Could not find a partof the pathC:\Program Files\QuestSoftware\Toad for SQLServer\Template\Scripts\InitialSqlServer.Sql"error message when

You attempted to migrate settings from a previous install ofToad to the current install, but the settings file(InitialSqlServer.Sql) for the previous install was eitherremoved, moved, or corrupt.You may also receive this error if you installed Toad andmigrated settings from a previous version, and lateruninstalled the previous version.Solution:You must specify a valid location for the InitialSqlServer.Sqlfile in Toad.

To specify a valid location

http://support.microsoft.com/kb/914277


86


connecting 1. Open the SQL Server options page under Tools |Options | Database | SQL Server.

2. Specify the location for the new install'sInitialSqlServer.Sql file in the Run Script on newconnection field.

By default, this file is located in the following directory:C:\Program Files\Quest Software\Toad for Data Analystsversion \Templates\ScriptsNote: Clicking may result in a "Path not found error". Ifyou receive this error, manually enter the location in thefield.

Cannot establishNamed Pipesconnection

If you are trying to connect to the server using Named Pipes,"Poll service status in connection list" option should becleared.Solution:

1. Open the options page under Tools | Options |Database | General.

2. Clear Poll service status in connection list checkbox.

Cannot establish Azureconnection

Failing to establish Azure connection may indicate that yourIP address is restricted from having access to the Azureserver.Solutions:

1. Select Tools | Cloud Computing | SQL Azure Portalto login to Azure Portal.

2. Create a firewall rule on the master database,enabling access to current IP address or range. See"Create and Alter Azure Firewall Rules" in the onlinehelp for more information.

Troubleshoot Sybase IssuesReview the following solutions to help troubleshoot Sybase issues pertaining to thefollowing in Toad:


87

Connection Issues


Unable to connect to thedatabase. The following messagedisplays: "The ODBCMDAprocedures have not beeninstalled on this database..."

Stored procedures that the ODBC driver requirescurrently do not exist on the server.Solution:Install the required procedures.



Unable to view or export datafor objects with non-standardnames.

Sybase ODBC driver has issues handling non-standard names for objects.Solution:When setting up a Sybase connection in Toad,select Use quoted identifiers on the Connection tabin the Adaptive Server Enterprise window to enablethe use of quotations in identifiers.

Unable to view linked tables. Linked tables store DSN connection information.Solution:Set up the DSN connection information exactly thesame on all machines that access the database.

Other Issues


DBMS name showing as SQLServer.

Older versions of the Sybase ODBC driver returnSQL Server as the DBMS name.Solution:Upgrade to the latest version of the Sybase ODBCdriver, which correctly returns Adaptive ServerEnterprise as the DBMS name.

Configure Version Control

About Version ControlToad integrates with your existing version control system so you can maintain multiplerevisions of files.

Important: See "Troubleshoot Version Control" (page 95) for more information about issueswhen upgrading version control from a previous version.

Prerequisites

You must install a supported version control client on the computer where Toad isinstalled. The following table lists the supported version control providers and the versionstested with Toad.

SupportedProvider

Server VersionTested

Client Version Tested

VisualSourceSafe(VSS)

VSS 6.0d VSS 6.0d See "Configure TFS or VSS" (page 89) for moreinformation.

ConcurrentVersionsSystem(CVS)

CVS 1.11.22 onSolarisCVSNT 2.5.03 onWindows

CVSNT 2.5.03See "Configure CVS " (page 91) for moreinformation.

Subversion Subversion 1.5.6on WindowsNote: Toad onlysupportsSubversion 1.5.6or later.

CollabNet Subversion Command-Line Client 1.5.6Notes:

l Toad only supports Subversion 1.5.6 orlater.

l Any Subversion client must have svn.exein its installation directory to use versioncontrol in Toad.

l Tortoise SVN is no longer supported inToad because it no longer includes svn.exein its installation directory.

See "Configure Subversion" (page 93) for moreinformation.

Toad for Data Analysts Installation GuideConfigure Version Control

89

SupportedProvider

Server VersionTested

Client Version Tested

TeamFoundationServer(TFS)

TFS 2005, 2008 Visual Studio (2005, 2008) Team Explorer ClientSee "Configure TFS or VSS" (page 89) for moreinformation.

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

Configure TFS or VSSYou can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 95) for more information.

To configure TFS or VSS to work with SQL scripts in the Editor

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

2. Open an Editor window.

3. Right-click anywhere in the toolbar area and select Version Control to display theVersion Control toolbar.

Tip: You can also access version control functionality from the File | VersionControl menu when the Editor window has focus.

4. Click to open the Version Control wizard.


VersionControlSystem Page

Description

Type Select either Team Foundation Server or Visual SourceSafe.Note: If you select TFS, you must specify the workspace namefor the provider in the Team Foundation Server Propertieswindow that displays.

Properties (TFS only) Click this button (beside the Type field) and specifythe workspace name for the provider in the Team FoundationServer Properties window.


90

Server Select one of the following:

l For TFS, specify the server where your version controlprovider is installed and the port number (default is8080) to use in the following format:http://MyServer:Port

l For VSS, select the folder where the Source Safe client isinstalled and the srcsafe.ini file (for example:C:\SourceSafe\VSS\srcsafe.ini).

Username/Password

Enter login information for the version control provider andclick Login.Note: For TFS only, if you leave the user name and passwordfields blank, Toad uses your default Windows credentials.

VersionControlSettingsPage

Description

Versioncontrolfolder

Select the folder on the version control server where you want tocheck the scripts in.If you already have the Editor-managed scripts under versioncontrol, select the folder on the server where these scripts arelocated.Notes:

l Version control automatically checks out the scripts inthis folder and any subfolders to the location you specifyin the Working folder field.

Workingfolder

Select the root repository folder on the client computer to use asthe default working folder for checking SQL scripts out.If you already have Editor-managed SQL scripts under versioncontrol, select the existing working folder for these.

6. See "Add Scripts Using the Editor" in the Toad help for more information.

Tips:

l You can view revision history and revision comments for a script from the Historytab; and can also right-click a revision to send it to the Diff Viewer to comparedifferences.


91

l You can enable, disable, or delete a version control configuration under Tools |Options | Version Control | General.

l You can modify current settings, including whether to require comments whenchecking objects and scripts in or out, avoid checking scripts in automatically whenexecuting a script in the Editor, disable or delete a version control configuration, etc.,from Tools | Options | Version Control | <options page>.

Configure CVSYou can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 95) for more information.

To configure CVS to work with SQL scripts in the Editor








Description

Type Select CVS.

Properties Click this button (beside the Type field) and complete thefollowing in the Command Based Version Control Propertieswindow:

l BinaryPath—Enter the path where the CVS client isinstalled. For example, if you installed CVSNT, youwould enter:C:\Program Files\CVSNT

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you are


92

working from a branch, enter the branch number or namein this field.Caution: Specifying HEAD for the BranchRevisionparameter can cause errors. Leave the parameter blankwhen working with the HEAD revision.

Server Select the existing working folder for the version controlrepository or specify the server string. For example, if you areconnecting using pserver, you should specify the server string asfollows::pserver:MyServer:Port:/MyWorkingRepository

Username/password

Enter your CVS command-line user name and password andclick Login.Note: The User name field is optional.

DefaultVersionControlSettingsPage

Description




Workingfolder


6. See "Add Scripts Using the Editor" in the online help for more information.

Tips:



93



Configure SubversionYou can configure version control to work with SQL scripts in the Editor. See "TroubleshootVersion Control" (page 95) for more information.

To configure Subversion to work with SQL scripts in the Editor








Description

Type Select Subversion.

Properties Click this button (beside the Type field) and complete thefollowing in the Command Based Version Control Propertieswindow:


94

l BinaryPath—Enter the path where the Subversion clientthat contains svn.exe is installed. For example, if youinstalled the CollabNet Subversion Client, you wouldenter:C:\Program Files\CollabNet Subversion ClientNote: Do not include svn.exe in the path.

l BranchRevision—Leave this field blank if you areworking from the trunk in version control. If you areworking from a branch, enter the branch number or namein this field.Important: Specifying HEAD for the BranchRevisionparameter can cause errors. Leave the parameter blankwhen working with the HEAD revision.

Server Select the existing working folder for the version controlrepository or specify the server string (for example:svn://MyServer).

Username/Password

Enter your Subversion command-line user name and passwordand click Login.

DefaultVersionControlSettingsPage

Description




Workingfolder


6. See "Add Scripts Using the Editor" in the Toad help for more information.


95

Tips:




Troubleshoot Version Control

Troubleshoot Upgrades

For this release, the back-end of version control has been rewritten. If you previously usedversion control in Toad, the following may occur:

l If you migrate settings when upgrading Toad, you may have to reconfigure therepository setting in version control if a "Failed to open the settings for moduleVersionControl reverting to defaults" error displays. To reconfigure the repository,select Tools | Options | Version Control | Defaults and select the previous repositoryin the Version control folder field. Your previous project settings are applied.

l In previous releases, the method Toad used to generate the script was different thanthe current method. After upgrading Toad, a message may display stating that files inversion control are different than the local version. If your local version is current, youshould check the files into version control.

Troubleshoot Other Issues

Review the following to help troubleshoot issues with version control:


96

VSS Issues Description

Languagesupport

VSS 6.0 uses ANSI strings. Consequently, the English-encoded VSSserver and client do not handle certain characters in other languages.This issue may also exist on previous or later VSS languageinstallations.

Caseinsensitive

VSS is not case-sensitive. Using version control on objects whosenames differ by case only can cause history and version-tracking issues.

CVS Issues Description

Systemcannotfind file

If a message stating that, “The system cannot find the file specified”displays, this usually means that the CVS executable cannot be foundin the path you specified in the BinaryPath field of the CommandBased Version Control Properties window. Verify that cvs.exe exists inthe directory you specified in this field

Commandexecution

When executing CVS commands, user input is not allowed. Thispresents an issue when the user is using CVS with the SSH method andmust enter a password to establish the Secure Shell.Workaround:Generate identity keys that automatically authenticate between theclient and the server when connecting with SSH.

SubversionIssues

Description

Systemcannotfind file

If a message stating that, “The system cannot find the file specified”displays, this usually means that the Subversion executable cannot befound in the path you specified in the BinaryPath field of theCommand 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. Thispresents an issue when the user is using Subversion with the SSHmethod and must enter a password to establish the Secure Shell.Workaround:Generate identity keys that automatically authenticate between theclient and the server when connecting with SSH.

Appendix: Contact Quest

Contact Quest SupportQuest Support is available to customers who have a trial version of a Quest product or whohave purchased a Quest product and have a valid maintenance contract. Quest Supportprovides unlimited 24x7 access to SupportLink, our self-service portal. Visit SupportLink athttp://support.quest.com.

From SupportLink, you can do the following:

l Retrieve thousands of solutions from our online Knowledgebase

l Download the latest releases and service packs

l Create, update and review Support cases

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

Toad Community

Get the latest product information, find helpful resources, and join a discussion with the Toadfor Data Analysts team and other community members. Join the Toad for Data Analystscommunity at http://tda.inside.quest.com/index.jspa.

Contact Quest Software

Email [email protected]

Mail

Quest Software, Inc.World Headquarters5 Polaris WayAliso Viejo, CA 92656 USA

Web site www.quest.com

See our web site for regional and international office information.

http://support.quest.com/

http://support.quest.com/

http://tda.inside.quest.com/index.jspa


Toad for Data Analysts Installation GuideContact Quest Support

98

About Quest SoftwareQuest Software simplifies and reduces the cost of managing IT for more than 100,000customers worldwide. Our innovative solutions make solving the toughest IT managementproblems easier, enabling customers to save time and money across physical, virtual andcloud environments. For more information about Quest go to www.quest.com.


IndexA

Access

create connections 54

troubleshoot 71

application virtualization 12

B

Business Objects


C

Citrix

install 24

requirements 12

client requirements 7

configure Toad 28

connections

configure DB2 client 39

create Access 54

create DB2 50

create Excel 57

create MySQL 60

create ODBC 61

create Oracle 34

create SQL Azure 64

create SQL Server 64

create Sybase ASE 67

create Sybase IQ 67

create Sybase SQL Anywhere 67

DB2 LDAP support 49

Oracle LDAP support 33

share for all session windows 32

troubleshoot 85

Access 71

Informix 82

Oracle 84

Sybase ASE 86

troubleshoot DB2 LUW 74

troubleshoot DB2 z/OS 78

troubleshoot SQL Server 85

understand 32

contact support 97

corporate deployment 17

customize

Toad 28

CVS, configure 91

D

DB2


troubleshoot LUW issues 74

troubleshoot z/OS issues 78

desktop virtualization 12

E

Excel


ranges 57

troubleshoot 71

Toad for Data Analysts Installation GuideIndex

100

I

Informix, troubleshoot 82

install 14

Citrix 24

Citrix support 12

client requirements 7

read-only 16

silent 17

L

LDAP

DB2 support 49

Oracle support 33

license keys 28

look and feel configuration 28

M

mst file 20

MySQL


troubleshoot 82

O

ODBC


Oracle

Business Intelligence 37


create OBIEE connections 37

troubleshoot 84

R

read-only installation 16

requirements

Citrix 12

client 7

virtualization 12

S

Salesforce, create connections 63

server virtualization 12

shortcut keys

configure to match otherapplications

28

silent install 17

create transform file 20

Microsoft installer (MSI) 20

prerequisites 18

SourceSafe, configure 89

SQL Azure


SQL Server


troubleshoot 85

Subversion, configure 93

Sybase


system requirements 7

T

Team Foundation Server, configure 89

Teradata


TFS, configure 89

Toad for Data Analysts Installation GuideIndex

101

Toad, customize 28

transform file 20

troubleshoot

DB2 LUW connections 74

DB2 z/OS connections 78

Excel 71

Informix issues 82

MySQL 82

Oracle connections 84

SQL Server connections 85

version control 95

tutorials

create ODBC connections 61

U

uninstall 27

V

Version Control 88

configure CVS 91

configure Subversion 93

configure TFS 89

configure VSS 89

troubleshoot 95

virtualization support 12

Visual SourceSafe, configure 89

VSS, configure 89

ToadforDataAnalysts_31_InstallGuide

Documents

program filesquest

handle tcp

installation

net frameworkv2

avoid losing

maximum character

team foundation

oracle instant