Dell Toad Data Point database query tool User Guide

PDF

Document

Toad™ Data Point 4.0

User Guide

This product is protected by U.S. and international copyright and intellectual property laws.

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 purchaser’s personal use without the written permission of Dell Inc.

The information in this document is provided in connection with Dell 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 Dell products. EXCEPT AS SET FORTH IN

THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR

THIS PRODUCT, DELL 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 DELL 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 DELL HAS BEEN ADVISED OF THE

POSSIBILITY OF SUCH DAMAGES. Dell 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.

Dell 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:

Dell Inc.

Attn: LEGAL Dept

5 Polaris Way

Aliso Viejo, CA 92656

Refer to our web site ( software.dell.com

) for regional and international office information.

Patents

This product includes patent pending technology.

Trademarks

Dell, the Dell logo, Quest, LiteSpeed, SQL Navigator, vWorkspace, and Toad are trademarks of Dell Inc. and/or its affiliates. Microsoft, Windows, Windows Server, Windows

Vista, Visual Studio, SQL Server, SharePoint, Access and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Oracle is a trademark or registered trademark of Oracle and/or its affiliates in the

United States and other countries. Citrix® and XenApp™ are trademarks of Citrix Systems,

Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. SAP is the registered trademark of SAP AG in

Germany and in several other countries. IBM and DB2 are registered trademarks of

International Business Machines Corporation. MySQL is a registered trademark of MySQL

AB in the United States, the European Union and other countries. Google and Google

Analytics are registered trademarks of Google Inc. PostgreSQL is a registered trademark of the

PostgreSQL Community Association of Canada. Subversion is a trademark of the Apache

Software Foundation. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims any proprietary interest in the marks and names of others.

Toad Data Point 4.0

User Guide

Thursday, June 16, 2016

Introduction

About Toad Data Point

Best Practices

Understand Toad's Workflow

Connect

Create ODBC Connections

Create Oracle Connections

Client Connection or Direct Connection

Configure the Oracle Instant Client

Create an Oracle Connection

Create SQL Server and SQL Azure Connections

Understand Toad Connections

Toad Open Connections

Sharing a Connection Among Windows

Troubleshoot SQL Server® Issues

Connection Issues

Understand

Determine the Best Method to Locate Objects

Object Explorer

Filter Databases and Objects

Types of Filters

Before Creating a Filter

Create Filters

Use Filters

Import/Export Filters

Tutorial: Understand a Table Using the Database Explorer

23

24

29

18

20

13

16

7

10

11

Toad Data Point User Guide

Table of Contents

Search for Objects

Tutorial: Create a Database Diagram to Use as a Query Template

Browse Data in Related Tables

Query

Tutorial: Visually Build a Query

Create Cross-Connection Queries

Considerations and Limitations of Cross-Connection Queries

Reverse Engineer Queries

Considerations and Limitations in the Query Builder

Tutorial: Build a Subquery

About Editing SQL

Configure Editor Options

Editor Shortcut Keys

View Result Sets

Visual Inspection Grid

Troubleshoot Data

Tips for Working with Data

Compare Differences in Data

Export Data with One Click Export

Share Excel Linked Queries

Report

Tutorial: Create a Toad Data Report

Step 1: Run the Toad Data Report Wizard

Step 2: Update Fields

Step 3: Use Styles to Format the Report Appearance

Step 4: Update Bands and Add Controls

Manage Reports

51

54

57

37

39

42

45

48

32

35

37

57

60

62

68

Toad Data Point User Guide

Table of Contents

About Managing Reports

Publish and Share Reports

Automate

Getting Started with Automation

Introduction

The Automation Window

Create a Basic Script

Test and Run Your Script

Schedule Your Script

Automate Exporting to Excel® Reports

Introduction

Create a Simple Excel Report

Create a Multi-Page Excel Report Using One Query

Create a Multi-Page Excel Report Using Multiple Queries

Schedule A Script

Automate Tasks

Use Database Automation Activities

Use File Automation Activities

Use System Automation Activities

Using Variables in Automation

How to Create Variables

How to Use Variables

Variable Scope

92

95

105

81

88

79

81

110

117

118

120

Toad Data Point User Guide

Table of Contents

Execute and Schedule Automation Scripts

About Dell

Contact Dell

Technical Support Resources

Toad Community

Index

121

123

124

125 Introduction

About Toad Data Point

Toad™ Data Point is a multi-platform database query tool built for anyone who needs to access data, understand data relationships, and quickly produce reports.

With Toad Data Point, you can: l

Connect to almost any database or ODBC data source (see the Release Notes for a list of tested ODBC connections) l

Write SQL queries and join data across all platforms l

Automate and schedule frequent and repetitive tasks l

Streamline data collection l

Collaborate with team members l

Export data in a variety of file formats

Toad Data Point provides a full-featured Database Explorer, Query Builder, and Editor for the following databases: l

Oracle ® l

SQL Server ® and SQL Azure l

IBM ® DB2 ® (LUW and z/OS) l

SAP ® ASE, IQ, SQL Anywhere, and HANA l

Teradata ® l

MySQL

Toad Data Point also provides querying and reporting functionality via the following provider types: l

ODBC l

Business Intelligence and NoSQL data sources l

Microsoft ® Excel ® l

Microsoft Access ®

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 System Requirements in the Release Notes. This form of

Toad Data Point User Guide

Introduction 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 the other databases.

Business Intelligence and NoSQL Data Sources

Toad Data Point provides users with the ability to connect to non-traditional data sources, such as Business Intelligence and NoSQL sources. You can connect to these data sources and explore data and objects, query data, report results, and automate tasks.

The following data sources are supported:

Business

Intelligence

NoSQL

Oracle Business Intelligence Enterprise Edition (OBIEE), SAP Business

Objects™, Salesforce ® , Microsoft SQL Server Analysis Services, Azure

DataMarket, Google Analytics™, OData, and SharePoint ®

Azure Table Services, Cassandra™, Cloudera Impala, DynamoDB,

HBASE™, Hive™, MongoDB™

Click here to view a video of this feature.

Best Practices

Toad provides tools that help you succeed in your query and reporting goals. Many of these tools are considered Best Practices and are beneficial for individual users as well as managers.

The following table describes the benefits of using Toad to improve Best Practices:

Best Practice

One tool

Shared connections

Project management

Benefit

Connect to any database type for basic query needs. Using one tool for all platforms makes it easier to learn and train others. Managers can create common files shared by all users. This ensures consistency for connections, queries, and reports.

Easily share connections between users by importing or exporting them.

Organize files and make them easily accessible to provide significant time savings. The Project Manager provides an easy way to group

Database Diagrams, queries, and reports. It also provides the following useful features: l

Create multiple projects to manage and track related tasks.

Double-click files in the project to quickly load them for review or execution. You can also add favorite web sites and directories.

Email files to colleagues or send them to your local network share.

Toad Data Point User Guide

Introduction

Best Practice

Automation

Database

Diagram

Query Builder

Excel

Share Files

Benefit l

Use the To-Do list to track items you need to complete.

Tasks that are frequently repeated can be automated and scheduled using Automation. You can schedule long running queries to execute during off-hours and can automatically export the results to Excel.

You can also add these tasks to the Project Manager, and then doubleclick them to execute them. Automation offers an extension to your work day without you having to be there.

Database schemas can be complex and difficult for new users to understand. The Database Diagram displays the database relationships between tables to reduce the learning curve. It also provides the following useful features: l

Add notes to help users learn more about specific tables and columns.

Hide columns that are rarely used so users can focus on critical information.

Add manual relationships to commonly used joins in queries.

Save, share, or use Database Diagrams as a template for building queries.

Create complex queries visually using the Query Builder. You can also: l

Reverse engineer a query from the Editor.

Create a cross-connection query between different database providers, such as Oracle and DB2.

Add Lookup tables to a column for easy filtering.

Use bind variables to optimize a query.

Annotate tables, relationships, or the actual diagram with notes.

Save or share the query for future use.

Add Query Builder files to the Project Manager for easy access during your sessions.

Build Excel reports and share them with colleagues. The One Click

Export feature offers options for quickly building Excel reports, including pivot tables for data manipulation. If you want data in an exported report to reflect changes to the database, you can use the

One Click Export feature to export the underlying query with the report so it can be refreshed with the latest updates.

Store files and reports in libraries that can be shared with colleagues.

Toad Data Point User Guide

Introduction

Best Practice and Reports

Benefit

You can specify a directory on a network share to share these files with others.

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.

Understand—Successful 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.

Query—Queries 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.

Report—Data 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.

Automate—Queries 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.

Connect

Create ODBC Connections

Toad Data Point allows you to create a connection to a database that supports an ODBC 3.0

or later driver. ODBC connectivity provides basic querying capability, but may not be as full-featured as a native connection in Toad. 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.

Note: Distinct values are not available in Code Completion for ODBC connections.

To create an ODBC connection

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

2. Select ODBC Generic from the Group list box.

3. Click

4. Click Add.

in the Data Source Name field.

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.

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.

7. Specify the connection properties in the Create New Connection dialog. Review the

Toad Data Point User Guide

Connect following for additional information:

General

Use data source name

Data source name

User

Password

Select to display the Data source names.

Do not select this option if you want to display the driver names.

Select the driver or data source name you added in the previous steps.

Database

Enter the user name to use when connecting.

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.

Select a database or schema. Click to create a temporary connection and display available databases/schemas in the dropdown list.

Information

Data

Source

Name

Driver

Advanced

Default

Table

Column

Displays the selected driver or data source name.

Displays the ODBC driver associated with the data source.

Advanced

Options

Category

Specify default options to use when creating a new table.

Column type—Select the default data type to use when creating a table.

Column length—For the selected column type, enter a default column length to use.

Block Cursor Size—Specify the number of rows to return in a single fetch of data from the result set.

Disable multi-threading—Multi-threading is disabled by default. Enable multi-threading only if supported by the driver.

Multi-threading can improve performance, but can also result in unpredictable behavior if not supported by the driver.

Default: Selected

(Optional) Select an existing category or create a new one.

Toad Data Point User Guide

Connect

8. Click Connect to connect immediately while saving the connection information.

Optionally, click Save to save the connection without connecting.

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 Data Point

Create Oracle Connections

You can create a new connection, or connect to an existing connection from the Create New

Connection window.

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

Tip: You can configure Toad Data Point to accept connection information from Toad for Oracle.

Client Connection or Direct Connection

You can connect to your database using a native Oracle database provider in Toad using one of the following methods:

Connection Method Advantages Disadvantages

Client connection

Client tab—Uses an installed Oracle Client or

Oracle Instant Client to establish a connection to the database from Toad.

Supports LDAP Requires an Oracle client

Note: Toad supports Oracle clients and Oracle Instant clients using version 9i or later.

Direct connection

Direct Connect tab—

Uses TCP/IP to connect directly to the database.

Does not require an installed Oracle

Client

Recommended for connecting to

Oracle 8i databases

This method only supports common data types. Some advanced Oracle object types cannot be retrieved when connecting using this method.

This method does not support

LDAP. (To connect using LDAP, use the Client Connection method instead.)

This method cannot be used in a cross-connection query.

Note: Dell recommends using one of the methods described in this table to connect to

Oracle rather than an ODBC driver. Because ODBC connectivity is generic, it is not fullfeatured and may not be as robust as the fully exploited native database provider.

Toad Data Point User Guide

Connect

Configure the Oracle Instant Client

The Oracle Instant client installs only those files needed to connect to your database using

OCI. Because this client does not write to the registry (no ORACLE_HOMES) or add to the environmental path, you must manually set environment variables so the client can be used with Toad.

To configure the Oracle Instant Client to work with Toad

1. Save the Oracle Instant Client files in any location on the computer where Toad is installed.

2. On your Windows desktop, right-click My Computer and select Properties.

3. Select the Advanced tab and click Environment Variables.

4. Click New under System Variables and complete the following:

Variable name

PATH

Variable Value

<Path where Instant Client is installed>;%PATH%

For Example: C:\Program Files\OracleInstantClient;%PATH%

<Path where tnsnames.ora file is installed> TNS_

ADMIN

5. To use the Oracle Instant Client connection in a cross-connection query, you must also install an Oracle ODBC driver. (While the Oracle Client full install includes an

ODBC driver, the Oracle Instant Client does not.)

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

Create an Oracle Connection

To create an Oracle connection

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

2. Select Oracle from the Group list box.

3. Review the following for additional information:

Login Tab

Database name

Description

Select the alias to use when connecting. This list displays aliases from LDAP, as well as any local tnsnames.ora file.

When you initially open the connection dialog, Toad retrieves the list of LDAP names from the LDAP server. Toad caches this

Toad Data Point User Guide

Connect

Password

Connect as

Schema

Explain plan table

Category list and displays it upon subsequent requests, within one Toad session. To refresh the list, click .

Note: If you do not select a database, Toad uses the ORACLE_

SID for the selected home. If an ORACLE_SID value does not exist and you do not specify a database, you cannot connect.

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.

Select whether to connect as either SYSDBA or SYSOPER if you have the appropriate permissions. Otherwise, use the default.

Select a schema if you frequently work in a different schema than the one associated with your user name.

(Optional) Specify the location of an existing explain plan table to use instead of Toad automatically creating one for you when you execute a statement. This is useful if you do not have necessary permissions to create explain plan tables or want to use an existing table.

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.

