Creating Documentation Data

Data dictionary objects can be created

  • manually

  • with incorporation functions or the function Redocument program

  • with the Load/Import functions of the Predict Coordinator

  • using other Software AG systems

  • using the Predict Application Programming Interface (API)

The different options are described below.

Note:
It is strongly recommended not to write data to the Predict file with any other method. Predict performs comprehensive consistency checks before adding or modifying documentation data. These checks naturally do not apply when writing to the Predict file directly.

This document covers the following topics:

Creating Predict Objects Manually

Predict functions to create or maintain object descriptions can be called with commands or using a menu. See Creating Predict Objects in the section Maintenance in the Predict Reference documentation.

Creating Predict Objects from Implemented Objects

  • Predict objects documenting data structures and objects of type user can be created from external objects with incorporation functions.

  • Predict objects documenting Natural and 3GL programs can be created with the function Redocument program.

The table gives an overview of which objects can be incorporated from implemented code:

System/Language Type of Object
Adabas Databases, files
DB2 Databases, Tables/views
Adabas SQL Server Tables/views
Natural for DL/I Database descriptions (NDB),
User defined fields, (UDF)
Natural Data definition modules (DDM), Classes, Interfaces, Methods, Programs, Properties, Resources (information is taken from XRef data)
COBOL Copy Code
Super Natural User information
Natural Security User information
3GL programs Programs (information is taken from XRef data)
Following SQL systems
Adabas D Informix Ingres Oracle Sybase 		Tables/views

Loading Objects with the Predict Coordinator

Data dictionary information which is already available in a suitable machine-readable format can be loaded into a Predict data dictionary with the Predict Coordinator utility. When loading, it is possible to replace matching information which already exists in the data dictionary.

See the Predict Coordinator documentation for more information.

Using Other Software AG Systems

Various other Software AG systems create Predict data, for example Predict Case, or Natural Construct.

See the documentation of the respective products for more information.