Chat now with support
Chat with Support

Toad Data Point 5.0 - Installation Guide

Upgrade Automation Scripts

If you upgrade to a newer version of Toad, Automation scripts created in a previous version must be upgraded before you can open them in the newer version. Toad prompts you to automatically upgrade a script when you attempt to open it in a newer version.

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

Note: If Toad was installed with the Prohibit saving passwords option selected, the Automation module is disabled and Toad does not prompt you to migrate scripts.

Upgrade Automation Scripts to Newer Version of Toad

An automation script is compatible with the version of Toad in which the script was created. If you want to open and/or modify a script using a newer version of Toad, you must upgrade the script. Toad automatically prompts you to upgrade the script the first time you open it in the newer version.

To upgrade an Automation script

  1. Open the script in Toad. Toad prompts you to upgrade the script.

  2. To upgrade the script, select Yes.

    Caution: If you upgrade an automation script, it will no longer be compatible with earlier versions of Toad.

  3. Select No (and do not elect to save the script), to keep the script compatible with the previous version.
  4. If you selected Yes, Toad upgrades your script and saves a backup copy of the original script in the following location:

    <application data directory>\Automation\bak\

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

Migrate Scheduling Tasks to Newer Version of Toad

Each scheduled Automation script uses a Windows scheduling task. The scheduling task specifies which version of Toad to use by specifying the version's application path. Toad provides you with two easy ways to migrate your scheduled scripts' scheduling tasks when you upgrade Toad. First, Toad prompts you to migrate scheduling tasks upon initial launch of the application after installation. Next, you can migrate scheduling tasks at any time using the Job Manager.

Notes:

  • If you upgrade a previously-created script by opening it in a newer version of Toad, you must also migrate the scheduling task to the newer version.
  • If you install the newer version of Toad side-by-side with the older version, previously-created, scheduled scripts will continue to execute using the older version, until you migrate the scheduling tasks (provided that you do not open the scripts in the newer version).

To migrate scheduling tasks upon initial launch

  1. After upgrading Toad, and upon initial launch of the application, the Migrate Scheduled Tasks dialog opens.
  2. Select the scheduled tasks (scheduled Automation scripts) to migrate to the new version of Toad.
  3. Click OK to close the dialog.
  4. Toad immediately prompts you for your Windows password. Enter your password to migrate the scheduled tasks.

To migrate scheduling tasks using the Job Manager

  1. Select Tools | Administer | Job Manager.
  2. Click on the Job Manager toolbar.
  3. Select the scheduled tasks to migrate and click OK.

    Note: Only currently-scheduled tasks (enabled or disabled) are listed in the Migrate Scheduled Tasks dialog.

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

Manually Edit Scheduling Tasks

On occasion you may need to modify the application path in a Windows scheduling task. You can do this by manually editing the scheduling task using the following procedure.

To manually edit a scheduling task

  1. In the Job Manager (Tools | Administer | Job Manager), right-click a task and select Edit Task.
  2. To change the version of Toad used to run the script, in the Actions tab, change the folder name in the toad.exe path.

  

Files Migrated During Upgrades

When upgrading to a new version of Toad, the following files can be migrated from the previous version's Application Data Directory (click the Application Data Directory link in Help | About to open the directory).

Caution! Migrating settings from a previous version of Toad may overwrite new settings files, 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 share this data, the file is automatically sent to Quest Software on a periodic basis.

Connections.xml

Contains all connections stored in the Navigation Manager or the New Connection window.

ConnectionTrace.log

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

ExceptionTrace.log

Contains a log of all exceptions encountered while running Toad.

FTPConnection.log

Contains a log of exceptions encountered when attempting to connect to FTP servers.

FTPConnections.xml

Contains connections to FTP servers stored in the FTP Connections window.

Quest.PersistentCache.xml

Contains the private object annotation cache options (object notes, Lookup tables, and hidden columns). You can 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 (temporary folder)

Used by automation when executing automation scripts.

Cache

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

Context

Contains settings that depend on the context within Toad including the following:

  • Adapter—Custom data editing statements.

  • Filter—Unnamed filters defined in the Object Explorer or Database Explorer.

  • Named Filter—Named filters defined in the Object Explorer or Database Explorer.

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

Document Recovery

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

Keyboard

Contains custom keyboard shortcut layouts.

Layouts

Contains layouts for some areas in Toad, such as tool windows that automatically display in the Editor and column layouts for the Messages tab.

ModuleSettings

Contains general settings for various components in Toad, 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 toolbar customizations and tool window locations.

SQLFormatter

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

SQLRecall

Contains the SQL statements saved by SQL Recall.

Templates

Contains the following templates:

  • Code Templates—Templates used to define default values when creating new objects in the Object Explorer or Database Browser.

  • Scripts—Startup scripts to run when connecting.   

  • Snippets—Code Snippet entries.

  • Reports—Report entries.

 

Uninstall Toad

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

  • Any new files you create
  • Any copies of files you make for backup purposes
  • Settings files

You can uninstall Toad Data Point by using the Installer or by using the Windows Add/Remove Programs (or Uninstall a program) feature. Using the Installer is the preferred way to uninstall Toad Data Point.

