Toad Data Point 5.7 - Installation Guide

Configure DB2 Client Connections

Setting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems that Toad will manage requires two main steps.

Step 1. Configure DB2 client connections - Before you can create a connection profile, each of the databases or subsystems must be cataloged on the DB2 client. This topic helps you with that process.

Step 2. Create connection profiles - Step 2 involves creating Toad connection profiles for the cataloged DB2 databases or subsystems. Each profile contains the information that Toad needs to connect to the system, such as the user ID and password, DB2 registry settings, and the default schema. See Create Toad Connection Profiles for DB2 for more information.

Note: You must have a DB2 client installed before you can configure client connections and create connection profiles. Beginning with Toad Data Point 3.6, a DB2 client is no longer included in the product installation. Refer to IBM for information regarding a DB2 client download, http://www-01.ibm.com/software/data/db2/linux-unix-windows/downloads.html, or consult your organization's IT department. For a list of supported DB2 client versions, see the Toad Data Point Release Notes.

Show all

If You Previously Used the Toad DB2 Client

If you previously used the Toad DB2 client installed with earlier versions of Toad Data Point, you may need to do the following:

• Install a DB2 client from IBM and set it as the default. Because Toad no longer installs a client along with the product, you must now have a DB2 client from IBM installed to use your DB2 connections.
• Transfer the catalog from the previous Toad DB2 client to your current default DB2 client. If you used the Toad DB2 client in a previous version of Toad, install a default DB2 client from IBM, and then transfer the catalog from the Toad client to the new default DB2 client. See Transfer a Catalog Any Time After Initial Setup.

To check default client

• You may want to check that the correct client is set as the default, before you import a catalog to it. The default client is identified as such in the Start menu (Start | All Programs | IBM DB2). The default client has “(Default)” after the client name.

To specify default client

• You can specify the default client using the Database Client Interface Selection Wizard (Start | All Programs | IBM DB2 client name | Database Client Interface Selection Wizard).

Use one of the following methods to catalog each of the databases or subsystems on the DB2 client.

Transfer a Catalog Any Time After Initial Setup

Use this method to transfer a catalog from another DB2 client on your machine to your default DB2 client. If you previously used the Toad DB2 client installed with the product in prior versions, use this method to transfer the catalog from the previous Toad DB2 client to your current default DB2 client.

To transfer a catalog any time after initial setup

1. In the Connection Manager, click in the toolbar.

   Note: If the Client Configuration Wizard opens, Toad found only one DB2 client installed.

2. From the DB2 Client list, select the name of the DB2 client whose catalog you want to transfer to your default DB2 client.

   This list contains all current previously installed DB2 clients on your computer, including the default DB2 client instance and any Toad DB2 client installations.

3. Click OK.
4. To create a connection in Toad for any of the transferred catalog entries, see Create Toad Connection Profiles for DB2.

 Import a DB2 catalog previously exported to a file

To import an exported catalog profile

1. In the Connections (or Create New Connection) window, click  beside the Database alias drop-down list to open the Client Configuration wizard.

2. On the Welcome page, select Import Profile.

3. Click Next.

4. Click in the Profile name field to browse for and select the exported profile you want to import. When you select the profile, its contents display in the text pane.

5. Complete the wizard.

   Once you close the wizard, the Database alias drop-down list in the Connections window includes all the DB2 databases and subsystems whose catalog entries you imported.

   Note: DB2 does not automatically export catalog entries for the local DB2 instance and its databases on the computer from which the export is run (unless these entries already exist in the catalog). Therefore, the profile you are importing might not include these node entries. To add the missing entries to your DB2 client catalog, you must manually catalog the databases. If these databases are local to your computer, catalog them as remote databases. See  Manually catalog DB2 for LUW databases for more information.

6. Proceed to catalog entries as needed. See Create Toad Connection Profiles for DB2 for more information.

 Manually catalog DB2 for LUW databases

To manually catalog a DB2 for LUW database

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down list to open the Client Configuration wizard. The Welcome page displays, showing the DB2 client's existing catalog configuration in a tree view.

