Toad Data Studio 1.0 - Installation Guide

Install Toad Silently

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

Determine Which Installer to Use

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

Silent Installation Prerequisites

Before you can perform a silent installation, the following software must be installed on every computer where you are installing Toad: 

• Microsoft .NET Framework 4.7.1
• (Installation using .msi Microsoft installer only) Visual C++ Redistributable for Visual Studio 2015. See Visual C++ Redistributable for VS 2015 for downloads. See KB2999226 - Update for Universal C Runtime in Windows for additional information.

Silent Installation Using the Executable

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

To perform a silent install using the executable file

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

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

   “ToadInstaller.exe” /S

   You can customize MSIEXEC command-line options and overrides for your installation similar to the following command:

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

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

   Command-Line Options

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

   Option	Description
   /L “C:\temp\installLog.txt”	(Optional) Write installation messages to the specified log file. Substitute “C:\temp\installLog.txt” in the example with the fully qualified name of the log file. Enclose this value in double quotations. The installation process creates this file if it does not exist. Otherwise, the existing file is overwritten. You can add additional parameters to the logging option to indicate what type of information to log. /Lx—Adds extra debugging information to the log (used in previous example) /Lv—Specifies verbose output /L*—Log all information, except that specified by x and v /L*v—Log all information, including v (verbose output) /L*x—Log all information, including x (extra debugging info) /L*vx—Log all information, including that specified by v and x See the log section at http://msdn2.microsoft.com/en-us/library/aa367988.aspx for more information about additional logging parameters.
   /64BIT	Setup installs a 64-bit version of Toad. This parameter applies only if written right after the path to the executable, e.g.: C:\Users\JDoe\Downloads\ToadDataStudio_pro_1.0.0.exe" /64BIT /S /Lx “C:\temp\installLog.txt” INSTALLDIR=”C:\Program Files\Quest Software\Toad”
   License="full_path"	Specify the full path to a license file, e.g. License="C:\ProgramData\Quest Software\Toad Data Studio". Toad Data Studio to use Toad with the desired license.

   Toad Default Installation Option Overrides

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

   Option	Description
   INSTALLDIR	(Optional) Specify the absolute path for the directory in which you want to install Toad. If you do not include this path, the installation program defaults to: C:\Program Files \Quest Software\Toad Data Studio1.0.
   ALLUSERS	(Optional) Specify one of the following: For a per-machine installation, specify 1. This value allows any user to use the Toad shortcut on the desktop after the installation completes. For a per-user installation, enter the empty string value (“”) This value allows only the user specified for USERNAME (and the user that installed Toad) to see the Toad shortcut on the target desktop. If USERNAME is omitted, only the user that installed Toad sees the shortcut. Note: If you do not specify this property, the installation program defaults to a per-user installation.
   USERNAME	(Optional) Specify the user that intends to use Toad on the target computer. Notes: If ALLUSERS is omitted or defined with the empty string value (""), only the user specified here (and the user that installed Toad) can see the Toad shortcut on the desktop after the installation completes. If ALLUSERS is omitted or defined with the empty string value ("") and you omit the USERNAME option, only the user that installed Toad sees the Toad shortcut on the desktop. If ALLUSERS is 1, the USERNAME value is ignored during installation.
   COMPANYNAME	(Optional) Specify the name of the company that owns this installation.
   ALLOWPASSWORDS=FALSE	(Optional) Set in order to prohibit users from saving their passwords in Toad.
   OPTIONSTEMPLATE	(Optional) Enter a full path to the Options Template that you generated in Tools | Options | General.
   Notes:  All default installation option overrides are case-sensitive. Enclose all values (except for the ALLUSERS value) in double quotations.

Silent Installation Using the Microsoft Installer

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

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

MSI Prerequisites

Visual C++ Redistributable for Visual Studio 2015 is required by Toad, however it is not installed when you use the Microsoft (.msi) installer. Ensure that this software is installed prior to performing an install using the .msi installer. For downloads, see Visual C++ Redistributable for VS 2015. For related information, see KB2999226 - Update for Universal C Runtime in Windows.

Install both vc_redist.x86.exe and vc_redist.x64.exe.

This software is required to enable some features in Toad Data Studio, such as Local Storage. This software is included in installation when using the executable (.exe) installer.

Perform Silent Installation Using MSI

You can deploy the license key, custom settings, and connections files when installing using the .msi installer. See Install Toad Silently for more information.

To perform a silent install using msi

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

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

   msiexec /i “ToadInstaller.msi” /q

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

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

   Command-Line Options

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

   Option	Description
   /i	Run the installation.
   /q	Specify the user interface (UI) that displays during installation. You can append other options, such as n to hide the UI or b to hide the Cancel button during the installation.
   Note: All command-line options are case-insensitive. See http://msdn2.microsoft.com/en-us/library/aa367988.aspx for a complete list of command-line options.

    

   Toad Default Installation Option Overrides

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

   Option	Description
   INSTALLDIR	(Optional) Specify the absolute path for the directory in which you want to install Toad. If you do not include this path, the installation program defaults to: C:\Program Files \Quest Software\Toad Data Studio1.0.
   ALLUSERS	(Optional) Specify one of the following: For a per-machine installation, specify 1. This value allows any user to use the Toad shortcut on the desktop after the installation completes. For a per-user installation, enter the empty string value (“”) This value allows only the user specified for USERNAME (and the user that installed Toad) to see the Toad shortcut on the target desktop. If USERNAME is omitted, only the user that installed Toad sees the shortcut. Note: If you do not specify this property, the installation program defaults to a per-user installation.
   USERNAME	(Optional) Specify the user that intends to use Toad on the target computer. Notes: If ALLUSERS is omitted or defined with the empty string value (""), only the user specified here (and the user that installed Toad) can see the Toad shortcut on the desktop after the installation completes. If ALLUSERS is omitted or defined with the empty string value ("") and you omit the USERNAME option, only the user that installed Toad sees the Toad shortcut on the desktop. If ALLUSERS is 1, the USERNAME value is ignored during installation.
   COMPANYNAME	(Optional) Specify the name of the company that owns this installation.
   ALLOWPASSWORDS=FALSE	(Optional) Set in order to prohibit users from saving their passwords in Toad.
   OPTIONSTEMPLATE	(Optional) Enter a full path to the Options Template that you generated in Tools | Options | General.
   Notes:  All default installation option overrides are case-sensitive. Enclose all values (except for the ALLUSERS value) in double quotations.

Install Toad on Citrix Systems

Toad must be installed on the Citrix server by the Citrix administrator. Users then connect to this instance through their Citrix login.

To install Toad on a Citrix system

1. Connect to the Citrix Environment as an administrator.

2. Copy Toad to the Citrix server, if needed.

3. Start the Toad installation process.

4. During installation, select the Anyone who uses this computer checkbox when prompted.

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

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

6. Review the following considerations regarding licensing:

   • A license supplied by an administrator always overrides a user-supplied license in a Citrix environment.
   • If you need to provide the same Toad functionality to all users, you can enter the default license key for all users.

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 Studio 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 Studio.

To uninstall Toad

1. Run the ToadInstaller.exe.
2. Select Uninstall Toad Data Studio 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 Studio. 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.