Toad for Data Analysts 3.

User Guide
 2012 Quest Software, Inc.

ALL RIGHTS RESERVED.

This guide contains proprietary information protected by copyright. The software described in
this guide is furnished under a software license or nondisclosure agreement. This software
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
or mechanical, including photocopying and recording for any purpose other than the
purchasers personal use without the written permission of Quest Software, Inc.

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 QUEST'S 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.

If you have any questions regarding your potential use of this material, contact:

Quest Software World Headquarters

LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656

www.quest.com
email: [email protected]

Refer to our web site for regional and international office information.

Trademarks

Quest, Quest Software, the Quest Software logo, Benchmark Factory, Toad, T.O.A.D.,
Toad World, and vToad are trademarks and registered trademarks of Quest Software, Inc
in the United States of America and other countries. For a complete list of Quest
Softwares trademarks, please see http://www.quest.com/legal/trademark-information.aspx.
Other trademarks and registered trademarks used in this guide are property of their
respective owners.

Toad for Data Analysts 3.1

User Guide
March 03, 2012
Table of Contents
Introduction 6
Understand Toad's Workflow 6
Connect 7
Create ODBC Connections 7
Understand Toad Connections 8
Share Database Connections 9

Understand 10
Determine the Best Method to Locate Objects 10
Object Explorer 10
Filter Databases and Objects 11
Tutorial:Understand a Table Using the Database Explorer 13
Search for Objects 16
Tutorial:Create a Database Diagram to Use as a Query Template 17
Browse Data in Related Tables 19
Query 21
Tutorial:Visually Build a Query 21
Create Cross-Connection Queries 23
Considerations and Limitations of Cross-Connection Queries 25

Reverse Engineer Queries 26

Considerations and Limitations in the Query Builder 27

Tutorial:Build a Subquery 30
About Editing SQL 33
Configure Editor Options 35

Editor Shortcut Keys 35

View Result Sets 38
Toad for Data Analysts User Guide 4
Table of Contents

Troubleshoot Data 38

Tips for Working with Data 39

Compare Differences in Data 40

Export Data with One Click Export 40
Share Excel Linked Queries 43
Report 45
Tutorial:Create a Toad Data Report 45
Step 1: Run the Toad Data Report Wizard 45

Step 2: Update Fields 46

Step 3: Use Styles to Format the Report Appearance 47

Step 4: Update Bands and Add Controls 49

Manage Reports 51
About Managing Reports 51

DB2 Reports 52

MySQL Reports 56

ODBC Reports 56

Oracle Reports 56

SQL Server Reports 59

Publish and Share Reports 62

Automate 64
Scenario: Automate a Query and Email the Report 64
Automate Tasks 66
Use Database Automation Activities 69
Use File Automation Activities 73
Use System Automation Activities 79
Use Variables in Automation 83
Generate Reports per Product (Use the Loop Dataset Activity) 83
Toad for Data Analysts User Guide 5
Table of Contents

Find Unbatched Transactions (Use the Row Count Field and If..Condition..
Activity) 87

Execute Automation Scripts 90

Appendix: Contact Quest 91
Contact Quest Support 91
Toad Community 91

Contact Quest Software 91

About Quest Software 92
Index 93
 1
Introduction

Understand Toad's Workflow

Most reporting projects have a general flow throughout their lifecycle that requires you to
understand your data sources, create queries, generate reports based on query results, and
automate scripts for repetitive tasks.

l UnderstandSuccessful queries begin with a clear understanding of the data source to

which you connect. If you understand the data and the objects, as well as their
relationships to one another, you can build informed queries that are effective and
more optimized than you could without this understanding.
l QueryQueries are the most important, and often the most time-consuming, aspect of
your project. Once you have a clear understanding of the data source, you can begin
to create your query.
l ReportData retrieved from a query frequently needs to be shared with colleagues or
management in the form of a report, such as a pivot grid or chart.
l AutomateQueries and reports usually need to run on a daily, weekly, or monthly
basis. With Automation, you can create a workflow that includes connecting to data
sources, importing/exporting data, executing scripts, running queries, and building and
distributing reports on a scheduled basis.
 2
Connect

Create ODBC Connections

The purpose of the ODBC provider is to offer basic connection and querying capabilities to
any database that supports an ODBC 3.0 or later driver. For a list of databases tested with the
ODBC provider, see the Release Notes. This form of connectivity allows connections to
databases such as Netezza, IBM iSeries, Ingres, and Vertica. Because this form of connectivity
is generic, it is not full-featured and may not be as robust as the fully exploited providers for
databases that use a native provider.

To create an ODBC connection

1. Click on the toolbar (ALT+F+N+O).

2. Select ODBC from the Group list box.

3. Click in the Data Source Name field.

4. Click Add.

5. Select an ODBC driver from the list, and click Finish.

Note: If creating an Oracle ODBC connection, select the ODBC driver provided by
Oracle. The Microsoft ODBC for Oracle driver has less functionality than the driver
provided by Oracle.

6. Specify the configuration properties required for the database in the windows
configuration dialog.

Notes:

l If you have an Oracle database with Unicode data, make sure to select Force
SQL_WCHAR Support on the Workarounds tab of the windows Oracle ODBC
Configuration dialog. If you do not, you will not be able to see the data.
l If creating a MySQL ODBC connection to use in a cross-connection query,
you must specify a database in the windows MySQL ODBC Configuration
dialog. See Troubleshoot MySQL Issues for more information.

7. Specify the connection properties in the Create New Connection dialog. Review the
following for additional information:

Use data Select to display the Data source names.

source name Deselect to display the driver names.

Data source Select the driver or data source name you added in the previous
Toad for Data Analysts User Guide 8
Connect

name steps.

User Enter the user name to use when connecting.

Password Enter the password to use when connecting.

Tip: After connecting, you can set a master password to further
secure your connection in Tools |Options|Environment |
Security.

Database Specify the location of the database schema. Click to create a

temporary connection and display available schemas in the drop-
down list.

Information

Data Displays the selected driver or data source name.

Source
Name

Driver Displays the ODBC driver associated with the data source.

Category Select or create a category if you want to color code Editor tabs
for a specific connection. This can help differentiate between
development and production databases. You can also set an
option to color code the Object Explorer pane and object editor
windows (Create, Alter, Drop, etc.). Click here to view a
video of this feature.

8. Click Connect to save the connection and immediately connect to the database.

or

Click Save to save the connection without connecting to the database.

Tip:Connections are stored in the connections.xml file and can be found by clicking the
Application Data Directory link in Help |About.

Click here to view a video about creating connections in Toad for Data Analysts

Understand Toad Connections

In Toad, a connection represents one or more actual connections to the database. Toad creates
an initial database connection for general usage. It also creates a separate database connection
for each Editor (the first time you execute a statement) and a separate database connection for
each Data tab in the Database Explorer (the first time you select the tab and data is queried).
The database connection for each Editor and Data tab remain open until you close the
associated window; however, the connections remain in an inactive state if a statement is not
currently executing.
Toad for Data Analysts User Guide 9
Connect

Tips:

l To view the number of actual database connections that exist for a Toad connection
and how many of those database connections are active, place the cursor over the
connection in the Navigation Manager or the Connection toolbar (illustrated in the
following example).

l You can view the progress of statements executing in the background in a progress
bar located on the lower right side of the status bar. To cancel a script's execution,
click the progress bar to display the Background Processes window. It is
recommended to cancel only your own processes, as terminating Toad activities may
lead to unexpected behavior.

Share Database Connections

Editors and Data tabs can share the same database connection when the connection is
inactive if you clear the Use specific connection for each open editor checkbox in Tools
|Options |Editor |General. Any new executions or windows attempt to use this
connection first. For example; if you share a database connection, you can execute a query
in the Editor, execute another query in a new Editor, and then select the Data tab from the
same connection. If the connection is in use and you attempt to execute it, one of the
following occurs:

l (DB2 and Oracle only) If your database supports executing multiple queries
simultaneously on a shared connection, the query is placed in a queue and executes as
soon as the current operation completes.
l If your database does not support executing multiple queries on a shared connection, a
dialog prompts you to either permanently associate the window with a new database
connection, cancel the previous operation, or add the query to a queue until the
current operation completes, and the execute it. If you place multiple queries in the
queue, each one executes in the order that it was added to the queue.

Note: Although you can share a database connection, any commits apply to the selected
window only.
 3
Understand

Determine the Best Method to Locate Objects

Toad offers a number of features to assist you in locating objects. The following table
provides guidelines based on typical use cases:

If you know the.... Use this...

Column name, but do not know the table Use Object Search
name

String of DDL for an object

Dependency for an object Uses and Used By tabs in the Database

Explorer, ,and then drill-down to the
object from there

Criteria for excluding objects Filter feature in the Object Explorer

Object Explorer
You can view database objects for the current connection with the Object Explorer. This
feature is useful for dragging and dropping database objects into an open Editor, Query
Builder, or other document window. Right-click the objects in the Object Explorer to access
additional features such as multiple tasks and actions.

To open the Object Explorer

1. Click on the View toolbar.

2. Review the following for additional information:

Schema (first Select the schema you want to view. You can filter the list of
field) schemas that display. See "Filter Databases and Objects"
(page 11) for more information.

Object Filter You can quickly set a filter in this field. To do so, enter a
(second field) name or partial name of an object and press ENTER. Any
advanced object filters you set display in this field.
You can also perform advanced filtering based on case
sensitivity, statistics, or other options. See "Filter Databases
Toad for Data Analysts User Guide 11
Understand

and Objects" (page 11) for more information.

Tip:You can enable an option to filter using regular
expressions in Tools |Options |Explorer |General.

Note: For tables and views, the columns, data types, and comments display at the
bottom of this window.

Tips:

l To navigate to a previously selected object, click . You can also click to move
to the next selected object.
l To locate objects including procedures, functions, views, variable names and
comments in an object's source code, use Object Search. See "Search for Objects"
(page 16) for more information.
l To use a different method to select objects such as tabs, drop-downs, or a tree
view, click .
l To generate reports, export data, create SQL statements, version control objects, or
send objects to the Project Manager, SQL Modeler, or Master Detail windows, right-
click the objects and select an option.
l To open the Background Processes window and cancel a query, click the progress bar
at the bottom of the window.

Filter Databases and Objects

Filters can reduce the number of database and/or objects you have to work with and
reduce the amount of time required to query large databases. You can set the following
types of filters:

l Quick filterApplies to the current schema, or objects in the current schema only.
Any unnamed filter you set is in effect the next time you open Toad
l Unnamed filterApplies to the current schema, or objects in the current schema only.
Any unnamed filter you set is in effect the next time you open Toad.

l Named filterApplies to any database connection for the current database provider.
Any named filter you set is in effect the next time you open Toad.

Note: If you rename a table that has a filter defined, it results in an orphaned filter.
Orphaned filters are automatically removed unless you used a tool other than Toad to
remove them.

A filter is associated with a specific list of objects from a specific database. Consider the
following guidelines when setting filters:
Toad for Data Analysts User Guide 12
Understand

l A filter defined for a set of objects such as tables on one specific database connection
does not apply to a list of objects for another database connection.

l A filter defined for a list of tables on one schema in the database does not apply to
the list of tables for a different schema on the same database.

l A filter set for a specific schema or object is applied when altering objects, using the
SQL Editor, Master Detail Browser, etc., for that schema or object.

Tip: To apply any filters you set to the code completion list in the editor, select the
Apply explorer filters checkbox in Tools |Options | Editor |Code Completion.

To set a quick filter

Enter text to use for filtering in the field below the database/schema name in the
Object Explorer:

To set a named filter

1. Click beside the database or object field in the Object Explorer.

2. Define criteria for the filter in the Properties tab.
3. Select the SQL tab and select the Enable custom SQL checkbox to create a custom
filter based on criteria you specify.
4. Select the Preview tab to view a list of databases or objects that meet your filter
criteria before applying the actual filter.

5. Enter a name for the filter if you want to use the filter for other database connections
and click .

Icon Description

A filter has not been set so all databases/objects display.

A filter has been set.

Toad for Data Analysts User Guide 13
Understand

6. If you set a named filter, you can click the arrow beside the icon to apply or
remove the filter:

Tips:

l To export a named filter or any filters associated with the current connection, click the
arrow beside the icon and select Export Filters.

To import the filters, select File |Open from the menu.

l Click in the Explorer toolbar to clear all database, object, and data filters.

Tutorial:Understand a Table Using the

Database Explorer
Click here to view a video of this feature.

Scenario
You need to build a query listing customers and want to know more
about the table before writing the query.
Note: This exercise uses the Toad Sample Database. This connection
does not have the relationship and script tabs. The tabs available can
differ depending on the type of connection.

Note: This topic focuses on information that may be unfamiliar to you. It does not include all
step and field descriptions.

To understand a table using the Database Explorer

1. Connect to the Toad Sample (Access) database in the Navigation Manager.

2. Right-click the CONTACTtable and select View Details.

Toad for Data Analysts User Guide 14
Understand

3. View information for the following:

a. Click the Indexes tab and view the index information.
b. Click the Primary Keys and Foreign Keys tabs to view relationships.
4. Click the Data tab.

5. Place the cursor over the LAST_NAME column, click , and select Acton.

The only row that now displays is the one with Acton as the last name.

6. Click to the right of the LAST_NAME column again and select All to
clear the filter.
7. Click the CONTACT_ID column to sort the rows in ascending or descending order.

8. Click in the top left of the Data tab.

9. Create the following filter in the Where Clause tab:

CONTACT_ID > 2000

The filter string displays at the bottom on the grid. Click to remove the filter.
Toad for Data Analysts User Guide 15
Understand

10. Select a row of data in the grid. Notice that the row number changes in the bottom
right of the status bar:

11. Under the SEX column, right-click the area below the last row in the grid that says
"Right-click to add column totals" and select Count. The total number of rows that
have either a M or F value display.

12. Click to the right of the SEX column and select F. The count value updates based
on the new filter.

13. Click to the right of the SEX column again and select All to clear the filter.

14. Select the SEX column header and drag it the area above the columns that says "Drag
a column header here to group by that column":