2. If the host and node names for the database you want to configure are listed in the tree, select them. These selections pre-fill certain fields required later in the wizard process. If these names are not listed, you must provide the necessary host and node information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

   Add a Host	Description
   Operating system	Select the operating system for the server on which the DB2 for LUW instance containing the DB2 database you are cataloging resides. For a list of supported server platforms, see the release notes.
   Host name	Enter the TCP/IP address or the system name for the server on which the DB2 database resides.
   Port number	Enter the port number for the server on which the DB2 database resides.
   Security type	Select a secure protocol to handle TCP traffic for this connection.
   Specify an Instance	Description
   Node name	Enter a user-defined name for the DB2 instance containing the database you are cataloging. If you selected the node name from the tree on the Welcome page, this information is pre-filled (but you can update it as needed).
   Instance name	Enter the real name of the DB2 instance.
   Comment	Enter a descriptive comment for the instance, if needed.
   Add a Database	Description
   Database name	Enter the real name of the DB2 database.
   Database alias	Enter a unique nickname to identify the database on your system.
   Authentication	Select the authentication method that is required to connect to the database.
   Target principal	Enter the service account name for server's service where the database resides. Note: This option is available only when Kerberos is selected as the authentication method.

5. Complete the wizard.

   The Database alias drop-down list in the Connections window shows the alias for the newly cataloged database. To complete the Toad connection setup, you must create a Toad connection profile for the database. See Create Toad Connection Profiles for DB2 for more information.

 Manually catalog DB2 for z/OS subsystems

Note: If you connect directly to a DB2 for z/OS subsystem, you cannot take advantage of Sysplex. If you want to use Sysplex, catalog an entry to a DB2 Connect gateway instead. See  Manually catalog DB2 Connect gateways for more information.

To manually catalog a DB2 for z/OS subsystem

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down list to open the Client Configuration wizard. The Welcome page displays, showing the DB2 client's existing catalog configuration in a tree view.

2. If the host name for the DB2 subsystem you want to configure is listed in the tree, select it. This selection pre-fills certain fields required later in the wizard process. If the host name is not listed, you must provide the necessary host information later in the wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

   Add a Host	Description
   Operating system	Select z/OS for the server operating system.
   Host name	Enter the TCP/IP address or the system name for the server on which the DB2 subsystem resides.
   Port number	Enter the port number of the service for the DB2 subsystem.
   Enable SOCKS security	Select this checkbox to enable the SOCKS secure protocol to handle TCP traffic for this connection. SOCKS adds an authentication mechanism for additional security.
   Add a DB2 Subsystem	Description
   Location name	Enter the location name of the DB2 subsystem as defined during the DB2 installation.
   Database alias	Enter a unique, user-defined alias to identify the DB2 subsystem on your system. You can use the same name you used in the previous Location name field, as long as it does not already exist in the list aliases in the DB2 client.

5. Complete the wizard. A message informs you whether the entry was added successfully.

   The Database alias drop-down list in the Connections window shows the alias for the newly cataloged subsystem. To complete the Toad connection setup, create a Toad connection profile for the database. See Create Toad Connection Profiles for DB2 for more information.

 Manually catalog DB2 Connect gateways

In order to connect to a DB2 for z/OS subsystem, you need to catalog two entries. First, you need to catalog the DB2 subsystem on the DB2 Connect gateway. During this process, you define an alias for the DB2 subsystem. Second, you need to catalog this DB2 subsystem alias in Toad. The procedure below describes both cataloging events.

To manually catalog an entry to a DB2 Connect gateway

1. Catalog the DB2 subsystem on the DB2 Connect gateway. See the IBM DB2 for z/OS documentation for more information.

2. In the Connections (or Create New Connection) window in Toad, click  beside the Database alias drop-down list to open the Client Configuration wizard.

3. Click Add Catalog Entry.

