TOAD®

GETTING STARTED GUIDE

Version 7.6

Contents

© Copyright Quest Software, Inc. 2000-2003. All Rights Reserved.This guide contains proprietary information, which is protected by copyright. The softwaredescribed in this guide is furnished under a software license or nondisclosure agreement. Thissoftware may be used or copied only in accordance with the terms of the applicable agreement.No part of this guide may be reproduced or transmitted in any form or by any means, electronic ormechanical, including photocopying and recording, for any purpose other than the purchaser’spersonal use without the written permission of Quest Software, Inc.

WARRANTYThe information contained in this document is subject to change without notice. Quest Softwaremakes no warranty of any kind with respect to this information. QUEST SOFTWARESPECIFICALLY DISCLAIMS THE IMPLIED WARRANTY OF THE MERCHANTABILITYAND FITNESS FOR A PARTICULAR PURPOSE. Quest Software shall not be liable for anydirect, indirect, incidental, consequential, or other damage alleged in connection with thefurnishing or use of this information.

TRADEMARKSQuest® and TOAD® are registered trademarks of Quest Software, Inc. Other trademarks andregistered trademarks used in this guide are the property of their respective owners.

Quest Software, Inc.World Headquarters

8001 Irvine Center DriveIrvine, CA 92618www.quest.com

U.S. and Canada 949.754.8000email: info@quest.com

TOAD Getting Started GuideUpdated November 2003Software Version 7.6

4 TOAD Getting Started Guide

About Quest SoftwareQuest Software, Inc. (NASDAQ: QSFT) is a leading provider of application managementsolutions. Quest provides customers with Application Confidencesm by delivering reliablesoftware products to develop, deploy, manage and maintain enterprise applicationswithout expensive downtime or business interruption. Targeting high availability,monitoring, database management and Microsoft infrastructure management, Questproducts increase the performance and uptime of business-critical applications and enableIT professionals to achieve more with fewer resources. Headquartered in Irvine, Calif.,Quest Software has offices around the globe and more than 18,000 global customers,including 75% of the Fortune 500. For more information on Quest Software, visitwww.quest.com

Contacting Quest SoftwarePhone: 949-754-8000 (United States and Canada)Email info@quest.com Mail Quest Software, Inc.

World Headquarters8001 Irvine Center DriveIrvine, CA 92618USA

Web site www.quest.comPlease refer to our Web site for regional and international office information.

Contacting Customer SupportQuest Software's world-class support team is dedicated to ensuring successful productinstallation and use for all Quest Software solutions.

SupportLink www.quest.com/supportEmail support@quest.com.You can use SupportLink to do the following:

� Create, update, or view support requests

� Search the knowledge base

� Access FAQs

� Download Patches

Contents

C O N T E N T S

TOAD Getting Started Guide

1 ABOUT THIS GUIDE 7

2 INTRODUCTION 9

3 INSTALL/UNINSTALL AND TOAD FILES 11

SYSTEM REQUIREMENTS 11INSTALL 13TOAD FILES 19UNINSTALL 26

4 SERVER SIDE INSTALLATION WIZARD 29

INSTALL, UPGRADE, OR REMOVE OBJECTS FOR ALL USERS TO SHARE 31INSTALL OR REMOVE OBJECTS FOR AN INDIVIDUAL SCHEMA TO USE 33CREATE SETUP SCRIPTS WITHOUT A DATABASE CONNECTION 33SET UP WIZARD FINISHED 33

5 REGISTRATION 35

TRIAL VERSION REGISTRATION 35To Start Trial TOAD 35

PURCHASE 37PRODUCT AUTHORIZATION ERRORS 38

6 FEATURES 39

SQL EDITOR 40SCHEMA BROWSER 42PROCEDURE EDITOR 43OPTIONS MENU 44TOAD HELP 45

TROUBLESHOOTING 47

SQL*NET/NET8 INSTALLATION PROBLEMS 47CANNOT CONNECT TO PERSONAL ORACLE 48SUPPORT 49

INDEX 51

1About this guide

This guide introduces TOAD. It helps you install and run TOAD. It alsointroduces you to some of the main TOAD windows.

The guide covers the following major topics:

� System requirements

� Install/uninstall

� Registration

� Troubleshooting

� TOAD files

This is an introductory guide. Refer to TOAD Help for the latest information.You can easily access TOAD Help while in TOAD by pressing the F1 key.

Remember, you can always access TOAD Help while in TOAD bypressing the F1 Key.

8

The TOAD User's Guide contains details about the main TOAD windows (SQLEditor, Procedure Editor, Schema Browser, SQL Modeler) and additionalwindows and feature information.

RELEASENOTES.HTM contains the latest information about upgrades andchanges.

Note that this guide was prepared in November 2003. New or changed TOADfeatures since November 2003 are not reflected in this version of the TOADGetting Started Guide.

For details on TOAD, including navigation and main windows, refer to theTOAD User's Guide and Toad Help.

2Introduction