You can expand each group to view the row data.

15. Switch the default view:

a. Right-click within a group or row on the grid and select Show |Card View.
b. Scroll through some records.
c. Click Customize in the Card View window.
d. Click Filter beside the ADDRESS_IDcolumn and select 100. Notice how the
card view is filtered, but not the grid view.
e. Close the Card View window.
16. Edit a row:
a. Select a row in the FIRST_NAME column and edit the value.
b. Press ENTER to update the row.
Toad for Data Analysts User Guide 16
Understand

c. Go to the BIRTH_DATE column and use the date picker to change the date.

Each data type have an appropriate editor.

Note: If you are using Oracle or a database that does not have auto commit on,
you will need to press Commit at the left hand bottom of the window.

17. Update the number of rows in in the data:

a. Select Tools | Options | Database | General from the menu.
b. Enter 50 in the Number of rows to initially fetch in data tab.
c. Click OK.

d. Press F5 in the data grid. Notice the bottom right status bar now says "1 of 50
(scroll for more)".

The option you set controls the number of rows fetched in the Data tab.

e. Click the scrollbar and hold down to retrieve more.

f. Right-click the grid and select Read All Rows.

Search for Objects

You can quickly locate an object rather than browsing through a list of objects in the
Database Explorer orObject Explorer. Object Search locates the following:

l Names of objects for a string.

l Text in objects that include source code, which typically includes procedures,
functions, triggers, data types, and views. However, the database provider determines
which objects include source code.

l Variable names and comments in the object's source code.

l Column names for tables and views.

To search for objects

1. Click on the toolbar (F4).

2. Specify search criteria and click Search.

Note:To append additional search results to the current search, click Append instead.
If you click Search, new results replace the previous search results in the data grid.
Toad for Data Analysts User Guide 17
Understand

Tips:

l To remove objects from the search results, right-click the objects in the data grid and
select Remove Items. This is useful if you want to narrow the list of results to
relevant objects.This does not remove the objects from your database.

l To create a DDL script from the search results, right-click the data grid and select
Create DDL Script. You can then paste the results into the Editor.

l To perform any actions available for the object, such as creating, altering, dropping,
exporting, and generating reports or SQL, right-click the results in the data grid and
select an option.

Tutorial:Create a Database Diagram to Use as a

Query Template
Click here to view a video of this feature.

Scenario
Your company creates several daily and weekly reports regarding
customer sales. You need to create a Database Diagram that can be
used as a template for these queries.

To create a Database Diagram to use as a query template

1. Connect to the Toad Sample (Access) database in the Navigation Manager.

2. Click .

3. Drag the CONTACTtable in the Object Explorer to the Diagram pane.

Toad for Data Analysts User Guide 18
Understand

4. Right click the Diagram pane and clear Show Dependencies to hide the Referenced
Objects at the bottom of each table/view, as illustrated in the following:

5. Right-click the ORDERS table and select Notes.

6. Enter the following note in the window for other users:

The shipping and billing ADDRESS_ID foreign key relations are not needed in most
queries and should be hidden when building a query.
Toad for Data Analysts User Guide 19
Understand

7. Because it is against company policy to display sex and a home phone number in
reports, right click on each of these columns in the CONTACT table and select
Hide Column.

Tip:If you have a large number of columns you need to hide, you can right-click a
table and select Manage Hidden Columns to quickly select them from a list.

8. Click Add to Project from the wizard bar at the bottom of thewindow and enter
DBDiagram_Test asthe name for the file. This adds the file to the current project in
the Project Manager under a Diagrams folder.
9. Close the Database Diagram window and open the Project Manager window.
10. Expand the Diagrams folder and double-click DBDiagram_Test to reload the file in a
new Database Diagram window.
11. To share your project, hidden columns, and notes with colleagues, complete
the following:
a. Select Tools | Options | Environment |Network Share, and navigate to a
shared drive where you want to store the Project Manager file.
b. Select Database |Cache from the open Options window and set the
following options:

Object An Description
notation Cache

Share object Select this checkbox and enter a shared drive

annotations location where users can access this file.

Share hidden Select this checkbox.

column settings

c. Provide the location of the Network Share and Object Annotation Cache
settings to colleagues who need to use this diagram.

Browse Data in Related Tables

Use the Master Detail Browser to browse data in parent tables and drill-down to data in
related child tables. This is useful when you need to analyze or edit data. For example,
suppose you need to view a list of all Nick's Flix stores and the inventory of comedy movies
at each store. Using the Master Detail Browser, you specify the table that contains the list of
stores as the parent table and specify the table that contains comedy movies as the child table
to quickly locate comedies and analyze the inventory.

To browse tables using the Master Detail Browser

1. Select Tools | Master Detail Browser (ALT+T+A).

2. Drag one or more tables from the Object Explorer, Object Search, or Project Manager
Toad for Data Analysts User Guide 20
Understand

window to the Diagram pane at the top of the Master Detail Browser. Press
CTRL+click to select multiple tables at once.

Notes:

l A line between tables indicates any existing relationships between the

selected tables.

l At least one parent table (table without any join arrows pointing to it) must be
added to the window or an error message displays when returning results.

3. Join Columns.

4. Select the checkbox beside each column you want to include.

Note: Any columns included in a join are automatically included in the results.

5. Click (F9) to retrieve data for the parent table initially. To view data in a child
table, click + to the left of each row.

or

Click to retrieve data in the parent and child tables. If there is more than one child
table, a tab displays for each child table.

6. From the data grid, you can:

l Edit the data and commit your changes to the database.

l Right-click the data grid and select Send To | option to add the data to a
report, chart, or pivot grid.

Tips:

l Click to align tables and snap them to the grid.

l Select the parent table from the drop-down list in the toolbar to view data for a parent
table if there are multiple parent tables.

l Click X on the table you want to remove in the Diagram pane to remove a table and
any conditions (e.g., join, where clause) associated with the table.
 4
Query

Tutorial:Visually Build a Query

The Query Builder enables you to create a query without writing or editing SQLstatements.
Even if you are familiar with SQL, the graphical interface makes it easier to create
relationships and visualize the query.

Note: This procedure does not cover all of the possible steps of visually building a query. It
only covers the steps required to build a query for the scenario.

Scenario
Your company wants to improve its global sales, starting with
countries where it has a customer base but generally low sales. You
need to create a query that identifies countries with less than
$500,000 in sales for each of the last four fiscal years.
Note: This scenario uses the SH (Sales History) sample schema that
comes with Oracle 10g so you can follow the procedure.

To visually build a query based on this scenario

1. Connect to the database and click Query Builder.

2. Select the SH schema in the Object Explorer.

3. Drag the following tables from the Object Explorer to the Diagram pane: TIMES,
SALES, CUSTOMERS, and COUNTRIES.

Tips:

l Select Query Builder |Arrange Tables (ALT+Q+A) to have Toad arrange the
tables in the Diagram pane.
l You can press CTRL and select a table, and then drag the table into the Editor
pane. Click the list to create statements.
l You can also press CTRL and select all of the tables in the Object
Explorer, and then drag them into the Diagram pane. Toad automatically
arranges the tables.
4. Add the following columns to the query by clicking each column:

Table Column

COUNTRIES COUNTRY_NAME
Toad for Data Analysts User Guide 22
Query

Table Column

TIMES FISCAL_YEAR

SALES AMOUNT_SOLD

Tips:

l To view details for a table in the Diagram, click (F4). If a table is not
selected, details for the last selected table display.

l To remove a column from the query, click or drag column off grid.
5. Complete the following steps to group the data and sum the sales:
a. Select the Group By field in the COUNTRY_NAME column, and then
click +. The Group By field is in the Criteria pane, which is below the
Diagram pane.
b. Select the Group By field in the FISCAL_YEAR column, and then click +.

c. Select the Aggregate Function field in the AMOUNT_SOLD column and

select Sum. This sums all of the sales per fiscal year per country.

Note: If you select a group by clause or aggregate function for a column, the
rest of the columns in the query must also have a group by clause or
aggregate function.

6. Complete the following steps to select the fiscal year range:

a. Select the Where Condition field in the FISCAL_YEAR column and click .
The Where Condition window displays.
b. On the Form tab, select BETWEEN in the Operators field.
c. Select 1998 in the first Constant field.

d. Select 2001 in the second Constant field and click OK.

Note: The SH schema does not have current data. The 1998-2001 years
provide the best data for the purposes of this scenario.

7. Complete the following steps to select countries with less than $500,000 in sales:
a. Select the Having Condition field in the AMOUNT_SOLD column and click
. The Having Condition window displays.
b. On the Form tab, select < in the Operators field.
c. Select Sum in the Aggregate field.
d. Enter 500000 in the Constant field and click OK.
8. Select Ascending in the Sort field of the COUNTRY_NAME and FISCAL_
YEAR columns.
Toad for Data Analysts User Guide 23
Query

9. Click .

The query results display in the Results tab. See "View Result Sets" (page 38) for
more information.

10. To save the query, right-click the Query Builder tab and select Save File.

You can save a query and any results sets in a Toad editor file (.tef). This file format is
useful for building scripts that have large result sets that you do not want to continue
executing or for saving results when you have not finished building a script.

Create Cross-Connection Queries

Use the Cross-Connection Query Builder or the Cross-Connection Editor to create a query
that combines data from multiple, dissimilar databases. For example, you can create a query
that joins managers from a SQL Server database to their employees in an Oracle database.
(This is also often called a heterogeneous or cross-database query.) Toad uses an enhanced
query engine to implement advanced execution processes that are specially designed to
improve the performance of cross-connection queries.

Before creating a cross-connection query using an Oracle, Teradata or MySQL ODBC

connection, or if using the Base edition, please see the special considerations listed at the end
of this topic.

Notes:The enhanced and fully-optimized version of cross-connection query is available only

in the Professional and Premium editions of Toad for Data Analysts.
Toad for Data Analysts User Guide 24
Query

To build a cross-connection query visually

1. Select Build Query | Cross-Connection Query Builder.

Note: A blue banner along the right side of the Diagram pane indicates that you are
in Cross-Connection Query mode.

2. Drag tables and views from the Object Explorer to the Diagram pane.
3. Complete the query in the same manner as you would a non-cross-connection query,
but note the following exceptions.

Object Explorer Feature In Cross-Connection Query Mode...

Options Connection Treelist is the only view option available.

In this option, connections, databases, tables, and views
are displayed in a treelist in the Object Explorer
window.

Filters Filters are especially useful in cross-connection queries

to reduce the number of objects displayed in the treelist
in the Object Explorer window.

Note: Review the "Considerations and Limitations of Cross-Connection Queries"

section below.

To compose a cross-connection query in the editor

1. Select Editor | Cross-Connection SQL Editor.

Note: A blue banner along the right side of the Editor pane indicates that you are in
Cross-Connection Query mode.

2. Compose the SQL statement in the same manner as you would a non-cross-connection
query, but note the following exceptions.

SQL Editor Task In Cross-Connection Query Mode...

Naming tables and views To reference a table or view, you must use a cross-
connection fully-qualified name. The format for a cross-
connection fully-qualified name depends on the
database. The following is an example using the SQL
Server format:
<database connection
string>.<database>.<schema>.<table>
'sqlserverconn'.database.dbo.table
Note: For the database connection string, use the
connection string displayed in the Navigation Manager
window for each connection (or in the Name field in
Connection Properties).
Toad for Data Analysts User Guide 25
Query

SQL Editor Task In Cross-Connection Query Mode...

Tip: Copy and paste a SQL statement from a single

connection editor to a cross-connection editor and Toad
automatically changes the syntax of the statement to
include the cross-connection fully-qualified names.

Using alias names You must use alias names for tables and columns in a
cross-connection query.

Using code completion In Cross-Connection Query mode, the scope of available

options in code completion expands to include the
databases, tables, and views for all the open database
connections.
Tip: To expand/collapse a database node in the code
completion list, use CTRL+left arrow and CTRL+right
arrow.

Tips:

l In a cross-connection code completion list, the selected database displays a descriptive

tooltip containing database and connection information.
l To learn how to optimize cross-connection queries, see Optimize Cross-
Connection Queries.

Considerations and Limitations of Cross-Connection

Queries
Review the following considerations and limitations before creating a cross-connection
query.

Consideration/Limitation Description

Toad Access database In the Base edition of Toad for Data Analysts, the
Query Builder uses the Access database installed with
Toad as a staging area for the query. Do not uninstall
this database if you need to create cross-connection
queries.

Performance concerns A cross-connection query may take longer to execute

than a query against a single database because result
sets from each database are retrieved and combined to
generate a single result set.
In the Professional edition of Toad for Data Analysts,
the enhanced execution engine utilizes several
optimizing techniques to improve the performance of
cross-connection queries.
Toad for Data Analysts User Guide 26
Query

Consideration/Limitation Description

ODBC driver support An ODBC driver can be selected for a single connection
through each connection's Properties dialog or globally
through Tools | Options | Database.

Using an Oracle connection To use an Oracle connection in a cross-connection

in a cross-connection query query, you must install an Oracle ODBC driver.
Note: The Oracle Full Install client includes an ODBC
driver. However, if you are using the Oracle Instant
client (which may not include an ODBC driver), you
may need to install an Oracle ODBC driver.

Oracle Direct Connection You cannot use an Oracle Direct Connection in a cross-
connection query.

Using a Teradata connection To use a Teradata connection in a cross-connection

in a cross-connection query query, you must install a Teradata ODBC driver.

Using a Teradata connection In the Base edition of Toad, to use a Teradata

in a cross-connection query connection in a cross-connection query, you must create
in the Base edition of Toad and use a Teradata ODBC connection (instead of the
native connection).

Using a MySQL ODBC To use a MySQL ODBC connection in a cross-

connection in a cross- connection query, you must specify a database for the
connection query connection.

Result sets You cannot edit result sets.

Oracle Long Data Type Cross-connection query does not support Oracle long
data types or Oracle LOBs.

Reverse Engineer Queries