4. Review the following for additional information:

   Add a Host	Description
   Operating system	Select the operating system for the server on which the DB2 Connect gateway resides.
   Host name	Enter the TCP/IP address or the system name for the server on which the DB2 Connect gateway resides.
   Port number	Enter the port number of the service for the DB2 Connect gateway.
   Enable SOCKS security	Select this checkbox to enable the SOCKS secure protocol to handle TCP traffic for this connection. SOCKS adds an authentication mechanism for additional security.
   Specify an Instance	Description
   Node name	Enter an alias for the user-defined node name you specify in the Instance name field.
   Instance name	Enter a user-defined name for the gateway node or use the same value entered in the Node name. Note: This name does not point to an actual node on the gateway system, but is needed to continue the cataloging process.
   Add a Database	Description
   Database name	Enter the database alias name for the DB2 subsystem. Note: This alias name must match the alias cataloged on the DB2 Connect gateway.
   Database alias	Enter a unique, user-defined alias for the DB2 Connect gateway. You can use the same alias you used in the previous Database name field, as long as it does not exist in the list of Toad for DB2 aliases.
   Authentication	Select the authentication method that matches the method specified for the DB2 subsystem on the DB2 Connect gateway.

5. Complete the wizard.

   The Database alias drop-down list in the Connections window shows the name for the newly cataloged DB2 subsystem. To complete the Toad connection setup, you must create a Toad connection profile for the subsystem. See Create Toad Connection Profiles for DB2 for more information.

Note: Toad for DB2 supports LDAP connections. See Configure DB2 LDAP Support for more information.

Maintain DB2 Client Connections

Additionally, Toad provides functionality to perform the following maintenance on the catalog you set up for the current DB2 client:

 Edit DB2 catalog entries

To edit a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the DB2 client, select the catalog entry for the DB2 database or subsystem that you want to edit.

3. Click Edit Catalog Entry.

4. On the Edit Catalog Entry page, update the catalog properties as needed. For a description of the catalog properties, see the following links:

   •  Manually catalog DB2 for LUW databases

   •  Manually catalog DB2 for z/OS subsystems
   •  Manually catalog DB2 Connect gateways

5. Click Next to open the Catalog Script Review window.

6. Review and modify the script in the preview pane as needed.

7. Click Finish. A message window displays, informing you whether the updates to the catalog entry completed successfully.

 Remove DB2 catalog entries

To remove a DB2 catalog entry

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down list to open the Client Configuration wizard.

2. In the catalog configuration tree for the DB2 client, expand one or more nodes, and select the catalog entries that you want to remove. (Press CTRL+click to select multiple entries.)

   Note: You can remove a node by selecting all database entries for that node.

3. Click Remove Catalog Entry.

4. On the Catalog Script Review page, modify the script in the preview pane as needed.

5. Click Finish. A message window displays, informing you whether the removals completed successfully.

 Export the catalog for the current DB2 client

Toad Data Point provides functionality to export your current DB2 client catalog to a file, called an export profile. You can then import this profile to set up the catalog for another DB2 client. 

To create the export profile containing the current DB2 client catalog, Toad executes the DB2 Connectivity Configuration Export Tool command db2cfexp. If you want to export the catalog of a remote or local DB2 client (other than your current DB2 client), you must manually execute this command. For more information, see the following IBM documentation: http://publib.boulder.ibm.com/infocenter/db2luw/v8/index.jsp?topic=/
com.ibm.db2.udb.doc/core/r0002442.htm.

To export the DB2 client catalog

1. In the Connections (or Create New Connection) window, click beside the Database alias drop-down list.

2. Click Export Profile in the Welcome window of the Client Configuration wizard. (You might need to click this button.)

3. Click Next.

4. Click in the Profile name field to browse for and select the path for the profile in which to export the current DB2 client catalog.

5. Select the type of profile you want to create:

   • Template to create a profile used as a template for other DB2 clients (default for exporting a DB2 catalog)
   • Backup to create a profile used to back up a DB2 database instance

   • Maintain to create a profile that contains only database or node information required for updating other instances

     For more information about these profile types, see the IBM documentation (as cited previously) describing the db2cfexp command.