Select this checkbox if you plan to use Automation to generate reports.

Description

Save password

Oracle

Client Tab

Current home

TNSNames

Editor

SQLNET

Editor

Modify the Oracle home to use, if needed.

Click this button to edit your local TNSNames file.

Tip: You can press CTRL+F to open the Find/Replace window to locate entries in the TNS Names Editor. Pressing F3 locates the next entry that matches your criteria.

Click this button to edit SQLNET.ORA parameters. Before editing this file, you should create a backup copy. See

SQLNET.ORA Profile Parameters in the Oracle documentation

Toad Data Point User Guide

Connect

Direct Tab

SID for more information.

Description

Enter the ORACLE_SID value for the database. This value is specified in the registry under each installed home.

Description Advanced

Tab

ODBC driver

If an Oracle Client is installed, the default is the Oracle ODBC driver.

If an Oracle Client is not installed, the default is the Microsoft

Access ODBC driver.

Tip: You can specify the ODBC driver to use for all connections for this database provider in Tools | Options

| Database | Oracle.

4. Click Connect to connect immediately while saving the connection information.

Optionally, click Save to save the connection without connecting.

Tip: Connections are stored in the connections.xml file and can be found by clicking the

Application Data Directory link in Help | About.

Create SQL Server and SQL Azure Connections

You can create a new connection, or connect to an existing connection from the Create New

Connection window. See "Troubleshoot SQL Server® Issues" (page 20) for more information

about troubleshooting connection issues.

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

Note: For SQL Azure connections: l

To be able to utilize majority of Toad functionality please grant VIEW DEFINITION on the SQL Azure databases you want to work with.

You can login to Windows Azure Platform by selecting Tools | Cloud Computing |

SQL Azure Portal and providing your credentials.

Make sure that no Azure firewall rule restricts your IP address from having access to

Azure server. See "Create and Alter Azure Firewall Rules" in the online help for more information.

To create a new connection

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

Toad Data Point User Guide

Connect

2. Select Microsoft SQL Server or Microsoft SQL Azure from the Group list box.

3. Review the following for additional information:

Login Tab

Server name

Password

Understand Toad Connections

Review this topic to learn about open database connections in Toad.

Toad Open Connections

In Toad, an open connection in the Connection/Navigation Manager represents one or more actual connections to the database or data source. When you open a database connection in Toad: l

Toad creates an initial database connection for general use.

Toad also creates a separate database connection for each Editor (the first time you execute a statement) and for each Data tab in the Database Explorer (the first time you

Toad Data Point User Guide

Connect

19 select the tab and query data).

The connection associated with the window (or tab) remains open until you close the window. If a window has an associated connection, but a statement is not currently executing, the connection is in an inactive state.

To view information for an open connection l

To view the number of actual database connections that exist for a Toad connection, including the number of active connections, place the cursor over the connection in the Connection/Navigation Manager pane or in the connection drop-down list.

To use the Background Processes pane l

When a statement is executing, a progress bar displays in the Status bar located at the bottom of the Toad application window. Click the executing progress bar to open the

Background Processes pane.

To cancel statement execution, use the Background Processes pane.

Note: It is recommended that you cancel only your own processes, because terminating Toad activities could cause unexpected behavior.

Sharing a Connection Among Windows

You can instruct Toad to share an open connection among windows. In this way, the Editor windows and Data tabs can share the same connection when the connection is inactive.

To share a database connection among windows in Toad

1. Select Tools | Options | Editor | General.

2. Clear the checkbox for the Use individual connection for each open editor option.

3. When this option is not selected, Toad attempts to use a single connection for any new windows or query execution. 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.

Toad Data Point User Guide

Connect

If the single connection is in use when Toad attempts to execute it, 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.

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.

Troubleshoot SQL Server

®

Issues

Connection Issues

Review the following solutions to help troubleshoot SQL Server connection issues in Toad.

Issue

Cannot specify a port number when connecting

Cannot connect to a remote instance in SQL

Server 2005

Cause/Solution

Currently, Toad does not have a separate field for specifying a port number.

Solution:

You can connect if you know the port number for the instance by entering the following in the Server name field on the New Connection window:

ServerName,Port or

IPAddress,Port

For example:

10.1.29.129,1234 (where 1234 is the port number of the instance)

Remote connections may not be enabled in SQL Server

2005. Also, named instances are configured to use dynamic ports and select an available port once the SQL Server

Service starts. If you are connecting to a named instance through a firewall, configure the Database Engine to listen on a specific port, so that the appropriate port is opened in the firewall.

Note: Remote connections are disabled by default in the

Toad Data Point User Guide

Connect

Issue

"Path is not of a legal form" error message when connecting or

"Could not find a part of the path

C:\Program Files\Dell

\Toad Data

Point\Template\Scripts\

InitialSqlServer.Sql" error message when connecting

Cannot establish

Named Pipes connection

Cannot establish Azure connection

Cause/Solution

Express and Developer editions of SQL Server 2005.

Solution:

To enable remote connections, see "How to configure SQL

Server 2005 to allow remote connections" at: http://support.microsoft.com/kb/914277

You attempted to migrate settings from a previous install of

Toad to the current install, but the settings file

(InitialSqlServer.Sql) for the previous install was either removed, moved, or corrupt.

You may also receive this error if you installed Toad and migrated settings from a previous version, and later uninstalled the previous version.

Solution:

You must specify a valid location for the InitialSqlServer.Sql

file in Toad.

To specify a valid location

1. Open the SQL Server options page under Tools |

Options | Database | SQL Server.

2. Specify the location for the new install's

InitialSqlServer.Sql file in the Run Script on new

connection field.

By default, this file is located in the following directory:

C:\Program Files\Dell\Toad Data Point version

\Templates\Scripts

Note: Clicking may result in a "Path not found error". If you receive this error, manually enter the location in the field.

If you are trying to connect to the server using Named Pipes,

"Poll service status in connection list" option should be cleared.

Solution:

1. Open the options page under Tools | Options |

Database | General.

2. Clear Poll service status in connection list checkbox.

Failing to establish Azure connection may indicate that your

IP address is restricted from having access to the Azure server.

Solutions:

Toad Data Point User Guide

Connect

Issue

Cannot access some functionality when working with Azure connection.

Cause/Solution

1. Select Tools | Cloud Computing | SQL Azure Portal to login to Azure Portal.

2. Create a firewall rule on the master database, enabling access to current IP address or range. See "Create and

Alter Azure Firewall Rules" in the online help for more information.

To utilize majority of Toad functionality VIEW

DEFINITION grant is required for those databases you want to work with.

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

Column name, but do not know the table name

String of DDL for an object

Dependency for an object

Use this...

Use Object Search

Criteria for excluding objects

Uses and Used By tabs in the Database

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

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. Select View | Object Explorer.

2. Review the following for additional information:

Schema (first field)

Object Filter

(second field)

Select the schema you want to view. You can filter the list of

schemas that display. See "Filter Databases and Objects"

(page 24) for more information.

You can quickly set a filter in this field. To do so, enter a 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 Data Point User Guide

Understand

and Objects" (page 24) 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 the next selected object.

to move 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 32) for more information.

To use a different method to select objects such as tabs, drop-downs, or a tree view, click .

To generate reports, export data, create SQL statements, or send objects to the Project

Manager, SQL Modeler, or Master Detail windows, right-click the objects and select an option.

To open the Background Processes window and cancel a query, click the progress bar at the bottom of the window.

Filter Databases and Objects

Toad allows you to filter the list of databases or objects that display in the Object Explorer.

You can use filters to reduce the number of databases and/or objects to work with.

Types of Filters

You can create a Quick filter by entering a search string in the object filter field. You can also use the Filter dialog (click ) to choose additional filter options. If you use the Filter dialog, you can also name and save your filter.

Filter Type

Quick (unnamed)

Description

Can be used to quickly filter objects for a single connection or schema.

Create a Quick filter by entering a search string in the object filter field.

Behavior

Applies to the current schema (or to objects in the current schema) only.

Once applied, a

Quick filter is in effect on that connection when

Toad Data Point User Guide

Understand

Filter Type Description Behavior you reconnect or relaunch Toad.

Because Quick filters are not named, they cannot be applied to other connections by selecting from the filter list. You must recreate the Quick filter for each connection/schema.

-- same behavior as a Quick filter --

Detailed (unnamed)

Named

Use like a Quick filter, but add more detail by using the Filter dialog to enter filter criteria.

Use this method to create an unnamed database filter.

Create and save named filters to reuse and to apply to other connections of the same data source type.

Once applied, a

Named filter is in effect when you reconnect or relaunch Toad.

Can be re-used on other connections of the same data source type

(DBMS).

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.

Before Creating a Filter

A filter is associated with a specific list of objects from a specific database. Consider the following guidelines when setting filters: l

A filter applied to a set of objects such as tables in one specific database connection is not automatically applied to the list of objects in another database connection.

A filter applied to a list of tables on one schema in the database is not automatically applied to the list of tables for a different schema in the same database.

A filter set for a specific schema or object is applied when altering objects, using the

Toad Data Point User Guide

Understand

SQL Editor, Master Detail Browser, etc., for that schema or object.

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

Create Filters

To create a Quick filter (objects only) l

Enter a search string to use for filtering in the object filter field (below the database field) in the Object Explorer.

Note: As you enter a search string, the currently specified Search Condition displays in a blue banner below the object filter field. This Search Condition will be used in your filter. To change the Search Condition, click the Search Condition drop-down.

and select a different one from

To create a Detailed filter

1. Click beside the database or object filter fields in the Object Explorer.

2. Specify criteria for the filter in the Properties tab. Review the following for additional information:

Search String

Search Condition

Enter a text string and search characters to use for filtering.

Select a search type to use in this filter.

Note: You can set a default value for this field in

Tools | Options | Explorer | General. If you don't specify a default value in Options, this field defaults to the search type you specified the last time you created or modified a filter (includes previous sessions).

Toad Data Point User Guide

Understand

Case Sensitive

Tip: To include in your text string certain characters normally used in search logic, such as the underscore

(_), use one of the following Search Conditions: l

Contains (Exact) l

Starts With (Exact) l

End With (Exact)

In DB2 connections, this property is set to True by default.

3. To create custom SQL, select the SQL tab and then select the Enable custom SQL option. Modify the existing SQL. (The existing SQL reflects the criteria you specified in the Properties tab).

4. Select the Preview tab to review the list of databases or objects that are selected based on your filter criteria.

To create a Named filter

1. Click and create a Detailed filter (see above).

2. Enter a name for the filter and click . Creating a name for the filter allows you to use it on other database connections.

Creating a new Quick filter from a current filter l

If you apply a filter and then enter a search string into the object filter field without completely clearing the current filter in the field, the new search string is applied, as well as the properties specified for the old filter.

If you apply a filter and then completely clear the object filter field before entering a new search string, all properties return to the default values.

Note: The Search Condition also returns to the default value. This default is either the

Search Condition you specified the last time you created or modified a filter or it is the new default you specified in Options.

Use Filters

To use Named filters l

To apply a Named filter, click the down-arrow beside drop-down list.

To clear a Named filter, click the down-arrow beside and select the filter from the and select <None>.

Toad Data Point User Guide

Understand

28 l

To determine if a filter is applied, observe the filter icon.

Icon Indicates

No filter is applied (all databases/objects display).

A filter is applied.

Import/Export Filters

You can export all named filters and you can export all filters defined for the current connection.

To export Named filters or all filters defined for the current connection, click the down-arrow beside in the database field and select Export Filters.

To import filters previously exported from Toad, click the down-arrow beside in the database field and select Import Filters. Browse to and select the filter file

(.tfp) to import.

Tip: Click in the Database Explorer (Viewer) toolbar to clear all database, object, and data filters.

Toad Data Point User Guide

Understand

Tutorial: Understand a Table Using the

Database Explorer

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 CONTACT table and select View Details.

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.

Toad Data Point User Guide

Understand

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.

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":

Toad Data Point User Guide

Understand

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_ID column 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.

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.

Toad Data Point User Guide

Understand

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.

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.

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

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.

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.

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.

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

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.

Toad Data Point User Guide

Understand

To create a Database Diagram to use as a query template

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

2. Select Tools | Database Diagram.

3. Drag the CONTACT table in the Object Explorer to the Diagram pane.

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 screen capture.

Toad Data Point User Guide

Understand

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.

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 the window 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:

Description Object An notation Cache

Share object annotations

Select this checkbox and enter a shared drive location where users can access this file.

Toad Data Point User Guide

Understand

Share hidden column settings

Select this checkbox.

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

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.

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.

Toad Data Point User Guide

Understand

6. From the data grid, you can: l

Edit the data and commit your changes to the database.

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.

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.

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.

Query

Tutorial: Visually Build a Query

The Query Builder enables you to create a query without writing or editing SQL statements.

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. See Building Queries

Visually for more information.

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 select Tools | Query Builder | 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.

You can press CTRL and select a table, and then drag the table into the Editor pane. Click the list to create statements.

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:

Toad Data Point User Guide

Query

Table

COUNTRIES

TIMES

SALES

Column

COUNTRY_NAME

FISCAL_YEAR

AMOUNT_SOLD

Tips: l