One way to build a query is to begin adding columns and creating joins in the Query
Builder, and then send the query to the editor to add more complex functionality, such as a
UNION join. You can also send a query from the editor to the Query Builder. For example,
you inherited a large query when an employee left and you need to edit it to resolve an issue.
After looking at the query in the editor for some time, you still cannot decipher it. So, you
right-click the statement and select Send to Query Builder. Now that you can visually see
how the tables are referenced, you can identify and resolve the issue.
Toad for Data Analysts User Guide 27
Query

Considerations and Limitations in the Query Builder

Consider the following when reverse engineering a query using the Query Builder:

General Description

Single statement The Query Builder only supports one statement at a time. If
support you add multiple statements to the Query tab, only the first
statement is used. If you make any changes to the statement
on the Diagram tab, the other statements are lost.

Quote identifiers If you selected the Quote Identifiers checkbox in Tools |

Options |Database |General and generate a query from the
Query Builder in SQL Server, the query cannot be reverse
engineered.

ODBC support You must use ANSI SQL for the query.

Excel support Copying a generated query and attempting to reverse

engineer that query results in an error. This issue occurs
because the parser defaults to Oracle syntax, which does not
understand quotation marks for fully qualified object names.
To avoid this issue, clear the Use fully qualified object
names and Use fully qualified column names checkboxes in
Tools |Options |Database |Query Builder or manually edit
the query.

Non-ANSI joins When sending a query from the Editor to the Query Builder,
(Oracle only) Toad automatically uses ANSI joins. If you use Where clause
joins, click to disable ANSI joins. This converts the
statement to the correct join.

Where Condition Description

Where condition If you send a query that contains a Where condition from the
does not display in editor to the Query Builder, it displays in a Global Where
the Criteria grid after clause bubble on the Diagram pane instead of in the Where
sending it to the Condition field in the Criteria grid.
Query Builder from You can double-click the Global Where Clause bubble in
the Editor
the Diagram pane or can click to edit it.
You can also use the Where condition fields in the Criteria
grid to add new Where conditions. Although they display in
the grid, they are added to the Global Where clause in the
Query tab.

Where condition If you define a Where condition in the Criteria grid and edit
created in the any part of the query in the Query tab, the Where condition
Criteria grid of the is removed from the Criteria grid and placed in a Global
Diagram tab Where Clause bubble.
Toad for Data Analysts User Guide 28
Query

disappears You can double-click the Global Where Clause bubble in

the Diagram pane or can click to edit it.

Having Condition Description

Having condition If you send a query that contains a Having condition from
does not display in the editor to the Query Builder, it displays in a Global
the Criteria grid after Having clause bubble on the Diagram pane instead of in the
sending it to the Having Condition field in the Criteria grid.
Query Builder from You can double-click the Global Having Clause bubble in
the Editor
the Diagram pane or can click to edit it.
You can also use the Having condition fields in the Criteria
grid to add new Having conditions. Although they display
in the grid, they are added to the Global Where clause in the
Query tab.

Having condition If you define a Having condition in the Criteria grid and edit
created in the any part of the query in the Query tab, the Having condition
Criteria grid of the is removed from the Criteria grid and placed in a Global
Diagram tab Having Clause bubble.
disappears You can double-click the Global Having Clause bubble in
the Diagram pane or can click to edit it.

Query Builder Description

Diagram Tab

Comments and code When reverse engineering a statement from the editor or the
regions removed after Query tab and switching to the Diagram tab, if the statement
making changes in contains a block comment or code region and you make a
the Diagram tab change in the Diagram tab, the comment or code region is
removed from the statement.

Same column cannot You cannot use the same column more than once in the
be used in the criteria grid. Even if you create a separate alias for the second
criteria grid use of the column, that column is created as a calculated
field

Execute with If the query in the Diagram tab is different than the query in
different query in the the Query tab, executing the query executes the SQL in the
Diagram and Query Query tab instead of the Diagram.
tabs

Save with different The Query Builder saves both the statement and diagram in
query in the Diagram the same file. The contents of the statement and diagram can
and Query tabs be different without losing changes.
Toad for Data Analysts User Guide 29
Query

To reverse engineer a query

1. Right-click a statement in the Editor, and select Send to Query Builder.See "About
Editing SQL" (page 33) for more information.

or

Click in the Query Builder to send a statement to the Editor. Skip the remaining
steps and continue to edit the query. See "About Editing SQL" (page 33) for more
information.

Troubleshooting:If the query cannot be modeled in the Diagram tab, a message

displays and the statement opens in the Query tab. This usually occurs because the
graphical diagram cannot support some functionality in the statement. You can view
an explanation for this in the Output window or by hovering over the syntax with a
red underline ( ) in the Query tab. To continue, correct the error and click to
apply the change and open the Diagram tab.

2. Continue to build your query visually using the diagram.

3. Select the Query tab and make any additional edits. Indicators for an edited statement
are as follows:

Inserted lines
Modified or removed lines
Modified characters

Use the toolbar in the lower-right corner of the Query tab to modify
the color used for each indicator.

Caution: If you manually enter or update the statement in the Query tab, you
must click to model the query in the Diagram tab. If you do not do this and
make additional changes in the Diagram tab, any changes you made in the Query
tab are lost.

4. Click to execute the query.

Tip: If you have multiple statements in the Editor and you want to send only one to the
Query Builder, highlight the statement, then right-click it and select Send to Query Builder.

Create Cross-Connection Queries (page 23)

Toad for Data Analysts User Guide 30
Query

Tutorial:Build a Subquery

Scenario
Your database of customer information includes detailed information
for each contact you have within a customer. You need a report that
lists all of your customers that have a contact that resides in (or
covers) a specific region.

To build a subquery

1. Connect to the Toad Sample (Access) database in the Navigation Manager.

2. Click .
3. Drag the CUSTOMER table to the Diagram pane.

4. Click these column names in the CUSTOMER table to add the columns to the query:

l CUSTOMER_ID
l CUSTOMER_NAME
5. To add a subquery:

a. Select the Where field in the CUSTOMER_ID column and click . The
Where Condition editor displays.

b. Select the INoperator from the list and click Subquery. A child Query Builder
Toad for Data Analysts User Guide 31
Query

window displays for you to use to build the subquery.

l The child (subquery) Query Builder window includes a Diagram pane,

a Criteria pane, and a Queries pane for navigating back and forth
between subqueries and the main query.

c. Drag the following tables to the Diagram pane and select the
following columns:

Select this table... Select this column...

ADDRESS REGION_ID

CONTACT CUSTOMER_ID

d. Select the Where field in the REGION_ID column and click . In the Where
Condition editor, select the equal to (=) comparison operator, select Constant,
and select a value of 1.

e. Deselect the checkbox in the Visible field in the REGION_ID column. This
will remove the REGION_ID column from the result set.

Your subquery window should look something like this:

Toad for Data Analysts User Guide 32
Query

f. Click to execute the subquery. Select the Results tab to

review the result set for the subquery.
6. Click the Query node in the Queries pane to return to the main query window. A
callout in the main query Diagram pane indicates that the statement contains a
subquery and also shows the type of subquery and which column it is on.

7. Click to execute the main query.

To use the Lookup Table

Use the lookup table to add a description to ID values to aid in selecting from ID columns
when building a query or subquery.

1. Click the subquery node in the Queries pane to return to the subquery.
2. In the ADDRESS table, right-click REGION_ID and select Find Lookup Table.
3. Follow the instructions in the Lookup Table dialog to specify the ID Column and the
Description Column.
Toad for Data Analysts User Guide 33
Query

4. After completing and closing the Lookup Table dialog, again select the Where field
in the REGION_ID column and click . Open the drop-down list to the right of
Constant. Notice that a description for each region now displays.

About Editing SQL

The editor combines a powerful SQL and procedure editor into a single interface.

Notes:

l See "Editor Shortcut Keys" (page 35) for more information about keyboard shortcuts
used in the Editor.
l Toad has implemented a large script mode to improve performance when opening files
larger than 2 MB. By default, when you open a large file, some features such as word
wrap, syntax highlighting, and the Code Navigator are disabled in the Editor. When a
large script loads, a message indicates that you are in large script mode in the right
margin of the Editor. You can cancel large script mode by clearing the option in
Tools | Options |Editor |General.

To edit SQL

1. Click on the toolbar (ALT+T+E).

Note: You can query the worksheet from the Editor by entering a dollar sign ($)
followed by a cell range to limit the results similar to the following statement:
Select * from (MyWorksheet$A1:C10)

You can also query the entire worksheet by entering a dollar sign ($) after the
worksheet name; however, this returns empty rows and columns in the worksheet.

2. Review the following to help enter SQL:

l Code completion
l Navigate code
Toad for Data Analysts User Guide 34
Query

l Code regions
l Code snippets
l SQL recall
l Add/remove application code
l Object lookup (Describe)
l Macros to record keystrokes

3. Click to format the code. See Format SQL for more information.

4. Select the block of code in the Editor, and click to validate the syntax.

Note:Toad undoes any changes to the object and data in the database after executing
the script (notice that the Result Sets tab is empty). To modify the object and data,
you need to execute the script.

5. Click to execute SQL on the current server or multiple servers at one time.

6. Select the block of code in the Editor and click to create a stored procedure.
Stored Procedure creation dialog automatically recognizes procedure body and
declared parameters.

Tips:

l Toad automatically saves a backup copy of any modified editor file in the
Application Data Directory to avoid losing your work. When you restart Toad after an
unexpected close, Toad checks the timestamp on the backup file against the original
file, and opens the file that has the latest timestamp. The document recovery option is
in Tools | Options | Environment | General. See General Environment Options for
more information.

l You can save the current connection, SQL script, executed results, filters, and group
execute connections/results (if enabled) in a Toad editor file (.tef). This file format is
useful for building scripts that have large result sets that you do not want to continue
executing or for saving results when you have not finished building a script.

l In the Editor toolbar, the execute SQL buttons are grouped under . The button
will retain the function of the last execute action for the active Editor window. If you
switch to another Editor window, the button will change to reflect the last action for
that window.
l If you copy and paste a SQL statement from one editor window to another, Toad
automatically rewrites the statement to match the syntax of the connection for the
second editor window.
Toad for Data Analysts User Guide 35
Query

Configure Editor Options

To... Use this Option Page...

Set options to display line numbers, line modifications, and Editor | General
general text formatting

Specify options to automatically replace typed text with the Editor | Auto-replace
correct substitution text

Customize code formatting options including headers and Editor | Formatter

layout characteristics

Click here to view a video of this feature.

Editor Shortcut Keys

You can assign individual shortcut keys in Keyboard options. See Keyboard Options for
more information. You can also customize Toad to use the shortcut keys of existing
applications such as Toad for Oracle, SQL Navigator, or Query Analyzer in the Configuration
Wizard (Tools | Configuration Wizard).

Caution! If you have some global access keys assigned, make sure that Toad shortcut
keys do not coincide with them. When using such duplicating shortcut keys in Toad, the
third party application commands, assigned globally, will be performed instead of ones
assigned by Toad.

The following table describes the default shortcut keys in Toad.

Frequently Used Functions Description

CTRL+PERIOD Displays the code completion list

F9 Execute all statements as a batch

F5 Execute all statements, in order, one at a time

CTRL+MINUS Comments the selected line

CTRL+SHIFT+MINUS Uncomments the selected line

CTRL+J Collapses all code regions

CTRL+M Expands all code regions

ALT+PAUSE Stops script execution

Toad for Data Analysts User Guide 36
Query

Bookmark Description

CTRL+SHIFT+0-9 Sets a numbered bookmark at the selected line

CTRL+0-9 Goes to the numbered bookmark

Case Description

CTRL+L Converts the selected text to lowercase

CTRL+U Converts the selected text to uppercase

Clipboard Description

CTRL+C Copies the selected text to the clipboard

CTRL+X Cuts the selected text for pasting in the clipboard

CTRL+V Pastes text from the clipboard

Code Completion Description

CTRL+PERIOD Displays code completion list

ENTER Selects an item and close the code completion list

CTRL+SPACE Selects an item without closing the code completion

list

CTRL+<right arrow> Expands a node in the code completion list

CTRL+<left arrow> Collapses a node in the code completion list

Comment Description

CTRL+MINUS Comments the selected line

CTRL+SHIFT+MINUS Uncomments the selected line

Cursor Description

HOME Moves the cursor to the beginning of the line

CTRL+HOME Moves the cursor to the beginning of the file

END Moves the cursor to the end of the line

CTRL+END Moves the cursor to the end of the file

Debugger Description
Toad for Data Analysts User Guide 37
Query

SHIFT+F12 Step from cursor

F7 Step into

SHIFT+F7 Step out

F8 Step over

F11 Run to breakpoint

F12 Run to cursor

CTRL+B Set breakpoint

CTRL+W Add watch at cursor

Delete Description

BACKSPACE Deletes the selected text (if text is selected); otherwise,

deletes the previous character

CTRL+BACKSPACE Deletes text to the beginning of the previous word

CTRL+SHIFT+DELETE Deletes the entire script

Find and Replace Description

CTRL+F Finds text

F3 Finds the next occurrence of text

SHIFT+F3 Finds the previous occurrence of text

CTRL+G Goes to line number

CTRL+I Performs an incremental search

CTRL+SHIFT+I Performs a reverse incremental search

Indent Description

TAB Indents the selected line

SHIFT+TAB Outdents the selected line

Macros Description

CTRL+SHIFT+R Starts/Stops recording a macro

CTRL+SHIFT+P Plays the recorded macro

Toad for Data Analysts User Guide 38
Query

Miscellaneous Description

F4 Invokes objects search

F4+SHIFT Describes the object next to the cursor

F6 Toggles between the Editor and Data Grid

CTRL+D Sends SQL to Query Builder

SHIFT+F8 Recalls the previous SQL statement

CTRL+ Scrolls up the window.

CTRL+ Scrolls down the window

<auto-replace Automatically replaces a misspelled word, inserts

token>+SPACE symbols, and expands text.
Note: You can set autoreplace in Tools | Options |
Editor | Autoreplace.

CTRL+SPACE Displays the Code Snippets folder browser

<code snippet shortcut Inserts the code snippet template

name>+CTRL+SPACE

