Chat now with support
Chat with Support

Toad Intelligence Central 3.3 - Quick Start Guide

Accessing Intelligence Central

You are here: Access Toad Intelligence Central

You can access Toad Intelligence Central using one or more of the following methods:

  • The Web interface (Web server)
  • A Toad application, such as Toad Data Point or Toad for Oracle
  • A third-party tool, such as Tableau or a MySQL command line interface

Web Interface

The Web interface (Web server) provides Standard users with the ability to view and perform limited operations on objects published to Intelligence Central from other Toad applications. To use the Web interface, the Web server must be installed on the same computer as Intelligence Central.

See Log In From a Web Browser for more information about accessing Intelligence Central through the Web interface.

The Web interface allows users with the Administrator role to perform advanced activities such as the management of users, groups, and objects, as well as Intelligence Central server configuration and maintenance. See the Toad Intelligence Central Deployment Guide to learn more about performing Administrator activities through the Web interface.

Toad Applications

Toad Data Point users can publish data objects, Automation scripts, Toad documents, and other resources created in Toad Data Point to Intelligence Central. Toad for Oracle users can publish Automation apps, files, and other resources created in Toad for Oracle. For these users, their primary method to view, access, manage, and edit Intelligence Central objects is through their Toad application.

Third-Party Tool

A Toad Intelligence Central user can create a MySQL connection to Toad Intelligence Central through a third party tool such as Tableau, MySQL command line interface, or MySQL Workbench. This connection can be used to query Data Connectivity objects stored in Toad Intelligence Central. See Third Party Connection to Toad Intelligence Central for more information.

 

 

Third Party Connection to Intelligence Central

You are here: Accessing Intelligence Central > Third Party Connection to Intelligence Central

A Toad Intelligence Central user can create a MySQL connection to Toad Intelligence Central through a third-party tool, such as one of the following:

  • Tableau
  • MySQL command line interface
  • MySQL Workbench

This connection can be used to query tables, views, snapshots and datasets stored in Toad Intelligence Central.

Requirements / Limitations

Third party tool Ensure the authentication method you use to connect to Toad Intelligence Central is supported by the third party tool. This is straightforward if you login to Toad Intelligence Central using credentials local to Toad Intelligence Central. If you login to Toad Intelligence Central using Windows credentials then the third party tool must also support MySQL connection via Windows credentials.

Computer where the third party tool is installed

Ensure a MySQL driver is installed appropriate to the third party tool and Toad Intelligence Central.

Ensure the default character set is UTF8.

Toad Intelligence Central Share / Manage rights To see an object that you did not create yourself you must have Share or Manage rights to that object. These rights can be granted by any Toad Intelligence Central user with Manage rights to the object using an application such as Toad Data Point or the Admin Console.
Data source authentication Ensure the data source authentication you use to access the result set of a table or view is defined in Toad Intelligence Central. This can be done using an application such as Toad Data Point or the Admin Console. It cannot be done using the third party tool.

Connection

Create the MySQL connection.

Parameter Description
Host name

The name of the Toad Intelligence Central server host.

Port

The connection port to the Toad Intelligence Central server. This is the Port number set during installation of the Toad Intelligence Central server, by default 3566.

Username and Password

Your username and password to Toad Intelligence Central. Alternatively, if you use Windows credentials to connect to Toad Intelligence Central then select the option to connect via Windows credentials.

MySQL database

Select the MySQL database where the object is stored. This is dependent on the application used to create the object.

Application Description
Toad Data Point

The database is defined when the object is published to Toad Intelligence Central.

Admin Console

For a table, view or snapshot the MySQL database is the name of the data source. For a dataset the database is of the form data_owner. The owner is the user that created the dataset.

 

Note: Hidden, temporary and internal Toad Intelligence Central databases and MySQL databases may be visible.

Queries

Query tables, views, snapshots and datasets.

Note: When querying tables and views, execution of SQL may fail under some circumstances. If the SQL used by the third party tool has a MySQL dialect, then that SQL may fail if the query is shipped to a non-MySQL relational database for remote execution. As a workaround, you could use Toad Data Point or the Admin Console to save the table or view as a snapshot and then access the snapshot via the third party tool.

MySQL Views

You can use the following MySQL commands to verify the third party tool.

  • SHOW [FULL] TABLES command
  • DESC[RIBE] command
  • EXPLAIN command
  • SHOW [FULL] COLUMNS command
  • SELECT query against information_schema.views
  • SELECT query against information_schema.tables

Home Page

You are here: Home Page

The Home page is displayed by default when you access Intelligence Central through a Web browser. The Home page allows you to view and access the objects in Intelligence Central that have been shared with you.

Objects and Files Displayed

The Home page of the Web interface displays the objects and files published to Intelligence Central. The objects you see are the objects that have been shared with you. The types of objects/files you see depends on what Toad application/applications are being used to publish to Intelligence Central.

For example, Toad Data Point users can publish data objects (views, snapshots, and datasets), Toad documents, Automation scripts, and other resources created in Toad Data Point. Toad for Oracle users can publish Automation apps, .sql files, as well as other resources created in Toad for Oracle.