To view details for a table in the Diagram, click selected, details for the last selected table display.

(F4). If a table is not 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 Data Point User Guide

Query

9. Click .

The query results display in the Results tab. See "View Result Sets" (page 54) 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.

See Tutorial: Build a Subquery (page 45) for a tutorial on creating a subquery.

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, please see the special considerations listed at the end of this topic.

Note: This feature is available in the Toad Data Point Professional Edition only.

Toad Data Point User Guide

Query

To build a cross-connection query visually

1. Select Tools | 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

Options

Filters

In Cross-Connection Query Mode...

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 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 Tools | Edit | 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

Naming tables and views

In Cross-Connection Query Mode...

To reference a table or view, you must use a crossconnection 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>.<tab le>

Toad Data Point User Guide

Query

SQL Editor Task

Using alias names

Using code completion

In Cross-Connection Query Mode...

'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).

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.

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

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.

Use the Database Diagram tool to create and save cross-connection relationships, and then send the tables with their relationships already created to the Query Builder.

Considerations and Limitations of Cross-Connection

Queries

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

Consideration/Limitation

Performance concerns

Description

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 Data Point, the enhanced execution engine utilizes several optimizing techniques to improve the performance of cross-

Toad Data Point User Guide

Query

Consideration/Limitation

ODBC driver support

Using an Oracle connection in a cross-connection query

Oracle Direct Connection

Using a Teradata connection in a cross-connection query

Using a MySQL ODBC connection in a crossconnection query

Result sets

Oracle Long Data Type

Description connection queries.

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

To use an Oracle connection in a cross-connection 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.

You cannot use an Oracle Direct Connection in a crossconnection query.

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

To use a MySQL ODBC connection in a crossconnection query, you must specify a database for the connection.

You cannot edit result sets.

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.

Considerations and Limitations in the Query Builder

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

General

Single statement

Description

The Query Builder only supports one statement at a time. If

Toad Data Point User Guide

Query support

Quote identifiers

ODBC support

Excel support

Non-ANSI joins

(Oracle only)

Where Condition

Where condition does not display in the Criteria grid after sending it to the

Query Builder from the Editor

Where condition created in the

Criteria grid of the

Diagram tab disappears

Having Condition

Having condition 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.

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.

You must use ANSI SQL for the query.

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.

When sending a query from the Editor to the Query Builder,

Toad automatically uses ANSI joins. If you use Where clause joins, click to disable ANSI joins. This converts the statement to the correct join.

Description

If you send a query that contains a Where condition from the editor to the Query Builder, it displays in a Global Where clause bubble on the Diagram pane instead of in the Where

Condition field in the Criteria grid.

You can double-click the Global Where Clause bubble in 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.

If you define a Where condition in the Criteria grid and edit any part of the query in the Query tab, the Where condition is removed from the Criteria grid and placed in a Global

Where Clause bubble.

You can double-click the Global Where Clause bubble in the Diagram pane or can click to edit it.

Description

If you send a query that contains a Having condition from

Toad Data Point User Guide

Query does not display in the Criteria grid after sending it to the

Query Builder from the Editor

Having condition created in the

Criteria grid of the

Diagram tab disappears

Query Builder

Diagram Tab

Comments and code regions removed after making changes in the Diagram tab

Same column cannot be used in the criteria grid

Execute with different query in the

Diagram and Query tabs

Save with different query in the Diagram and Query tabs the editor to the Query Builder, it displays in a Global

Having clause bubble on the Diagram pane instead of in the

Having Condition field in the Criteria grid.

You can double-click the Global Having Clause bubble in 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.

If you define a Having condition in the Criteria grid and edit any part of the query in the Query tab, the Having condition is removed from the Criteria grid and placed in a Global

Having Clause bubble.

You can double-click the Global Having Clause bubble in the Diagram pane or can click to edit it.

Description

When reverse engineering a statement from the editor or the

Query tab and switching to the Diagram tab, if the statement contains a block comment or code region and you make a change in the Diagram tab, the comment or code region is removed from the statement.

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

If the query in the Diagram tab is different than the query in the Query tab, executing the query executes the SQL in the

Query tab instead of the Diagram.

The Query Builder saves both the statement and diagram in the same file. The contents of the statement and diagram can be different without losing changes.

To reverse engineer a query

1. Right-click a statement in the Editor, and select Send to Query Builder.See "About

Editing SQL" (page 48) for more information.

Toad Data Point User Guide

Query

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 48) 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 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.

Tutorial: Build a Subquery

In this tutorial you will create a subquery to use to filter your selection of address IDs to only those addresses from specific regions.

To build a subquery

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

2. Select Tools | Query Builder | Query Builder.

3. Drag the ADDRESS table to the Diagram pane.

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

Toad Data Point User Guide

Query l

ADDRESS_ID l

REGION_ID

5. To add a subquery: a. Select the Where field in the REGION_ID column and click . The Where

Condition editor displays.

46 b. Select the IN operator from the list, and then click Subquery.

c. A child Query Builder window displays for you to use to build the subquery.

The child (subquery) Query Builder window includes a Diagram pane, a Criteria pane, and a Queries pane for navigating back and forth

Toad Data Point User Guide

Query between subqueries and the main query.

47 d. Drag the REGION table to the Diagram pane and select the REGION_

ID column.

e. Select the Where field in the REGION_ID column and click . In the Where

Condition editor, select the In comparison operator, select Constant, and select the values 1 and 2.

f. Your subquery window should look something like this:

Toad Data Point User Guide

Query

48 g. 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 identifies the column it is on. Hover over the call-out to view the subquery statement.

7. Click to execute the main query.

About Editing SQL

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

Notes: l

See "Editor Shortcut Keys" (page 51) for more information about keyboard shortcuts

used in the Editor.

Toad Data Point User Guide

Query

49 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 Script Map 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 show the Script Map, Script Results or Group Execute panes for the current Editor window select Editor | Windows | <pane>.

To edit SQL

1. Select Tools | Edit | SQL Editor.

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

Script Map l

Code regions l

Code snippets l

Toad views l

SQL recall l

Add/remove application code l

View Objects at Cursor l

Macros to record keystrokes

3. Click to format the code.

4. Right-click a block of code in the Editor to see additional actions available in the context menu. For example, you can turn a line into comment, uppercase or lowercase it, surround with snippet, set numbered bookmark, collapse or expand nodes, send to

Query Builder and etc. You can also right-click an object (e.g. a table) and manage it as if in the Object Explorer.

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

Toad Data Point User Guide

Query

6. Click to execute SQL on the current server or multiple servers at one time. 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.

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

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.

Editor supports floating window mode.

The script is automatically checked for syntax errors when executing current statement

(F9), checking syntax, changing database, or refreshing the Script Map. The syntax errors are listed in the Script Results pane in the Messages tab.

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.

Configure Editor Options

You can specify options for the look and behavior of the SQL Editor by using the Toad

Options dialog.

To configure Editor options

1. Select Tools | Options.

2. To specify one of the following options, select the corresponding page in the

Options dialog.

Option Description

Display the tabs for the current connection only when

Page in Options

Dialog

Select Environment |

Toad Data Point User Guide

Query

Option Description using Tabbed windows

Change background color of the Editor

Use connection color as background color

Position Editor tab headers vertically

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

Specify options to automatically replace typed text with the correct substitution text

Customize code formatting options including headers and layout characteristics

Page in Options

Dialog

Interface

Select Editor |

General

Select Editor |

General

Select Environment |

Interface

Select Editor |

General

Select Editor | Auto- replace

Select Editor |

Formatter

Click here to view a video of this feature.

Editor Shortcut Keys

You can assign individual shortcut keys in Keyboard options. 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

CTRL+PERIOD

CTRL+MINUS

Description

Displays the code completion list

Execute current statement

Execute all statements, in order, one at a time

Comments the selected line

Toad Data Point User Guide

Query

CTRL+SHIFT+MINUS

CTRL+J

CTRL+M

ALT+PAUSE

Bookmark

CTRL+SHIFT+0-9

CTRL+0-9

Case

CTRL+L

CTRL+U

Clipboard

CTRL+C

CTRL+X

CTRL+V

Code Completion

CTRL+PERIOD

ENTER

CTRL+SPACE

CTRL+<right arrow>

CTRL+<left arrow>

Comment

CTRL+MINUS

CTRL+SHIFT+MINUS

Cursor

HOME

Uncomments the selected line

Collapses all code regions

Expands all code regions

Stops script execution

Description

Sets a numbered bookmark at the selected line

Goes to the numbered bookmark

Description

Converts the selected text to lowercase

Converts the selected text to uppercase

Description

Copies the selected text to the clipboard

Cuts the selected text for pasting in the clipboard

Pastes text from the clipboard

Description

Displays code completion list

Selects an item and close the code completion list

Selects an item without closing the code completion list

Expands a node in the code completion list

Collapses a node in the code completion list

Description

Comments the selected line

Uncomments the selected line

Description

Moves the cursor to the beginning of the line

Toad Data Point User Guide

Query

CTRL+HOME

END

CTRL+END

Debugger

SHIFT+F12

SHIFT+F7

F11

F12

CTRL+B

CTRL+W

Delete

BACKSPACE

CTRL+BACKSPACE

CTRL+SHIFT+DELETE

Find and Replace

CTRL+F

SHIFT+F3

CTRL+G

CTRL+I

CTRL+SHIFT+I

Indent

TAB

Moves the cursor to the beginning of the file

Moves the cursor to the end of the line

Moves the cursor to the end of the file

Description

Step from cursor

Step into

Step out

Step over

Run to breakpoint

Run to cursor

Set breakpoint

Add watch at cursor

Description

Deletes the selected text (if text is selected); otherwise, deletes the previous character

Deletes text to the beginning of the previous word

Deletes the entire script

Description

Finds text

Finds the next occurrence of text

Finds the previous occurrence of text

Goes to line number

Performs an incremental search

Performs a reverse incremental search

Description

Indents the selected line

Toad Data Point User Guide

Query

SHIFT+TAB

Macros

CTRL+SHIFT+R

CTRL+SHIFT+P

Miscellaneous

F4+SHIFT

CTRL+D

SHIFT+F8

CTRL+á

CTRL+â

<auto-replace token>+SPACE

CTRL+SPACE

<code snippet shortcut name>+CTRL+SPACE

CTRL+DELETE

Outdents the selected line

Description

Starts/Stops recording a macro

Plays the recorded macro

Description

Invokes objects search

Describes the object next to the cursor

Toggles between the Editor and Data Grid

Sends SQL to Query Builder

Recalls the previous SQL statement

Scrolls up the window.

Scrolls down the window

Automatically replaces a misspelled word, inserts symbols, and expands text.

Note: You can set autoreplace in Tools | Options |

Editor | Autoreplace.

Displays the Code Snippets folder browser

Inserts the code snippet template

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

View Result Sets

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

If you occasionally closed the Results pane, you can restore it by selecting Editor | Windows

| Script Results.

Visual Inspection Grid

You can easily review all (or the selected Result sets) in one Result Sets tab. Left-click and hold Shift or Ctrl to select more than one Result sets of your script. Select All results to

Toad Data Point User Guide

Query

55 review all in one tab.

To enable view of all Result Sets in one Tab

» Check Options | Database | Script results | Enable all results view

Troubleshoot Data

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.

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.

Tips for Working with Data

To...

Pin a result set so it is not overwritten by a subsequent query in the Editor or Query Builder.

Do this...

Click the push pin beside the result set:

Set the value of a cell to null.

Toggle between the Editor and Data Grid.

Add column or group summary values

Apply a summary function to the data (Sum, Min, Max,

Count, Avg).

Press CTRL+DELETE.

Press F6.

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

| Group Panel), you can also add a summary total to grouped records.

Right-click below the

Toad Data Point User Guide

Query

To...

Show or hide columns of data.

Display data in a report, pivot grid, or chart.

Compare differences between two data sets.

Display the data in a grid or card view; grid view is useful for viewing summary information at a glance; card view is useful for viewing information in greater detail.

View multi-line text in the data grid as one-line text separated by spaces.

Do this...

column you want to apply the summary function (but above the

Navigation toolbar) and select an option.

Right-click a column heading in the data grid and select Column

Chooser.

Right-click the data and select Send To

|<option>.

Right-click the data and select Compare To.

Right-click a record and select Show |Grid View or Card View.

Right-click the data and select Show | Multi-line

Text as One-line. When the option is cleared, only the first line of the multi-line text is shown.

To see the full text hover a mouse over a data grid or expand it.

Toad Data Point User Guide

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.

You cannot modify files in the Diff Viewer at this time.

To compare differences in data

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. Review the 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 .

You can also open files to compare by clicking at the top of each pane.

beside the drop-down list l

You can show or hide tables that contain equal records, different records, etc., at any time using the toolbar.

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. Typically, the PIAs are installed automatically when you install Microsoft Office.

Toad Data Point User Guide

Query l

Use the Export wizard if you need to specify column delimiters and advanced field options when exporting data.

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

Excel File

CSV File

HTML File

Excel

Instance

Excel

Instance at active cell

Excel Pivot

Table

Excel Pivot

Table at active cell

Excel

Linked

Query

Excel

Linked

Query at active cell

Description

Export data to an Excel file. The file is automatically saved under a default name in the default export folder.

Export data to a CSV file (comma separated value file).