CTRL+DELETE Sets the column value for the current cell to Null in
the data grid

Insert Code Snippets

View Result Sets

The Result Sets tab displays a data grid for executed SQL statements and scripts that
return data.

Troubleshoot Data
l If you cannot edit data, click the red icon in the lower left corner of the grid,
and then click OK on the window that displays. You do not need to edit fields in
this window.

l By default, auto commit is enabled and any row changes you make are automatically
submitted to the database. You can disable this option in Tools |Options
|Environment | Grid.
Toad for Data Analysts User Guide 39
Query

Tips for Working with Data

To... Do this...

Pin a result set so it is not overwritten Click the push pin beside the result set:
by a subsequent query in the Editor or
Query Builder.

Set the value of a cell to null. Press CTRL+DELETE.

Toggle between the Editor and Data Press F6.

Grid.

Add column or group summary values Right-click the data and select Show
|Summary Footer Panel. Then, right-click
the Summary Footer Panel below the column
you want to add a summary total to and
select an option.
If you have grouped columns using the
Grouping panel (Show |Grouping Panel),
you can also add a summary total to grouped
records.

Show or hide columns of data. Right-click a column heading in the data

grid and select Chooser.

Display data in a report, pivot grid, or Right-click the data and select Send To
chart. |<option>.

Compare differences between two data Right-click the data and select Send To |
sets. Data Diff Viewer.

Display the data in a grid or card view; Right-click a record and select Show | Grid
grid view is useful for viewing View or Card View.
summary information at a glance; card
view is useful for viewing information
in greater detail.

Apply a summary function to the data Right-click below the column you want to
(Sum, Min, Max, Count, Avg). apply the summary function (but above the
Navigation toolbar) and select an option.

View a list of all existing values in a Right-click the column and select Show |
column, including the number of times Existing Values.
a value is used.
Toad for Data Analysts User Guide 40
Query

Compare Differences in Data

You can compare result sets from the current editor or a different editor in the Database
Explorer's Data tab or the editor's Result Sets without having to save one of the sets to a file.

Notes:

l If you want to synchronize data, use Data Compare instead of the Data Diff Viewer.
l You cannot modify files in the Diff Viewer at this time.

To compare differences

1. Right-click data in the Editor's result set or Database Explorer's Data tab and select
Compare To | Set_number.

You can also save a result set and later use it as a historical comparison.

2. Use the Diff Viewer toolbar to view any differences.

Tips:

l To switch the contents of the left pane to the right pane, and the contents of
the right pane to the left, click .
l You can also open files to compare by clicking beside the drop-down list
at the top of each pane.

Export Data with One Click Export

Use One Click Export to quickly export data to an Excel report. You can also export data
and include a linked query in the file. A linked query lets you create a "live" Excel report
that can be refreshed dynamically. Because a linked query contains the underlying SQL for a
report, each time you refresh the report the query executes and retrieves the latest data. The
dynamic nature of linked query reports makes them ideal for distribution to users who need
to see changes to data on demand without waiting for new static reports to be distributed.

Click here to view a video of this feature.

Notes:

l Before you can export to Excel, the Primary Interop Assemblies (PIAs) for your
version of Excel must be installed.

l Use the Export wizard if you need to specify column delimiters and advanced field
options when exporting data.
Toad for Data Analysts User Guide 41
Query

To export data in one click

1. Select the range of data to export or click any row in a data grid to export all data.

2. Right-click the selected range or data grid and select Quick Export.

3. Select an export option. Review the following for additional information:

Icon Option Description

Excel File Export data to an Excel file. The file is automatically

saved under a default name in the default export folder.

CSV File Export data to a CSV file (comma separated value file).
The file is automatically saved under a default name in
the default export folder.

HTML File Export data to an HTML file. The file is automatically

saved under a default name in the default export folder.

Excel Export data to an Excel instance. Data is copied to a

Instance clipboard, Excel is launched, and a worksheet is
populated with data. You can save the worksheet under
a name and folder you specify or in the default export
folder.

Excel Export data to an active cell in Excel. First open Excel

Instance at and select a cell. Then select the Excel Instance at
active cell active cell option.

Excel Pivot Export data to an Excel pivot grid report. See the Excel
Table documentation for information on creating a Pivot
Table report with external data.

Excel Pivot Export data to an active cell for an Excel Pivot Table
Table at report. First open Excel and select a cell. Then select
active cell the Excel Pivot Table at active cell option.
Toad for Data Analysts User Guide 42
Query

Icon Option Description

Excel Export the underlying query for data to Excel.

Linked
Query

Excel Export the underlying query for data to an active cell in

Linked Excel. First open Excel and select a cell. Then select the
Query at Excel Linked Query at active cell option.
active cell

Excel Export the underlying query for data to an Excel Pivot

Linked Table report. See the Excel documentation for
Query with information on creating a pivot grid report with external
pivot table data.

Excel Export the underlying query for data to an active cell

Linked for an Excel Pivot Table report. First open Excel and
Query at select a cell. Then select the Excel Linked Query at
active cell active cell with pivot table option.
with pivot
table

Excel Export data to an Excel chart instance. Data is copied

Column to the clipboard, Excel is launched, and a chart is
Chart created with the data. You can then modify the chart's
design and save the Excel file.

Tip: To refresh data in a linked query report, click in Excel's External Data
toolbar. This executes the underlying query for the report. See "Share Excel
Linked Queries" (page 43) for more information about creating and using linked
queries.

Note: If the window containing data does not have the focus when you select a One
Click Export option, the following message displays: "Export did not find any results sets
to process".

Tip: You can specify a default export folder in Tools | Options |Environment
|OneClick Export.
Toad for Data Analysts User Guide 43
Query

Share Excel Linked Queries

You can use linked queries to create "live" Excel reports that can be refreshed dynamically.
Because a linked query contains the underlying SQL for a report, each time you refresh the
report the query is executed and the latest data is retrieved. The dynamic nature of linked
query reports makes them ideal for distribution to users who need to see changes to data
without waiting for scheduled updates or for new reports to be distributed.

Notes:

l Any user who opens an Excel linked query must have access to a user name and
password for the queried database to refresh the data. If a user does not have access to
the database, they can only see the original data in the spreadsheet.

l If the Excel linked query was created from an ODBC connection that uses a Data
Source Name (DSN), the DSN must also exist on the computer where the Excel file is
opened to refresh the data.

Scenario
You need to create an Excel linked query so that the Regional Sales
Manager, can track whether the Sales Representatives in his region
meet their monthly and quarterly goals. By providing a linked query,
you only have to create the query once, and then the Regional Sales
Manager can refresh the data at any time to view the latest sales
information.

To create an Excel linked query

1. Connect to the database.

2. Create a query in the Query Builder or Editor.
3. Execute the query to display data results.

4. Select the result set and click one of the following options from the toolbar:

5. Save the Excel spreadsheet.

6. Email or upload the spreadsheet to a shared network folder to share it with colleagues.
Toad for Data Analysts User Guide 44
Query

To refresh data in an Excel linked query

1. Open the spreadsheet with the linked query in Excel. The original data from the
query displays.
2. In Excel, select Data | Refresh to update the original data with the current data.

3. If prompted, enter a user name and password to connect to the database and
refresh the data.

or

If the following error displays: "[Microsoft][ODBC Driver Manager] Data source name
not found and no default driver specified", you must specify the DSN used by the
query on your computer. Complete the following steps to resolve this issue:

(Excel 2003)
a. Click OK.
b. Select the Machine Data Source tab, and then click New.
c. Use the wizard to select a User Data Source and create a DSN that points to
the database.
d. Click OK to return to Excel and open an ODBC Driver Connect window.
e. Enter a user name and password to refresh the data.
 5
Report

Tutorial:Create a Toad Data Report

Use the Data Report Designer to design reports visually. Stored in .tdr files, data reports are
"live" reports that can be refreshed dynamically. What makes them dynamic is that they
contain the underlying queries for report data sets. Each time a data report is opened, its
query runs and the latest data is retrieved. The dynamic nature of data reports makes them
ideal for distribution to users who need to see changes to data without waiting for scheduled
updates or for new reports to be distributed.

The process of creating a data report has the following steps:

l Step 1: Run the Toad Data Report Wizard

l Step 2: Update Fields
l Step 3: Use Styles to Format the Report Appearance
l Step 4: Update Bands and Add Controls

Note: This procedure does not cover all of the possible steps of creating a data report. It only
covers the steps required to create a report for the scenario.

Scenario
Your company wants to improve its global sales, starting with countries where it has a
customer base but averages low sales. You created a query that displays countries with
less than $500,000 in sales per fiscal year, but now you need to create a report to help
represent and evaluate the results. The data should be grouped per country and show the
total and average sales for each country. In addition, you want the report to look similar
to the rest of the company's documents, which use specific colors and fonts.
Note: This scenario uses the data generated in Visually Build a Query.

Step 1: Run the Toad Data Report Wizard

The Toad Data Report wizard creates an initial layout of the report based on options you
select, including what columns to include, whether to group data, and the basic style.

To run the wizard

1. Right-click the data grid in the Results tab and select Send To | Data Report
Designer. The Toad Report Designer displays.
2. Select Standard Report and click Next.
3. Click to include all columns in the report and click Next.
Toad for Data Analysts User Guide 46
Report

4. Select COUNTRY_NAME and click , and then click Next. This groups the data by
the country name so that each country is listed as a heading and its sales per year
display below it.

Tip: You can create a secondary group by selecting another column and clicking
again. A secondary group is not appropriate for this scenario, but it would be if the
data included regions in each country or fiscal quarters. You would need to make the
region or fiscal quarter a secondary group for the data to be organized appropriately.

5. Select the Sumand Avg checkboxes for the SUM(SALES.AMOUNT) row, and
then click Next. These options calculate the sum and average sales amount for
each country.

6. Select Outline 1 and click Next.

Tip: The Outline and Align Left options are good choices if you grouped the data.

7. Select Casual and click Next.

8. Enter Countries with Sales Less Than $500,000 in the Report Title field, and then
click Finish. The initial report layout displays in the Report window with the
information grouped under bands. For more information on bands, see Add Report
Bands in the Toad help.
9. Click Preview to see what the report looks like in print. Previewing the report makes
it easier to see how the bands and their content display in the printable report.

Step 2: Update Fields

You can move, rename, and update the category of a field.

To update the fields

1. Complete the following steps to update the field category:

a. Select the FISCAL_YEAR field in detailBand1.

b. Click directly above the field.

c. Click by the Format String field.

d. Clear the Prefix field and click OK.
2. Double-click the following fields and enter their new name:

Field Band Name

FISCAL YEAR groupHeaderBand2 Fiscal Year

Toad for Data Analysts User Guide 47
Report

Field Band Name

SUM(SALES.AMOUNT_SOLD) groupHeaderBand2 Sales Amount

Avg groupFooterBand1 Average

3. Select the following fields one at a time and make them wide enough to see the full
text: Sum (groupFooterBand1), Average (groupFooterBand1), and Grand Total
(reportFooterBand1).
4. Select the following fields one at a time and drag them to the one inch mark on the
ruler: Sum, Average, and Grand Total.

5. Right-click the COUNTRY NAME field (not the COUNTRY_NAME field on the right)
in groupHeaderBand1 and select Delete.

Note: The COUNTRY NAME field is a label that precedes the COUNTRY_NAME field
value. If you preview the report before you delete the COUNTRY NAME field, the
country displays as 'COUNTRY NAME Argentina'. It is clear that Argentina is the
country name, so this field is redundant.

6. Select the COUNTRY_NAME field and drag it to align with the report title.
7. Select the COUNTRY_NAME field and make it three inches wide to accommodate
long country names.

Step 3: Use Styles to Format the Report Appearance

The Data Report Designer uses styles to format different objects and kinds of data. Once
you define a style, you can apply it to similar fields to create a consistent and easy-to-
update design.

To create, update, and apply styles

1. Complete the following steps to update the report title style:

a. Select the Styles field in the Properties pane.
b. Click . The Styles Editor window displays.
c. Select Title.

d. Select the Foreground Color field, and then select MidnightBlue in the
Web tab.

Note: All colors in this scenario are from the Web tab.

e. Select the Font field and click . The Font window displays.
f. Select 22 in the Size field and click OK.
2. Complete the following steps in the Styles Editor window to create and define four
new styles:
Toad for Data Analysts User Guide 48
Report

a. Click four times in the Styles Editor window to create four new styles.
b. Set the following properties for the new styles:

First Style Properties

Name OddRow

Background Color WhiteSmoke

Border Color MidnightBlue

Borders Bottom

Font Tahoma, 10pt

Second Style Properties

Name EvenRow

Border Color MidnightBlue

Borders Bottom

Font Tahoma, 10pt

Third Style Properties

Name TableHeading

Background Color MidnightBlue

Font Tahoma, 10pt, bold

Foreground Color White

Fourth Style Properties

Name CountryName

Font Tahoma, 14pt, bold

Foreground Color Black

3. Complete the following steps to apply the new styles:

a. Expand the Styles field in the Properties pane.

b. Select TableHeading in the Style field (under Styles) for the Fiscal Year and
Sales Amount fields in groupHeaderBand2.
Toad for Data Analysts User Guide 49
Report

c. Set the following fields for [FISCAL_YEAR] and [SUM(SALES.AMOUNT_

SOLD)] in detailBand1:

Field Property

Even Style EvenRow

Odd Style OddRow

d. Select the COUNTRY_NAME field in groupHeaderBand1 and then select

CountryName in the Style field.

Step 4: Update Bands and Add Controls

Bands group the information layout in the report and you can add controls to include
additional tables, images, fields, and other items in the report. For more information on
controls, see Add Controls in the Toad help. For the scenario, you will expand bands, delete
a band, and add a control.

1. Right-click pageHeaderBand1 and select Delete.

2. Complete the following steps to add a line under the report title:

a. Select the groupHeaderBand1 and move it down half an inch.

Tip: It is helpful to expand a band before adding controls to give you plenty
of room in which to work.

b. Drag Line from the Toolbox into reportHeaderBand1.