6. Complete the wizard. A message window displays, informing you whether the export completed successfully.

   Note: DB2 does not automatically export catalog entries for the local DB2 instance and its databases installed on your computer unless these entries already exist in the catalog you are exporting. If you later import the export catalog to a DB2 client, you must manually catalog the missing local-node databases as remote databases. See  Manually catalog DB2 for LUW databases for more information.

After you have set up the catalog on the current DB2 client, you can proceed to the second phase of the Toad connection setup. This phase involves creating Toad connection profiles for the cataloged DB2 databases or subsystems. See Create Toad Connection Profiles for DB2 for more information.

Related Topics

Create DB2 Connections

Configure DB2 LDAP Support

You can create DB2 Lightweight Directory Access Protocol (LDAP) connections when the DB2 client installed with Toad is configured for LDAP. Configuring the client consists of enabling LDAP support and specifying the host name and port number of the LDAP server. Once the client is configured, Toad retrieves names from your LDAP server and displays them in the Database Alias list in the Connections window.

Notes:

• You must configure LDAP support for the DB2 client installed with Toad regardless of whether an existing DB2 client on the computer is already configured to support LDAP.

• Currently, Toad for DB2 supports only the access of DB2 LDAP catalog entries. Toad does not support the management of these entries.

To configure the DB2 client for LDAP

1. Open the Command Window for the DB2 client installed with Toad by selecting Start | All Programs | IBM DB2 | <ToadCom, ToadEval, or ToadFree> | Command Line Tools | Command Window.

2. Enter the following command to enable LDAP support:

   db2set DB2_ENABLE_LDAP=YES

3. Enter the following command to specify the TCP/IP host name and port number of the LDAP server:

   db2set DB2LDAPHOST=<hostname[:port]>

   The port number defaults to 389 (default LDAP port) if you leave the port number blank.  

4. Exit the Command window.

5. Launch Toad and open the Connections window.

   Databases on the LDAP server should be available from the Database alias drop-down list in the Connections window. To complete the Toad connection setup, you must create a Toad connection profile for each database. See Create Toad Connection Profiles for DB2 for more information.

Related Topics

Create DB2 Connections

Create DB2 Connections

Setting up connections to the DB2 for LUW databases and DB2 for z/OS subsystems that Toad will manage requires two steps.

Step 1. Configure DB2 client connections - If you use a DB2 client each of the databases or subsystems must be cataloged on the client. See Configure DB2 Client Connections to learn how to catalog databases/subsystems.

Step 2. Create connection profiles - Step 2 involves creating Toad connection profiles for DB2 databases or subsystems that were either cataloged in the DB2 client or imported from your Data Server Driver configuration file. Each profile contains the information that Toad needs to connect to the system, such as the user ID and password, DB2 registry settings, and the default schema. If you use IBM DSD environment you can import your connection profile from a Data Server Driver configuration file.

Note: You must have a DB2 client installed before you can configure client connections and create connection profiles. Beginning with Toad Data Point 3.6, a DB2 client is no longer included in the product installation. Refer to IBM for information regarding a DB2 client download, http://www-01.ibm.com/software/data/db2/linux-unix-windows/downloads.html, or consult your organization's IT department. For a list of supported DB2 client versions, see the Toad Data Point Release Notes.

Note: The default location of your Data Server Driver configuration file is in ...Program Data\IBM\DB2\IBMDBCL1\cfg. The default config filename is db2dsdriver.cfg.

Note: When you connect using IBM Data Server Driver the Database button and the toolbar option in Tools | LUW Database Options will not be available.

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

Connection Using a Custom Connection String

You can also connect to your DB2 database/subsystem using a custom connection string.

• Select Connect Using | Connection String in Connection Properties
• Enter Database alias, Host name, Login, and Password and the connection string will be automatically updated according to what you enter
• You can save a connection created using a custom connection string in your Connection Manager

If You Previously Used the Toad DB2 Client

If you previously used the Toad DB2 client installed with earlier versions of Toad Data Point, you may need to do the following:

• Install a DB2 client from IBM and set it as the default client. Because Toad no longer installs a client along with the product, you must now have a DB2 client from IBM installed to use your DB2 connections.
• Transfer the catalog from the previous Toad DB2 client to your current default DB2 client. If you used the Toad DB2 client in a previous version of Toad, install a default DB2 client from IBM, and then transfer the catalog from the Toad client to the new default DB2 client. See Configure DB2 Client Connections for more information.

Show all

Create Connection Profiles

Use one of the following methods to create Toad connection profiles:

• Import Toad connection profiles previously exported to an XML file

  (See Export connection profiles to an XML file for more information about exporting a profile that you can later import.)

  Note: The connection profiles are not usable unless you have also created entries in the DB2 catalog for the DB2 databases and subsystems to which these profiles correspond. See Configure DB2 Client Connections for more information.

  To import connection profiles

  1. In the Connections (or Create New Connection) window, click on the toolbar, and select Connection file.

  2. From the Import Connections window, browse for and select the XML file containing the connection profiles you want to import.

  3. Click Open.

  4. Select DB2 and click OK to complete the import.

     The connections whose profiles you imported are listed on the Connections window.

• Manually define Toad connection profiles.

  To create a Toad connection profile for a DB2 database or subsystem

  1. In the Connections (or Create New Connection) window, click on the toolbar (ALT+F+N).

  2. Select IBM DB2 LUW or IBM DB2 z/OS from the Group list box.

  3. Review the following for additional information:

     Database alias	Select the alias for the DB2 database or subsystem. This alias was defined when you cataloged this DB2 database or subsystem on the DB2 client. See Configure DB2 Client Connections for more information if the alias does not display in the list. Tip: Click to refresh the alias list. Normally, Toad caches the DB2 catalog the first time you open this window in your Toad session and continues to read from cache each time you subsequently open this window. This button forces Toad to reread the DB2 catalog to list any new systems that might have been cataloged externally during the caching period.
     Default schema/auth ID	Enter the SET SCHEMA value (DB2 for LUW) or the SET SCHEMA or SET CURRENT SQLID value (DB2 for z/OS) for this connection.
     Category	Select or create a category if you want to color code Editor tabs for a specific connection. This can help differentiate between development and production databases. You can also set an option to color code the Object Explorer pane and object editor windows (Create, Alter, Drop, etc.). See Set Connection Categories for more information.   Click here to view a video of this feature.

  4. Select the Advanced tab to define special register values that are then in effect each time Toad connects to the DB2 database or subsystem.

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

     or

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

Manage Connections

After you have completed both phases for configuring Toad connections to DB2 databases or subsystems, the Connections window lists all the configured connections, allowing you to perform the following:

• Connect to and manage a DB2 database or subsystem through Toad

• Export connection profiles to an XML file

  Toad for DB2 provides functionality to export one or more of your current Toad connection profiles to an XML file. You can then import these exported connection profiles into another Toad installation. See Import Toad connection profiles previously exported to an XML file for more information. 

  To export connection profiles

  1. In the Connections (or Create New Connection) window, select the connections whose profiles you want to export.

  2. Click on the toolbar, and select Connection file.

  3. On the Export Connections window, review the selected connections, and click OK.

  4. Browse for and select the path for the file in which to export the selected profiles.

• Import missing connections defined on the Toad client

  You can import all connection entries currently defined in the DB2 client catalog or Data Server Driver configuration file but missing from your current list of Toad connections.

  Note: Default location for Data Server Driver configuration files is in ...\IBM\DB2\IBMDBCL1\cfg.

  Note: The imported connection entries might be associated with incorrect or missing DB2 catalog or Toad connection profile information, making them currently invalid. To re-instate any of these connections, you might need to provide accurate DB2 catalog and Toad profile information.

  To import missing connections

  • In the Connections or Connections Manager window, click .

• Troubleshoot connection issues

Note: Click to open the Client Configuration Wizard. See Configure DB2 Client Connections for more information.

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

Related Topics

Connection/Navigation Manager

Understand Toad Connections