Note: A Toad Intelligence Central Data Connectivity license is required to enable data connectivity functionality in Intelligence Central.

Web Users

If you are using the Web interface to view and access objects/files published from one or more Toad applications, see the following for more information about the objects and the actions available to you.

Toad Application Users

If your primary method to view and access Intelligence Central objects is through one of the Toad applications, see the application's online Help for more-detailed information about the full range of functionality that is available through the application.

  • To learn how to location objects in Intelligence Central, see Find Objects.
  • To learn how to view object information, see Object Details.

Click a folder to expand it. Select an object to view more information in the Details pane.

 

Toad Data Point

You are here: Toad Data Point

Toad Data Point allows users to publish data objects (views, snapshots, and datasets), Toad documents (Query Builder, SQL Editor), Automation scripts, database connections, Project Manager projects, and other resources created in Toad Data Point to Intelligence Central.

If you are a Toad Data Point user, your primary method to view and access Intelligence Central objects is through the Toad Data Point application. However, both Toad Data Point users and non-users can view and perform limited operations on Intelligence Central objects using the Web interface.

Note: A Toad Intelligence Central Data Connectivity license is required to enable data connectivity functionality in Intelligence Central.

Download Objects

Users of Toad Intelligence Central can log in through a web browser and download Toad Data Point objects that have been shared with them.

  1. Log in through a web browser. See Log In From a Web Browser.
  2. Click Home.
  3. Locate the object. See Find Objects.
  4. Select the object to show details. See Object Details.
  5. Download object. Click in the Details pane to download the object. The location of the downloaded object is determined by your Web-browser settings.
    • Enter Variables—For views containing a variable, Intelligence Central prompts you for a variable value. Enter a new value or use the default. The new value applies to this download only. The default value is specified when the view is published from Toad Data Point and can be modified through Toad Data Point.

    • Data objects—For data objects (view, snapshot, or dataset), Intelligence Central prepares the object and displays a Success message when the object is ready to download. Click Download in the Success message to download the result set. For more information about data objects, see Data Connectivity.

      Note: If authentication is required, the data object is not downloaded/accessed and an error message is displayed. You must authenticate through Toad Data Point before you can download this data object. For example, you might be required to authenticate the first time you access a View that was published with a personal key, instead of a shared key.

  6. Filter data. For data objects, you can filter the data before downloading. Click in the Details pane to filter data. See Filter Data to Download for more information.

Automation Scripts

The Intelligence Central Web interface allows you to view and execute Automation scripts that have been shared with you.

Note: If the Automation Script scheduled to execute on the Toad Intelligence Central server includes an instruction to send an email then in order for that email to be sent the Toad Intelligence Central server must have access to an email SMTP port. If the Automation Script scheduled to execute on the Toad Intelligence Central server includes an instruction to create an Excel spreadsheet then Microsoft® Excel® must be installed on the Toad Intelligence Central host computer for the Excel spreadsheet to be created. Refer to your Toad Intelligence Central Administrator for more information.

View Script Details

Select a script to view script details in the Details pane. See Object Details for a description of the Details fields. For Automation scripts, the following additional details are provided.

  • Logs tab—Displays script execution history. Click Expand to expand the Logs tab. This action allows you to view run duration, results, and exit code. Select a run (in the expanded tab) to view the individual execution log.

Run Automation Scripts

You can execute an Automation script from the Web interface. You can execute scripts that you own or that have been shared with you.

  1. Log in through a web browser. See Log In From a Web Browser
  2. Click Home.
  3. Select the Automation script to execute.
  4. Click in the Details pane.
    • Enter Variables—If the Automation script executes SQL containing a variable, Intelligence Central prompts you for a variable value. Enter a new value or use the default. The new value applies to this run only. The default value is specified when the script is published from Toad Data Point and can be modified through Toad Data Point.
  5. To cancel script execution, click the down arrow in the progress message (located in the page header). Then click Cancel in the Background Tasks pane.
  6. In the Success (or Error) message, click View Log to display the execution log.

For more-detailed information about publishing, using, creating, and managing Automation scripts, see the Toad Data Point online Help.

Snapshots

In the Web interface, you can view and refresh Toad Data Point snapshots. You can view snapshots you own or that have been shared with you. You can refresh snapshots you own or those to which you have Manage privileges.

View Snapshot Details

Select a snapshot to view snapshot information in the Details pane. See Object Details for a description of the Details fields. For snapshots, the following additional details are also provided.

  • Columns tab—Displays columns included in the snapshot. Select the Columns tab and click Expand to view more details.
  • Query tab—Displays the snapshot's query.

Refresh Snapshots

You can refresh a Toad Data Point snapshot from the Web interface.

  1. Log in through a web browser. See Log In From a Web Browser
  2. Click Home.
  3. Select the snapshot to refresh.
  4. Click in the Details pane.
  5. You can view the refresh progress in the Background Tasks pane. Click the down arrow in the progress message (located in the page header) to open the Background Tasks pane.

For more-detailed information about creating, publishing, using, scheduling, and automating snapshots, see the Toad Data Point online Help.

Related Documents