=========+=========+=========+=========+=========+=========+=========+========= TOAD (r) Copyright (c) 1995-2002 Quest Software All Rights Reserved =========+=========+=========+=========+=========+=========+=========+========= LAST REVISED: October

2, 2002 -----------------Table of Contents: -----------------1. TOAD REQUIREMENTS/INSTALL 2. Oracle SQL*Net 3. SQL*NET2 CONNECTIONS 4. LICENSING ISSUES, ADD-ON MODULES 5. READ ONLY TOAD 6. WHAT IS TOAD? 7. GETTING STARTED 8. SYNTAX HIGHLIGHTING 9. TOOLBARS AND MENUS 10. TECHNICAL SUPPORT Thank you for your interest in Quest Software products! Please see ReleaseNotes.htm for information about the changes in this release of TOAD. ---------------------------1. TOAD REQUIREMENTS/INSTALL ---------------------------TOAD connects to Oracle versions 7.3 thru 9iR2. It runs on a Windows 98, NT, 20 00, or XP client. The installation, including Formatter Plus (but not including the Xp ert option), requires approximately 38 MB of disk space. We recommend another 5 MB of space for the temporary and option-related files created by TOAD. (1). For the TOAD tables, run TEMPS\TOADPREP.SQL to create a separate TOAD schema and create the two tables required for storage and retrieval of the Explain Plan results. Or if you do not want a separate schema for the TOAD Explain Plan tables, run TEMPS\NOTOAD.SQL in your own schema. (2). For the TOAD Profiler, run TEMPS\TOADProfiler.sql to create the required objects to profile PL/SQL code. This is an Oracle 8i and above feature onl y. In order to use the Profiler, you must also have Oracle's DBMS_PROFILER package installed. Or if you do not want to install the Profiler objects i nto the TOAD schema, run TEMPS\TOADPROFILER_NOTOAD.SQL in your own schema. (3). For the TOAD Security feature, run TEMPS\TOADSecurity.sql to create the necessary table in the TOAD schema. (4). The installation script takes care of creating folders and installing the files. (5). If you have purchased the TOAD debugger then it is enabled through the lice nse key and no further installation is necessary. But for the debugger to work , you must have the Oracle package DBMS_DEBUG on your database.

(6). If you have purchased the TOAD DBA module then it is also enabled through t he license key and no further installation is necessary. ----------------2. Oracle SQL*Net ----------------TOAD requires a complete SQL*Net or Net8 installation. It is not sufficient to run SQL*Plus and conclude that SQL*Net/Net8 is installed properly because SQL*Plus does NOT use all of the same infrastructure and components that any other third party tool, TOAD included, uses to connect to Oracle. Oracle installers may break windows registry settings, PATH settings, etc. If you are having trouble connecting TOAD to Oracle, here are a few things to check. ------------------------------------------Step (1). Determine your ORACLE_HOME value. ------------------------------------------The first thing to check is the ORACLE_HOME value. Look in your windows registry, via Start Run Regedit, drill down to: HKEY_LOCAL_MACHINE\Software\ORACLE There should be an entry for ORACLE_HOME, as well as many other entries. Like this: [HKEY_LOCAL_MACHINE\Software\ORACLE] "ORACLE_HOME"="D:\ORANT" In this case, my ORACLE_HOME on this Windows NT 4.0 box is "D:\ORANT". If you have Oracle 8i, Oracle 9i, or a Oracle product called the "Home Swit cher" which gives you the option of changing ORACLE_HOME settings to reconfigure your computer for access to several different types of Oracle Databases, then your registry settings will look like this: [HKEY_LOCAL_MACHINE\Software\ORACLE\ALL_HOMES] "HOME_COUNTER"="1" "DEFAULT_HOME"="DEFAULT_HOME" "LAST_HOME"="0" [HKEY_LOCAL_MACHINE\Software\ORACLE\HOME0] "ID"="0" "ORACLE_HOME"="D:\ORANT" "ORACLE_HOME_NAME"="DEFAULT_HOME" When Oracle connects, it will look in ALL_HOMES for the "LAST_HOME" value, which in this case is zero "0". It appends zero to "HOME" to produce "HOME0", then it looks in HKLM\Software\ORACLE\HOME0 for the ORACLE_HOME value. ---------------------------------------------Step (2). Make sure ORACLE_HOME\bin is in PATH ----------------------------------------------

