Configure DB2 Client Connections

You can transfer the catalog of an existing DB2 client on your local computer to the new Toad DB2 client during initial setup or at any time later. 

Transfer a Catalog During Initial Setup

When you first launch Toad for DB2 after installation, Toad provides an opportunity to transfer the catalog of an existing DB2 client on your local computer to your new Toad DB2 client. (In other words, Toad exports and imports the catalog for you.)

Toad makes this option available only when all of these conditions exist:

• You are launching Toad for the first time since installation.

• This installation is a first-time Toad for DB2 installation on your computer, or it is an upgrade from a previous Toad for DB2 version already on your computer.

• Toad detects other DB2 clients installed on your computer. These can include the DB2 clients laid down with other installations.

If you choose not to transfer an existing catalog at this point, you can transfer a catalog later. See Transfer a Catalog Any Time After Initial Setup for more information.

To transfer an existing DB2 catalog

1. Open Toad for DB2 after installation is complete.

2. If Toad displays the Settings Migration Utility window, select whether to migrate from your previously installed Toad for DB2. (These settings include Toad connection profiles.)

• If you migrate settings, the window showing the option to transfer a catalog displays once the migration completes.

• If you do not migrate settings, Toad steps you through its Configuration wizard before displaying the Connections window. When you select to create a connection, the window showing the option to transfer a catalog displays.

  If the Settings Migration Utility window does not display, go to step 3.

3. On the window showing the option to transfer a catalog, locate the DB2 Client list, and select the name of the existing DB2 client whose catalog you want to transfer to your newly installed Toad for DB2.

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

4. Click OK to proceed with the catalog transfer.

   When the transfer completes, the Connections window displays. The Database alias drop-down list now includes all the DB2 databases and subsystems whose catalog entries you transferred.

   Note: During the transfer process, 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 transferring. To include local node entries in your Toad DB2 client catalog, you must manually catalog these databases.

5. Proceed to create Toad connection profiles for the DB2 databases and subsystems whose connection profiles you did not migrate (in step 2). For those profiles you migrated, simply select the connection in the Connections window, and provide the login ID and password to start the connection. See Create Toad Connection Profiles for DB2 for more information.

 

Transfer a Catalog Any Time After Initial Setup

To transfer a catalog any time after initial setup

1. In the Connection Manager or on the Connections window, click in the toolbar.

2. From the DB2 Client list, select the name of the existing DB2 client whose catalog you want to transfer to your newly installed Toad for DB2.

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

3. Click OK.
4. Create Toad Connection Profiles for DB2 for any of the transferred catalog entries as needed.

Toad for DB2 provides functionality to import an existing DB2 client catalog to your Toad DB2 client, saving you the effort of manually creating individual catalog entries on the Toad DB2 client. This feature executes the DB2 Connectivity Configuration Import Tool command db2cfimp, which imports an export profile containing the catalog exported the from a local or remote DB2 client or a local Toad DB2 client. Either of these functions export DB2 catalogs: 

• Export Profile feature in the Toad Configuration wizard (for exporting your current Toad DB2 client catalog only). See Export the catalog for the current DB2 client for more information.

• DB2 Connectivity Configuration Export Tool Command db2cfexp. 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.

Note: Do not attempt to manually import catalog entries from the IBM CLP window provided with Toad. If you have any DB2 ODBC entries, db2cfimp will override your existing ODBC system with DSN entries and can cause previously configured DB2 ODBC connections to stop working.

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

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

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

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.

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

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

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

To create the export profile containing the current Toad 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 Toad 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 Toad 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 Toad 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 Toad 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 Toad DB2 client, you must manually catalog the missing local-node databases as remote databases. See Manually catalog DB2 for LUW databases for more information.