c. Expand it to the width of the page.
d. Drag and position it directly below the report title.
e. Enter 2 in the Line Width field in the Properties pane.
3. Select reportFooterBand1 and drag it down half an inch. This adds white space
between the country information.

The Data Report Designer displays with the following layout:

Toad for Data Analysts User Guide 50
Report

4. Click Preview.

The print preview displays with the following layout:

Toad for Data Analysts User Guide 51
Report

5. To save the report, right-click the Data Report Designer tab and select Save File.

Manage Reports

About Managing Reports

Use the Report Manager to create and organize data reports, add existing Toad or Excel
reports, or generate reports.

To create a report

1. Select Tools | Reports | Report Manager from the menu.

2. Right-click a folder and select Create Report.

3. Complete the wizard and design the report.

4. Save the report.

5. To add the report to the Reports Manager window:

Toad for Data Analysts User Guide 52
Report

a. Navigate to the open Reports Manager window.

b. Right-click the folder where you want to add the report, and select Add
Existing Report.

To generate an existing report

1. Select Tools | Reports | Report Manager from the menu.

2. Double-click the existing report.

3. Review the following for additional information:

Direction Select the direction of variable from the list.

Value Enter the value of the variable.

Note: Enter a percent (%) in this field to generate all values.

Tips:

l To add an existing Toad or Excel report to the Report Manager, right-click the Report
Manager window and select Add Existing Report.

l To send a Toad or Excel report via email or to a shared folder or other location, right-
click the report, select Send To, and then select an option.

l To share reports with other users, specify a shared network directory in Network Share
Options (Tools | Options |Environment |Network Share).

DB2 Reports
The following reports are available from the Reports Manager (Tools |Reports
|Reports Manager).

Report Name Description

Activity Lists and describes activity reports that the Activity Monitor for
the current DB2 for LUW database uses. This report also lists the
switches required to gather data for a specific activity report. Toad
uses the AM_BASE_RPTS table function to generate this report.

ADMIN_LIST_ Displays information from the database history table for the DB2
HIST_V82 for LUW database partition to which Toad is currently connected.
Toad uses the ADMIN_LIST_HIST table function to generate this
report.

Database Shows information about each database partition on the current

Partitions DB2 for LUW database. Toad uses the DB_PARTITIONS function
to gather this information from db2nodes.cfg.

DBManager Lists the database manager configuration parameters and their

Config Info values defined for the current DB2 for LUW database.
Toad for Data Analysts User Guide 53
Report

Report Name Description

HEALTH_ Shows the current "health" status of all containers that tablespaces
CONT_HI in the current DB2 for LUW database use. Toad uses the
HEALTH_CONT_HI table function to generate this report.

HEALTH_ Shows a "health" history for all containers that the tablespaces in
CONT_HI_HIS the current DB2 for LUW database use. Toad uses the HEALTH_
CONT_HI_HIS table function to generate this report.

HEALTH_ Identifies the containers that tablespaces in the current DB2 for
CONT_INFO LUW database use and lists the highest current alert status for each
container. Toad uses the HEALTH_CONT_INFO table function to
generate this report.

HEALTH_DB_HI Shows the "health" status of the current DB2 for LUW database,
including its highest current alert status. Toad uses the HEALTH_
DB_HI table function to generate this report.

HEALTH_DB_ Shows the "health" history of the current DB2 for LUW database.
HI_HIS Toad uses the HEALTH_DB_HI_HIS table function to generate
this report.

HEALTH_DB_ Shows the "health" status of objects in the current DB2 for LUW
HIC database. Toad uses the HEALTH_DB_HIC table function to
generate this report.s

HEALTH_DB_ Displays a "health" history for objects in the current DB2 for LUW
HIC_HIS database. Toad uses the HEALTH_DB_HIC_HIS table function to
generate this report.

HEALTH_DB_ Shows the highest current alert status for the current DB2 for LUW
INFO database. Toad uses the HEALTH_DB_INFO table function to
generate this report.

HEALTH_DBM_ Shows the "health" status for the current DB2 for LUW instance.
HI Toad uses the HEALTH_DBM_HI table function to generate this
report.

HEALTH_DBM_ Shows a "health" history at the database manager level for the
HI_HIS current DB2 for LUW instance. Toad uses the HEALTH_DBM_
HI_HIS table function to generate this report.

HEALTH_DBM_ Shows the highest current alert status for the current DB2 for LUW
INFO instance. Toad uses the HEALTH_DBM_INFO table function to
generate this report.

HEALTH_TBS_ Shows the "health" status of all tablespaces in the current DB2 for
HI LUW database. Toad uses the HEALTH_TBS_HI table function to
generate this report.
Toad for Data Analysts User Guide 54
Report

Report Name Description

HEALTH_TBS_ Shows a "health" history for tablespace in the current DB2 for
HI_HIS LUW database. Toad uses the HEALTH_TBS_HI_HIS table
function to generate this report.

HEALTH_TBS_ Shows the highest current alert status for each tablespace in the
INFO current DB2 for LUW database. Toad uses the HEALTH_TBS_
INFO table function to generate this report.

Index Statistics Displays statistics for the indexes under the current schema for the
DB2 for LUW database and flags those indexes that need
reorganization. Toad uses the REORGCHK_IX_STATS procedure
to generate this report.

Installed DB2 Lists the DB2 for LUW 9 products currently installed on your
Products system. Toad uses the ENV_GET_PROD_INFO table function to
generate this report. Products can include the following: RTCL
DB2 Run-Time Client CONSV DB2 Connect Server (any edition)
CONPE DB2 Connect Personal Edition

Installed DB2 Lists the DB2 for LUW 8 products currently installed on your
Products_V82 system. Toad uses the ENV_GET_PROD_INFO table function to
generate this report. Products can include the following:
l ADCL DB2Application Development Client
l ADMCL DB2Administration Client
l CONEE DB2Connect Enterprise Edition, DB2 Connect
Unlimited Edition, or DB2 Connect Application Server
Edition
l CONPE DB2Connect Personal Edition
l CUBE DB2Cube Views
l DLM DB2Data Links Manager
l ESE DB2Enterprise Server Edition
l EXP DB2Express Edition or DB2 Express Edition
processor option
l GSE DB2Spatial extender
l PE DB2Personal Edition
l QP DB2Query patroller
l RTCL DB2Run time client
l WM DB2Warehouse Manager
l WSUE DB2Workgroup Server Unlimited Edition
Toad for Data Analysts User Guide 55
Report

Report Name Description

Instance Lists details about the current DB2 for LUW instance. Toad uses
Information_V82 the ENV_GET_INST_INFO table function to generate this report.

Recommendations Provides recommendations (in English) for the various activity

for Activity reports that the activity monitor uses. Toad uses the AM_BASE_
Reports RPT_RECOMS table function to generate this report.

SNAP_GET_ Displays information and statistics about each container that

CONTAINER _ tablespaces in the current DB2 for LUW 8 database use. To
V82 generate this report, Toad uses the SNAP_GET_CONTAINER
table function to retrieve information from the tablespace_
container logical data group.

SNAP_GET_DB_ Lists information and statistics captured for the current DB2 for
V82 LUW 8 database. To generate this report, Toad uses the SNAP_
GET_DB table function to retrieve information from the database
and detail_log logical data groups.

SNAP_GET_ Lists statistics and information about the dynamic SQL statements
DYN_SQL_V82 executed against the current DB2 for LUW 8 database use. To
generate this report, Toad uses the SNAP_GET_DYN_SQL table
function to retrieve information from the dynsql logical data
group.

SNAP_GET_ Lists information and statistics about the tables in the current DB2
TAB_V82 for LUW database 8. To generate the report, Toad uses the SNAP_
GET_TAB table function to retrieve information from the table
logical data group.

SNAP_GET_ Lists information and statistics for the database partitions that
TBSP_PART_ make up each tablespace in the current DB2 for LUW 8 database.
V82 To generate this report, use the SNAP_GET_TBSP_PART table
function to retrieve information from the tablespace_nodeinfo
logical data group.

SNAP_GET_ Lists information and statistics for each tablespace in the current
TBSP_V82 DB2 for LUW 8 database. To generate the report, Toad uses the
SNAP_GET_TBSP table function to retrieve information from the
tablespace logical data group.

SNAPSHOT_ Lists the agents working for the various applications connected to
AGENT_V82 the current DB2 for LUW 8 database. To generate the report, Toad
uses the SNAPSHOT_AGENT function to retrieve information
from the application snapshot, especially from the agent logical
group.

System Displays information about the operating system in which the

Information_V82 current DB2 for LUW 8 database operates and about the CPUs
Toad for Data Analysts User Guide 56
Report

Report Name Description

configured on this operating system. Toad uses the ENV_GET_

SYS_INFO table function to generate this report.

Table Statistics Displays statistics for the tables under the current schema in the
Column View DB2 for LUW database and flags those tables that need
reorganization. Toad uses the REORGCHK_TB_STATS procedure
to generate this report.

Table Statistics Displays statistics for the tables under the current schema in the
DB2 for LUW database and flags those tables that need
reorganization. Toad uses the REORGCHK_TB_STATS procedure
to generate this report.

MySQL Reports
The following reports are available from the Reports Manager (Tools |Reports
|Reports Manager).

Report Name Description

Help Topic Displays the first 10 rows of the mysql.help_topic table.

ODBC Reports
The following reports are available for the Toad Sample Database in the Reports Manager
(Tools |Reports |Reports Manager):

Report Name Description

Customer Displays customer orders for contact IDs less than 10 from the Toad
orders sample database. It is an example of master detail display using a
single result set.

Customer list Displays a list of customers from the Toad sample database.

Items to order Displays items in stock that have a quantity of less than 50 and
should be reordered from the Toad sample database.

Oracle Reports
The following reports are available from the Reports Manager (Tools |Reports
|Reports Manager).

Cluster Reports
Toad for Data Analysts User Guide 57
Report

Report Name Description

Clusters Displays cluster information, including the cluster type, definitions,

storage parameters, and affected tables.

Other Reports

Report Name Description

Invalid objects Displays any invalid objects for the selected schema and includes a
subtotal of all invalid objects for that owner.

Loads into Displays packages that have been loaded five or more times, into the
shared pool Oracle shared pool.
Note: You must have DBA privileges for this report.

Non-system Displays any objects in the SYSTEM tablespace that are not owned
objects in by SYSTEM.
SYSTEMtables

Oracle Displays the values for all parameters defined in the PFILE for the
initialization selected user.
parameters

Tablespaces Displays tablespaces that over 90% full, and do not have the
near capacity autoextend feature enabled.

Total shared Displays the number of times objects in the shared pool were
pool reload reloaded.
stats Note: You must have DBA privileges for this report.

User hit ratios Displays the buffer cache hit ratio users and includes consistent gets,
blocked gets, and physical reads.

User resource Displays values for resource usage such as CPU used and SQL*Net
usage roundtrips for each user.

Sequence reports

Report Name Description

Sequences Displays the sequences that are within 10% of the maximum value.
Any sequences that do not have a maximum value set, or those that
cycle are excluded from the report.

Sequences Displays the sequences that are within 10% of the maximum value.
near max Any sequences that do not have a maximum value set, or those that
cycle are excluded from the report.

Stored Program Reports

Toad for Data Analysts User Guide 58
Report

Report Name Description

Arguments of Displays any parameters required for the selected stored procedure.
stand-alone
stored
programs

Object type Displays the body or source code for a selected object.
bodies

Object types Displays the type of objects owned by a user, including whether the
objects are valid and when they were created or last modified.

Package Displays the body or source code for a selected package

bodies

Package Displays specifications for a selected package, including whether it is

specifications valid and when it was created or last modified.

Stand-alone Displays the source code for a stored program, including the type of
stored program and the last time DDLwas generated.
programs

Stored Displays a list of stored functions for a selected owner.

functions

Stored object Displays a list of all stored programs including their source.
with source

Stored Displays the source for stored procedures for a selected owner.
procedures

Synonym Reports

Report Name Description

Synonyms Displays information for each synonym, including the owner, table
owner and name, and the DB link.

Table Reports

Report Name Description

Indexes Displays details for the index definition, storage parameters, and
columns included in the index.

Non-indexed Displays any tables that have not been indexed for the selected
tables database.
Toad for Data Analysts User Guide 59
Report

Report Name Description

Table Displays any comments for the selected table.

comments

Tables Displays all columns for a selected table, including the maximum
&columns transactions, used/free blocks, free lists and groups, min/max extents,
and columns included in this index.

Tables Displays any indexes for a selected table, including the status,
&indexes uniqueness, and columns included in the index.

Trigger Reports

Report Name Description

Triggers Displays triggers for a selected table, including the trigger event,
&columns status, WHEN clause, and columns associated with the trigger.

User-defined Reports

Report Name Description

Sample Displays a sample user report based on a select * from dual query.

View Reports

Report Name Description

View Displays any comments for the selected view.

comments

Views & Displays all columns for a selected view, including the query and
columns columns included in the view.

SQL Server Reports

The following reports are available from the Reports Manager (Tools |Reports
|Reports Manager).

DBA Reports

Report Name Description

All jobs Displays all scheduled SQLServer jobs and the job owner, organized
by server.

Backup Displays the backup start date, type, and device used for the backup
history for a specified database for a set number of days.
Toad for Data Analysts User Guide 60
Report

Report Name Description

Backup status Displays the database name, date of the last backup, days since the
last backup, and the type of backup performed.

Current lock Displays any locks on the server, including the database name, object
report or index name, type of lock, resource, mode, and status.

Database Displays configuration options for each database on the specified

configuration server.
options

Database Displays any common options and their values for all the databases on
settings your server.

Database user Displays the user name, roles, objects, granted/denied status, and
details column permissions for each database.

Display errors Displays a log file without entries for log backups. This is useful
when you have a number of log backup entries and you need to locate
non-backup errors.

Drive space Displays space for all databases on the server, including free space,
usage space used, maximum size, and growth type.

Foreign key Displays tables in the order you can either populate or delete from
sequence them without violating any foreign key constraints. Objects with the
lowest wave number indicate that they can be deleted with the fewest
number of foreign key references. Objects with the highest wave
number should be populated first.

