Creating individual federated objects

You can use the Administration Explorer of IBM® Data Studio to create each of the federated objects that are required to set up a federated server to access the supported Db2® data sources and the Oracle data source.

About this task

This procedure explains how to use the Administration Explorer to create a database connection, and then create and deploy the federated objects that are required to access the supported Db2 data sources and the Oracle data source.

The Administration Explorer is an object tree that contains database objects. The objects are grouped into folders based on object type. To create and manage federated objects, you work with the Federated Database Objects folder and the other main areas of the Administration Explorer:
Object List
You can use the object list area to display or edit the content of an object.
Properties view
The Properties view is where the object properties are displayed and where you create and modify object definitions.


  1. Connect to a database by using one of the following methods.
    • Create a new database connection.
      1. In the Administration Explorer, click New > New Connection to a database.
      2. Configure the connection by entering parameters in the connection dialog.
      3. Right-click to connect to the database.
    • Connect to an existing database connection.
      1. Right-click the connection profile in the Administration Explorer.
      2. Click Connect.
      Note: If a federated or Db2 database is already catalogued on the machine where IBM Data Studio is installed, the database connection profiles are automatically created when you launch IBM Data Studio.
  2. Create the required federated objects:
    • Wrappers
    • Server definitions
    • User mappings
    • Nicknames
    You can also create federated stored procedures.
    1. Expand the contents of the Federated Database Objects folder.
    2. Right-click a federated object folder, and select an object to create in the dropdown menu.

      The changes that you make to a database are saved in a change plan in the local workspace. You can use the change plan to define changes to your federated or Db2 database and to define how to implement the changes.

      For example, right-click the Wrappers folder and select Create wrapper. When you create the wrapper, the Object List area opens and the new wrapper is displayed in the Default Change Plan view.

    3. Specify the object attributes and options in the Properties view.
      Figure 1. Example of Administration explorer, object list, and properties view.
      This figure shows the Administration Explorer. The Federated objects folder is highlighted in the Administration Explorer in the left panel. The Ojbects list displays on the upper right with the Change plan toolbar. The properies view displays on the bottom right.using applications.
      The following properties are required for federated objects:
      Table 1. Required object properties
      Federated objects Required object properties
      • Library name
      • DBNAME option
      • Name
      • Type
      • Version
      • Remote user ID
      • Remote password
      User mappings
      • Local user ID
      • Server name
      • Remote user ID
      • Remote password
      • Name
      • Server
      • Remote schema
      • Remote table
      Federated stored procedures
      • Name
      • Server
      • Remote schema
      • Remote procedure
  3. Review and deploy the commands.

    When the object definitions are complete, click Review and Deploy Changes to review the generated DDL and deploy the object definitions. You can edit the commands, run the commands, or schedule the plan to run later.

    Figure 2. Example of the Review and Deploy dialog with definitions for a wrapper, server, user mapping, and nickname.
    This figure shows the Review and Deploy dialog with SQL statements to create a wrapper, server, user mapping, and nickname.


You can now access the federated objects that you created in the Federated Database Objects folder to manage those objects. For example, you can select a wrapper and choose Alter wrapper to make modifications to a wrapper definition, or you can choose Drop wrapper to remove a wrapper.