The file is automatically saved under a default name in the default export folder.

Export data to an HTML file. The file is automatically saved under a default name in the default export folder.

Export data to an Excel instance. Data is copied to a clipboard, Excel is launched, and a worksheet is populated with data. You can save the worksheet under a name and folder you specify or save it in the default export folder.

Export data to an active cell in Excel. First open Excel and select a cell. Then select the Excel Instance at

active cell option.

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

Table report with external data.

Export data to an active cell for an Excel Pivot Table report. First open Excel and select a cell. Then select the Excel Pivot Table at active cell option.

Export the underlying query for data to Excel.

Export the underlying query for data to an active cell in

Excel. First open Excel and select a cell. Then select the

Excel Linked Query at active cell option.

Toad Data Point User Guide

Query

Icon Option

Excel

Linked

Query with pivot table

Excel

Linked

Query at active cell with pivot table

Excel

Column

Chart

Description

Export the underlying query for data to an Excel Pivot

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

Export the underlying query for data to an active cell for an Excel Pivot Table report. First open Excel and select a cell. Then select the Excel Linked Query at

active cell with pivot table option.

Export data to an Excel chart instance. Data is copied to the clipboard, Excel is launched, and a chart is 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 60) 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."

Tips: l

To specify a default export folder, go to Tools | Options | Environment

| One Click Export.

To always open a Save File dialog when exporting using One Click Export, go to

Tools | Options | Environment | One Click Export and select the option. This allows you to always customize the file name.

Toad Data Point User Guide

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.

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 Data Point User Guide

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.

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.

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

Step 2: Update Fields

Step 3: Use Styles to Format the Report Appearance

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. See About Designing Toad Data

Reports for more information.

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.

Toad Data Point User Guide

Report

3. Click to include all columns in the report and click Next.

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 Sum and 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.

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

FISCAL YEAR

Band groupHeaderBand2

Name

Fiscal Year

Toad Data Point User Guide

Report

Field

SUM(SALES.AMOUNT_SOLD)

Avg

Band groupHeaderBand2 groupFooterBand1

Name

Sales Amount

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-toupdate 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 Data Point User Guide

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

Name

Background Color

Border Color

Borders

Font

Second Style

Name

Border Color

Borders

Font

Third Style

Name

Background Color

Font

Foreground Color

Fourth Style

Name

Font

Foreground Color

Properties

OddRow

WhiteSmoke

MidnightBlue

Bottom

Tahoma, 10pt

Properties

EvenRow

MidnightBlue

Bottom

Tahoma, 10pt

Properties

TableHeading

MidnightBlue

Tahoma, 10pt, bold

White

Properties

CountryName

Tahoma, 14pt, bold

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 Data Point User Guide

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

SOLD)] in detailBand1:

Field

Even Style

Odd Style

Property

EvenRow

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 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 Data Point User Guide

Report

4. Click Preview.

The print preview displays with the following layout:

Toad Data Point User Guide

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 Data Point User Guide

Report

69 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

Value

Select the direction of variable from the list.

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.

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

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

Activity

ADMIN_LIST_

HIST_V82

Database

Partitions

DB Manager

Description

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.

Displays information from the database history table for the DB2 for LUW database partition to which Toad is currently connected.

Toad uses the ADMIN_LIST_HIST table function to generate this report.

Shows information about each database partition on the current

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

Lists the database manager configuration parameters and their

Toad Data Point User Guide

Report

Report Name Description

Config Info

HEALTH_

CONT_HI

HEALTH_

CONT_HI_HIS

HEALTH_

CONT_INFO values defined for the current DB2 for LUW database.

Shows the current "health" status of all containers that tablespaces in the current DB2 for LUW database use. Toad uses the

HEALTH_CONT_HI table function to generate this report.

Shows a "health" history for all containers that the tablespaces in the current DB2 for LUW database use. Toad uses the HEALTH_

CONT_HI_HIS table function to generate this report.

Identifies the containers that tablespaces in the current DB2 for

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_

HI_HIS

Shows the "health" history of the current DB2 for LUW database.

Toad uses the HEALTH_DB_HI_HIS table function to generate this report.

HEALTH_DB_

HIC

HEALTH_DB_

HIC_HIS

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

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

HEALTH_DB_

INFO

HEALTH_DBM_

HI_HIS

HEALTH_DBM_

INFO

HEALTH_TBS_

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

Shows the "health" status for the current DB2 for LUW instance.

Toad uses the HEALTH_DBM_HI table function to generate this report.

Shows a "health" history at the database manager level for the current DB2 for LUW instance. Toad uses the HEALTH_DBM_

HI_HIS table function to generate this report.

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

Shows the "health" status of all tablespaces in the current DB2 for

Toad Data Point User Guide

Report

Report Name

HEALTH_TBS_

HI_HIS

HEALTH_TBS_

INFO

Index Statistics

Installed DB2

Products

Installed DB2

Products_V82

Description

LUW database. Toad uses the HEALTH_TBS_HI table function to generate this report.

Shows a "health" history for tablespace in the current DB2 for

LUW database. Toad uses the HEALTH_TBS_HI_HIS table function to generate this report.

Shows the highest current alert status for each tablespace in the current DB2 for LUW database. Toad uses the HEALTH_TBS_

INFO table function to generate this report.

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.

Lists the DB2 for LUW 9 products currently installed on your 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

Lists the DB2 for LUW 8 products currently installed on your system. Toad uses the ENV_GET_PROD_INFO table function to generate this report. Products can include the following: l

ADCL DB2—Application Development Client l

ADMCL DB2—Administration Client l

CONEE DB2—Connect Enterprise Edition, DB2 Connect

Unlimited Edition, or DB2 Connect Application Server

Edition l

CONPE DB2—Connect Personal Edition l

CUBE DB2—Cube Views l

DLM DB2—Data Links Manager l

ESE DB2—Enterprise Server Edition l

EXP DB2—Express Edition or DB2 Express Edition processor option l

GSE DB2—Spatial extender l

PE DB2—Personal Edition l

QP DB2—Query patroller l

RTCL DB2—Run time client l

WM DB2—Warehouse Manager

Toad Data Point User Guide

Report

Report Name

Instance

Information_V82

Recommendations for Activity

Reports

SNAP_GET_

CONTAINER _

V82

SNAP_GET_DB_

V82

SNAP_GET_

DYN_SQL_V82

SNAP_GET_

TAB_V82

SNAP_GET_

TBSP_PART_

V82

SNAP_GET_

TBSP_V82

SNAPSHOT_

AGENT_V82

Description l

WSUE DB2—Workgroup Server Unlimited Edition

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

Provides recommendations (in English) for the various activity reports that the activity monitor uses. Toad uses the AM_BASE_

RPT_RECOMS table function to generate this report.

Displays information and statistics about each container that tablespaces in the current DB2 for LUW 8 database use. To generate this report, Toad uses the SNAP_GET_CONTAINER table function to retrieve information from the tablespace_ container logical data group.

Lists information and statistics captured for the current DB2 for

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.

Lists statistics and information about the dynamic SQL statements 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.

Lists information and statistics about the tables in the current DB2 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.

Lists information and statistics for the database partitions that make up each tablespace in the current DB2 for LUW 8 database.

To generate this report, use the SNAP_GET_TBSP_PART table function to retrieve information from the tablespace_nodeinfo logical data group.

Lists information and statistics for each tablespace in the current

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.

Lists the agents working for the various applications connected to 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.

Toad Data Point User Guide

Report

Report Name

System

Information_V82

Table Statistics

Column View

Table Statistics

Description

Displays information about the operating system in which the current DB2 for LUW 8 database operates and about the CPUs configured on this operating system. Toad uses the ENV_GET_

SYS_INFO table function to generate this report.

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.

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

Help Topic

Description

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

Customer orders

Customer list

Items to order

Description

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

Displays a list of customers from the Toad sample database.

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

Toad Data Point User Guide

Report

Oracle Reports

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

| Reports Manager).

Cluster Reports

Report Name

Clusters

Description

Displays cluster information, including the cluster type, definitions, storage parameters, and affected tables.

Other Reports

Report Name

Invalid objects

Loads into shared pool

Description

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

Displays packages that have been loaded five or more times, into the

Oracle shared pool.

Note: You must have DBA privileges for this report.

Displays any objects in the SYSTEM tablespace that are not owned by SYSTEM.

Non-system objects in

SYSTEM tables

Oracle initialization parameters

Tablespaces near capacity

Total shared pool reload stats

User hit ratios

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

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

Displays the number of times objects in the shared pool were reloaded.

Note: You must have DBA privileges for this report.

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

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

User resource usage

Sequence reports

Report Name

Sequences

Description

Displays the sequences that are within 10% of the maximum value.

Toad Data Point User Guide

Report

Report Name

Sequences near max

Description

Any sequences that do not have a maximum value set, or those that cycle are excluded from the report.

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.

Stored Program Reports

Report Name

Arguments of stand-alone stored programs

Object type bodies

Object types

Description

Displays any parameters required for the selected stored procedure.

Displays the body or source code for a selected object.

Package bodies

Package specifications

Stand-alone stored programs

Stored functions

Stored object with source

Stored procedures

Synonym Reports

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

Displays the body or source code for a selected package

Displays specifications for a selected package, including whether it is valid and when it was created or last modified.

Displays the source code for a stored program, including the type of program and the last time DDL was generated.

Displays a list of stored functions for a selected owner.

Displays a list of all stored programs including their source.

Displays the source for stored procedures for a selected owner.

Report Name

Synonyms

Description

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

Toad Data Point User Guide

Report

Table Reports

Report Name

Indexes

Non-indexed tables

Table comments

Tables

& columns

Description

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

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

Displays any comments for the selected table.

Tables

& indexes

Trigger Reports

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

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

Report Name

Triggers

& columns

User-defined Reports

Description

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

Description

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

Report Name

Sample

View Reports

Report Name

View comments

Views & columns

Description

Displays any comments for the selected view.

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

Toad Data Point User Guide

Report

SQL Server Reports

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

| Reports Manager).

DBA Reports

Report Name

All jobs

Backup history

Backup status

Current lock report

Database configuration options

Database settings

Database user details

Display errors

Description

Displays all scheduled SQL Server jobs and the job owner, organized by server.

Displays the backup start date, type, and device used for the backup for a specified database for a set number of days.

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

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

Displays configuration options for each database on the specified server.

Drive space usage

Foreign key sequence

Index description

Job details

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

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

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.

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

Displays tables in the order you can either populate or delete from 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.

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

(SQL Server 2000 only) Displays all SQL Server jobs, including whether they are scheduled, enabled, start date and time,

Toad Data Point User Guide

Report

Report Name

Row count for tables with clustered index

Total rows and space used

Description

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

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

Displays users permissions, grouped by role name and object type.

User permissions

Other Reports (SQL Server 2005 only)

Report Name

Configuration change history

Schema change history

Table Reports

Report Name

Indexes

Description

Displays a history of all sp_configure and Trace Flag Changes recorded by the default trace.

Displays a history of all committed DDL statement executions recorded by the default trace.

Non-indexed tables

Table constraints

Description

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.

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

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

Displays any extended properties for a selected table.

Table extended properties

Table relationships

Tables and columns

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

Displays all columns for a selected table, including the data type, default value, whether it allows null values, and for SQL Server

2005 any extended properties.

Toad Data Point User Guide

Report

Report Name

Tables and indexes

Description

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

Stored procedures

Description

Displays stored procedures for a selected database, including their status, status, replication information, schema version, statistics, and procedure text.

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.

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

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

Add reports and files to a ZIP folder or file.

Publish reports and files to Toad Intelligence Central

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

To email from...

Automation

To publish to a central location from...

Project Manager,

Reports Manager

Automation

Do this...

Drag the Send Email activity to the Automation workflow and attach files as needed. The email is sent when the automation script executes.

Do this...

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

Shared. The file is sent to the Toad shared folder specified in

Tools | Options | Environment | Network Share.

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.

Toad Data Point User Guide

Report

To send to a zip file...

Automation

Do this...

Drag the Zip File activity to the workflow. Add reports and files to the Zip file and specify a file name with a .zip

extension. The ZIP file can then be emailed with the Send

Email activity or copied with the Copy File activity.

Do this...

To publish to

Intelligence Central from...

Project Manager,

Reports Manager

Automation

Right-click a file and select Send To | Publish File.

Drag the Publish Files activity to the Automation workflow.

Add reports and files created previously in the script or add other existing files.

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.

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.

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.

Automate

Getting Started with Automation

Summary

This tutorial helps you get started with Automation by giving you an overview of the

Automation module and then guiding you through the process of creating a basic script.

In this tutorial you will learn: l

How to use the Automation window l

How to create a basic script using the Select to File activity l

How to test and run a script l

How to schedule a script l

How to create an activity template to reuse an Automation activity

Watch a video version of this tutorial: Getting Started with Automation .

Introduction

Toad provides an Automation utility that allows you to easily script database activities and schedule them using the windows scheduler. In this way, database tasks can be automated to save you time. Toad Automation can increase your productivity by allowing you to automate tasks that you perform repeatedly.

The Benefits of Using Automation l

Automating repeatable tasks allows you to be more productive and increases your efficiency.

Toad Automation scripts are very flexible and extensible, allowing you to customized them to your needs.