Index (SQLServer 2000 only) Displays all indexes for the current database
description sorted by table. Index information includes whether it is clustered,
unique, index keys, and the index size. run frequency, and the
maximum duration.

Job details (SQLServer 2000 only) Displays all SQLServer jobs, including
whether they are scheduled, enabled, start date and time,

Row count for Displays the number of rows for all tables on a server that contain a
tables with clustered index.
clustered
index

Total rows Displays the total number of rows and space used for each table or
and space view in the current database, including the reserved rows, unused
used rows, and index size. This report is sorted in descending order by
reserved rows.

User Displays users permissions, grouped by role name and object type.
permissions
Toad for Data Analysts User Guide 61
Report

Other Reports (SQLServer 2005 only)

Report Name Description

Configuration Displays a history of all sp_configure and Trace Flag Changes

change history recorded by the default trace.

Schema change Displays a history of all committed DDL statement executions

history recorded by the default trace.

Table Reports

Report Name Description

Indexes Displays index information for a selected table, including

whether the index is clustered, unique, ignores duplicate keys,
allows page/row locks, and a list of indexed columns.

Non-indexed Displays any tables that have not been indexed for the selected
tables database.

Table constraints Displays any check constraints for a selected table, including
whether the constraint is enabled, valid data, and affected
columns.

Table extended Displays any extended properties for a selected table.

properties

Table relationships Displays any foreign key constraints for a selected table,
including whether the constraint is enabled, referenced tables, and
referenced keys.

Tables and Displays all columns for a selected table, including the data type,
columns default value, whether it allows null values, and for SQLServer
2005 any extended properties.

Tables and indexes Displays any indexes for a selected table, including the name,
columns included in the index, and whether it is unique or
clustered.

User-defined Reports

Report Name Description

Stored procedures Displays stored procedures for a selected database, including their
status, status, replication information, schema version, statistics,
and procedure text.
Toad for Data Analysts User Guide 62
Report

Publish and Share Reports

Toad provides multiple ways to publish and share information with your business
community. Use the following methods to publish and share information from the Project
Manager, Reports Manager, and Automation:

l Email reports and files, including Database Diagrams, Query Builder queries, SQL
scripts, and results for reports, queries, and scripts.

l Share reports and files in a central location such as the Toad shared folder.

l Add reports and files to a ZIP folder or file.

l Publish reports and files to a web site.

You can use the following methods to publish and share information:

To email from... Do this...

Project Manager Right-click a report or file and select Send To | Mail

Reports Manager Recipient.

Automation Drag the Send Email activity to the Automation workflow

and attach files as needed. The email is sent when the
automation script executes.

To publish to a central Do this...

location from...

Project Manager Right-click a report or file and select Send To | Toad

Reports Manager Shared. The file is sent to the Toad shared folder specified in
Tools |Options |Environment |Network Share.

Automation Drag the Copy File activity to the automation workflow.

Specify the file to copy or move and a destination folder.
This can be any folder, including the Toad shared folder, or a
network folder. The file is copied or moved when the
automation script executes.

To send to a zip file... Do this...

Project Manager Right-click a report or file and select Send To | Compressed

Reports Manager (zipped) Folder.
Note: This function requires that ZIP files be associated with
the Compressed (zipped) Folders feature instead of WinZip or
another ZIP file handler.

Automation Drag the Zip File activity to the workflow. Add reports and
files to the Zip file and specify a file name with a .zip
Toad for Data Analysts User Guide 63
Report

extension. The ZIP file can then be emailed with the Send
Email activity or copied with the Copy File activity.

To publish to a web Do this...

site...

Project Manager or Right-click a report or file and select Send To | Web

Reports Manager Publishing Wizard. Complete the wizard to specify a URL
and directory for the file.

Tips:

l To export a Toad report to a file that can be read by other applications, double-click a
report in the Reports Manager, click in the Report Preview window, select a file
format, and add the file to a project. Share or publish the file using the Project
Manager functions.

l To capture report results in a file, add the Toad Report automation activity. This
activity runs a Toad report and saves the results in a file format you select. Share or
publish the file using the Automation functions.

l To execute and save a query in a file, add the Select To File automation activity. This
activity runs a query or SQL script and exports the results to an Excel spreadsheet.
Share or publish the spreadsheet using the Automation functions.
 6
Automate

Scenario: Automate a Query and Email the Report

Scenario
You need to create an Excel report that contains current regions and addresses and email
it to your manager every week.
Note:This scenario uses the Toad Sample(Access) database that ships with Toad for
Data Analysts.

To automate a task for this scenario

1. Connect to the Toad Sample (Access) database in the Navigation Manager.

2. Enter the following statements in the Editor and save them to a single file named
AutomationTest.sql:
Select * from region;

Select * from address;

3. Select Tools | Automation from the menu.

4. To send yourself an email if an error occurs, click Settings in the Automation design
window and enter the following:

Stop or Select Stop On Error

continue on
error

Send email Select this option.

when an error
occurs

Compose Email Click Compose Email and enter your email address in the
To and the From fields.

Email Server In the Compose Email form, click Email Server Settings and
Settings enter your SMTP server address and the port number.

5. Click the Select To File database activity in the toolbox to add it to the
design window.

6. Click the File_1 activity and select Toad Sample Database in the connection field.
Toad for Data Analysts User Guide 65
Automate

7. Click the File_1 activity and enter the following in the Activity Input window:

SQLfile Select AutomationTest.sql.

Export Select the following options:

file
l DestinationEnsure that the Excel file option is selected.
Then, select a folder and enter AutomationTestExcel as the
file name.
l Add Date/Time suffix to filenameSelect this checkbox.

8. Click the Send Email file activity in the toolbox to add it to the design window.

9. Click the Send Email activity and enter the following in the Activity Input window:

To Enter your email address.

From Enter your email address.

Add Click Add Attachments. Select AutomationTestExcel from

Attachments Activity Reports and click Add. Click the X in the upper-right
corner of the dialog.
The file is added as an email attachment.

Subject Enter Weekly Report.

Body Enter the following: Attached is a copy of the weekly regions

and addresses report.

Email Click Email Server Settings and enter your SMTP server address
Server and port number.
Settings

10. Save the Automation script.

11. Click Test on the wizard bar to ensure that the script works. The automation script is
compiled, then executed. All results display in the Log window.

12. Review the log and click the link to the Excel file generated to open the Excel
file in Toad.

Notice that the results of each SQL statement are in a different worksheet.

13. To schedule the automation script to run at a later time, click Schedule on the
wizard bar.
14. Complete the following fields:

Task Tab Description

Set Click this button and enter and confirm your O/S password.
password
Toad for Data Analysts User Guide 66
Automate

Schedule Description

Schedule Select Once.

task

Start time Select a time that is 2 minutes from the current time.

15. Check your email for confirmation of execution as well as thestatus of the job
manager window.

Automate Tasks
Use Automation to schedule a single script to run reports and queries, save results in Excel
spreadsheets, and distribute results to the business community via email. You can schedule
scripts that perform long-running tasks to run when database activity is light.

You can also use variables in automation scripts. With variables, you can update information
that may be different each time you run the script, such as the department name, revenue,
fiscal quarter, or product name. See "Use Variables in Automation" (page 83) for more
information.

For example, assume you are an analyst at Nick's Flicks movie rentals. You need to run
inventory and movie rental reports on a daily basis and distribute them to managers of the
inventory department. Using Toad, you create an automation script that runs the reports,
exports them to Excel spreadsheets, and emails the spreadsheets to the inventory department
everyday at 2:00 AM.

Troubleshooting:

l If Toad displays a "Variable must be initialized before referencing itself" error, you
need to initialize the variable. See "Use System Automation Activities" (page 79) for
more information.
l You must surround a variable name with the # sign (for example, #sleep#).

Note: This topic focuses on information that may be unfamiliar to you. It does not include all
step and field descriptions.

To automate tasks

1. Click Automate.

2. Select the Settings icon in the script design window to specify the script settings
before building your script. Use the Activity details pane in the bottom portion of the
Automation window to enter your settings. Review the following for additional
information:
Toad for Data Analysts User Guide 67
Automate

Activity
Input

Stop or Select Stop On Error to stop the script if an error occurs.

continue on
Error

Send email Select this option to send an email on script error.

when error If selected, you must also click Compose Email to compose
occurs the email message and to edit the Email Server Settings.
Note: When you specify the error email settings, Toad saves
your settings and uses them in all subsequent automation
scripts.

Use relative Select to use a relative path that does not include the drive or
path to find full path for all activities in the script. This is useful if you
SQL files want to share your automation scripts with colleagues, use
them with version control, or place them on a shared network
folder.

Embed Select to embed the actual SQL from SQLfiles in the script.
SQL into This makes it easier to share the script with colleagues.
Automation
script

Truncate Select to overwrite the log file each time the script runs.
log

Run Mode Select Test mode to run your script in test mode using the
database connection specified under Test settings.
Select Production mode to run your script in production mode
using the database connection specified under Production
settings.
Note: The default connection is the currently active, open
connection.

Activity Info

Name Enter a script name.

3. To build your script, click an activity in the Toolbox, or drag an activity from the
Toolbox to the Automation script design window. Repeat to add additional activities
to your script.

Note: You must drag the activity to the , then release the mouse button after you
see the activity's icon replace the .

4. For each activity in your script, select the activity in the design window and then
Toad for Data Analysts User Guide 68
Automate

specify the activity's properties in the Activity details pane.

See the following topics for details about each activity and its properties:

l Use Database Automation Activities (page 69)

l Use File Automation Activities (page 73)
l Use System Automation Activities (page 79)

Tip: You can save an activity and its properties as a template to reuse in other scripts.
Right-click the activity in the design window and select Save As Template. After
you create the first template, a Templates toolbox displays.

Note: Click Settings in the design window at any time to go back and review the
Automation script settings.

5. When you finish building your script, select one of the following actions from the
Automation toolbar or the Wizard bar:

Add to Project Add an automation script to the current project in the

Project Manager. The script is automatically placed in the
project's Automation Scripts folder.

Save Save an automation script (.tas) in a folder on a local or

network drive.

Run Run an automation script before scheduling it. The script

executes once and the execution log is displayed in the
Log window. Resolve any problems that cause activities to
fail, or disable failed activities before scheduling the script.
Tips:
l Press F5 to run the automation script.
l To view the script log, select the Log tab or select
View | Output.

Schedule Schedule an automation script in the Job Manager. You

can schedule a script to execute once or to run periodically
at a defined interval. See "Execute Automation Scripts"
(page 90) for more information.

Tips:

l Double-click an activity in the script design window to open the Activity Properties
pane in a format used in earlier versions of Toad.
l Right-click within the script design window and select Print Script to print the
script's workflow diagram.
Toad for Data Analysts User Guide 69
Automate

Use Database Automation Activities

You can use the following activities in automation scripts.

Note:When building an automation script, you must have the appropriate connections open
for database activities.

Tip: You can save an activity and its properties as a template to reuse in other scripts. Right-
click the activity in the design window and select Save As Template. After you create the
first template, a Templates toolbox displays.

Activity Description

Database In previous versions of Toad, the Database Connection activity was

Connection required in order to specify database connection details.
In the current version of Toad, the database connection details are
specified in each activity's properties.
Notes:
l If the connection was open before the script ran, it closes the
connection once the activities in the connection box are
complete.
l You can include connections for multiple databases in the
same automation script.

Select to File Execute an existing SQL script or Query Builder query and export the
results to an Excel, HTML, or CSV file. You can then use additional
activities to add the exported result file to a zip file, attach the file to
an email, or copy the file.
Review the following for additional information:
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l SQLManually enter SQL or select a SQL script or Query
Builder query to run. For SQL scripts, you can create a new
worksheet for the results of each SELECT statement in a script
by entering GO after each statement.
Note: To manually enter SQL in the text box, deselect Link
SQL file.
l Export fileClick the drop-down list to select the export file
type. Then, select the file location and enter the name. You can
use a variable in this field by entering the number sign before
Toad for Data Analysts User Guide 70
Automate

Activity Description

