Managing External Objects

This document covers the following topics:


Generating an External Object

You can generate an external object from a documentation object.

Start of instruction setTo generate an external object

  1. Select the documentation object for which you want to generate an external object.

    You can generate an external object from the following object types:

    • DB2 databases

    • dataspaces

    • files of many different types

    • programs of type database function and SQL procedure

    • storagespaces

    • verifications of type automatic

  2. Invoke the context menu and choose Schema Generation Wizard.

    The schema generation wizard appears.

  3. Specify all required options. If available choose the Next button to proceed to the next page.

    For detailed information on the object type-specific information that can be specified using this wizard, see Generation of External Objects in External Objects in Predict.

  4. If all required information has been specified, choose the Finish button to start generation.

    When the generation process has completed, the last page of the wizard is shown. When the List option has been selected on a previous page of the wizard, a report is shown. If an error occurs during the generation process, an error report is shown.

Incorporating External Objects

This section describes the wizard that is used for schema incorporation.

The wizard provides several pages in which you have to specify information. The number of pages and the information on these pages depends on the object type that has been selected on the first page of the wizard.

For detailed information on the object type-specific information that can be specified using this wizard, see Incorporation in External Objects in Predict.

The wizard uses edit controls such as text boxes, check boxes or drop-down list boxes. For the description of check boxes, the reference documentation External Objects in Predict uses the abbreviations Y (yes) and N (no). Y means that the check box is selected, and N means that the check box is not selected.

Start of instruction setTo incorporate an external schema

  1. In the Natural server view, choose Predict Description and Generation > Schema Incorporation Wizard.

    Or:
    In the Predict Description and Generation view right-click on the root node and select Schema Incorporation Wizard

    The schema incorporation wizard appears, providing several pages.

    Schema incorporation - page 1

    Note:
    If DB2 is not installed at your site, the incorporation functions for DB2 objects are not available.

  2. Select the option button for the type of external object that you want to incorporate.

  3. Choose the Next button to proceed to the next page.

    The information on the next pages depends on the object type that has been selected on the first page.

    Example - incorporate Adabas file:

    Schema incorporation - page 2

  4. Specify the selection criteria and choose the Next button to proceed to the next page.

    Example - incorporate Adabas file:

    Schema incorporation - page 3

    The incorporation functions that are available on this page depend on the object type that has been selected on the first page.

  5. From the drop-down list box, select the object that you want to incorporate.

    When an object has been selected, the option button(s) for the incorporation function(s) that can be executed for this object are visible.

    For general information on these buttons, see Overview of Incorporation Options in External Objects in Predict.

  6. Select the option button for the incorporation function that you want to execute (Incorporate, Connect or Test) and choose the Next button to proceed to the next page.

    An additional page appears when you have selected the incorporation function Incorporate or Connect. You can then specify the incorporation or connect options.

    Example - incorporation options for an Adabas file:

    Schema incorporation - page 4

    Note:
    Different options or pages appear for the incorporation functions Connect and Test.

  7. Specify the required information and choose the Next button to proceed to the next page.

    Example - incorporate Adabas file:

    Schema incorporation - page 5

    This page shows only the settings which have been modified on the previous pages.

  8. If all required information has been specified, choose the Finish button to start incorporation.

    Note:
    As long as you do not choose the Finish button, you can go back to the previous pages by choosing the Back button.

    When the incorporation process has completed and the List incorporated code option has been selected previously, a report is shown in a separate Predict Report view. If this option has not been selected, a message box shows only the resulting message of the incorporation process.

    However, if an error occurs during the generation process, an error report is shown in the Predict Report tab. The error report is always shown. The setting of the List incorporated code option is not considered in this case.

    Example - incorporate Adabas file:

    graphics/one-inc-wizard6.png

    You can Print the report on a printer that is defined in your environment or Save it using the standard Eclipse functions of the File menu .

Refreshing an External Object

You can refresh Adabas files and DB2 tables/views. When you refresh such an external object, you delete all of its contents.

See Administration of External Objects in External Objects in Predict.

Caution:
Do not confuse this type of refresh (this term is used with Adabas) with the refresh function which updates your display see Refreshing the Tree.

Start of instruction setTo refresh an external object

  1. Open the External Objects node containing the external object that you want to refresh.

  2. Select the external object.

  3. Invoke the context menu and choose Refresh External.

    Note:
    When the refresh function is not available for the selected external object, the Refresh External command is disabled.

    A dialog box appears asking whether you really want to refresh the object.

  4. To refresh the current object, choose the OK button.

Disconnecting an External Object

When you disconnect an external object from its corresponding documentation objects, the implementation pointer from the documentation object to the external object is deleted, but the object itself remains intact.

See Administration of External Objects in External Objects in Predict.

Start of instruction setTo disconnect an external object

  1. Open the External Objects node containing the external object that you want to disconnect.

  2. Select the external object.

  3. Invoke the context menu and choose Disconnect.

    A dialog box appears asking whether you really want to disconnect the object.

  4. To disconnect the current object, choose the OK button.

    Disconnected external objects are no longer shown in the External Objects node.

Purging an External Object

You can purge external objects using the Delete command. When you purge an external object, it is disconnected and physically deleted.

See Administration of External Objects in External Objects in Predict.

Start of instruction setTo purge an external object

  1. Open the External Objects node containing the external object that you want to purge.

  2. Select the external object.

  3. Invoke the context menu and choose Delete.

    A dialog box appears asking whether you really want to delete the object.

  4. To confirm the deletion for the current object, choose the OK button.