TOAD

TOAD is a powerful application development tool built around an advancedSQL and PL/SQL editor. Using TOAD, developers can build and test PL/SQLpackages, procedures, triggers, and functions. You can create and edit databasetables, views, indexes, constraints, and users.

TOAD lets you view the Oracle Dictionary, tables, indexes, stored procedures,and more- all through a multi-tabbed browser.

Code can be created from shortcuts and code templates. You can also create yourown code templates.

With TOAD you can:

� Create, browse, or alter objects

� Graphically build, execute, and tune queries

� Edit PL/SQL and profile stored procedures

� Manage your common DB tasks from one central window

� Find and fix database problems with constraints, triggers, extents, indexes,and grants

� Control code access and development (with or without a third party versioncontrol product) using TOAD's cooperative source control feature.

10

The optional PL/SQL Debugger lets you step through the code as it executes.With this module you can run a debug session with or without arguments, setbreakpoints, watch variables, and more.

The optional Quest DBA Module adds database administration functionality toTOAD. With this module you can manage space, compare schemas, monitordatabase performance, create new databases, maintain redo logs, perform healthchecks, and more.

3Install/Uninstall and TOAD Files

This chapter covers the install process for TOAD including an overview of theTOAD files that are installed. It explains the different types of installs. It alsoshows the uninstall procedure.

You can install TOAD from a CD-ROM or installation files you download fromthe Quest Software Web site, www.quest.com .

Before installing TOAD, make sure that your system meets the minimumhardware and software requirements. Also check your SQL*Net or Net8 setupwith another application, such as Oracle's tnsping utility, to verify yourconnection with the database.

NOTE: If you also have the freeware version of TOAD you should not install thecommercial version over the freeware version, because it will adversely affectsome functions. You should install the commercial version in a differentdirectory from the freeware version.

System Requirements

TOAD requires either NT 4.0, Windows 2000, or Windows XP.

12

Minimum Hardware RequirementsIBM style PC

44 MB disk space required to run TOAD

128 MB RAM required for NT 4.0, Windows 2000, Windows XP

CD-ROM drive (required for commercial version installation from CD-ROM)

VGA monitor

Mouse pointing device

Minimum Software RequirementsAt least Oracle 7.3.4

The current release of TOAD requires SQL*Net (32 bit) or Net8 for Oracle 8.

TOAD will not run on Linux, Unix, OS2, or Macintosh.

Additional Modules

Option Additional Requirements

Debugger Module Oracle Probe v2.0 or higher (SYS.DBMS_DEBUGpackage)

Quest DBA Module (Same as TOAD Requirements)

Tuning modules 32 MB of RAM and an additional 25 MB of diskspace

Chapter 3 Install/Uninstall and TOAD Files 13

InstallTo Install TOAD

1 Run the TOAD Installation program from the CD or downloaded file.

2 The first install dialog box is a Welcome screen. This ensures that you wantto install TOAD. If you want to cancel, click Cancel.

As you progress through the following dialog boxes, you will have a Backbutton to go back to the previous dialog box and a Cancel button to cancelthe installation. To progress through the installation, choose your option foreach dialog box and click Next.

NOTE: The TOAD Standard Edition - READ ONLY install is a read-onlyexecutable designed to prevent its users from changing the database. Forthis reason, it does not include Quest ScriptRunner (which lets a userexecute a script that can update database objects), SQLMonitor (which logsSQL calls via the OCI layer), and Server Side Install (which lets users makechanges to TOAD schemas).

3 The software license agreement displays in the next screen.

4 The next dialog asks you to select the type of installation you want. Thechoices are: Local TOAD Install (FULL) Network Install - Client (must run Server side install first) Network Install - Server

You can only choose one. TOAD always installs its files in a TOAD folder.No files will be placed in Windows folders or other miscellaneous folders.

14

Local TOAD Install (FULL)This is the default choice. This installation is a full client and server install.This installs all TOAD files to your local hard drive. A TOAD folder iscreated on your local hard drive and the install puts TOAD.EXE,TOAD.CHM, and other TOAD files in your TOAD folder. TOAD\TEMPScontains most of your personal configuration files and the majority of theTOAD files.

Is Network Installation the right choice for you?

An advantage of installing TOAD to a network server is that as TOAD isupdated, the network administrator only has to update the server files. Allusers are updated when you update TOAD on the server, as opposed tohaving to update each workstation individually. This makes periodic TOADupdates easier.

The disadvantage of installing TOAD to a server is whenever someone startsTOAD at their workstation they have to read the TOAD.EXE application file(currently approximately 5 megabytes) across the network. If you have aslow network or a network with a lot of traffic, this type of installation mightnot be your best choice.

Network Install - Client (must run Server side install first)This option installs the personal configuration files to the PC, and createsshortcuts to TOAD.EXE and TOAD.CHM on the server, which already hasTOAD installed. All other TOAD files, such as files that you can customize,are installed on your workstation in your hard drive in a TOAD folder. So, ifyou choose this option you need to know where on the server you want yourTOAD.EXE and TOAD.CHM files to be read from. This option is forindividual workstations in situations where TOAD.CHM and TOAD.EXEare already installed on the server.

