Toad Getting Started Guide
Toad Getting Started Guide
Trademarks
Quest, Quest Software, the Quest Software logo, Aelita, Benchmark Factory, Big Brother, DataFactory,
DeployDirector, ERDisk, Fastlane, Final, Foglight, Funnel Web, I/Watch, Imceda, InLook, InTrust, IT Dad, JClass,
JProbe, LeccoTech, LiveReorg, NBSpool, NetBase, PerformaSure, PL/Vision, Quest Central, RAPS, SharePlex,
Sitraka, SmartAlarm, Speed Change Manager, Speed Coefficient, Spotlight, SQL Firewall, SQL Impact, SQL
LiteSpeed, SQL Navigator, SQLab, SQLab Tuner, SQLab Xpert, SQLGuardian, SQLProtector, SQL Watch, Stat,
Stat!, Toad, T.O.A.D., Tag and Follow, Vintela, Virtual DBA, and XRT are trademarks and registered trademarks of
Quest Software, Inc. Other trademarks and registered trademarks used in this guide are property of their respective
owners.
Disclaimer: The information in this document is provided in connection with Quest products. No license, express or
implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with
the sale of Quest products. EXCEPT AS SET FORTH IN QUESTS TERMS AND CONDITIONS AS SPECIFIED IN
THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND
DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY
DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING,
WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF
INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with
respect to the accuracy or completeness of the contents of this document and reserves the right to make changes
to specifications and product descriptions at any time without notice. Quest does not make any commitment to
update the information contained in this document.
Getting Started Guide
October 2006
Software Version - 9.0
Table of Contents
Introduction ..........................................................................................................................................................1
Toad for Oracle ................................................................................................................................................................ 2
About this Guide............................................................................................................................................................... 3
Editions............................................................................................................................................................................. 4
Quest DBA Module.................................................................................................................................................. 5
SQL Optimizer Module ............................................................................................................................................ 5
eBiz Module............................................................................................................................................................. 5
About Quest Software, Inc. .............................................................................................................................................. 6
Installation ............................................................................................................................................................7
Overview .......................................................................................................................................................................... 8
System Requirements ...................................................................................................................................................... 9
Hardware Requirements.......................................................................................................................................... 9
Software Requirements ........................................................................................................................................... 9
Additional Requirements for different modules...................................................................................................... 10
Windows Privileges and Toad ............................................................................................................................... 10
Install .............................................................................................................................................................................. 11
Local Toad Install (Full) ......................................................................................................................................... 11
The Toad Standard Edition - READ ONLY............................................................................................................ 11
Network Install ....................................................................................................................................................... 11
Network Install - Server ................................................................................................................................ 12
Network Install - Client (must run Server install first).................................................................................... 12
Citrix/Terminal Server ................................................................................................................................... 12
install.log and install.txt.......................................................................................................................................... 13
install.log....................................................................................................................................................... 13
install.txt........................................................................................................................................................ 13
Silent Install .................................................................................................................................................................... 15
ii
Table of Contents
iii
Registration ........................................................................................................................................................27
Trial Version Registration................................................................................................................................................28
Expired or Invalid Registration Key ........................................................................................................................28
Purchase .........................................................................................................................................................................29
Product Authorization Errors ...........................................................................................................................................30
Troubleshooting.................................................................................................................................................31
Overview .........................................................................................................................................................................32
Cannot connect to Personal Oracle ...............................................................................................................................32
PATH Environment ........................................................................................................................................................32
Support ...........................................................................................................................................................................32
iv
Introduction
&RQWHQWV
Toad for Oracle
About this guide
Editions
About Quest Software, Inc.
Chapter 1
Introduction
Editions
Toad for Oracle, Version 9.0 comes in four editions. Choose the edition that is right for
your environment.
Edition
Description
You can also enhance Toads capabilities with optional add-on modules:
Chapter 1
Introduction
eBiz Module
Lets you quickly find information in your Oracle e-Business Suite about applications,
concurrent programs, current and past activity, users, responsibilities, workflows,
request sets, profile options, invalid objects, data groups, and more.
Installation
&RQWHQWV
Overview
System Requirements
Install
Silent Install
Uninstall
Overview
This chapter covers the system requirements and install process for Toad, and the
different types of installs. It also shows the uninstall procedure.
You can install Toad from a CD-ROM or installation files you have downloaded from
the Quest Software, Inc. web site, www.quest.com.
Before installing Toad, make sure that your system meets the minimum hardware and
software requirements. Also check your SQL*Net or Net8 setup with another
application, such as Oracles tnsping utility, to verify your connection with the database.
Note
If you also have the freeware version of Toad, you should not install the commercial version
over the freeware version. This will adversely affect some functions. Install the commercial
version in a different directory from the freeware version.
Chapter 2
Installation
System Requirements
Toad requires either Windows 2000, Windows Server 2003, Windows XP, or Windows
XP SP2.
Note
Hardware Requirements
75 MB disk space required to run Toad
512 MB RAM required, 1 GB recommended
CD-ROM drive or internet connection (required for installation only)
VGA monitor, 1024x768 resolution, small fonts
1024 x 768 screen resolution
Mouse pointing device
Software Requirements
SQL*Net (32 bit) or Net8 for Oracle 8
Oracle 7.34 or higher
10
699DUDPI6GS@RVDS@H@IUT
Debugger
Knowledge Xpert
5 MB of disk space.
SQL Optimizer
Hardware Requirements:
eBiz module
Chapter 2
Installation
11
Install
Note
If you are installing Toad as a network installation, the Toad license key is written to the
server. On the client side, Toad will prompt you for a license key the first time it runs. The
server should not be read-only when Toad is run for the first time.
There are several ways to install Toad. During the install process, you can choose any
one of the following. In addition, there is a Silent Install option available (see Silent
Install on page 15.)
Network Install
An advantage of installing Toad to a network server is that as Toad is updated, the
network administrator only has to update the server files. All users are updated when
you update Toad on the server, as opposed to having to update each workstation
individually. This makes periodic Toad updates easier.
A disadvantage of installing Toad to a server is that whenever someone starts Toad at
their workstation, they have to read the Toad.exe application file across the network. If
12
If you choose a Network installation and you have installed Microsoft Security Update
#896358, the Toad Help will not work. This is because the security update restricts the use
of the ActiveX control that governs the Help files. It is recommended that you install Toad
locally if you want to be able to use Toad Help.
A Network installation has two parts. The server installation, which resides on the
server and contains the build of the application, and the client installation, which installs
personal configurations to each individual workstation. The Server installation MUST
be installed before you can install a client installation on a personal computer.
Citrix/Terminal Server
Citrix/Terminal Server support is offered for Toad 8.5 and higher and enabled when you
choose the Citrix/Terminal Server option.
Toad requires read access to the Toad Installation directory, HKLM\Software\Quest
Software\Toad in the registry, and the Oracle directory.
Under Toad.exe Properties|Compatibility tab|User Account Privileges, make sure the
Allow non-administrators to run this program box is checked.
Write access is required to the Oracle directory if any of the users want to edit the
tnsnames.ora file by using the TNSNames Editor.
Chapter 2
Installation
13
When you choose a Citrix installation, all user files are stored in a user_name directory.
When a Citrix user opens Toad for the first time, Toad will copy the contents of this
folder to the users associated Application Data folder for Toad.
Do NOT edit this file or you may not be able to uninstall Toad properly.
install.txt
Install.txt is also created by the installation, but it has a different format. Its userfriendly approach is easier to follow. It is basically an outline of how the installation
script proceeded. If there is an installation problem, such as a problem creating icons,
the file can be helpful in determining why the problem is occurring. Here is a section
from an install.txt file:
Copying down files...
File install complete
Creating icons...
Create a shortcut to Toad on the desktop...
Done creating icons!
To Install Toad
1 Run the Toad Installation program from the CD or downloaded file.
The installer will check for another copy of Toad for Oracle on your machine. If
one is detected, the Select your Installation Type screen displays.This lets you
choose how to install Toad. You can choose New Install or Upgrade. If you
choose upgrade, Toad will automatically set your install directory to the last
place Toad for Oracle was installed, as displayed at the top of the screen.
2 The first install dialog box is a Welcome screen. This ensures that you want to
install Toad. If you want to cancel, click Cancel. Otherwise, click Next.
14
continue.
4 Select one type of installation:
Knowledge Xpert
SQL Optimizer
6 Click Next.
7 Select your destination directory. The default directory is C:\Program Files\Quest
Software\Toad for Oracle, but you can browse through your directories and select
another one if desired.
If in the previous step you chose to install some or all of Toad on a server, you
will also be asked for the destination directory for the server install.
Click Next.
8 Click Next to start the installation processes. As the installation program works,
following options:
View Release Notes - Refer to the releasenotes.htm for the latest information
about Toad upgrades, changes, fixes, and issues.
Run Server Side Objects Wizard - See the next chapter for detailed
information about the Server Side Objects wizard.
Start Toad for Oracle.
11 Restart your system to complete the installation.
Chapter 2
Installation
15
Silent Install
Toad for Oracle version 9.0 features the ability to configure a silent install.
executable. This is the file where the installer will look to find configuration
variables.
2 Copy the text below into the file.
[INSTALLATION]
INSTALL_TYPE=A
UPGRADE=A
INSTALL_DIR=C:\Program Files\Quest Software\Toad for Oracle9.0
NETWORK_DIR
KXPERT=A
SQL_OPTIMIZER=A
TOADSHORTCUT=YES
LICENSE_KEY=
LICENSE_MSG=
3 Enter the values to the right of the "=" and save the file. You can copy as many
Configuration Variables
INSTALL_TYPE
A - Full local install
B - Network install, client side (should install server side first)
C - Network install, server side
D - Citrix install
UPGRADE
A - New install
B - Upgrade from previous version
16
INSTALL_DIR
Destination folder for install. Do not use parentheses in pathname.
NETWORK_DIR
Destination folder for server side install. Do not use parentheses in pathname.
Note
When silently installing a client/server setup the server side (install type C) should be run
first. During the server side install, the INSTALL_DIR variable should be blank with the
NETWORK_DIR variable pointing to the install path on the server. During the subsequent
client side install, the NETWORK_DIR variable should remain the same, with the
INSTALL_DIR variable now defined for the client side.
KXPERT
A - Install Knowledge Xpert for PL/SQL
Blank - Skip installation of Knowledge Xpert
SQL _OPTIMIZER
A - Install SQL Optimizer
Blank - Skip installation of SQL Optimizer
TOADSHORTCUT
YES - Places a shortcut on the desktop
Blank - Do not make a shortcut
LICENSE_KEY
Your Quest-issued license key number
LICENSE_MSG
Your Quest-issued license key message (site message)
Chapter 2
Installation
17
If this is a Citrix install (install type D) the LICENSE_KEY and LICENSE_MSG values will
be copied to a file called QSAuth11.key in the subfolder ClientFiles on the server. Upon
initial launch, Toad will then copy this file locally.
If performing an upgrade (UPGRADE=B) the LICENSE_KEY and LICENSE_MSG values
will be ignored.
18
Uninstall
When you use Toad, you create new Toad files such as SQL scripts, data output, or temp
files. When you run uninstall, Toad has no way of knowing what those files are. So it
wont remove Toad files that you have created. You have to manually delete them.
To uninstall Toad:
Click Start|Programs|Quest Software|Toad for Oracle|Uninstall Toad
-OR Go to Add/Remove Programs in Windows and remove Toad.
Note
If a network administrator maintains server components, they will not be uninstalled. The
network Toad components will have to be manually deleted.
Server Side Installation Wizard
&RQWHQWV
Overview
Features with server side objects
Install, upgrade, or remove objects for all users to share
Install or remove objects for an individual schema to use
Create Setup scripts without a database connection
Set up wizard finished
20
Overview
During the installation, you have the opportunity to install the server side objects for
Toad using the Server Side Objects wizard. After installation, you can access this
wizard to administer these objects from the Database|Administer|Server Side Objects
Wizard menu item.
The Server Side Installation wizard lets you add, remove, or update server side objects
(for Toad features that require objects installed on the server side of the Oracle
instance).
The server side objects apply only to their corresponding features, and Toads other
features will run successfully without the server side objects.
The Server Side Installation wizard simplifies installing and administering these
objects. In order to install server side objects, you need access to the account for the
Toad user, the account for the schema where you are installing them, or an account with
the DBA role.
Chapter 3
Server Side Objects Installation
21
Toad
Individual
Publicly
Accessible
CodeXpert
Explain Plan
Profiler
Security
Team Coding
Space Manager*
The Space Manager wizard helps you set up the privileges for Toad, but the View
Tablespaces window will install and administer the objects.
The Explain Plan Server Side Objects can be installed and edited from within Toad
itself. They are not included in the Server Side Objects wizard.
The following are features with server side objects:
CodeXpert
Lets you save reports to the database and retrieve them at a later date.
Server side objects can be installed in the following schema: Toad, Publicly Accessible.
22
While Explain Plans have Server side objects, Toad can create these without the use of this
wizard. See the help file: Explain Plans for more information.
Toad Security
Toad Security lets you restrict users access to specific Toad features.
Server side objects can be installed in the following schema: Toad.
Team Coding
Team Coding lets users check in and check out PL/SQL objects and optionally associate
those objects with a third party source control provider.
Server side objects can be installed in the following schema: Toad, Publicly Accessible.
Chapter 3
Server Side Objects Installation
23
Whether you are using a TNS file, or an LDAP server, servers will be listed in the
database dropdown.
24
You must click Next from the first three options to access the Space Manager
screen.
Drop the Toad schema and all public synonyms for its objects
This option lets you easily drop both the Toad schema and all the public synonyms
associated with it.
The next screen asks you to enter the connection information. DBA privileges are
required. Enter the database where the Toad schema resides.
The Toad user and associated public synonyms are dropped. If you previously used this
client to set up Team Coding on your database, you will also be prompted to drop any
roles that you created for Team Coding.
Chapter 3
Server Side Objects Installation
25
26
Registration
&RQWHQWV
Trial Version Registration
Purchase
Product Authorization Errors
28
Before you register the trial version of Toad you will need a registration key. The PL/SQL
debugger and the Quest DBA module are activated in the trial key.
If you have previously used a Toad trial key you will receive an Invalid Key message.
A trial key can only be used once, even between different versions of Toad.
Chapter 4
Registration
29
Purchase
To purchase the latest version or place a large order, you can either;
Contact Quest Sales at 949-754-8000 to discuss payment options
-ORVisit the Quest Software web site at www.quest.com.
Youll receive a temporary key from the download.
After your order is processed, your permanent license key is sent to you. At this point,
go to the Help menu, click Register Toad, and enter your new authorization key
number, also known as the license or registration key number. Enter the site message
(for example, Company name).
In the future, when you download upgrades from the Quest web page, youll need the
license key number. Select Help|Register Toad, highlight your number from the
authorization key number box, and copy and paste the number into the web form.
You might need to restart Toad to reinitialize your options and enable all functionality.
30
Authorization
string has expired
This occurs when the trial authorization for Toad has expired.
Invalid
authorization
string or site
message
If the trial date has not passed, check that the date on your
system is set correctly.
Troubleshooting
&RQWHQWV
Overview
Cannot Connect to Personal Oracle
PATH Environment
Support
32
Overview
This section discusses troubleshooting installation and connection problems. For a
comprehensive list of Frequently Asked Questions, refer to the toadsoft.com site and
follow the links.
PATH Environment
The most frequent cause of problems is the resetting of the PATH environment variable.
To set your default Oracle home, you can use the Oracle Home selector (provided with
Oracle) to set it accurately. Refer to your Oracle documentation for more information.
Support
If you have questions about using Toad, and you cant find the answers in this guide or
Toad Help, please contact the customer support staff. The Help|Support Bundle
provides updated support information and tools for contacting support.
Chapter 5
Troubleshooting
The information it contains will be useful for support when resolving issues and you
should include this support information with emails to Quest Support. The Support
Bundle window is discussed in detail in the Toad Help.
33
34