You can create and use variables in Automation scripts. Variables allow you to make your scripts flexible and to customize your scripts to different audience and company needs.

You can incorporate a variety of templates into Automation scripts. Using templates in your scripts can help you get the most out of automating your tasks.

Templates include: Microsoft Excel

® files, Export Wizard templates, or Toad

Report templates. You can even create an Automation activity template allowing you to reuse an activity.

There is no limit to the number of tasks you can include in an automation script.

Toad Data Point User Guide

Automate l

Toad Automation scripts are conveniently scheduled and run by the Windows scheduler. You can track and manage your scheduled scripts using Toad or the

Windows Scheduler interface.

* Did You Know *

Opening the Automation Window

There are several ways to open an Automation window.

To build a script from scratch, use one of the following methods to open an

Automation window: l

Select Tools | Automation.

Click the Automate button in the main toolbar.

Click Automation in the Launch window.

To build a script incorporating your current workflow, use the following steps:

1. In the Query Builder or Editor, build or enter your SQL statement.

2. Click Send to Automation in the Wizard bar. Toad sends your SQL to the

Automation Tutorial (Guided Tour) which opens in a separate window.

3. Select a task and complete the wizard.

4. After you click Finish in the wizard, an Automation window opens containing your new script. The script incorporates your SQL statement and the settings you specified in the wizard.

The Automation Window

1. To get started with Automation, open an Automation window by selecting Tools |

Automation.

The Automation window consists of a Toolbox pane (along the left side of the window), a design pane (top half of the window), and a details pane (bottom half of the window).

Toad Data Point User Guide

Automate

Toolbox—Stores the Automation activities. Click an activity in the Toolbox to add it to the script design pane. Activities are listed by category: Database, File, or System.

Script Design Pane—Graphically displays the script as a workflow. Use the script design pane to build an Automation script. Drag an activity to the design pane to add the activity to a script.

Note: You must drag the activity to one of the Add Activity icons in the

Automation workflow, then release the mouse button after you see the activity's icon displayed in the workflow.

Details Pane—Displays an activity’s settings. Click an activity in the design pane to display its configurable settings in the details pane. Use the details pane to specify the settings for each activity in the script.

2. In the Toolbox, in the Database Activities category, single-click the Select to File activity to add it to the script design pane.

3. With the Select to File activity still selected in the script design pane, view the details pane. The details pane allows you to configure settings for the selected activity. The input fields change depending on which activity is currently selected in the design pane.

Note: The Activity Input tab is the tab where you will specify most of an activity's settings.

Toad Data Point User Guide

Automate

4. Click next to the Select to File activity. Toad uses this icon to indicate that more information is required to complete the activity. Click or hover over the icon to display the missing information. Use this icon to help you determine which input fields are required.

Note: This icon is also used to indicate a validation error, for example, when referencing a variable that has not been created yet.

5. Now click the Settings icon in the design pane. The details pane changes to display input fields for the script’s settings. You can use this area to specify script error handling, logging level, and run mode settings.

6. Click the Stop on Error button, if not already selected. This instructs the script to stop if an error is encountered.

Note: You can also enable or disable the Stop on Error option for each individual activity. If you know that a particular activity will have an error, you can disable the

Stop on Error option for just that activity. This option is located on the Activity Info tab for each activity.

7. In addition to selecting the Stop on Error option, enabling the Send email when

error occurs and Attach log file to email options is also preferred. This can be very useful if your script encounters an error. Enabling your script to send an email notification on error, as well as on success, helps you to feel confident that your processes are running as expected.

If you choose to enable these options, you must specify email settings. To specify email settings, click the Compose Email button.

8. Keep this Automation script window open, and proceed to the next section.

Create a Basic Script

1. If you kept the previous Automation window open, you will have a basic script consisting of one activity, the Select to File activity. Click on the Select to File activity in the design pane.

2. In the Activity Input tab, in the first text box, select a database connection, or use the default. The default database connection for each database activity is always the

Toad Data Point User Guide

Automate

85 currently-active open connection. To select a different database connection, click and browse to a different connection.

Note: If you schedule a script to run against a password-protected database for which you did not save the password in Toad, the script will error. To save the password, right-click the connection in the Connection/Navigation Manager and select

Properties. Enter the password and select the Save Password option.

3. Now select an input. Most activities require an input, and in the Select to File activity the input is a SQL statement. You can input a SQL statement using one of the following methods: l

Manually enter a SQL statement in the editor box (deselect the Link SQL

file option).

Click to browse to and select a SQL file.

Select Link SQL file, then click option retains a link to the SQL file.

to browse to and select a SQL file. This l

Click to open the SQL file (you previously selected) in the Editor where you can modify the SQL.

Select Link SQL file, then click the drop-down list to select a file from the currently open project in the Project Manager.

4. After selecting or entering your SQL statement, now select an output. Select Excel

File in the Type field in the Export File section.

5. Click in the Name field and select a location and enter a name for your new Excel file.

6. You can also add a suffix to the file name. In the Suffix field, click the drop-down to add a previously-used suffix, or click to build an expression. You can use this method to add a variable or a datetime stamp. Appending a datetime stamp to the file name allows you to create a unique file with each script execution.

7. You now have a complete activity, with input, output, and database connection specifications. You can save and reuse this activity in other scripts by saving the activity as a template. To do this, right-click the activity (after configuring all the settings) and select Save As Template. Enter a name for your template and click OK to save it.

Your template now appears in the Toolbox in the Templates category.

Toad Data Point User Guide

Automate

8. Keep the Automation script window open and proceed to the next section.

Test and Run Your Script

1. To test your script, click Run in the Wizard bar.

2. Toad will prompt you to save your script (if you have not already done so). In the

Save As dialog, select a location, enter a file name, and click Save.

3. Toad then validates your entries and compiles the script. If these processes are successful, the script runs.

4. While the script is running, Toad displays your script’s execution progress in the Log tab. The message “Done” indicates script execution is finished.

5. When a script produces an output file, a hyperlink to the output file is included in the

Log. If your script ran successfully, click the output file hyperlink to view the new

Excel file created by your script.

6. Click the Settings icon to return to the script’s settings.

7. If you require a more detailed Log, you can change the logging level. In the Settings’

Activity Input tab, select Verbose from the Logging level drop-down list to create a more detailed log.

Note: If you want to change the location of the Log file, select a new location in the

Logging folder input field.

8. Toad allows you to specify both a Test database connection and a Production database connection for each script. Toad also allows you to specify which connection to run your script against when the script executes. Both of these settings are made in the script’s settings. This feature allows you to easily test your script in a test environment before running your script in the production environment.

Toad Data Point User Guide

Automate

To specify a test and a production database, make the selections in the Connection text box under Test environment and Production environment in the Settings’

Activity Input tab. To select which of these databases to run your script against, select

Test or Production from the Select environment drop-down list.

9. Click the Select to File activity to return to its settings. Then select the

Activity Info tab.

10. If you remember from the overview of the Automation window, Toad allows you to enable or disable each activity in a script. This can be helpful when building a script, as it allows you to test one particular activity at a time by disabling the other activities.

In the Activity Info tab, click Disabled to disable the Select to File activity. Notice that the activity now appears shaded in the design pane. To enable the activity again, click Enabled, or right-click the activity in the design pane and select Enabled.

Schedule Your Script

Once you have thoroughly tested your script, you can schedule it.

1. To schedule your script, click Schedule in the Wizard bar.

2. The Job Manager window opens and a task properties dialog displays. The task properties dialog is pre-populated with the information required to run your script as a scheduled task. You only need to schedule it. (The Job Manager uses the Windows

Scheduler.)

3. To schedule the script, select the Triggers tab. Then select the scheduling trigger and click Edit. In the Edit Trigger dialog, ensure that the On a schedule trigger type is selected. Then specify a frequency, start time, interval, etc.

4. Click OK to save your schedule. Click OK to save and close the task properties dialog.

5. Your task (script) is now listed in the Task List in the Job Manager. Double-click your task in the list to open the task properties dialog again where you can make modifications, such as re-scheduling or changing the script location. Use the Task List to review the status of your tasks (scheduled scripts).

6. By default, the scheduled task runs under your Windows account. If you change your

Windows password, you may also need to update the password in your scheduled task

Toad Data Point User Guide

Automate

(depending on your version of Windows). Click and select the task to update.

Click OK and then enter your password when prompted.

7. After upgrading to a new version of Toad, you must migrate the scheduling tasks to the newer version. See "Upgrade Automation Scripts and Scheduling Tasks" in the online help for more information.

8. Script Execution and Status. When Toad is in the process of executing a scheduled script, you will see the Toad icon in the lower right corner of the Windows taskbar.

To check the status of your scheduled scripts, open the Job Manager (Tools |

Administer | Job Manager) and select the Task List.

Now you have learned how to increase your productivity by using Toad Automation to handle your repetitive reporting and deployment tasks!

Automate Exporting to Excel

®

Reports

Summary

This tutorial walks you through the process of automating the task of exporting query results to simple Excel reports. You will create three different, and very useful, simple Excel reports.

In this tutorial you will learn: l

How to use Automation to export query results to Excel l

How to use the Select to File activity in Automation l

How to automate an Excel report that appends a new worksheet with each execution l

How to automate an Excel report that uses multiple queries to produce multiple worksheets

Watch a video version of this tutorial: Automate Exporting Data to Excel .

Introduction

After creating a result set in Toad, you may need to send the results to your end users. The easiest way to create a report containing query results is to export the data to an Excel file by right-clicking the data grid and selecting Quick Export | File | Excel File. This action creates a basic Excel spreadsheet containing the result set from the data grid.

If you want to create more than a basic spreadsheet, and you want to automate the process,

Toad Automation helps you build a variety of Excel reports, from simple worksheets to complex and attractive Excel reports.

In this introduction to automating Excel reports, you will learn how to automate the process of exporting data to a variety of simple Excel reports.

Note: To learn how to get started with Automation, see Getting Started with

Automation (page 81).

Toad Data Point User Guide

Automate

Create a Simple Excel Report

1. Select Tools | Automation.

2. Click the Select to File activity in the Databases Activity pane of the Toolbox, or drag the activity from the Toolbox to the Automation design window.

3. When the Select to File activity is selected in the design window, the Activity Input tab displays. Select a database connection in the first text box or use the default (the default is the currently-active open connection).

4. Then select a SQL file or enter a SQL statement using one of the following methods: l

Manually enter a SQL statement in the editor box (deselect the Link SQL

file option).

l l

Click to browse to and select a SQL file.

Select Link SQL file, then click to browse to and select a SQL file.

Click to open the SQL file (you previously selected) in an editor where you can modify the SQL.

Select Link SQL file, then click the drop-down list to select a file from the currently open project in the Project Manager.

5. In the Export File Type field, select the Excel File button.

6. Click in the Name field to select a location and enter a name for your new Excel file, or you can select an existing file.

Note: To specify more-detailed options for the Excel file, click the Advanced

Properties button.

Toad Data Point User Guide

Automate

7. (Optional) You can choose to create a unique file by adding a suffix. In the Suffix field, click the drop-down to add a previously-used suffix, or click expression.

to build an

8. Select Overwrite if you want to overwrite the file.

Note: If you did not add a suffix, you can deselect Overwrite to append a new worksheet to the Excel file with each script execution.

9. To save your Automation script, click Save in the Wizard bar. Then select a location and file name for your script.

10. To test your script, clickRun in the Wizard bar.

11. After the script executes, the Log tab displays. Click the hyperlink in the Log to view the Excel file.

12. To learn how to schedule your Automation script, see Schedule Your Script (page 87).

That was simple, wasn't it. Now move on to the next example to learn how to create a slightly more complex Excel report.

Create a Multi-Page Excel Report Using One Query

Suppose you want to create a new report each week from the same query while retaining the previous week’s results. In this case, you want to append each week’s results as a new worksheet to a single Excel file. This is an excellent option if you want to compare the results each week (or each day, month, etc.) to see how the data is changing. (And Toad has several data compare features in the application to let you do that.)

1. Select Tools | Automation to open a new Automation window.

2. Click the Select to File activity in the Toolbox to add it to the Automation design window.

3. Select a database connection.

4. Select a SQL file or enter a SQL statement using one of the methods described in the first example.

5. In the Export File Type field, select the Excel File button.

6. In the Name field, click to select a location and enter a name for your file.

7. Leave the Suffix field blank (adding a date/time suffix could create a new file with each script execution, and this is not the objective in this example).

8. Deselect Overwrite (you do not want to overwrite the file).

9. Now click Advanced Properties. The Advanced Export Properties dialog opens.

10. In the Worksheet name field, enter a name to be used as the base worksheet name.

11. Select Append timestamp to named worksheet. This will append the date and time

(that the data was exported) to the base worksheet name. Click OK to save your settings and close the dialog.

Toad Data Point User Guide

Automate

12. Click Run to save and run your script.

13. Open the Excel file by clicking the link in the Log tab. Notice that the new worksheet’s name includes the base name you specified suffixed with the timestamp.

14. Run the script a second time and open the file. A new worksheet with a new timestamp was added to the Excel file.

The output of this script is one Excel file containing multiple worksheets. Each worksheet contains a result set from one execution of the script. And each worksheet name records the date and time the result set was exported.

Create a Multi-Page Excel Report Using Multiple Queries