Network Install - ServerThis installs TOAD.EXE and TOAD.CHM on the network server so otherusers can run the Network Install - Client installation to create shortcuts tothe served TOAD. If TOAD is installed to run on a server, the networkadministrator should be the only one with write access to TOAD.

Chapter 3 Install/Uninstall and TOAD Files 15

5 The next dialog asks you to select your destination directory. The defaultdirectory is C:\Program Files\Quest Software\TOAD, but you can browsethrough your directories and select another one if you want TOAD installedin another directory or another hard drive letter (D, E, F, etc.).

If in the previous step you chose to install some or all of TOAD on a serveryou will also be asked for the destination directory for the server install.

6 The next dialog box asks if you want to backup replaced files. If you chooseYes all copies of modified configuration files will be put in a backup folder.Then, when TOAD updates are performed, your configuration files won’t beoverwritten. This only backs up TOAD install files. The default is Yes.

7 If you chose Yes in the previous dialog, the install will ask you to select abackup directory. The default is the TOAD\BACKUP folder. You canbrowse through your directories if you want to choose another location.

8 The next screen has a checkbox that lets you Install UNIX Job SchedulerScripts. The UNIX Job Scheduler is part of the Quest DBA Module (version7.4 and up). It lets a DBA use TOAD to interface with the UNIX Crontabfacility to schedule scripts. If you do not install the UNIX Job SchedulerScripts, your UNIX Job Scheduler will be useless. If you have the QuestDBA Module and want to use the UNIX Job Scheduler, you should have theInstall Unix Job Scheduler Scripts checkbox checked. (It is checked bydefault.)

The screen also lets you select to backup several categories of modifiableTOAD files for local use. The checkboxes are:Backup SQL Templates?Backup Script Manager Scripts?Backup Unix Job Scheduler Scripts?These files are seldom modified. The files you choose to backup will besaved as file_name.DATE.SAV. (DATE is the date of the install.) The filesyou do not choose to backup will be overwritten during the install.

16

9 The next screen lets you select which file to copy over the PLSQLSCR.TXTfile. The PLSQLSCR.TXT file enables flexible syntax highlighting in theTOAD editors. You can select either Short Version (SHORTSCR.TXT) orLong Version (LONGSCR.TXT).

LONGSCR.TXT contains almost twice as many items for syntaxhighlighting and will give you access to over a thousand reserved words andkeywords (including some of the names in SYS packages). The longer listmight affect performance depending on your editor comments.

SHORTSCR.TXT is selected by default. This includes over 570 items.

If you later want to change your choice you can always copy eitherLONGSCR.TXT or SHORTSCR.TXT over PLSQLSCR.TXT as desired.Another way to change your selection at a later date is via the View >Options > Parser Scripts tab. Change the path for the PLSQL Parser ScriptFile (PLSQLSCR.TXT) to the desired file (LONGSCR.TXT orSHORTSCR.TXT).

If you plan on adding or removing Oracle SQL Reserved words, PL/SQLReserved words, or Oracle keywords from the lists that are syntaxhighlighted, you can edit the PLSQLSCR.TXT file directly. If you edit thePLSQLSCR.TXT file be careful, because no support will be provided foraltered scripts.

10 TOAD starts its installation process.

It checks your system to see if either SQL*Net or Net8 are installedproperly, such as ORACLE_HOME, PATH environment variable, andprerequisite SQL*Net/Net8 files.

It asks you if you would like a TOAD desktop shortcut icon. If you chooseYes it creates a TOAD shortcut and an icon on your desktop.

Chapter 3 Install/Uninstall and TOAD Files 17

After TOAD makes these checks, a progress bar displays which shows theinstall program uncompressing the files and copying the files to theirdestinations. At the same time, 2 log files are created in the TOAD folder:INSTALL.LOG and INSTALL.TXT.

INSTALL.LOG and INSTALL.TXT

INSTALL.LOG is created by the install script. It contains verbosecommands of what the installation did. Do not edit INSTALL.LOG, becauseit is needed by the uninstall engine. It is the file the uninstall engine readswhen removing files, icons, and other parts of TOAD. This file is alsohelpful when trying to diagnose an installation problem such as low diskspace, inadequate NT privileges, etc.

Here is a section from an INSTALL.LOG file.

File Copy: d:\Program Files\Quest Software\TOAD\readonly.licFile Copy: d:\Program Files\Quest Software\TOAD\temp.keyMade Dir: d:\Program Files\Quest Software\TOAD\BACKUPFile Overwrite: d:\Program Files\Quest Software\TOAD\Toad.exe.

INSTALL.TXT is also created by the installation, but it has a differentformat. Its user-friendly approach is easier to follow. It’s basically an outlineof how the installation script went. If there is an installation problem, suchas a problem creating icons, the file can be helpful in determining why thatproblem is occurring. Here is a section from an INSTALL.TXT file. Noticehow different its format is from the INSTALL.LOG.

