Standard Predict Commands

#### Search Results

Search

# Standard Predict Commands

Commands described in this section apply to all or most predefined and user-defined object types. The following rules apply to this description:

- For details of individual functions see the sections Maintenance, Retrieval and Active Retrieval in this documentation and Administration of External Objects in the External Objects in Predict documentation.

- Type-specific features or parameters of standard commands are described in the respective sections under Type-specific Commands.

This document covers the following topics:

- Standard Maintenance Commands

- Standard Retrieval Commands

- Standard Administration Commands

Active retrieval commands differ greatly for the different object types. For this reason they are described with the individual object types in this section and in the section Active Retrieval.

## Standard Maintenance Commands

The following rules apply to all of standard maintenance commands:

- In the following command descriptions, the predefined Predict object type or the user-defined object to be processed is represented by <object-type>.

- All type-specific features of standard maintenance commands are described in detail in the section Type-Specific Commands.

- If no valid <object-ID> is specified with any of the following commands, the maintenance menu for the respective object type is displayed.

Command Syntax | Description
--- | ---
ADD <object-type><object-ID> | If valid <object-ID> is entered or present in hot object table, this is taken as ID for the new object and one or more Add object screens appear. See the respective sections of Predefined Object Types in Predict for a detailed description of the attributes and corresponding input fields for the predefined object types.
COPY <object-type><object-ID><copy-ID> | If both <object-ID> and copy-ID are entered and are valid, the Copy object screen appears. Specify additional attributes to copy <object-ID> to <copy-ID>. Special rules apply when copying fields.
MODIFY <object-type><object-ID> | If valid <object-ID> is entered or present in hot object table, the Modify Object screen for this object appears.
RENAME <object-type><object-ID> | If valid <object-ID> is entered or present in hot object table, the Rename Object screen for this object appears. Special rules apply when renaming databases and files.
PURGE <object-type><object-ID> | If valid <object-ID> is entered or present in hot object table, the Purge Object screen for this object appears. Special rules apply when purging certain object types. These are described in the respective sections of Predefined Object Types in Predict.
EDIT <object-type> DESCRIPTION<object-ID> | If valid <object-ID> is entered or present in hot object table, the object extended description of an object can be edited directly.
EDIT <object-type> OWNER<object-ID> | If valid <object-ID> is entered or present in hot object table, the owner list of the object can be edited directly.
LINK <object-type> <active-association-type> <object-ID> | If both parameters are entered and are valid, the list of children of type <active-association-type> for <object-ID> can be edited directly. See Links to Child and Parent objects .

## Standard Retrieval Commands

Command Syntax | Description
--- | ---
DISPLAY| LIST| SELECT<object-type><parameters> | Executes the retrieval type Objects - Code D with output mode Display, List or Select. Information is retrieved on individual objects or range of object IDs.
SHOW <object-type><parameters> | Executes the retrieval type Objects - Code D. If the session variables table contains output mode Display, List or Select, this value is taken. If output mode is not contained in this table or is invalid for this retrieval type, output mode will be List.
EXECMODEL <object-type><parameters> | Executes the retrieval type Execute retrieval models - Code E with output mode Structured List or Cross Reference. Displays information on the associations of objects in the form of a structured or cross reference list.
DUMMY <object-type> <passive-association-type><parameters> | Executes retrieval type Dummy/Placeholder objects - Code C with output mode Select, List or Display. Output option Dummy/Placeholder determines whether dummies and/or placeholders are displayed.
PARENTS <object-type> <passive-association-type>| ALL <parameters> | Executes retrieval type Objects with parents - Code B with output mode List or Display. Lists objects with parents of type <passive-association-type>. If no object ID is entered, all objects are listed (hot object logic does not apply). If no parent type is entered, value is either taken from hot object table (if present) or a selection window appears.
FREE <object-type> <passive-association-type> | ANY | ALL <parameters> | Executes retrieval type Objects with no parent - Code O with output mode Select, List or Display. Lists objects with no parent of <passive-association-type> or with no parents of any type. If no object ID is entered, all objects are listed (hot object logic does not apply). If no parent type is entered, value is either taken from hot object table (if present) or a selection window appears. Note In owner retrieval this command refers to owners with no user only. See Owner Retrieval for further information.
CHILDREN <object-type> <active-association-type> | ALL <parameters> | Executes retrieval type Objects with children - Code T with output mode List or Display. Lists objects with children of <active-association-type>. If no object ID is entered, all objects are listed (hot object logic does not apply). If no child type is entered, value is either taken from hot object table (if present) or a selection window appears.
EMPTY <object-type> <active-association-type>| ANY | ALL <parameters> | Executes retrieval type Objects with no child - Code U with output mode Select, List or Display. Lists objects with no children of <active-association-type> or with no children of any type. Object ID and child type are stored in the hot object table. If no child type is entered, value is either taken from hot object table (if present) or a selection window appears. Note In owner retrieval this command refers to objects with no owners only. See Owner Retrieval for further information.

## Standard Administration Commands

Before executing these commands see the section Administration of External Objects in the External Objects in Predict documentation.

Command Syntax | Description
--- | ---
DISCONNECT<external-object-type><object-ID> | Disconnects documentation objects and external objects by deleting the implementation pointer of the documentation objects.
DISPLAY<external-object-type><object-ID> | Displays documentation data, generation options and the generation log for the specified external object. For some objects, only the generation log is displayed. See Administration of External Objects in the External Objects in Predict documentation for more information.
PURGE<external-object-type><object-ID> | Physically deletes the external object and any dependent objects. Not available for all external object types. See Administration of External Objects in the External Objects in Predict documentation.
SELECT<external-object-type><object-ID> | Used to select an external object for further processing with one of the Administration functions.

### On this page

- Standard Maintenance Commands
- Standard Retrieval Commands
- Standard Administration Commands