and after the variable (#VariableName#). If you select Excel

file, you can append the date and time that the file was
generated to the file name as a suffix.
Note: You can only use one variable per field or file
name (a suffix counts as one variable for a file name).

Execute Script Execute an existing SQL script or Query Builder query.

Review the following for additional information:
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l SQLManually enter SQL or select a SQL script or Query
Builder query to run. For SQL scripts, you can create a new
worksheet for the results of each SELECT statement in a script
by entering GO after each statement.
l Result variableEnter a name for the result variable, which
contains a data table with the results of the execution script.
You can use the result variable with the Loop Dataset activity.
See "Use System Automation Activities" (page 79) for more
information.

Select to Execute an existing SQL script or Query Builder query and save it
Editor with and any results sets in a Toad editor file (.tef).
Results This file format is useful for building scripts that have large result sets
that you do not want to continue executing or for saving results when
you have not finished building a script.
Review the following for additional information:
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l SQLManually enter SQL or select a SQL script or Query
Builder query to run. For SQL scripts, you can create a new
worksheet for the results of each SELECT statement in a script
by entering GO after each statement.
l Editor FileSelect the file location and enter the name. You
can use a variable in this field by entering the number sign
before and after the variable (#VariableName#).
Toad for Data Analysts User Guide 71
Automate

Activity Description

l SuffixSelect a suffix to append to the file name. The suffix

can be the date and time that the file was generated or the
content of a variable that you define with the Set Variable
system activity. See "Use System Automation Activities" (page
79) for more information.
Note: You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

Export Wizard Export data from databases, tables, views, or a query into a CSV,
Excel, or other file.
Review the following for additional information:
l Export templateYou can select an existing template, edit an
existing template, or create a new template.
l Use automation connectionSelect this option to use the
connection associated with the database activity. Clear the
checkbox to use the connection associated with the export
template.

Import Wizard Import data from a CSV, Excel, or other file into a new table or
append to an existing table.
Review the following for additional information:
l Import templateYou can select an existing template, edit an
existing template, or create a new template.
l Use automation connectionSelect this option to use the
connection associated with the database activity. Clear the
checkbox to use the connection associated with the import
template.

Toad Report Use this activity to open one or more Toad data reports and export the
contents as a PDF, HTML, Excel, CSV, RTF, or MHT file. You can
then add another activity to your script to zip the new file, attach it to
an email, or save it to a new location.
Review the following for additional information:
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l Report filesSelect one or more Toad data reports from the
Project Manager or other location, or edit an existing report.
l Export fileSelect the file type and location and enter the
Toad for Data Analysts User Guide 72
Automate

Activity Description

name. You can use a variable in this field by entering the

number sign before and after the variable (#VariableName#).
l SuffixSelect a suffix to append to the file name. The suffix
can be the date and time that the file was generated or the
content of a variable that you define with the Set Variable
system activity. See "Use System Automation Activities" (page
79) for more information.
Note: You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

Toad Pivot Refresh an existing pivot grid and export results to an Excel, HTML,
Grid or CVS file. You can then add another activity to your script to zip
the new file, attach it to an email, or copy it to a new location.
Review the following for additional information:
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l Pivot fileSelect a Toad pivot file from the Project Manager
or other location, or edit an existing pivot file.
l Export fileSelect the file type and location and enter the
name. You can use a variable in this field by entering the
number sign before and after the variable (#VariableName#).
l SuffixSelect a suffix to append to the file name. The suffix
can be the date and time that the file was generated or the
content of a variable that you define with the Set Variable
system activity. See "Use System Automation Activities" (page
79) for more information.
Note: You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

Clean Data Execute data cleansing to create a new data set by filtering an existing
data set or data source.
Review the following for additional information:
l Data cleansing creates a new, cleansed table and leaves the
source table intact. Implement a data hub repository or some
form of internal data store. Alternatively, you can specify a
schema or database to create, or alter and drop tables.
l Each data hub table needs a name and Test Representation
Language (TRL) representation. Groups of tables, data
Toad for Data Analysts User Guide 73
Automate

Activity Description

validation actions, and the sequential flow between them are

grouped and stored into projects displayed in the workbench.
l Data Cleansing fileSelect a data cleansing file or edit an
existing file.
l Row count variableEnter a name for the row count variable.
The value assigned to this variable equals the number of rows
returned from the activity. You can use this variable with the
If..Condition.. and While system activities. See "Use Variables
in Automation" (page 83) for more information on use cases for
this field.
l Export to fileSelect a file location and enter the name. You
can use a variable in this field by entering the number sign
before and after the variable (#VariableName#).
l Export to local storageSelect or create a database and table
in local storage to receive cleansed data.

Notes:
l StatusSelect Enabled to include the activity in script execution. Select
Disabled to disable the activity, for example, when testing other activities. Or
right-click the activity in the design window and select/deselect Enabled.
l Stop on ErrorAllows you to select, for each activity, whether to stop or
continue execution if Toad encounters an error.
l Select the Log tab to review a script's execution log.
l Automation does not support positional parameters denoted by a question mark.
l For each activity, you can specify the database connection in the activity's
properties. The default connection is the currently active, open connection.

Use File Automation Activities

You can use the following activities in automation scripts.

Tip: You can save an activity and its properties as a template to reuse in other scripts. Right-
click the activity in the design window and select Save As Template. After you create the
first template, a Templates toolbox displays.

Activity Description

Copy File Copy or move one or more files to a shared folder where they can
be accessed by your business community. You can copy or move
a file generated by other activities in the automation script and
overwrite an existing copy of a destination file.
Toad for Data Analysts User Guide 74
Automate

Activity Description

Review the following for additional information:

l Source fileSelect a single file to copy, or use an asterisk
(*) as a wildcard to select multiple files in the same
directory to copy.
l Copy nameEnter the name. You can use a variable in
this field by entering the number sign before and after the
variable (#VariableName#).
l SuffixSelect a suffix to append to the file name. The
suffix can be the date and time that the file was generated
or the content of a variable that you define with the Set
Variable system activity. See "Use System Automation
Activities" (page 79) for more information.
l Move/CopySelect Move to move a file from the source
folder to a destination folder. Select Copy to copy the file
to the destination folder.
Notes:
l If you want to use this activity for files generated by other
automation activities, those activities must precede this
one. The filenames and paths specified should match the
directories and names displayed in properties for the
preceding activities.
l You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

Delete File Delete one or more files from a specified location. You can use
this activity to delete files that are created earlier in the script.
Note: You can use an asterisk (*) in the FileName field as a
wildcard to select multiple files in the same directory to delete.

Log Comment Writes a comment to the scripts's log.

Zip Files Create a zip file and add files to it. Files generated with other
activities can be added to the zip file. You can then email the zip
file to colleagues.
Review the following for additional information:
l Archive nameSelect a location and name for the zip file.
You can use a variable in this field by entering the number
sign before and after the variable (#VariableName#).
l EncryptionSelect whether to create a zip file without
encryption (Standard) or to encrypt the zip file.
Note:If you encrypt the zip file, you must have a zip
utility that can support 128-bit or 256-bit decryption.
Toad for Data Analysts User Guide 75
Automate

Activity Description

l Zip all files in this directorySelect a directory. All files

in the directory will be included in the zip file.
l Source filesSelect one or more files. You can select files
that are generated by the automation script.
Notes:
l If you want to use this activity for files generated by other
automation activities, those activities must precede this
one. The filenames and paths specified should match the
directories and names displayed in properties for the
preceding activities.
l You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

Find and Replace This activity opens one or more files and performs a find and
replace within those files. You can write the results to a different
location and file name.
Review the following for additional information:
l Find/ReplaceYou can have multiple Find/Replace tasks
within one activity. You can specify a different set of
properties for each Find/Replace task.
l Source fileSelect the file in which to perform the find
and replace activity. To select multiple files for one
Find/Replace task, use standard wildcard characters in the
file name.
l FindEnter the content to find.
l Replace withSelect the type of replacement content: a
value, contents from a file, or a variable.
l Set valueEnter the replacement value, enter the
replacement variable, or select a file containing
replacement content.
You can use a variable in this field by entering the number
sign before and after the variable (#VariableName#). In the
following example, if variable X has a value of 10, the
updated file would display "Region 10" instead of
"Region".

l Save fileSelect a location and file name.

Default file is the source file.
Toad for Data Analysts User Guide 76
Automate

Activity Description

l SuffixSelect a suffix to append to the file name. The

suffix can be the date and time that the file was generated
or the content of a variable that you define with the Set
Variable system activity. See "Use System Automation
Activities" (page 79) for more information.
Notes:
l If you want to use this activity for files generated by other
automation activities, those activities must precede this
one. The filenames and paths specified should match the
directories and names displayed in properties for the
preceding activities.
l You can only use one variable per field or file name (a
suffix counts as one variable for a file name).
l Use drag and drop or up/down arrows to change the order
of multiple Find/Replace tasks in one activity.

Send Email Send an email to notify yourself or colleagues about the

automation script status. The message automatically includes
execution status for each activity that precedes the email activity.
You can also attach files generated by other activities and include
a log file or error messages in the email.
Note: To use this activity, an SMTP service must be running.
Review the following for additional information:
l Enter recipient email address, subject line, and body text.
l Email Server SettingsSpecify SMTP server name and
port.
Default settings are the Email Server Settings specified in
Settings properties.
l Add AttachmentsClick to add files created by this script
or to browse for other files to add as attachments.
l Use file for bodySelect a file to use as the body of the
email. This is useful if you need to send an email to a
mobile device that does not support attachments. For
example, you could send the results of an Execute Script
activity in the body of the email.
If you use the Toad Report activity, you can select
HTMLas the output format type. You can then select that
HTML file as the body for the email to produce a more
professional looking email version of the report.
You can also customize the file with the Find and Replace
activity.
Notes:
Toad for Data Analysts User Guide 77
Automate

Activity Description

l For the To, CC, Subject, and Body fields: You can use a
variable in this field by entering the number sign before
and after the variable (#VariableName#).
l You can only use one variable per field or file name (a
suffix counts as one variable for a file name).

FTP File Upload or download a file using an FTP or SFTP connection.

Review the following for additional information:
l Select an FTP connectionSelect an FTP connection or
define a new connection.
l Transfer ONLY ifSelect this option to set conditions for
FTP transfer, and then select a condition from the list. If
you select this option, the FTP activity only runs if the
conditions you specify are met. For example, you would
select remote file exists if a vendor uploads a file to the
FTP site containing a mailing list
l Local directoryIf you selected local directory exists or
local file exists, select the local directory to check.
l Local fileIf you selected local file exists, enter the name
of the local file.
l Remote directoryIf you selected remote directory exists
or remote file exists, select the remote directory to check.
l Remote fileIf you selected remote file exists, enter the
name of the remote file.
l Define OperationsReview the following for additional
information:
o Use file maskSelect this option if you want to
match files that use the file mask specified in the
File mask field at the bottom of this page.
o Move filesSelect whether to move the files from
the source location to the target location when
uploading or downloading the files.

Run Automation Run another automation script in your current automation script.
Script Review the following for additional information:
l Automation scriptSelect an automation script (.tas file).
Toad for Data Analysts User Guide 78
Automate

Activity Description

l Return codeEnter a variable name, such as "RC," for the

return code. Return code values are:
o 0 = Successful execution
o 999 = An error occurred during execution
o 111 = An error occurred, but you selected continue
on error.
You can use this variable with the If..Condition activity.

Compare Data Open a Toad data compare project and export the contents as a
PDF, HTML, Excel, CSV, RTF, or MHT file.
l Project fileSelect a Toad data compare project file.
l Report fileSelect a file location, file name, and file type
for the export file.
l SuffixSelect a suffix to append to the file name. The
suffix can be the date and time that the file was generated
or the content of a variable that you define with the Set
Variable system activity. See "Use System Automation
Activities" (page 79) for more information.

Visualize Data Open a Toad data visualization project, refresh the chart, and
export contents as a PDF, HTML, image, Excel, RTF, or MHT.
l Data Visualization documentSelect a Toad data
visualization file (.tdv).
l Output fileSelect a file location, file name, and file type
for the export file.
l SuffixSelect a suffix to append to the file name. The
suffix can be the date and time that the file was generated
or the content of a variable that you define with the Set
Variable system activity. See "Use System Automation
Activities" (page 79) for more information.

Notes:
l StatusSelect Enabled to include the activity in script execution. Select
Disabled to disable the activity, for example, when testing other activities. Or
right-click the activity in the design window and select/deselect Enabled.
l Stop on ErrorAllows you to select, for each activity, whether to stop or
continue execution if Toad encounters an error.
l Select the Log tab to review a script's execution log.
l Automation does not support positional parameters denoted by a question mark.
Toad for Data Analysts User Guide 79
Automate

Use System Automation Activities

You can use the following activities in automation scripts.

Tip: You can save an activity and its properties as a template to reuse in other scripts. Right-
click the activity in the design window and select Save As Template. After you create the
first template, a Templates toolbox displays.

Activity Description

Run Program Run a program with optional command-line arguments. Review the
following for additional information:
l ProgramSelect a .bat or .exe file.
l ArgumentsEnter command-line arguments. You can also enter
a variable, such as #sleep# in this field.
Note:If you want to run a macro in Access, enter
databasename /x macroname in this field. For example, if you
have a macro that beeps and runs in your Northwind database,
you would enter Northwind 2007.accdb /x beep.
l Run DirectorySelect the directory to change to when running
the program.
l Return Code VariableEnter a name for the return code
variable. You can use this variable with the If..Condition
activity.
l VerbEnter verbs used when running the program, such as
"Print".
l Wait for program to exitSelect this option to pause if there is
an error. Select duration of wait time in minutes.
Note: If the script opens a command-line window, you must manually
close the window once the script completes.

Set Variable Add one or more variables to the script. When you execute the script,
Toad replaces the variable with the defined value. With this feature,
you can update information that may be different each time you run
the script, such as the department name, revenue, fiscal quarter, or
product name.
Review the following for additional information:
ValueSelect this option to specify a value for the variable or to build
a variable expression. Click to build an expression. Build your
expression by selecting from the list of variables, operators, and
functions. (Click a list name in the left pane to display the items in the
right pane. Double-click an item to add it.) Click Test to test the
expression. See the following link for more information on VBScript
functions: http://www.w3schools.com/VBscript/vbscript_ref_
Toad for Data Analysts User Guide 80
Automate

Activity Description

functions.asp
SQLSelect or enter a variable value, you can enter a SQL statement
to use as the variable. If you enter a statement, the value from the first
row and column returned in the query is used as the variable value.
This is useful if you need a variable with a date.
See "Use Variables in Automation" (page 83) for more information.
Note: You can only use one variable per field or file name (a suffix
counts as one variable for a file name).

If..Condition Execute activities conditionally based on the value of a variable. For

each condition you can define unique activities, such as connecting to
a database, generating files, and sending emails.
To use this activity you must define a variable in the automation script
with the Set Variable activity.
This activity can have one or more conditions. To delete a condition,
select it and press DELETE. To add a condition, right-click the
If..Condition.. activity and select Add Branch. If you have multiple
conditions, they do not have to be mutually exclusive. Multiple
branches can be true.
l Build condition expressionTo define a condition, enter the
variable name and expression in the expression field. Build
your expression by selecting from the list of variables,
operators, and functions. (Click a list name in the left pane to
display the items in the right pane. Double-click an item to add
it.) Click Test to test the expression. See the following link for
more information on VBScript functions:
http://www.w3schools.com/VBscript/vbscript_ref_functions.asp

While.. Execute activities while the variable condition is true. The activity
ends when the condition becomes false, or when it completes the
selected number of loops.
To use this activity you must define a variable in the automation script
with the Set Variable activity.
This activity can have one or more conditions. To delete a condition,
select it and press DELETE. To add a condition, right-click the
If..Condition.. activity and select Add Branch. If you have multiple
conditions, they do not have to be mutually exclusive. Multiple
branches can be true.
Review the following for additional information:
l Build condition expressionTo define a condition, enter the
variable name and expression in the field. Build your
expression by selecting from the list of variables, operators, and
functions. (Click a list name in the left pane to display the
Toad for Data Analysts User Guide 81
Automate

Activity Description

items in the right pane. Double-click an item to add it.) Click

Test to test the expression. See the following link for more
information on VBScript functions:
http://www.w3schools.com/VBscript/vbscript_ref_functions.asp
l LoopEnter the number of times to loop the activity. If the
condition never becomes false, Toad ends the activity after this
number. The default is 10.

Loop dataset Execute activities on each row of a data table. The data table must be
the result set from an Execute Script activity that occurs previously in
the automation script. See "Use Database Automation Activities" (page
69) for more information.
You can reference a column in the data table by setting the value of an
initialized variable to 'DataTableName.ColumnName'. To initialize a
variable, your script must have two different Set Variable activities.
The first Set Variable activity defines the variable value with a
numeric value (such as 0 or 1.53), and the second defines it with the
column variable name.
For example, assume you want to perform a set of activities on each of
your company's products. You add the following activities and values:
l Execute ScriptExecute a script that returns product IDs. You
enter ProductIDTable in the Results variable field.
l Set VariableAdd activity to give the variable an initial value.
You enter ID in the Name field and 0 in the Value field.
l Loop datasetLoop based on the dataset from the Execute
Script activity. You enter ProductIDTable in the Data Table
field.
l Set VariableAdd a second variable activity to reference the
Product_ID column in the data table. You enter ID in the Name
field and ProductIDTable.Product_ID in the Value field. This
redefines the values of the ID variable to the values in the
Product_ID column.
Toad for Data Analysts User Guide 82
Automate

Activity Description

See "Use Variables in Automation" (page 83) for more information on

a scenario that uses this activity.

Pause Stops an activity for a set number of seconds before continuing. This is
useful, for example, if you are using parallel activities and need to
pause one branch while waiting for results or the complete execution
of another branch.

Group Use this activity to group and organize two or more activities together.
Activities

Parallel Run two or more activities in parallel. After adding a parallel activity
to the design pane, you can right-click it to add additional branches for
parallel activities.

Notes:
l StatusSelect Enabled to include the activity in script execution. Select
Disabled to disable the activity, for example, when testing other activities. Or
right-click the activity in the design window and select/deselect Enabled.
l Stop on ErrorAllows you to select, for each activity, whether to stop or
continue execution if Toad encounters an error.
l Select the Log tab to review a script's execution log.
l Automation does not support positional parameters denoted by a question mark.
Toad for Data Analysts User Guide 83
Automate

Use Variables in Automation

Variables are a powerful feature that allow you to change data in your script or use a dataset
collected from an activity in the automation script. For example, you can use variables to
perform the following tasks:

l Send an email to a group of people where the list of recipients is automatically

selected with a query.
l Generate repetitive reports where only the product number, date, region, or other
single element changes.
l Customize file names by including a variable in the file name or automatically
including the date that the automation script ran.
l Find content in a file and replace it with the value of a variable.

Note:You must surround a variable name with the # sign (for example, #sleep#).

Generate Reports per Product

(Use the Loop Dataset Activity)
This scenario describes generating a report for each product, but you can use variables for a
variety of reporting purposes:

l Report on warehouse inventoryquery warehouse inventory with the inventory

number as the variable, and then use the If..Condition.. activity to create different
reports for items with no inventory, low inventory, and high inventory.
l Report on revenue for each fiscal quartercreate a query with the fiscal quarter as
the variable.
l Report on revenue per sales personcreate a query with the sales person's name or
identification as the variable.

Scenario
Your Sales Manager wants a separate sales report for each of the
company's products every week. He wants you to email the reports to
him after they are generated.
To provide the reports to the Sales Manager, you need to create the
product queries and the sales report. Then, you can use them in an
automation script to run the queries, generate reports, and email the
Sales Manager every week.

To generate reports per product

1. Use the Query Builder to create a query that returns the product IDs.
2. Save the query and name it ProductIDQuery.tsm.
Toad for Data Analysts User Guide 84
Automate

3. Use the Query Builder to create a query that returns the sales information for products
and enter the following search criteria in the specified columns:

Column Search Criteria

Product_ID Click in the Where Condition field. Select = and

then Constant. Enter :ID in the field to define the
variable.

Order_Date Click in the Where Condition field. Select the Date

Range tab and then Last week.

4. Save the query and name it ProductSalesQuery.tsm.

5. Click Run Query and enter a value for the ID variable. The query results display.
6. Right-click the query results and select Send To | Data Report Designer.
7. Create the data report.
8. Save the report and name it ProductSalesPerWeek.tdr.
9. Close the report.
10. Click Automate to create a new automation script.
11. Click the Execute Script activity to add it to the Design pane and complete the
following fields:

SQLfile Select ProductIDQuery.tsm .

Variable Enter ProductIDTable.

12. Click the Set Variable activity and complete the following fields:

Name Enter ID.

Variable value Enter 0. Entering a number initializes the variable,

which is required before you can redefine the value to
another variable.

13. Click the Loop dataset activity and enter ProductIDTable in the Data Table field.
This loops activities on the content of the ProductIDQuery.tsm query.
14. Click the Set Variable activity to add a second variable and drag it into the Loop row.
15. Complete the following fields for the new Set Variable activity:

Name Enter ID.

Variable value Enter ProductIDTable.Product_ID. This uses the

content of the Product_ID column in the
ProductIDTable table as the values for the variable.
Toad for Data Analysts User Guide 85
Automate

16. Click the Database Connection activity and drag it into the Loop row beneath the Set
Variable activity.
17. Click the Toad Report activity and drag it into the new Database Connection activity.
18. Complete the following fields in the Toad Report activity:

Report files Select ProductSalesPerWeek.tdr.

Export files Select the file location and enter SalesForProduct#ID#

for the file name. When the automation script runs, it
replaces #ID# with the variable value.
Note: You can only use one variable per field or file
name (a suffix counts as one variable for a file name).

19. Click the Send Email activity and drag it beneath the Database Connection activity in
the Loop row.
20. Enter the following information and then complete the remaining required fields for
the Send Email activity:

To Enter the Sales Manager's email address.

Subject Enter Weekly sales report for product #ID#. When the
automation script runs, it replaces #ID# with the
variable value.

Body Enter the following: Attached is the weekly sales report

for product #ID#. See the attached file.

Add Attachments Select the file created in the Toad Report activity and
click Add.

21. Click Test to ensure that the script works. The following image displays the
automation script in the Design pane:
Toad for Data Analysts User Guide 86
Automate

If ProductIDQuery.tsm returns five product IDs, Toad creates a report and sends an
email for each one. If the first product ID is 101, the first email would have the
following properties:
Toad for Data Analysts User Guide 87
Automate

Attachments SalesForProduct101.xls

Subject Weekly sales report for product 101

Body Attached is the weekly sales report for product 101. See
the attached file.

22. Save the automation script.

23. Schedule the automation script to run weekly. See "Execute Automation Scripts"
(page 90) for more information.

Find Unbatched Transactions

(Use the Row Count Field and If..Condition.. Activity)

Scenario
Your company has a web site that customers use to order products.
The orders are automatically batched, and each order is recorded as a
row of data. When the batch is sent, it updates a column in the order
row.
You need to run a daily report to find orders that were submitted but
not batched. If there are any unbatched orders, you need to send an
email to yourself with a list of the unbatched orders. If there are no
unbatched orders, you need to send an email to yourself so you know
that all orders were batched successfully.

To generate a daily report of unbatched orders

1. Save the query and name it UnbatchedOrders.tsm.

2. Click Automate to create a new automation script.
3. Click the Execute Script activity to add it to the Design pane and complete the
following fields:

Row count variable Enter rc.

SQLfile Select UnbatchedOrders.tsm .

4. Click the If..Condition.. activity.

5. Complete the following steps to define the first condition:
a. Select the first condition and enter rc=0 in the Build condition
expression field.
b. Click the Send Email activity and drag it into the first condition.
c. Complete the required Send Email activity fields and enter No unbatched
orders in the Subject field.
Toad for Data Analysts User Guide 88
Automate

6. Complete the following steps to define the second condition:

a. Select the second condition and enter rc>0 in the Build condition
expression field.
b. Click the Database Connection activity and drag it into the second condition.
c. Click the Select to File activity and drag it into the Database Connection
activity in the second condition.
d. Complete the following Select to File activity fields:

SQLfile Select UnbatchedOrders.tsm .

Export file Click the drop-down and complete the following:

l Excel fileSelect this option, and then
select the file location and enter
UnbatchedOrders_ for the file name.
l Use column names for header rowSelect
this option and select a header row color.
l Add Date/Time suffix to filenameSelect
this option and then select Date in the
drop-down. This option appends the date
the automation script ran to the file name.

e. Click the Send Email activity and drag it beneath the Select to File activity.
f. Enter the following information and then complete the remaining required
fields for the Send Email activity:

Attachments Select the file created in the Select to File activity

and click Add.

Subject Enter #rc# unbatched order(s). When the

automation script runs, it replaces #rc# with the
variable value.

Body Enter the following: There were #rc# unbatched

orders. See the attached file for more information.

7. Click Test to ensure that the script works. The following image displays the
automation script in the Design pane:
Toad for Data Analysts User Guide 89
Automate

If there are no unbatched orders, Toad executes the first condition and sends an email
with "No unbatched orders" in the subject . If there are unbatched orders, Toad
executes the second condition. If there are two unbatched orders and you test on
December 10, 2009, the email would have the following properties:

Attachments UnbatchedOrders_2009-12-10.xls

Subject 2 unbatched orders

Body There were 2 unbatched orders. See the attached file for
more information.

8. Save the automation script.

9. Schedule the automation script to run daily. See "Execute Automation Scripts" (page
90) for more information.
Toad for Data Analysts User Guide 90
Automate

Execute Automation Scripts

You can execute automation scripts on demand from the Automation window or the
Project Manager. You can also schedule scripts to run on a recurring basis at a specific
time. For example, schedule a script that performs long-running tasks to run when database
activity is light.

To schedule an automation script

1. With a script open in Automation, click Schedule in the Wizard bar. A Windows
Scheduler task is created for the script and a task properties window displays. See
Schedule Windows Tasks for more information.
2. Select scheduling options in the Schedule tab of the task properties window.

3. After the script executes, to view the script's execution log, select View | Output or
select the Log tab in the script's open Automation window.

Note: When you view the Toad Event Log in the Output window, all log content
moves to that window. As a result, the log is cleared.

To execute a script from the Automation window

1. Click Test in the Wizard bar. The script is compiled and executes immediately.

2. To view the script's execution log, select the Log tab.

3. If you want to schedule the script, first resolve any problems that caused activities
to fail or disable failed activities. An activity can be disabled from its Activity
Info window.

Tip: To execute a script from the Project Manager, right-click the script and
select Execute.
Appendix: Contact Quest

Contact Quest Support

Quest Support is available to customers who have a trial version of a Quest product or who
have purchased a Quest product and have a valid maintenance contract. Quest Support
provides unlimited 24x7 access to SupportLink, our self-service portal. Visit SupportLink at
http://support.quest.com.

From SupportLink, you can do the following:

l Retrieve thousands of solutions from our online Knowledgebase

l Download the latest releases and service packs
l Create, update and review Support cases

View the Global Support Guide for a detailed explanation of support programs, online
services, contact information, policies and procedures. The guide is available at:
http://support.quest.com.

Toad Community
Get the latest product information, find helpful resources, and join a discussion with the Toad
for Data Analysts team and other community members. Join the Toad for Data Analysts
community at http://tda.inside.quest.com/index.jspa.

Contact Quest Software

Email [email protected]

Quest Software, Inc.

World Headquarters
Mail 5 Polaris Way
Aliso Viejo, CA 92656
USA

Web site www.quest.com

See our web site for regional and international office information.
Toad for Data Analysts User Guide 92
Contact Quest Support

About Quest Software

Quest Software simplifies and reduces the cost of managing IT for more than 100,000
customers worldwide. Our innovative solutions make solving the toughest IT management
problems easier, enabling customers to save time and money across physical, virtual and
cloud environments. For more information about Quest go to www.quest.com.
 export in one click 40

Index in result sets 38

reports tutorial 45
A
Database Diagram
activities, automation 66
tutorial 17
automation 66
Database Explorer
database activities 69
best method for locating objects 10
execute automation scripts 90
filter databases and objects 11
file activities 73
search for objects 16
system activities 79
database objects 10
variables 83
filter schemas 11
B
object explorer 10
build queries
search for 16
create cross-connection queries 23
databases
reverse engineer queries 26
automation activities 69
C
Diff Viewer, data 40
code
E
automating 66
Editor 33
shortcut keys 35
reverse engineer queries 26
view result sets 38
shortcut keys 35
connections
Excel
create ODBC 7
add to Report Manager 51
share for all session windows 9
share linked queries 43
understand 8
export
contact support 91
data with one click 40
cross-connection queries 23
F
D
files
data
automation activities 73
browse parent tables 19

compare differences 40
Toad for Data Analysts User Guide 94
Index

filter tutorial 21

databases and objects 11 R

H reports 51

heterogeneous queries 23 data tutorial 45

I DB2 52

intellisense manage reports 51

shortcut keys 35 MySQL 56

K ODBC 56

keyboard Oracle 56

editor shortcuts 35 publish and share 62

L SQLServer 59

linked queries 43 result sets 38

M reverse engineer queries 26

Master Detail Browser 19 S

O script results 38

Object Explorer 10 scripts

filter databases and objects 11 automating 66

search for objects 16 search 16

object search 16 database objects 16

ODBC shortcut keys 35

create connections 7 SQL

One Click Export 40 automating scripts 66

P shortcut keys 35

parameters SQL Editor 33

in Automation 83 subqueries

Q tutorial 30

Query Builder system automation activities 79

create cross-connection queries 23

reverse engineer queries 26

Toad for Data Analysts User Guide 95
Index

tables

browse data in related 19

tutorials 45

automate queries and email reports 64

create database diagrams 17

create ODBC connections 7

create Toad data reports 45

subquery 30

visually build queries 21

variables

in Automation 83