Copying down files...File install completeCreating icons...Create a shortcut to TOAD on the desktop...Done creating icons!

So, TOAD writes the files to the appropriate places.

18

11 TOAD creates icons/shortcuts in the Start/Programs/Quest Software/Toadmenu or Program Manager Group including:TOAD ApplicationTOAD HelpTOAD ReadMeUninstall TOADRelease NotesGetting Started GuideUser’s Guide

TOAD also display dialogs relevant to any add-on modules that you have.

12 The next screen asks if you want to run the TOAD Server Side Objectwizard. This wizard is discussed in detail in the next chapter.

13 The next screen includes an upgrade notice.

14 The finish dialog displays indicating installation has been completed.

Checkboxes let you choose to View Release Notes, View ReadmeInstallation notes, and Start TOAD.

TOAD puts the selected notes into notepad for you to read.

Refer to the RELEASENOTES.HTM for the latest information aboutTOAD upgrades, changes, fixes, and issues.

Chapter 3 Install/Uninstall and TOAD Files 19

TOAD files

When TOAD is installed, files are copied into the appropriate directories. As youwork with TOAD more files are created by you. This section is an overview ofsome of the TOAD files that are in your TOAD folder.

TOAD.EXEThis is the TOAD application file.

TOAD.CHMThis is the TOAD help file.

UNINSTALL.EXEThis is the uninstall engine. You select uninstall from the start menu, or controlpanel add/remove programs applet.The uninstall engine reads and undoes everything that it finds in theINSTALL.LOG.

TOAD.LIC – This file must be in the TOAD folder.FULLTOAD.LICREADONLY.LIC

TOAD.EXE only reads TOAD.LIC to determine if it is full TOAD orread-only. The default is FULLTOAD.LIC. So, the network administrator cancopy READONLY.LIC over the TOAD.LIC on an individual workstation, tomake TOAD read-only at that workstation.

20

NAMEDSQL.DATA list of user named SQLs

PERSSQLS.DATA list of user personal SQLs

SQLS.DATA list of last x SQLs executed by the user

README.RTFA legal reminder, install notes, license files, and other TOAD information

RELEASENOTES.HTMIncludes important information about upgrades, changes, fixes, and issues

REVBASE.DLLInterface from TOAD to Oracle Knowledge Base

TOAD.INIInitialization parameters file

CONNECTIONS.INIStores connection information such as passwords, usernames, and servers

TOADLOAD.WAVCroak sound, plays when TOAD.EXE is invoked

SCHEMA.FLTSchema filters files. If you use browser filters, TOAD creates SCHEMA.FLTfiles.

Chapter 3 Install/Uninstall and TOAD Files 21

TOADREPORTS.EXEThe executable that launches the Reports feature from within TOAD. It can onlybe launched from within TOAD.

REPORTSPARAMS.INIInitialization files for the Reports feature

FMTPLUS.DLLContains the code that TOAD uses from Formatter Plus—Format Code, ProfileCode, and Show Inline Advice

FMTOPTIONS.EXELaunched when you select View > Formatting Options. This window lets youconfigure how Formatter Plus will operate. The settings for the configurationwindow are saved in FMTOPTIONS.INI.

FMTPLUS.OPTThe settings for Formatter Plus that the View > Formatting Options windowconfigures are saved in FMTPLUS.OPT.

TOADSERVERSIDE.EXEThis is the TOAD Server Side Objects wizard.

Team Coding DLLsSCC.DLLVSS.DLLPVCS.DLL

22

The TEMPS folder contains 12 text files associated with SQL functions Help. Tosee the SQL Help templates, go to the toolbar in the SQL Edit window and selectShow SQL Help.

STRFUNCS.TXT Single Row CharacterFunctions

NUMFUNCS.TXT Single Row Number Functions

GRPFUNCS.TXT Group Functions

DATFUNC.TXT Date Functions

DATEFMTS.TXT Date Format Options

CNVFUNCS.TXT Data Conversion Functions

MSCFUNCS.TXT Other Misc. Functions

NMBRFMTS.TXT Number Format Options

PSEUDO.TXT Oracle Pseudo Columns

OPTHINTS.TXT SQL Optimizer Hints

PREDFXCP.TXT Defined Exceptions

USRFUNCS.TXT User Provided Function List

FILE NAME ASSOCIATED TEMPLATE

These templates are user configurable by editing the text file. This is especially useful for configuringPREDFXCP.TXT and USRFUNCS.TXT.

Chapter 3 Install/Uninstall and TOAD Files 23

Templates for the Procedure Editor in the Procedure Editor window include:

NEWFUNC.SQLNEWPACKAGE.SQLNEWPACKAGEBODY.SQLNEWPKGFUNC.SQLNEWPKGPROC.SQLNEWPROC.SQLNEWTRIG.SQLNEWTYPE.SQLNEWTYPEBODY.SQLNEWTYPEFUNC.SQLNEWTYPEPROC.SQL