Another variation of the multi-page Excel report is to export the results of multiple queries.

Each worksheet in the Excel file will be populated with the result set of a different query.

This can be accomplished by using a SQL file that contains multiple SQL statements as the input file.

1. To start, open a new Automation window.

2. Click the Select to File activity to add it to the design window.

3. Select a connection.

4. Select a SQL file or enter a SQL statement using one of the methods described in the first example. However, this time use a file that contains multiple SQL statements (or enter multiple statements in the editor box).

5. In the Export File Type field, select the Excel File button.

6. Click in the Name field to select a location and enter a name for your new Excel file.

7. Click Advanced Properties and make sure the Worksheet name field is blank.

Note: If the Worksheet name field is not blank, your script will export both result sets into the named sheet, and the second result set will overwrite the first.

8. Selecting to overwrite the existing file or to add a date/time suffix to the file name is optional in this example.

9. Click Run to save and run your script.

Toad Data Point User Guide

Automate

10. Open the new file by clicking the link in the Log tab. Notice that the file contains a separate worksheet for the result set of each query.

The output of this script is one Excel file containing multiple worksheets. Each worksheet contains the result set of a different query.

Schedule A Script

See Schedule Your Script (page 87) to learn how to schedule the Automation script.

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 "Using Variables in Automation" (page 117) 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 can 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: You must surround a variable name with the # sign (for example, #sleep#).

Note: Automation scripts are compatible with the version of Toad in which they are created.

To automate tasks

1. Select Tools | Automation.

2. Click Settings (icon) in the script design window and specify script settings. Enter settings in the bottom pane. Review the following for additional information:

Toad Data Point User Guide

Automate

Activity Input

Tab

Stop or continue on

Error

Send email when error occurs

Use relative path to find files

Embed files into

Automation script

Truncate

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

Select this option to send an email on script error.

If selected, you must also click Compose Email to compose 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.

Select to convert all local file paths to relative paths in all activities in the script (network file paths remain unchanged).

This is useful if you want to share your automation scripts with colleagues or place them on a shared network.

Toad makes the change the next time you run or save the script.

If you deselect this option later, the script reverts back to the original absolute paths.

Note: Toad deselects this option when publishing a script to

Intelligence Central.

Embeds Toad input files into the script. This makes it easier to share the script with colleagues.

Important: To use this option, deselect it, build your script, select input files, then re-select this option. This allows Toad to collect and save the input file paths.

This option embeds Data Compare, Data Cleansing,

Visualization, Pivot Grid, Toad Data Report, and

Import/Export template files. Scripts used by the Run

Automation Script activity are also embedded, as are SQL query files used as input by an Import/Export template.

Important: Files linked using the Link to File option in the

Select to File, Execute Script, and Select to Editor with Results activities are not embedded [.sql, Editor (.tef), and Query

Builder (.tsm) files)].

Toad embeds the files the next time you run or save the script.

If necessary, at a later time you can deselect this option and then re-establish links to the original files.

Note: Toad selects this option when publishing a script to

Intelligence Central.

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

Toad Data Point User Guide

Automate

94 log

Selected environment

Select Test to run your script in test mode using the database connection and other settings specified under Test

environment.

Select Production to run your script in production mode using the database connection and other settings specified under

Production environment.

Note: The default connection is the currently active, open connection.

Root path variable name—Enter a variable name or use the default name. Then use this variable name in your script wherever you want to apply the path defined under Root path in the Test settings and the

Production settings.

Activity Info

Tab

Name Enter a script name.

3. To build a script, single-click an activity in the Toolbox, or drag an activity from the

Toolbox to the Automation script design window. Repeat this process to add additional activities to your script.

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

4. Click an activity in your script workflow in the design window and then specify the activity's properties in the details pane (bottom pane). Repeat this process for each activity in your script. For a step by step tutorial on building an Automation script,

see Getting Started with Automation (page 81).

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

Use Database Automation Activities (page 95)

Use File Automation Activities (page 105)

Use System Automation Activities (page 110)

Tip: You can save an activity and its settings 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:

Toad Data Point User Guide

Automate

Add to Project

Save

Run

Publish

Schedule

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 an automation script (.tas) in a folder on a local or network drive.

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.

To view the script log, select the Log tab or select

View | Output.

Publish script to Toad Intelligence Central.

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 and Schedule

Automation Scripts" (page 121) for more information.

Important: To rename an Automation script file, do so through Toad (File | Save File As), not through Windows Explorer. Renaming a script file using Toad ensures that log files are created correctly and properly synced with their scripts.

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.

Right-click within the script design window and select Print Script to print the script's workflow diagram.

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 settings as a template to reuse in other scripts. Rightclick the activity in the design window and select Save As Template. After you create the first template, a Templates toolbox displays.

Toad Data Point User Guide

Automate

Activity

Select to File

Execute Script

Description

Execute an existing SQL script, Query Builder file, or Editor file and export the results to an Excel, HTML, or CSV file.

1. Select a database connection.

2. Select a SQL file or enter a SQL statement.

Click the drop-down list to select a file from the currently open project in the Project Manager.

Click to browse to and select a SQL file.

Click to open the SQL file in the Editor where you can modify the SQL file.

Enter a SQL statement in the editor. You must first deselect the Link SQL file option.

3. RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

4. Export File Type—Select an export file type.

5. Export File Name—Click a file name.

to select a file location and enter

6. Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

7. Overwrite—Select to overwrite the file. If you did not add a suffix to the file name, you can deselect Overwrite to append a new worksheet to the Excel file with each script execution.

8. Advanced Properties—Click to specify advanced options.

Worksheet name—Enter the worksheet name or select the worksheet from the list. Overwrite must be

deselected to display the list.

To add a worksheet, select Append worksheet from the list and enter a new name.

Append rows—Select to append to the selected worksheet.

Start export at—Enter the column and row position at which to begin the export.

Tip: After exporting your file, you can use a subsequent activity in your script to email the report, to zip the report in a zip folder, or to copy the report to another location.

Execute an existing SQL script, Query Builder file, or Editor file. You

Toad Data Point User Guide

Automate

Activity

Select to

Editor with

Results

Description can save the results of the script in a variable or export the results to

Local Storage or an Intelligence Central dataset.

1. Select a database connection.

2. Select a SQL file or enter a SQL statement.

Click the drop-down list to select a file from the currently open project in the Project Manager.

Click to browse to and select a SQL file.

Click to open the SQL file in the Editor where you can modify the SQL file.

Enter a SQL statement in the editor. You must first deselect the Link SQL file option.

3. Save result set in variable—Enter a name for the result variable, which contains a data table with the results of the execution script.

Tip: You can use the result variable with the Loop Dataset

activity. See "Use System Automation Activities" (page 110) for more information.

4. Local Storage—To export the results to Local Storage, select a database and a new or existing table or snapshot.

5. Intelligence Central—To export the results to Intelligence

Central as a dataset, click Publishing Wizard and specify your publishing options.

Review the following for additional information: l

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Overwrite existing dataset—Select to overwrite an existing dataset with the same name.

Execute an existing SQL script or Query Builder query and save it 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.

1. Select a database connection.

2. Select a SQL file or enter a SQL statement.

Click the drop-down list to select a file from the currently open project in the Project Manager.

Toad Data Point User Guide

Automate

Activity Description l

Click to browse to and select a SQL file.

Click to open the SQL file in the Editor where you can modify the SQL file.

Enter a SQL statement in the editor. You must first deselect the Link SQL file option.

3. Result saved in Editor file—You can select an Editor file from an open project or browse to select a file. Click selected file.

to edit the