Switching Connections in Toad

Create Excel Connections

Connecting to an Excel file is easy. To create the connection, simply open the Excel file from the Create New Connection dialog .

To create an Excel connection

1. Click on the Navigation or Connection Manager toolbar.

2. Select Excel from the Group list.

3. Browse to and select the Excel file.

4. Complete the Create New Connection dialog. Review the following for additional information:

   General Tab	Description
   Category	Select a category if you want to color code your connection. Tip: The color is applied in the Connection Manager and other connection dialogs. You can also create a new category for your connection. See Set Connection Categories for more information.
   Advanced Tab	Description
   Enable import mode	Select this checkbox to set IMEX=1 in the connection string, which converts intermixed data to text.
   Show system tables	Select to display worksheets as system tables. Toad uses the worksheet name suffixed with a dollar sign ($).
   Automatically create ranges	Select this option if you want Toad to automatically create named ranges. Toad creates one named range in each worksheet (unless the Toad name, AutoRange_<worksheet name>, already exists). Note: Toad does not overwrite the user defined named ranges. The Toad-created named ranges and the user defined named ranges are both visible in the Object Explorer after connecting. Deselect this option if the Excel file contains user defined named ranges and you do not want Toad to create additional named ranges. Important: If you deselect this option, and your Excel file does not contain named ranges, Toad is unable to create tables from your data. The feature is selected by default.
   Hide named ranges	Select the named ranges to hide. Note: Named ranges are not displayed until after a connection is created (in the Connections or Connection Properties dialog). In Excel 2007 files, named ranges are not displayed for active connections.
   Open in Excel	Click to open the selected file in Excel. This is useful if you want to modify your file or define named ranges before connecting.

4. Click Connect to connect immediately while saving the connection information. Optionally, click Save to save the connection without connecting.

Understand how Toad creates data tables from an Excel file

Toad uses Excel named ranges (regions) to define the data to include in a table. Therefore, any data that you want to display and easily query in Toad must be included in an Excel named range (region).

You can create named ranges using one of the following methods:

• Preferred method: You can ask Toad to automatically create named ranges when you create the connection to the Excel file. Toad creates one table from each worksheet and includes the contents of every formatted cell.
• If you do not want to include a worksheet's entire contents in one named range, or if a worksheet contains more than one table, then define the named ranges ahead of time in Excel.

To create a named range in Excel

1. In the Excel file, select the data that you want to include in the table (including column headings). Then define a named range.

   »

   In Excel 2003, select Insert | Name | Define.

   »

   In Excel 2007, right-click the data and select Name a Range.

2. Save your Excel file. In Toad, create a new connection to the file. In the New Connection dialog, deselect Automatically create ranges.

To allow Toad to automatically create named ranges

Tip: For an Excel file with an existing connection, in the Navigation Manger, right-click the file and select Properties. On the Advanced tab, select Automatically create ranges. Toad creates the named ranges the next time you reconnect to this file.

To hide named ranges

You can hide an Excel file's named ranges so that they do not display as tables in the Object Explorer.

1. In the Navigation Manager, right-click an Excel file connection and select Properties.

   Note: In Excel 2007 files, the connection must be inactive for the named ranges to display.

2. On the Advanced tab, select the named ranges to hide.

To view or modify connection properties

To view an Excel connection's properties, do one of the following:

• Right-click an Excel file connection in the Navigation or Connection Manager and select Properties.
• Select on the Connections toolbar to open the Connections dialog. Select the Excel file connection in the left pane to view the connection properties in the right pane.

Considerations and Limitations

Troubleshoot Excel

To troubleshoot Excel issues, see the following:

• See Troubleshoot Excel® Issues for more information about troubleshooting Excel connection issues.
• For a list of Excel file limitations from Microsoft, see Microsoft Excel specifications and limits.
• For special considerations when using Excel macro-enabled files, especially in Automation scripts, see Using Macro-Enabled Excel Files.

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

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

Related Topics

Connection/Navigation Manager

Understand Toad Connections

Switching Connections in Toad