Three files are associated with syntax highlighting in the SQL Editor andProcedure Editor.

PLSQLSCR.TXTMain file

SHORTSCR.TXTThe default – PLSQLSCR.TXT=SHORTSCR.TXT

LONGSCR.TXTCan copy LONGSCR.TXT over PLSQLSCR.TXT for more functionality

Syntax highlighting support also includes HTML, INI, JAVA, and TEXT files.

HTMLSCR.TXTINISCR.TXTJAVASCR.TXTTEXTSCR.TXT

24

ALIASES.TXTList of user-defined table aliasesFor example, Employee table can be set up as alias EMP.

PLSQL.DCICode completion templates activated in the SQL Edit or Procedure Edit windowby typing a couple of letters and <CTRL> + <SPACE> or to access the wholelist press <CTRL> + <SPACE>

The user can customize the file by manually editing PLSQL.DCI with notepadorFrom the edit menu – Editor Options dialog tab for editing code templates.

Code completion templates support also includes HTML, INI, JAVA (If youwant to use Java templates you'll have to create the files JAVASUB.TXT andJAVA.DCI), and TEXT files.

HTML.DCIINI.DCITEXT.DCI

PLSQLSUB.TXTList of AutoCorrect substitutions.

If you mistype and press <SPACE>, the word you incorrectly typed isautoreplaced if it’s in PLSQLSUB.TXT.Example; teh would be replaced with theYou can add words by accessing the editor options dialogor Notepad - PLSQLSUB.TXT.

Other SUB.TXT files are supported for HTML, INI, JAVA (If you want to useJava templates you'll have to create the files JAVASUB.TXT and JAVA.DCI),and TEXT files.

HTMLSUB.TXTINISUB.TXTTEXTSUB.TXT

Chapter 3 Install/Uninstall and TOAD Files 25

SCHEMA_DATABASE.LSTLists of Oracle users for the selected schema/database.You can use the View > Oracle Users List dialog to select which users’schemas you want to see. This saves query time.

TOADSTATS.INIWarning levels for server statistics window. You can set thresholds for when awarning or error will display.

warning – pinkerror – red

Script Manager Files

The files DBA.SDF and ORACLE 8i DATA DICTIONARY.SDF install intothe TOAD directory. When you load them into Script Manager, you will need toclick MOVE and update the directory path for the scripts.

SCHEMA OBJECTS.SDF are the category files for Script Manager.

If you select server installation, the files TOAD installs on the server include:

TOAD.EXETOAD.CHMREVBASE.DLLRELEASE NOTES.HTMTOAD GETTING STARTED GUIDE.PDFTOAD USER'S GUIDE.PDFQSR.EXESQLMONITOR.EXETOADLOAD.WAVTOAD.LIC

and

SQL Help TemplatesNew Procedure TemplatesCode Completion Templates

in \TEMPS folder

26

UninstallIf you uninstall TOAD, it might not totally uninstall. When you use TOAD, youcreate new TOAD files such as SQL scripts, data output, or temp files. Whenyou run uninstall, TOAD has no way of knowing what those files are. So it won’tremove new TOAD files that you’ve created. You’ll have to manually deletethem.

To uninstall TOAD.

From the Start MenuClick Start > Programs > Quest Software > Toad >Uninstall TOAD

-OR-

Go to Add/Remove Programs in Windows and uninstall TOAD.

If a network administrator installs server components they will not beuninstalled. The network TOAD components will have to be manually deleted.

Chapter 3 Install/Uninstall and TOAD Files 27

How Uninstalling TOAD works for each of the install types

Local TOAD Install (FULL) – Uninstall uninstalls everything from your PC.

Network Install - Client (must run server side install first) – Uninstall onlydeletes client files. With this type of install the TOAD.EXE and TOAD.CHMfiles were installed on a server. The files on the server will have to be manuallydeleted.

Network Install - Server – This is run by a network administrator. TOAD.EXEand TOAD.CHM files were installed on the server. An install log was notcreated and it did not create an uninstall. This was intentional. If a networkadministrator decided to uninstall TOAD, this would affect all the workstations.So, network TOAD files must be manually deleted.

So, when network installation is involved, remember that any TOADcomponents that are installed on the server cannot be uninstalled. They will haveto be manually deleted. When TOAD files are installed on the server they alwaysinclude TOAD.EXE and TOAD.CHM. TOAD files on the client (workstation)can be uninstalled.

4Server Side Installation Wizard

During the installation you have the opportunity to install the server side objectsfor TOAD via the Server Side Installation wizard. After installation, you canaccess the wizard from TOAD via the Tools menu.

The Server Side Installation wizard lets you add, remove, or update the serverside objects for TOAD features that require objects installed on the server side ofthe Oracle instance.

The following are features with server side objects:

Explain Plan Tables - displays formatted plan info and saves previous planscan install in the following schemas: TOAD, Individual, Publicly Accessible

TOAD Profiler interface to DBMS_PROFILERcan install in the following schemas: TOAD, Individual, Publicly Accessible

TOAD Security - lets you restrict users' access to specific TOAD featurescan install in the following schema: TOAD

TOAD ObjectName Function - speeds up Kill/Trace window's All Locks tabcan install in the following schema: TOAD

Team Coding - lets users check in and check out PL/SQL objects and optionallyassociate those objects with a third party source control providercan install in the following schemas: TOAD, Publicly Accessible

TOAD Space Manager - part of the Quest DBA Module, tracks space usage andI/O over timecan install in the following schema: TOAD

30

Schema(s) the features can be installed into

Features with server side objects TOAD Individual Publicly Accessible

Explain Plan X X X

Profiler X X X

Security X

Object Name X

Team Coding X X

Space Manager* X

The server side objects apply only to their corresponding features, and TOAD'sother features will run successfully without the server side objects.

The Server Side Installation wizard simplifies installing and administering theseobjects. In order to install server side objects, you will need to have access toeither the account for the TOAD user, the account for the schema where you areinstalling them, or an account with the DBA role.

Radio buttons let you:Install, upgrade, or remove objects for all users to shareInstall or remove objects for an individual schema to useCreate setup scripts without a database connection.

*The Space Manager wizard helps you set up the privileges for TOAD, but the View Tablespaces window will install and administer the objects.

Chapter 4 Server Side Installation Wizard 31

Install, upgrade, or remove objects for all users to share

If you choose the Install, upgrade, or remove objects for all users to shareradio button the next screen is a connection information window. It includesthree radio buttons:Install or remove shared objects in the TOAD schemaDrop the entire TOAD schema and all public synonyms for its objectsInstall or remove shared objects in a schema other than TOAD.

Install or remove shared objects in the TOAD schemaUse this option to create and administer a repository schema called TOAD. Thisschema gives you a central location from which to maintain the tables needed torun the above mentioned portions of TOAD. You could create some of theseobjects (Explain Plan and Profiler) in every schema in which you intend to usethem (every schema would have these same tables) but if you have a largenumber of users, using the TOAD schema is more efficient.

Checkboxes let you select which TOAD features that include server side objectsyou would like to Add, Remove, and depending on the situation Administer,Recreate, Recompile, or Repair. Below each object title TOAD lists the status bychecking the schema. The possible status messages are:Found and OKNot foundErrorAn Error notice describes the problem.

32

The window asks:Which TOAD objects would you like to administer?

The checkboxes and additional options are for:

TOAD Security

ObjectName function for Kill/Trace window

Explain Plan Tables

TOAD Profiler

Team Coding

TOAD Space Manager (part of Quest DBA Module, must be setup within TOADwhile connected to the TOAD schema)

Drop the entire TOAD schema and all public synonyms for itsobjectsThis option lets you easily drop both the TOAD schema and all the publicsynonyms associated with it.

The next screen asks you to enter the connection information. DBA privilegesare required. Enter the database where you want the TOAD schema dropped.

The TOAD user and associated public synonyms are dropped. If you previouslyused this client to set up Team Coding on your database, you will also getprompted to drop any roles that you created for Team Coding.

Install or remove shared objects in a schema other than TOADYou need to log in as the owner of the shared objects. (You cannot install TOADSecurity outside of the TOAD schema.) The window asks:Which objects would you like to administer?

The checkboxes and options are for:

Explain Plan tables

TOAD Profiler

Team Coding

Chapter 4 Server Side Installation Wizard 33

Install or remove objects for an individual schema to use

Explain Plan support and TOAD Profiler support can be provided on anindividual basis.

If you do not want to create the TOAD user, you can create and administer someof the objects in the schemas where you intend to use them. This might be moreefficient if you have a small number of users for these special features and youdo not want all of your users to have access.

If you choose this option, remember that each user who needs to use the featureswill have to have setup done individually.

The next window is a connection information window and asks for the log oninformation for the user account where you want to create the objects.

Create Setup scripts without a Database Connection

You can create the scripts to set up the TOAD schema, etc. without access to thedatabase connection that you need. Then you can log in later and run the scripts.The checkboxes let you select and save the desired setup scripts to disk.

Set up Wizard Finished

The last screen announces that the script has been run or saved and that set up iscomplete.

If there were errors they are noted, and you are referred back to the log to verify.

TOAD runs other checks on your database and describes:

Status of SYS.DBMS_DEBUG (required for use of the optional Debuggermodule)

Status of SYS.DBMS_PROFILER (required to use TOAD Profiler).

5Registration

This chapter discusses how to register trial and commercial versions of TOAD.This chapter also covers the purchase procedure for TOAD.

Trial Version Registration

Before you register the trial version of TOAD you need yourregistration key. The PL/SQL Debugger and the Quest DBA Moduleare activated in the trial key.

To Start Trial TOAD1 Start TOAD.

2 The Product Authorization window displays.

3 Click in the Product Authorization textbox.

4 Enter the software registration key number.

If you have previously used a TOAD trial key you will get an “Invalid Key”message. A trial key can only be used once, even between different versions ofTOAD.

36

Registration Key

If your registration key has not been activated after a certain time period, itexpires. This is to ensure that you are not evaluating an old copy of TOAD. Wewant users to have the latest and greatest copy to evaluate. So, if yourunactivated key expires, download the latest trial copy and get your newregistration key, or call Quest Sales at 949-754-8000 for a trial extension.

If you are satisfied with the trial version and want to purchase the commerciallicense key, refer to the next section. Remember, you’ll need to update yourlicense key through Help > Register TOAD.

Chapter 5 Registration 37

Purchase

To purchase the latest version or place a large order you can either contact QuestSales at 949-754-8000 to discuss payment options

or

Visit the Quest Software Web site at www.quest.com .

You’ll receive a temporary key in the download.

After your order is processed, your permanent license key is sent to you. Then goto the Help menu, click Register TOAD, and enter your new authorization keynumber, also known as the license or registration key number. Enter the SiteMessage such as Company Name. In the future, when you download upgradesfrom the Quest Web page you’ll need the license key number. Select Help >Register TOAD, highlight your number from the authorization key number box,Copy, and Paste the number.

NOTE: You may need to restart TOAD to reinitialize your options and enable allfunctions.

38

Product authorization errors

The following table shows steps that you can take when encountering anauthorization problem or error in TOAD.

Error Message Explanation and Possible Solution

Authorization string has expired. This occurs when the trial authorizationfor TOAD has expired.

If the trial date has not passed, checkthat the date on your system is setcorrectly.

Invalid authorization string or sitemessage.

This indicates that the authorizationstring or the site message has not beenentered correctly.

Make sure that they have been enteredexactly. The site message is casesensitive.

If you try to use a trial key more thanonce you will get an Invalid Keymessage because trial keys can only beused once.

6Features

This chapter introduces you to a few of TOAD’s many features. To learn moreabout these or other features refer to TOAD Help and the TOAD User’s Guide.

40

SQL Editor

Ways to invoke the SQL Editor window include:

� Click the button in TOAD’s main toolbar.

� Select menu item Database > SQL Editor.

� Set the SQL Editor to StartUp on new connection in the View > Options >Windows dialog.

When you first start TOAD you are in the SQL Editor window. The SQL Editorlets you type, edit, recall, execute, and tune. The window contains an editor tocompose SQL statements or scripts and a results grid to display the results fromSELECT SQL statements.

Chapter 6 Features 41

The Show Tables window button invokes the Table Names Select windowwhich lets you select tables from a dropdown. It's as easy as drag-and-drop.

The SQL Editor window supports standard windows editing commands butincludes other functions such as a gutter for quick multi-line text selection,programmer style double-click highlighting, and syntax highlighting ofcategories, keywords, table names, and more.

Data Grid

The data grid can be edited. You can rearrange columns (drag and drop) withouthaving to re-execute your queries. TOAD retains the column layout (order andwidths) from query to query as long as the column list in the query remains thesame. You can sort columns in the data grid in ascending or descending order. Ifa column has a lot of text, the memo editor can be used. The memo editor isinvoked by double-clicking on a cell.

A red or green box displays in the status panel at the bottom of the SQL Editorwindow indicating whether the recordset is editable (green) or not editable (red).If the indicator is red, while the data can’t be edited, it can still be selected andcopied.

Explain Plan tab

Explain Plan displays the steps that will occur in the selected statements. Youcan see the steps in a tree diagram and click expand buttons to see the details of astep.

Auto Trace tab

Auto Trace displays the results of every statement issued while in auto tracemode. It helps with tuning. When you run a query you can find out someperformance statistics related to that query.

DBMS Output tab

When you execute a DBMS Output statement, the DBMS Output willautomatically display in the DBMS Output tab of the results grid.

42

Schema Browser

Ways to invoke the Schema Browser window include:

� Click the button in TOAD’s main toolbar.

� Select menu item Database > Schema Browser.

� Set the Schema Browser to StartUp on new connection in theView > Options > Windows dialog.

The Schema Browser separates database objects in a selected schema by type,using tabs (or with a dropdown that you can select through the options menu).The left panel lists the objects and the right panel displays the details. You canhide, rearrange, or rename object tabs through the context menu.

TOAD can create scripts (through the Create Script buttons on the object tabs),for most objects that are displayed in the Schema Browser. You can copy objectnames and column data from the Schema Browser panels to a clipboard oranother application.

Chapter 6 Features 43

Procedure Editor

Ways to invoke the Procedure Editor window include:

� Click the button on TOAD’s main toolbar.

� Select menu item Database > Procedure Editor.

� Set the Procedure Editor to StartUp on new connection in the View >Options > Windows dialog.

The Procedure Editor lets you create or modify procedures, functions, packages,triggers, types, and type bodies. If you have the optional PL/SQL Debugger, thedebugger buttons will display enabled.

The Procedure Editor window has two panels. The left panel contains theNavigator List. The right panel contains the Procedure Editor, which shows thecode for the selected object. The tab interface allows multiple objects in thewindow.

44

Options Menu

To access the Options Menu click the Configure TOAD Options button on themain toolbar or select the View > Options menu item. Click a topic from the leftpanel and options for that topic appear in the right panel. Click in the boxes or onthe item text to check or uncheck the options. Keyboard users can press the<Tab> key to move from the left panel to the right panel and press <SPACE> tocheck or uncheck boxes.

More options are in the Edit > Editor Options window and the FormatterOptions window. Both windows can also be accessed from buttons on the mainView > Options window.

Chapter 6 Features 45

TOAD Help

To access TOAD Help while in TOAD, simply press the F1 key. TOAD Helpincludes contents, a searchable index, and details on TOAD’s features.

Troubleshooting

This section discusses troubleshooting installation and connection problems. Fora comprehensive list of Frequently Asked Questions refer to the toadsoft.comsite and follow the links.

SQL*Net/Net8 Installation Problems

For SQL*Net/Net8 installation problems, follow these steps:

1 Determine your ORACLE_HOME value.Check the Registry under HKEY_LOCAL_MACHINE\Software\Oracle

2 Check to see if you have access to ORACLE_HOME\bin.The most common cause of problems involves the PATH environmentvariable.ORACLE_HOME\bin must be in your PATH environment variable.Confirm you have access to the drive and make sure the Oracle Home folderexists.Your PATH should look similar to this:PATH=C:\PROGRA~1\MSOFFICE\OFFICE;C:\WINDOWS;C:\ORAWIN95\BIN;

3 Confirm that the Oracle interface DLL is in the Bin folder.TOAD must have an Oracle interface DLL to connect. It would beORAxy.DLL, where xy is the database version you are connecting to. So, for7.1 it is ORA71.DLL. For 8.0.5 it is ORA805.DLL. For Net8/Oracle8i, theDLL is called ORACLIENT8.DLL. Remember, if this DLL file is not in the

48

bin folder, then TOAD cannot connect.

4 Look for TNS Admin value.The TNS Admin value would be a folder name in the Windows registry. Thisis an optional folder. If it is not present the default isOracle_Home\Network\Admin

Open up the TNSNAMES.ORA file. It should be in the Admin folder. Makesure the database alias name you are using is in the TNSNAMES.ORA file.

Cannot connect to Personal Oracle

If you are having trouble connecting to Personal Oracle or creating a SQL*Netalias for PO7 or PO8, then for the database name on the TOAD login window tryone of the following entries:

2:BEQ-LOCALLOCALTCP-LOOPBACK

For Schema/Passwords try one of the following pairs:

DEMO/DEMOSCOTT/TIGERSYS/CHANGE_ON_INSTALLSYSTEM/MANAGER

Troubleshooting 49

Support

If you have questions about using TOAD, and you can’t find the answers in thisguide, the user's guide or TOAD Help please contact the customer support staff.The Help > Support Bundle menu item window provides updated supportinformation and tools for contacting support.

The information it contains will be useful for support when resolving issues andwe recommend that you include this support information with emails to QuestSupport. The Support Bundle window is discussed in detail in the TOAD User'sGuide - Frequently Asked Questions/Support chapter and in TOAD Help.

50

INDEX

A

ALIASES.TXT 24Authorization Errors 38

D

DBA.SDF 25disk space 12

E

Error Messages 38

F

FMTOPTIONS.EXE 21FMTPLUS.DLL 21FMTPLUS.OPT 21FULLTOAD.LIC 19

H

Help 7

I

Install 11, 13Install.Log 17

L

LONGSCR.TXT 23

N

NAMEDSQL .DAT 20

O

Options Menu 44ORACLE 8i DATA DICTIONARY.SDF 25

P

PERSSQLS.DAT 20PLSQL.DCI 24PLSQLSCR.TXT 23PLSQLSUB.TXT 24

Q

Quest SoftwareCustomer Support 49

R

README.RTF 20READONLY.LIC 19Registration 35RELEASENOTES.HTM 8, 18, 20REPORTSPARAMS.INI 21Requirements 11, 12REVBASE.DLL 20

52

S

SCHEMA.FLT 20Script Manager Files 25Server Side Installation wizard 29SHORTSCR.TXT 23SQL Editor 40SQLS.DAT 20

T

Team Coding 29TNS Admin Value 48TOAD

Schema 48

TOAD Getting Started Guide 8TOAD Help 7TOAD ObjectName 29TOAD User's Guide 8TOAD.CHM 19TOAD.EXE 19TOAD.LIC 19TOADLOAD.WAV 20TOADREPORTS.EXE 21TOADSTATS.INI 25

U

Uninstall 26UNINSTALL.EXE 19