In either case, ORACLE_HOME\bin must be in the user's PATH environment variable. Go to a DOS prompt, type "PATH" and see what your path is. It could look like this: PATH=C:\PROGRA~1\MSOFFICE\OFFICE;C:\WINNT;C:\ORANT\BIN; You could either go through the Control Panel to alter the PATH, or edit AUTOEXEC.BAT in the root c:\ folder. -----------------------------------------------------------------Step (3). Make sure the Oracle interface DLL is in the BIN folder. -----------------------------------------------------------------TOAD requires an Oracle interface DLL to connect. Depending on the database version you are connecting to, it is called ORAxy.DLL, where xy is the database version, e.g., for 7.0 it is called ORA70.DLL, 7.1 it is called ORA71.DLL, etc. For Net8/Oracle 8i, the DLL is called ORACLIENT8.DLL. For Oracle 9i, the DLL is called ORACLIENT9.DLL. If this file is not in the BIN folder, then TOAD cannot connect. ----------------------------------Step (4). Check for TNS_ADMIN value ----------------------------------Check the registry again for: [HKEY_LOCAL_MACHINE\Software\ORACLE] "TNS_ADMIN"="D:\ORANT\network\admin" "TNS_ADMIN" should equal something like "D:\ORANT\network\admin" for Window s NT machines. TNS_ADMIN can be blank, in which case it will default to the ORACLE_HOME\network\admin folder. Look in the tnsnames.ora file. Make sure you have an entry for the database alias you are using. After this has been checked, reboot the machine. Should connect. SQL*Plus is NOT a good test of a correct SQL*Net install, as SQL*Plus does NOT use all of the infrastructure and components of a good SQL*Net install. Use TNSPING or TNSPING80 in a DOS prompt. On the Login window, there is a <SQL*Net Help> button to display the information TOAD has collected about your SQL*Net configuration, such as multipl e homes, client DLL version, PATH, and so on. You can select an Oracle Home for the TOAD home, copy the results for tech support, etc. ----------------------3. SQL*NET2 CONNECTIONS ----------------------TOAD also requires that all Oracle connections utilize 32 bit SQL*NET2 via TNS. Therefore, any Oracle database accessed through TOAD must have appropriate entries in the SQLNET2.INI and the TNSNAMES.ORA files. If you are an Oracle developer, you already know this and are most likely already using TNS

entries for server/protocol mapping. Optionally, you can connect to Personal Oracle databases using "2:" as the database name (other possible options for Personal Oracle are LOCAL and BEQ-LOCAL). ----------------------------------4. LICENSING ISSUES, ADD-ON MODULES ----------------------------------Obtain a software registration key from www.quest.com. Enter it when prompted at TOAD startup. The trial key is good for 30 days after you put it in. The commercial key is good indefinitely. There are 3 add on modules for TOAD that can be activated through the TOAD licen se key: PL/SQL Debugger, the DBA Module, and SQLab Xpert. To activate these module s, you must purchase them via www.quest.com, and be issued a new software registrat ion key, which will have the appropriate modules enabled. Go to the "Help > Registe r TOAD" menu item dialog, enter your new key, and your add-on modules should becom e enabled. SQLab Xpert requires the TOAD Xpert installation. The PL/SQL Debugger code and DBA module code are built into TOAD.EXE. There is also an add-on product called Formatter Plus that will format your SQL for you, inside of TOAD. Formatter Plus also has its own standalone interface and will provide you with advice for improving your code. Formatter Plus is install ed by the TOAD installation routine. The Oracle Administration Knowledge Xpert and the PLSQL Administration Knowledge Xpert can also be called from within TOAD. To purchase or trial any of these products, contact Quest Sales or send email to info@quest.com. With TOAD versions 7.3 and later, the minimum Formatter Plus dll version require d for TOAD is 4.4. If you have a lower version of the FmtPlus.dll, TOAD will warn you with a dialog box at TOAD startup. You can set a wealth of formatting options in the "View > Formatting Options" dialog. Note that the demo version of PL/Formatter will not work with TOAD. You must purchase the commercial version of Formatter in order to get it working with TOA D. For example, given this query, select it, click the right mouse button, and select "Formatting Tools > Format Code" from the popup menu. select fIRst_name, last_name from %' order by last_name The statement gets formatted as follows. To disable the header, go to View Formatting Options choose General Layout Tabs, and choose "Disable". employee where first_Name like 'S