To uninstall Toad

  1. Run the ToadInstaller.exe.
  2. Select Uninstall Toad Data Point only.
  3. Complete the wizard.

Configure Toad Layouts

Toad can emulate the layout and settings of other products. Use the Configuration Wizard to select a pre-defined layout that matches Toad® for Oracle®, SQL Navigator, or your native database tool. The Configuration Wizard also allows you to specify a skin and grid color.

If you want to group documents using Toad's built-in workflow: Understand, Query, Report, and Automate, select the Toad for Data Analysts (Original) option. Then open the Configuration Wizard again and select Custom to configure Toad behavior, such as showing/hiding windows, or opening and grouping documents according to the selected workflow group.

To learn how to customize toolbars and menus, see Customize Toolbars and Menus.

You can also manually rearrange windows and panes to customize the Toad workspace. See Customize Your Toad Workspace for more information.

To configure Toad layout using the Configuration Wizard

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

  2. To match the look of another product, select a layout option and click Finish.

    Review the following layout options before selecting:

    Layout and Settings Page

    Layout options:

    • Toad Data Point 3.0—Applies shortcut keys used by Toad Data Point, opens default windows, and adds the Wizard toolbar.

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

    • MS Query Analyzer—Applies shortcut keys used by Query Analyzer and automatically opens the Object Explorer, Code Snippets, and Editor windows.

    • MS Management Studio—Applies shortcut keys used by Management Studio and automatically opens the Connection Manager and Editor windows.

    • SQL Navigator—Applies shortcut keys used by SQL Navigator and automatically opens the Navigation Manager, Object Explorer, Editor, and Code Snippets windows.

    • Toad for Data Analysts (Original)—Applies shortcut keys used by Toad for Data Analysts. This option also displays the Grouping (Toad workflow) toolbar and Wizard toolbar.

    • Custom—Applies shortcut keys used by Toad Data Point. This option allows you to select skin and grid styles, as well as Database Explorer display options.

      Use this option to customize the Toad for Data Analysts layout if you have previously selected it.

    Tip: You can set or modify individual keyboard shortcuts in Keyboard Options in Tools | Options | Environment | Keyboard.

    Note: If you select a new layout, you may need to restart Toad to see the changes to the Grouping and Wizard toolbars.

  3. To customize your layout, select Custom and click Next. Then specify options on each page of the wizard. Review the following for additional information:

    Page

    Options

    Look and Feel

    Select a skin and grid style.

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

    • Grid style—Applies the grid style you select to the data grid only.

    A preview of the selected style is automatically displayed in the wizard and in the grid.

    Tip: You can change the skin and grid style later in Tools | Options | Environment | Interface.

    Database Explorer Style

    Specify how objects display in the Object Explorer window.

    Tip: Click in the Object Explorer at any time to switch to a different view style.

    Quick Guide

    Displays a Quick Start Guide that lets you quickly launch frequently used features and tutorials until you are more familiar with the application.

    Tips:

    • To view this window at anytime, select View | Quick Guide from the menu.

    • To hide this window when starting Toad, select the Do not show on start up checkbox at the bottom of the Quick Guide window.

    Group Documents

    Applies to the Toad for Data Analysts (Original) layout. Select this layout option prior to customizing.

    Specify one or more of the following options:

    • Use document groups—Associates each open document with its respective group in the Groupings (Toad workflow) toolbar.

    • Hide windows per group—Displays only those windows that are associated with the selected group in the Groupings toolbar. For example, if the Query group is selected and a Query Builder window is open, it will be hidden when you select the Report group.

      Note: Unless the Hide windows per connection checkbox is selected, any connections that have a window open for this group display.

    • Hide windows per connection—Displays only those windows for the current connection that are associated with the selected group.

    Tip: To hide the Grouping toolbar, select Tools | Customize, and then deselect the Grouping toolbar in the Toolbar tab.

    Group Document Defaults

    Applies to the Toad for Data Analysts (Original) layout. Select this layout option prior to customizing.

    Select the default window to open when selecting a group from the Grouping toolbar.

    Understand

    • Database Diagram—Easily identify relationships between tables via foreign keys.

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

    Query

    • Query Builder—Quickly create complex queries and subqueries using a graphical interface.

    • SQL Editor—Powerful editor for writing SQL queries and scripts.

    Report

    • Excel—Automatically export query results and open them in Excel.

    • Toad Report—Send query results to the Toad Data Report wizard.

    Wizard Bar

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

    Tip: To modify this option later, use the Configuration Wizard.

    Connection Documents

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

    Tip: You can modify this option later in Tools | Options | Database | General.

    Additional Settings

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

  4. Click Finish when you are done customizing.

Customize Your Toad Workspace

You can customize your Toad workspace by re-arranging windows and panes. For docked panes selected from the View menu, Toad remembers the configuration of your last open session and displays it when you re-launch the application.

To rearrange windows and panes

  1. Open a Toad pane by selecting it from the View menu.
  2. Drag the pane to a new location in the Toad workspace.
  3. Drop the pane into the desired section of the workspace when it becomes highlighted.
  4. To move an open window, drag it to the desired area of the workspace and drop it into a highlighted section.

 

Related Documents