NaturalONE Version 8.3.7
 —  Predict Description and Generation  —

Managing Documentation Objects

This document covers the following topics:


Object Type-Specific Content Editors

An object type-specific content editor appears when you open an existing documentation object, or when you add a new documentation object.

The object type-specific content editors have different tabs with different types of edit controls.

Note:
With Predict 4.6.1 Fix 1 the metadata structures are changed to be more user friendly. Therefore, it may appear that tabs and edit controls within tabs are differing from those displayed in this documentation.

Tabs

Two types of tabs are available:

The tabs are shown at the bottom of the content editor. When more tabs are available than can be shown on the screen, a number at the bottom right indicates that there are more tabs. When you select this number, you can display a tab by choosing its name from a list.

graphics/ecl-tablist.png

Several tabs require that you specify mandatory information. Such a tab shows an asterisk (*) next to the tab name.

Simple Edit Controls

Some tabs provide simple edit controls such as text boxes, check boxes or drop-down list boxes.

For the description of check boxes, the reference documentation Predefined Object Types 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.

Text Box

Some tabs such as the Overview tab provide a simple text editor such as the Abstract section. Edit commands like Copy and Paste are available in a context menu. Example:

graphics/one-editor-abstract.png

Text Editor

The following tabs provide a text editor:

Using the commands from the common Edit menu, you can Cut, Copy, Paste, Delete, Select All and Find/Replace text. In addition, you can undo and redo your last change and make a Revert File operation.

The above commands are available using the corresponding Eclipse keyboard shortcuts.

Some of these commands are also available when you invoke the context menu in the editor.

When using the editor the following functions are available:

Tables

Some tabs provide tables to which you can add new information. A table may contain one or more resizable columns. Example:

graphics/one-table-assosize.png

The following command buttons are provided with a table:

Command Button Description
Add... Creates a new row containing several cells in which you can enter information.
Remove Removes the selected row.

The following functions are provided in the context menu of a table:

Command Button Description
Insert Creates a new row containing several cells in which you can enter information.
Delete Deletes the selected row.

To modify existing information in a cell of the table, simply overwrite it. You can either enter information directly in a cell or select it from a drop-down list box.

Saving Your Changes

To save your changes in an object type-specific content editor, you simply use the Eclipse save functionality.

Notes:

  1. When you save a new object and a name has not yet been specified, the Save As dialog box appears. In this case, you have to specify a name for the new documentation object and choose the OK button.
  2. When mandatory information has not been specified, an appropriate error message is shown in a dialog box. The tab on which information is missing is automatically shown. The documentation can only be saved after all mandatory information has been specified.

Top of page

Adding a New Documentation Object

You can manually add documentation objects for all predefined and user-defined objects types in Predict. You have to specify all information yourself, including the implementation pointer. This function is helpful, if documentation is to take place before implementation. Information on the implementation pointer can be found under Opening the Description for a Natural Object.

Start of instruction setTo add a new documentation object

  1. Select the object type for which you want to add a new object.

  2. Invoke the context menu and choose New.

    In some cases, you have to select a type (for example, a database type) in a dialog box. The resulting content editor then shows object-specific information.

  3. Specify all required information as described in the reference documentation Predefined Object Types in Predict. See also Object Type-Specific Content Editors.

Top of page

Locking of Documentation Objects

When a documentation object is modified, renamed or deleted, it is automatically locked to prevent concurrent updates.

When working with associations and links, the following applies:

Caution:
Currently, locking of documentation objects is only possible on the client side when using Predict Description and Generation. When performing actions on documentation objects in Predict on the server side, the locking mechanism is ignored. This can result in inconsistent data.

When a system interruption has occurred, you can manually unlock locked documentation objects.

Important:
You should only unlock a documentation object when you are sure that this object is currently not being edited by another user.

Start of instruction setTo unlock a documentation object

  1. Select the documentation object that you want to unlock.

  2. Invoke the context menu and choose Unlock Object.

Top of page

Opening/Displaying an Existing Documentation Object

When you open a documentation object, it is possible to modify it (edit mode). There is one exception: when the documentation object is currently locked, it is only possible to view the information, it is not possible to modify the documentation object (read-only mode).

Start of instruction setTo open a documentation object

  1. Select the documentation object.

  2. Invoke the context menu and choose either Open or Display.

    Or:
    Double-click the documentation object.

    An object type-specific content editor appears. See also Object Type-Specific Content Editors.

Top of page

Renaming a Documentation Object

You can change the object ID with the Rename command. The new object ID must not already exist in the dictionary.

Start of instruction setTo rename a documentation object

  1. Select the documentation object that you want to rename.

  2. Invoke the context menu and choose Rename.

    A dialog box appears prompting for a new name.

  3. Specify another name and choose the OK button.

Top of page

Purging a Documentation Object

You can purge documentation objects using the Delete command.

For further information on the purge process, see the object type-specific descriptions in the reference documentation Predefined Object Types in Predict.

Start of instruction setTo purge a documentation object

  1. Select the documentation object that you want to purge.

  2. Invoke the context menu and choose Delete.

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

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

Top of page

Printing and Saving a Report for a Documentation Object

The information shown in an object-type specific window (which can be invoked with the Open or Display command) can also be shown as a report in simple text format. It is possible to print and save this report.

Start of instruction setTo print and save a report

  1. Select the documentation object.

  2. Invoke the context menu and choose Report.

    A window such as the following appears.

    graphics/one-report-window.png

  3. Choose the desired command button:

    Command Button Description
    Print The Print Setup dialog box appears. Specify all required information (for example, a different printer or text orientation) and choose the OK button.
    Save The Save Report dialog box appears. Select the folder in which you want to store the report, specify a report name and choose the Save button.
  4. To close the window in which the report is shown, choose the OK button.

Top of page