/* Formatted on 2002/08/13 14:26 (Formatter Plus v4.6.6) */ SELECT first_name, last_name FROM employee WHERE first_name LIKE 'S%' ORDER BY last_name -----------------5. READ ONLY TOAD -----------------TOAD will require a valid license file upon startup. This file must be named TOAD.LIC. TOAD is distributed with 3 license files named FULLTOAD.LIC and READONLY.LIC. If you want to install a readonly version of TOAD for a user, rename READONLY.LIC to TOAD.LIC. FULLTOAD.LIC is the same as TOAD.LIC, so if you have set TOAD to be read-only and want to restore the ability to write to the database, rename FULLTOAD.LIC to TOAD.LIC. ---------------6. WHAT IS TOAD? ---------------TOAD was begun in 1995 as a personal development aid and has grown to be used daily by many thousands of developers. There are similar tools on the market, but none can better TOAD's simple developer oriented interface, the author's attention to users, or the price. So, what you must remember when evaluating TOAD or while using TOAD is that TOAD is first and foremost a developer's aid. The interface is simple by design. The features are either what we personally want in an Oracle tool or what TOAD users have requested. TOAD wasn't built on features that were "cool" or fun to implement; nor with an interface that looked "slick" since, generally, the slicker it looks, the worse it is to operate. If there is a feature that is lacking, a report that is missing, an interface implementation that is nagging, please send an email to support@quest.com. -----------------7. GETTING STARTED -----------------When TOAD first loads, the main MDI screen appears and an initial TOAD Login Window is displayed. This window will prompt for a Database, UserName, and Password (typical Oracle stuff). The database name should be one of the valid Oracle TNS entries. The user and password are the user/password for the schema to which you want to connect. For example, one of the sample schemas that is installed with Oracle 8.1.7 has a user/password of SCOTT/TIGER. The TNS entry may be (and this value will vary according to your installation) either LOCAL or BEQ-LOCAL. Previous connections will display in a list on the left of the Login window. TOAD stores passwords for previous logins if the appropriate option is enabled. On most TOAD screens, the Oracle connection active for that screen will display in the first or second panel of the status bar at the bottom of that particular screen. This is important to note because with several connections active, you will need to know which connection is in use for the active window. Several TOAD functions also require the creation of Oracle tables; for example, Explain Plan. To create these tables, load the file \TEMPS\TOADPREP.SQL into a SQL Edit Window and execute as a script. TOADPREP will require creation of a new Oracle schema named TOAD. Alternatively, if you

want to create the required Oracle tables but do not want to create a new schema, load and execute the script file \TEMPS\NOTOAD.SQL. NOTOAD will create the objects in the current schema and grant public access to them for all other users. If you already have a PLAN_TABLE in your database, you do not HAVE to create any TOAD objects, but the View > Explain Plan window will not show the history of your executed explain plans. Just fill in the correct p lan table name under View > Options > Oracle. ---------------------8. SYNTAX HIGHLIGHTING ---------------------The primary configuration for syntax parsing and highlighting in TOAD comes from a parser script file that is loaded at runtime. By default, TOAD looks at PLSQLSCR.TXT in your TOAD\temps directory. TOAD's installation will ask whether you want to install the contents of LONGSCR .TXT or SHORTSCR.TXT into PLSQLSCR.TXT If you later want to change which script TOAD is using, go in TOAD to View > Options > Parser Scripts, and change the path for the PLSQL parser script to the file (LONGSCR.TXT or SHORTSCR.TXT) that you want TOAD to use. SHORTSCR.TXT contains a basic list of keywords for TOAD to highlight. LONGSCR.T XT contains more keywords to syntax highlight and might perform more slowly, depend ing on your editor contents. LONGSCR.TXT also contains commonly used package functi ons and procedures from the SYS schema, such as DBMS_OUTPUT, DBMS_PIPE, DBMS_JOB, DBMS_S QL, DBMS_STANDARD, and DBMS_UTILITY. Each additional item to syntax highlight takes a little more execution time. If you want to add or remove Oracle SQL Reserved words, PL/SQL Reserved words, o r Oracle keywords from the lists that are syntax highlighted, then you can edit the parse r script files, but be VERY careful and keep a backup if you decide to edit one, because NO support for altered scripts will be provided. You can also configure TOAD's Procedure Editor and Offline Editor to perform syn tax highlighting for languages other than PL/SQL, depending on the extension of the file that is loaded. TOAD comes with parser scripts for Java (JAVASCR.TXT), Text files (TEXTSCR.TXT), Ini files (INISCR.TXT), and HTML (HTMLSCR.TXT). To use these, go to View > Options > Parser Scripts, and add these languages and the file extensions you want to use for them. --------------------9. TOOLBARS AND MENUS ---------------------

TOAD's main menu and toolbars are configurable. TOAD ships with several sample toolbar and menu configurations that it installs into the TOAD\temps directory. You can not perform customizations on the toolbars that are pre-installed with TOAD. Howeve r, you can go to View > Options > Toolbars and choose to create your own toolbar and me nu configuration, using one of the pre-installed configurations as a template. If you create your own toolbar, then the Tools > Customize menu item will become enable d, and you will be able to bring up a window that allows you to add, remove, move, and rename items on the menus and main toolbars. The menus for the SQL Editor and Procedure Editor are also configurable. Rightclick over the toolbar and choose "Customize". -------------------10. TECHNICAL SUPPORT -------------------www.quest.com support@quest.com