Tip: You can use a variable in this field by entering the hash symbol before and after the variable name (#VariableName#).

4. Append results—Select to include the result set in the Editor file.

Review the following for additional information: l

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

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 template—You can select an existing template, edit an existing template, or create a new template.

Tip: You can use a variable in the file name to select an

existing template file by entering the hash symbol before and after the variable name (#VariableName#).

Use Automation Connection—Select this option to use the connection associated with the Export Wizard 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. You can also import data from one database to another.

Review the following for additional information: l

Import template—You can select an existing template, edit an existing template, or create a new template.

Toad Data Point User Guide

Automate

Activity

Toad Report

Description

Tip: You can use a variable in the file name to select an

existing template file by entering the hash symbol before and after the variable name (#VariableName#).

Use Automation Connection—Select this option to use the connection associated with the Import Wizard activity. Clear the checkbox to use the connection associated with the import template.

Use this activity to open a Toad Data Report (executing the query) and then export the results to a file using the layout specified in the

Toad Data Report. Several export file formats are available, including

PDF, HTML, and Excel.

You can also select multiple Toad Data Reports and export the results to a single file.

Note: You must create a Toad Data Report file (.tdr) before you can select it using this activity.

Review the following for additional information: l

Select a connection to execute the Toad Data Report query against.

Add Reports—Click to browse to and select one or more Toad

Data Report files (.tdr). Click the arrow and select From

Project Manager to add the reports in the currently-open project.

Edit Report—Click to edit the selected report.

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Export file—Enter a name and select a file type and location for your export file. You can use a variable in this field by entering the hash symbol before and after the variable name

(#VariableName#).

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Note: In most cases, the script uses the connection you specify in this activity. However, when a Toad Data Report contains a crossconnection query, the cross-database connection in the report takes precedence.

For more information about Toad Data Reports: l

Watch Automation and Toad Data Reports (video).

Toad Data Point User Guide

Automate

100

Activity

Toad Pivot

Grid

Profile Data

Description

Refresh an existing Toad Pivot Grid file and export results to an

Excel, HTML, or CSV 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.

Note: You must create a Toad Pivot Grid file (.tpg) before you can select it using this activity.

Review the following for additional information: l

Connection—Select a connection to execute the Toad Pivot

Grid file against.

Pivot file—You can select a Toad Pivot Grid file from the currently-open project or browse to select a file. Click edit the selected pivot file.

to l

Export file—Enter a name and select a file type and location for your export file. You can use a variable in this field by entering the hash symbol before and after the variable name

(#VariableName#).

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Automate data profiling tasks. This activity profiles data from a selected query and exports a report containing the profiling results.

1. Select a database connection.

2. Select a SQL file or enter a SQL statement.

Click the drop-down list to select a file from the currently open project in the Project Manager.

Click to browse to and select a SQL file.

l l

Click to edit the selected file.

Enter a SQL statement in the editor.

3. To specify options for the profiling task, click Profiling

Options.

4. Create Report—(Required) Select a location, select a file format, and enter a file name for the exported report (PDF,

HTML, etc).

5. Suffix—Select a suffix to append to the file name. Select from

Toad Data Point User Guide

Automate

101

Activity

Clean Data

Description the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

6. Export Data Profiling File—(Optional) Select a location and enter a file name for the Toad Profiling Report file (.tpr).

Note: You cannot attach this file in subsequent activities in the script.

See Data Profiling for more information.

Automate data transformation and cleansing tasks. This activity opens an existing Toad Data Cleansing file, performs the transform and cleansing tasks on the current result set, and exports the modified data to a file, Local Storage, or Intelligence Central.

1. Connection—Select a database connection.

2. Cleaning file—Select a Toad Data Cleansing file or edit an existing file using one of the following methods: l

Click the drop-down list to select a file from the currently-open project in the Project Manager.

Click to browse to and select a file.

Click to edit the selected file.

3. Error options—Click to specify error options.

4. Select one or more of the following actions: l

Export to a file—Select a file, or select a location and enter a new file name. You can use a variable in this field by entering the hash symbol before and after the variable name (#VariableName#).

Local Storage—To export to Local Storage, select or create a database. Then select or create a snapshot or table to receive the modified data.

Intelligence Central—To export the results to

Intelligence Central, click Publishing Wizard and specify your publishing options.

Review the following for additional information: l

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Toad Data Point User Guide

Automate

102

Activity

Visualize

Data

Compare Data

Refresh a

Snapshot

Description

See Transform and Cleanse Data for more information.

Open an existing Toad Data Visualization file (.tdv), refresh the chart, and export contents as a report. Select from a number of output file formats, including PDF and Excel.

Data Visualization document—Select an existing Toad Data

Visualization file.

Output file—Select a file location, file name, and file type for your output file. You can use a variable in this field by entering the hash symbol before and after the variable name

(#VariableName#).

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

See Visualize Data for more information.

Open a Toad Data Compare project (.dcp) and export the contents as a summary report and detailed object reports. Select from a number of output file formats for the summary report, including PDF and Excel.

Data Compare Project—Select an existing Toad Data Compare project file.

Summary Report—Select a file location, file name, and file type for the comparison summary report file.

Object reports folder—Select a destination folder for the detailed object comparison reports generated by the activity.

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Generate sync script—Select a location and enter a file name to generate a synchronization script. Click options for the synchronization script.

to configure l

Execute script—Select to execute the generated script.

Compare result variable—Enter a variable name or use the default. This variable is assigned a value of True or False based on the results of the data comparison.

See Create Data Comparisons for more information.

Use this activity to refresh a snapshot in Local Storage or in Toad

Intelligence Central (TIC). This action will update the snapshot to reflect the current data in the source table.

Select one of the following:

Toad Data Point User Guide

Automate

103

Activity

Database

Connection

Loop

Connections

Description l

Local Storage l

Database—Select the database containing the snapshot to refresh.

Snapshot—Select the snapshot to refresh.

Intelligence Central l

Select a destination—Select the TIC connection containing the snapshot to be refreshed.

Datasource—Select the data source in TIC containing the snapshot to refresh.

Snapshot—Select the snapshot to refresh.

In previous versions of Toad, the Database Connection activity was required in order to specify database connection details.

In the current version of Toad, you can specify the database connection details within each applicable activity, eliminating the need to use the Database activity. You may continue to use the

Database activity if you prefer.

Note: The database connection specified for the Database Connection activity takes precedence over the connection specified for the individual activity.

Loops through multiple connections and executes the activities you specify. Add as many activities as you want to the loop. The Loop

Connections activity can have more than one branch.

Select connections to loop through—Click Add Connections to select one or more connections to loop through.

Connection description variable—Enter a new name for the variable or use the default name. The connection description variable is a SQL-type variable comprised of one row containing the connection information for the current connection.

Use the following column names to gather connection information from the connection description variable. The exact content of each column depends on the provider type.

Column Name

DescriptionLong

ProviderType

Description

Description of the connection details.

Provider type such as SQLServer,

Oracle, or SAP ASE.

Toad Data Point User Guide

Automate

104

Activity Description

Column Name

HostName

UserName

TrueUserName

Database

Description

Hostname or instance for the connection.

User name.

If the connection supports and uses

Windows authentication (e.g., SQL

Server connection) this column contains the current Windows Logon name as: domain\username (e.g.,

"PROD\bgates"). Otherwise, if database authentication is used, it contains the same as the UserName column.

Default Database context for the connection.

Next, add activities to the loop to execute for each connection in the connection list.

Note: The connections you specify in the Loop Connections activity take precedence over any connection specified in an individual activity.

Notes: l

To disable an activity, right-click the activity in the design window and select

Disabled. This is helpful if you want to disable an activity while testing other activities.

The Stop on Error option for each activity allows you to select whether to stop or continue execution if Toad encounters an error during that activity.

To prevent an error in one activity from causing a failure at the script level, clear the Generate Error check box (Activity Info tab) for that activity.

Select the Log tab to review a script's execution log.

In the Suffix field, the drop-down list includes two predefined suffixes (Date and

DateTime). The list also includes any suffixes you have created and saved since installing Toad. To delete a suffix from the list, select the suffix, click , delete the suffix in the Expression field, and click OK.

Automation does not support positional parameters denoted by a question mark.

For each applicable activity, you can specify the database connection in the activity's properties. The default connection is the currently-active open connection.

Toad Data Point User Guide

Automate

105

Activity Description l

The connection associated with an activity takes precedence over the connection information in a report or SQL script, unless the report or SQL script information is a cross-connection query.

Use File Automation Activities

You can use the following activities in automation scripts.

Activity

Copy File

Delete File

Description

Copy or move one or more files to another location (for example, to a shared folder where they can be accessed by your business community).

Review the following for additional information: l

Source file—Select the file to copy.

In this field, you can also use the asterisk (*) and question mark

(?) wildcard characters, as well as variables, in the file name to help you select one or more files (in the same directory) to copy.

To use this method:

1. Specify the file directory by browsing to and selecting one of the files.

2. Then modify the file name in the Source file field using wildcard characters and/or variables.

Copy to folder—Select the destination folder into which you want to copy or move the file or files.

Copy name—To rename the copied or moved file, enter a new name.

Note: This field is only applicable when copying a single source file.

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Delete source file—Select to move the file from the source folder to the destination folder. Deselect to copy the file to the destination folder.

Delete one or more files from one or more specified locations. You can also use this activity to delete files that are created previously in the

Toad Data Point User Guide

Automate

106

Activity

Log

Comment

Zip/Unzip

Files

Description script.

Files to delete—Click Add Files to select one or more files to delete. In the File Collection Editor, do one or both of the following: l

To delete files created previously in the script, select a file in the left pane and click Add.

Note: When a file name is displayed for selection in the left pane, any variable names that are used in the file name are visible (#MyVariable#), but suffixes are not visible.

To select other existing files, click the files.

to browse to and select

In this field, you can also use the asterisk (*) and question mark

(?) wildcard characters, as well as variables, in the file name to help you select one or more files (in the same directory) to delete. To use this method:

1. Specify the file directory by browsing to and selecting one of the files.

2. Then modify the file name in the Files to Delete pane using wildcard characters and/or variables.

Note: As an example of using wildcards and variables, using the file name MonthlyReport_#var#*.xls, where #var# is Feb, would delete all reports whose file name begins with "MonthlyReport_

Feb" in the same directory.

Writes a comment to the scripts's log.

Log message—Enter the text of the comment you want to insert into the log when this activity executes.

Create a zip file (compressed folder) and add files to it. You can add files created previously in the script to the zip file. Use this activity to zip multiple files and then attach the zip file to an email using the

Email activity.

You can also use this activity to unzip a zip file.

Review the following for additional information:

Zip Tab l

Archive name—Select a location and name for the zip file. You can use a variable in this field by entering the hash symbol before and after the variable name (#VariableName#).

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Password—Enter a password if you want to password protect the

Toad Data Point User Guide

Automate

107

Activity

Find and

Replace

Description zip file.

Hide password—Select this option to mask password during input.

Encryption—Select 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.

Zip all files in this directory—Select a directory. All files in the directory will be added to the zip file. You can use both this field and the Source files field to select files to add to the zip file.

Source files—Click Add Files to select one or more files to add to the zip file. In the File Collection Editor, do one or both of the following: l

To add files created previously in the script, select a file in the left pane and click Add.

Note: When a file name is displayed for selection in the left pane, any variable names that are used in the file name are visible (#MyVariable#), but suffixes are not visible.

To select other existing files, click select the files.

to browse to and

In this field, you can also use the asterisk (*) and question mark (?) wildcard characters, as well as variables, in the file name to help you select one or more files (in the same directory) to add. To use this method:

1. Specify the file directory by browsing to and selecting one of the files.

2. Then modify the file name in the Files to Archive pane using wildcard characters and/or variables.

Unzip Tab l

Archive name—Select a zip file.

Password—If password-protected, enter the password.

Extract to folder—Select a location to extract the files to.

To learn how to use the Zip/Unzip Files activity, see the following: l

Automation and the Zip Activity (video)

This activity opens one or more files and performs find and replace actions inside the files. You can write the results to a different location

Toad Data Point User Guide

Automate

108

Activity

FTP File

Description and file name.

Review the following for additional information: l

Find/Replace—You can have multiple Find/Replace tasks within one activity. You can specify a different source file, save file, and action for each Find/Replace task.

Source file—Select the file in which to perform the find and replace action for the selected Find/Replace task.

In this field, you can also use the asterisk (*) and question mark

(?) wildcard characters in the file name to help you select one or more files (in the same directory). To use this method:

1. Specify the file directory by browsing to and selecting one of the files.

2. Then modify the file name in the Source file field using the wildcard characters.

Find—Enter the content to find.

Replace with—Select the type of replacement content: a value, contents from a file, or a variable value.

Set value—Enter the replacement value, select the replacement variable, or select a file containing replacement content.

Save file—Select a location and file name.

The source file is selected by default.

Suffix—Select a suffix to append to the file name. Select from the list of existing suffixes, or click to select a variable or build a new suffix using the expression editor.

Note: Use drag and drop or up/down arrows to change the order of multiple Find/Replace tasks in one activity.

To learn how to use the Find and Replace activity, see the following: l

Automate Find and Replace (video)

Upload or download one or more files using an FTP or SFTP connection. Review the following for additional information: l

Select an FTP connection—Select an FTP connection or define a new connection.

Note: You can define a new connection prior to using the FTP activity by selecting View | FTP Connections.

Transfer ONLY if—Select 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 condition you specify is met.

Toad Data Point User Guide

Automate

109

Activity Description l

Local directory exists—Select this option to transfer only if a local directory exists, then browse to and select the directory.

Local file exists—Select this option to transfer only if a local file exists, then enter the name of the local file.

Remote directory exists—Select this option to transfer only if a remote directory exists, then browse to and select the directory.

Remote file exists—Select this option to transfer only if a remote file exists, then enter the name of the remote file.

Define Operations—Click to specify the files and other options for the FTP upload or download task. Review the following for additional information: o Operation—Select Upload or Download.

o Use file mask—Select this option if you want to select files by using a file mask. Then specify file mask filtering options in the File Mask fields at the bottom of the page.

o Move files—Select this option to move the files from the source location to the target location instead of copying them.

To learn how to use the FTP activity, see the following: l

Automate FTP Upload and Download (video)

Publish Files Publish one or more files to Intelligence Central. You can select files created by previous activities in this script or other existing files.

Review the following for additional information:

Files to Publish—Click Manage Files to select files created previously in this script or to browse for other files to publish. In the File

Collection Editor do one or both of the following: l

Select one or more previously-created files in the left pane and click Add.

Click and then browse to select an existing file.

Publishing Options—Click Publishing Wizard to select an Intelligence

Central connection and specify publishing options.

See Publish to Toad Intelligence Central for more information.

Notes: l

To disable an activity, right-click the activity in the design window and select

Disabled. This is helpful if you want to disable an activity while testing other activities.

Toad Data Point User Guide

Automate

110

Activity Description l

The Stop on Error option for each activity allows you to select whether to stop or continue execution if Toad encounters an error during that activity.

To prevent an error in one activity from causing a failure at the script level, clear the Generate Error check box (Activity Info tab) for that activity.

Select the Log tab to review a script's execution log.

In the Suffix field, the drop-down list includes two predefined suffixes (Date and

Automation does not support positional parameters denoted by a question mark.

Tips: l

For activities in which you can add a suffix to the output file, click suffix using the expression editor.

to build a l

You can use the expression editor to select a variable created in a previous activity or select one of your stored bind variables.

Use System Automation Activities

You can use the following activities in automation scripts.

Activity

Set Variable

Description

Automation variables are a powerful tool that can greatly extend your scripts by adding flexibility and customization. You can use variables to represent and store data that may be different each time the script executes. Variables can be used with almost every Automation activity.

Use this activity to define one or more variables.

Review the following for additional information: l

Variable name—Enter a name for the variable. When you use the variable name later in the script, for example in a file name or in an expression, surround the variable name with the hash symbol (#MyVariable#).

Variable type—Specify a variable type.

SQL—Select SQL if you plan to use the result set of a

Toad Data Point User Guide

Automate

111

Activity

Set Variable

Value

If..Condition..

Description query as the variable value.

DateTime—If you select DateTime variable type, you must use a date/time function.

Variable value—Enter a value or click expression.

to build an l

If you click to build an expression, select from the list of variables, operators, and functions. Click a category in the left pane to display a list of items in the right pane. Double-click an item to add it. Click Test to test the expression.

If you selected SQL as the variable type, the variable value options expand to allow you to specify a query.

Select a database connection, then select a SQL file or enter a SQL statement. Toad uses the result set of the query as the value for your variable.

See "Using Variables in Automation" (page 117) for more information about SQL type variables.

To learn more about variables, see the following: l

Using Variables in Automation (page 117)

Automation and Variables (video)

Use this activity to assign a new value to a variable previously defined in the current script or current activity. You can assign a new value to any variable type, except SQL.

Review the following for additional information: l

Variable name—Select a previously defined variable.

Variable type—Displays the variable type of the selected variable.

Variable value—Enter a new value or click expression.

to build an

See Variable Scope (page 120) in Using Variables in Automation to

learn more about how to use this activity with the Set Variable activity.

Execute one or more activities if a condition you specify evaluates to true. You can add several branches to the If Condition activity to simultaneously evaluate more than one condition.

To learn how to use the If Condition activity, see the following tutorial: l

Using the If Condition in Automation (video)

Toad Data Point User Guide

Automate

112

Activity

Loop Dataset

Description

Use the expression editor to build an expression that evaluates a condition. Typically this includes a variable (user-defined or built-in).

Expression—Build your expression by selecting from the list of variables, operators, and functions. Click a category in the left pane to display a list of items in the right pane. Double-click an item to add it. Click Test to test the expression.

This activity can have one or more branches. To delete a branch, select it and press Delete. To add a branch, right-click the activity (the outside loop) and select Add Branch. If you have multiple conditions, they do not have to be mutually exclusive. Multiple branches can be true.

To learn more about variables, see the following: l

Using Variables in Automation (page 117)

Automation and Variables (video)

Loops through each row in a dataset and performs the activities you specify. The dataset is the result set of a query you provide (the driving query) and is stored in the dataset variable. Add as many activities as you want to the loop. The Loop Dataset activity can have more than one branch.

Tip: You also have the option to select any SQL-type variable created in a previous activity to use as the dataset variable. Activities that create SQL-type variables include Execute Script, Set Variable, or

Loop Dataset.

To learn how to use the Loop Dataset activity, see the following tutorial: l

Automation and the Loop Dataset Activity (video)

Review the following for additional information: l

Dataset variable—Enter a new name for the dataset variable or use the default name.

Select dataset variable—(Optional) You can select one of the

SQL-type variables created in a previous activity to use as the dataset variable.

Connection—Select a connection.

SQL script file—Select a SQL file to use as the driving query.

After the script executes, the result set of the driving query is stored in the dataset variable.

Click the drop-down list to select a file from the currently open project in the Project Manager.

Click to browse to and select a SQL file.

Toad Data Point User Guide

Automate

113

Activity

While..

Description l

Click to open the SQL file (you just selected) in the

Editor where you can modify the SQL.

Note: Click to preview the query results.

Link SQL file—Select to link the SQL script file you selected in the previous step.

SQL script—Enter a SQL statement to use as the driving query

(if you did not select a SQL file).

RowCount variable—Enter a name for the row count variable or use the default. The value assigned to this variable equals

the number of rows returned from the activity. See "Using

Variables in Automation" (page 117) for more information.

Tip: In the Loop Dataset, you can use the following format to filter data from the dataset variable when referencing it: <dataset variable

name>.<filter parameter>.

Example: Loop_data_1_SQL.region_id, where region_ id is a column name

The While activity runs a loop while a condition you specify is true.

The activity ends when the condition becomes false, or when the activity completes the selected number of loops. Each loop executes the activities you specify.

To learn how to use the While activity, see the following tutorial: l

Using the While Loop in Automation (video)

Use the expression editor to build an expression that evaluates a condition. Typically this includes a variable (user-defined or built-in).

Loop—Enter the number of times to loop the activity. If the condition never becomes false, Toad ends the activity after this number of loops. The default is 10.

To learn more about variables, see the following: l

Using Variables in Automation (page 117)

Automation and Variables (video)

Toad Data Point User Guide

Automate

114

Activity

Send Email

Description

Use this activity to distribute reports produced by previous activities in the script or to send notification of script execution status.

Note: To use this activity, an SMTP service must be running.

Review the following for additional information: l

From—Enter your email address or click this field with your email address.

to auto-populate

Note: If you encounter a security alert message from your email application, and you want to use this auto-populate feature, grant Toad access (at least temporarily).

To—Enter an email address or click field with your email address.

to auto-populate this l

Email Server Settings—Click this button to specify your SMTP email server settings.

Server—Enter the address of your SMTP email server or click to auto-populate this field. If Toad is unable to auto-populate this field, contact your email administrator for the SMTP email server address.

Note: The email server setting automatically defaults to that specified in the script's Settings (click the Settings icon and then click the Compose Email button).

User name / Password—If a non-SSL connection requires authentication, enter credentials. If using an

SSL connection, enter credentials and select Use Secure

SSL/TLS connection.

Subject, Body—Enter a subject line and enter text for the body of your email.

Add Attachments—Click to add files created by this script or to browse for other files to add as attachments. In the File

Collection Editor do one or both of the following: l

Select one or more previously created files in the left pane and click Add.

Click and browse to select an existing file.

1. Specify the file directory by browsing to and selecting one of the files.

2. Then, in the File Collection Editor, modify the

Toad Data Point User Guide

Automate

115

Activity

Run Program

Description selected file name (in the right pane) using wildcard characters and/or variables.

Use file for body—Select a file to use as the body of the email.

This is useful if you want to include report contents in the body of the email instead of as an attached file. For example, in the Select to File activity you can select HTML as the output file format, and then use this HTML file as the body of the email.

In another scenario, you can use a form letter as the body of your email. Create a form letter template and then customize the file with the Find and Replace activity.

Note: In the To, CC, Subject, and Body fields: You can use a variable in this field by entering the hash symbol before and after the variable name (#VariableName#).

To learn more about how to use email in an Automation script, see the following: l

Automation and Email (video)

Run a program with optional command-line arguments. Review the following for additional information: l

Program—Select a batch file (.bat) or executable (.exe) file.

Arguments—Enter 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 directory—Select the directory to change to, when running the program.

Run style—Select the window state for the program when it runs.

Verb—Enter verbs used when running the program, such as

"Print".

Wait for program to exit—Select this option to pause if there is an error. Select duration of wait time in minutes.

Return code variable—Enter a variable name or use the default name. You can use this variable with the If Condition activity.

Return code (exit code) values of 16384 (4000 hex) or larger do not generate a script error in this activity. Other return code values do. This allows you to use your program to generate a custom return code value in this range and use it in subsequent

Toad Data Point User Guide

Automate

116

Activity

Run

Automation

Script

Pause

Group

Activities

Throw Error

Parallel

Description activities without generating a script error.

Note: If the script opens a command-line window, you must manually close the window once the script completes.

Run another automation script in your current automation script.

Review the following for additional information: l

Automation script—Select an automation script (.tas file).

After selecting a script, click in a new window.

to open the child script l

Return code variable—Enter a variable name or use the default name. After the child script executes, a return code value is stored in this variable. 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.

Stops an activity for a specified 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.

For an example of how to use the Pause activity in an Automation script, see the following: l

Using the While Loop in Automation (video)

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

Use this activity to generate an error and add a custom error message to the script execution log.

Select Stop On Error to stop the script after the error is logged. This option is independent of the global Stop/Continue on Error option specified in script Settings or the Stop on Error option in the Activity

Info tab. This activity generates a script exit code of 555.

Run two or more activities in parallel.

After adding the activity to the design window, hover over the activity to display a drop-down list of view options.

View Parallel—Normal view.

View Cancel Handler—Select to add cancel handler activity.

Toad Data Point User Guide

Automate

117

Activity Description

View Fault Handlers—Select to add fault handler activity.

This activity can have one or more branches. To delete a branch, select it and press Delete. To add a branch, right-click the activity (the outside loop) and select Add Branch.

Notes: l

To disable an activity, right-click the activity in the design window and select

Disabled. This is helpful if you want to disable an activity while testing other activities.

The Stop on Error option for each activity allows you to select whether to stop or continue execution if Toad encounters an error during that activity.

To prevent an error in one activity from causing a failure at the script level, clear the Generate Error check box (Activity Info tab) for that activity.

Select the Log tab to review a script's execution log.

In the Suffix field, the drop-down list includes two predefined suffixes (Date and

Automation does not support positional parameters denoted by a question mark.

Using Variables in Automation

Automation variables are a powerful tool that can greatly extend your scripts. Variables can add flexibility and customization. Variables can be used in almost every Automation activity.

Watch Using Variables in Automation for a video demonstration of this feature.

How to Create Variables

User-Defined Variables

You can use the Set Variable activity to create user-defined variables. See "Use System

Automation Activities" (page 110) for more information.

Built-In Variables

Several Automation activities create variables by default. The following built-in variables are created by Automation activities.

Toad Data Point User Guide

Automate

118 l

RowCount variable— This integer type variable is created by several activities.

The value assigned to this variable is the number of rows returned by the query in the activity.

Return code variable— This integer type variable is created by the Run Automation

Script and the Run Program activities. The variable value is assigned based on the execution status of the script or program.

Built-in SQL type variables—The Loop Dataset and Execute Script activities create a

SQL type variable which is used to store the result set of a query. The Loop

Connections activity creates a SQL type variable with only one row containing connection information.

Activity Result variable—This variable captures the result of each activity's execution.

If an error occurs, it captures the error message. The name of this variable is _

ACTIVITY_RESULT.

How to Use Variables

Where to Use Variables

The following are some examples of where you can use a variable (built-in or user-defined) in an Automation script.

In the file name of a file exported by an activity.

In the suffix appended to a file name.

In an expression used in the While or If Condition activities.

In a SQL statement as a bind variable for filtering data.

In a SQL statement as a bind variable in an Import or Export template.

How to Use a Variable

To express the value of a variable, surround the variable name with hash symbols (#), for example #myvar#. The following are some examples of how variables might be used.

#myvar#_report.xlsx

Report_#Dept_Name#.xlsx

#File_1_RCOUNT# > 0

It is important to remember that when a variable is expressed, the variable value is substituted as text in place of the variable name (#myvar#). The only exception is when you use a variable as a bind variable in a SQL statement.

To use a variable as a bind variable in a SQL statement, use the following syntax format

(regardless of what the address_id column type is):

SELECT * FROM contact WHERE address_id = :myvar

Toad Data Point User Guide

Automate

119

You can also use the Automation variable here as text substitution, but in this case single quotes might be required (because it is a text substitution) depending on the column type in the WHERE clause.

For example, if last_name is a character column, use the following syntax (single quotes are required):

SELECT * FROM contact WHERE last_name = ‘#myvar#’

If address_id is a non-character column, use the following syntax:

SELECT * FROM contact WHERE address_id = #myvar#

How to Use a String Variable in a Comparison Expression

When comparing a string variable to a string value in an expression, always surround the variable name and the string value with single quotes, for example:

'#myvar#' = 'Dog'

About DateTime Type Variables

If you define a variable using the Set Variable activity and specify the variable type as

DateTime, you must use a Date function for the value.

About SQL Type Variables

SQL type variables are created in two ways: l

You can create user-defined SQL type variables using the Set Variable activity.

A built-in SQL variable is created by the Loop Dataset activity, the Execute Script activity, and the Loop Connection activity.

If you ask just for the variable value of a SQL type variable, Toad returns the value from the first row and column of the result set. However, you can filter by column using this syntax:

<variable name>.<column name>.

For example, Region.Region_Name returns the first value (first row) in the column

Region_Name.

Dataset/SQL Variable - Special Format for Filtering

You can use the following syntax format to filter data from the dataset variable (or any SQL type variable):

<dataset variable name>.<filter parameter>

Example: Loop_data_SQL_1.region_id, where region_id is a column name

Bind Variables

Toad Data Point User Guide

Automate

120

You can store global bind variable/value combinations in Toad . After storing a global bind variable, that variable is available to use in Automation. Your stored global bind variables appear in the list of variables in the expression editor of applicable activities.

Variable Scope

When you are building an Automation script that uses a variable, it is important to understand the variable's scope of visibility. This section describes the concept of variable scope in Automation scripts.

Terms and Definitions

Term

Container

Levels

Container Activity

Set Variable Activity

Set Variable Value

Activity

Definition

Let's define a container as: l

The script itself.

An activity that contains other activities (like the

Group, While, or Loop Dataset activities).

A branch of an activity (for example, a branch in the If

Condition activity).

Suppose that a script is composed of nested containers. Each container is a different level with respect to variable scope. The outermost container is the script itself. Inside the script are activities. The script and its activities in the main workflow comprise the first level. Some activities can contain other activities. These "container activities" are at the second level.

Container activities can contain branches. A branch within a container activity is the third level. And so on, until we get to the innermost level.

An activity that contains other activities. The Loop Dataset,

Group, If Condition, While, and Parallel activities are container activities.

Use this activity to define a variable.

Use this activity to assign a new value to a previously-defined variable.

Scope Rules

Basically, the scope of a variable includes all activities subsequent to the variable-defining activity AND at or below the level at which the variable is defined.

The following are the rules for variable scope.

Toad Data Point User Guide

Automate

121 l

Use a variable in an expression—You can use a previously-defined variable in an expression in any activity subsequent to the variable-defining activity AND at or below the level at which the variable was defined.

l Reassigning a variable value—You can reassign the value of a variable (except a

SQL type variable) at any point within the variable's scope. This task is accomplished

using the Set Variable Value activity. See "Use System Automation Activities" (page

110) for more information.

Once a variable value is reassigned, the new value applies to activities subsequent to the original Set Variable activity AND at or below the level of the original Set

Variable activity.

Example: You can use the Set Variable Value to turn a previously-defined variable into a counter (var=var+1) in the Loop Dataset activity.

Define a new variable with the same name—You can redefine a new variable with the same name, but only within an activity one or more levels below the variabledefining activity. For example, if you defined a variable in the main workflow of your script (first level), you can define a new variable with the same name within a container activity (second level). The scope of this variable value is restricted to that container activity.

You cannot define a new variable with the same name at the same level as the original.

Execute and Schedule 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 execute a script from the Automation window

1. Click Run 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.

Toad Data Point User Guide

Automate

122

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 dialog opens.

2. To schedule the script, select the Triggers tab. Select the scheduling trigger for this task and click Edit.

3. In the Edit Trigger dialog, specify scheduling details. Click OK to save your changes and close the dialog.

4. To run the script when you are not logged on, in the General tab select Run whether

user is logged on or not. Then enter your Windows credentials when prompted.

5. When finished, click OK to save your changes and close the task properties dialog.

For detailed information about the task properties dialog, see "Schedule Windows

Tasks" in the online Help.

Note: Automation scripts are compatible with the version of Toad in which they are created.

To learn how to upgrade your scripts and migrate scheduled tasks that were created in a previous version of Toad, see "Upgrade Scripts and Scheduled Tasks" in the online Help.

About Dell

Contact Dell

Dell listens to customers and delivers worldwide innovative technology, business solutions and services they trust and value. For more information, visit www.software.dell.com

For sales or other inquiries, visit http://software.dell.com/company/contact-us.aspx

or call 1-

949-754-8000.

Technical Support Resources

Technical support is available to customers who have purchased Dell software with a valid maintenance contract and to customers who have trial versions. To access the Support Portal, go to http://software.dell.com/support/ .

The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a day, 365 days a year. In addition, the portal provides direct access to product support engineers through an online Service Request system.

The site enables you to: l

Create, update, and manage Service Requests (cases) l

View Knowledge Base articles l

Obtain product notifications l

Download software. For trial software, go to Trial Downloads .

View how-to videos l

Engage in community discussions l

Chat with a support engineer

Toad Data Point User Guide

Contacting Dell

124