Field Active Retrieval

#### Search Results

Search

# Field Active Retrieval

The Field Active Retrieval screen is displayed with function code A and object code EL in a main menu or the command `ACTIVE ELEMENT`.

        13:55:18             *****  P R E D I C T  *****              2007-05-31
        Plan   3              - (EL) Field Active Retrieval -               Profile HNO

                           Retrieval type

                           D  Fields
                           R  Fields referenced by members
                           U  Fields inconsistently used
                           O  Fields not documented

        Retrieval type ...
        Output mode .....*

        Field ID/Synonym .                                  Synonym language .*
        in file ..........                                  Usage ............*

        Restrictions ....*   Profile HNO,used               For master fields . N (Y/N)
        Output options ..*   Profile HNO                    Save set .......... N (Y/N)

        Command ===>
        Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
              Help  Next  Stop  Last  LnkEl Flip  Print Impl  AdmFi SelFi Prof  Main

Field Active Retrieval functions retrieve information from Predict field objects and from XRef data on the use of fields by implemented members. XRef data on the use of fields can only be evaluated for fields contained in implemented files. A file is regarded as implemented if

- a DDM has been generated for the file, or

- at least one 3GL program using the file has been processed by the Predict Preprocessor, Adabas Native SQL or the Adabas SQL Precompiler.

This document covers the following topics:

- Retrieval Type, Output Mode and Save Set Option

- Limiting the Scope of Field Active Retrieval

- Retrieval Types

## Retrieval Type, Output Mode and Save Set Option

An active retrieval operation consists of a retrieval type and an output mode. The retrieval types are described in more detail below. The output mode determines how the results are presented. Not all output modes are valid for all retrieval types. See table below:

Retrieval Type | Code | Output Mode | Save Set
select | list | disp | count
--- | --- | --- | ---
Fields | D | X | X | X |  |
Fields referenced by members | R | X | X |  | X | X
Fields inconsistently used | U | X | X |  |  |
Fields not documented | O |  | X |  |  |

## Limiting the Scope of Field Active Retrieval

Not all parameters are valid for all retrieval types. See table below:

Parameter | Retrieval Type
--- | ---
D | R | U | O
Field ID/Synonym | X | X | X |
File | X | X | X | X
Language | X | X | X |
Usage |  | X | X |
Master |  | X | X |
Restrictions | X | X | X |
Output options | X | X | X |

Parameter | Description
--- | ---
Field ID/Synonym | Name of field or field name synonym. Synonyms are defined with the field attribute Field name synonym. Synonyms are used as field names when generating external objects from files.
Synonym language | Language of field name synonym. Enter asterisk for valid values. See table below for result of retrieval operations when synonym language is entered.
Field ID/synonym | Synonym language | Result
ABC* | C (COBOL) | - Fields with a COBOL synonym (for example) starting with ABC. - Fields with name starting with ABC and having no COBOL synonym.
ABC* | all | - Fields with any language synonym starting with ABC. - Fields with name starting with ABC without a synonym in at least one language.
ABC* | blank | All fields with name starting with ABC.
in file | Limits operation to fields in implemented file with specified ID. Enter asterisk to specify range.
Usage | How the field is used.
A | Defined in area. The field is defined in a view of a Natural data area.
C | Counter. The C* (counter) variable of a MU or PE is used:
S | Search. The field is used in a search criterion:
R | Read. The field is used in a FIND or READ statement.
O | Read only. The field is read but not modified.
M | Modify. The field is used in an UPDATE or STORE statement.
N | Store. The field is used in a STORE statement.
U | Update. The field is used in an UPDATE statement:
blank | All.
Restrictions | The scope of the function can be limited by Restrictions . Restrictions can be specified temporarily with code T in this field or taken from a profile. See Using Restrictions and Output Options from Profiles.
For master fields | Retrieval types R and U can be restricted to show only the references to master fields. The related master fields are selected for each user view matching the other selection criteria.
Output options | Output options determine the amount of information contained in a report. Output options can be specified temporarily with code T in the field Output options or taken from a profile. Enter asterisk for valid values or see Output Options for more information. Only output options Cover page, Page size and Sorted by field apply to field active retrieval operations.

## Retrieval Types

### Fields - Code D

Provides information on fields by invoking the retrieval type of same name. Output mode D, L or S must be specified:

Output Mode | Description
--- | ---
D | Shows for each field the attributes that are specified in the output options.
L | Shows a single-line list of fields with some main attributes.
S | Shows list as above, from which fields can be selected for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.

### Fields referenced by members - Code R

Provides information on members using fields. Output mode L, C or S must be specified:

Output Mode | Description
--- | ---
L | Shows for every referenced field the list of all members using the field. Member type/language/library, file number, database number and field usage are also indicated. Command: REFERENCED ELEMENT
C | Shows for every referenced field a summary list which indicates for each library and each field usage (for example read or update) the number of members that use the field. Command: COUNT ELEMENT
S | Shows a list of referenced fields indicating how many members use each field. Fields can be selected for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.

### Fields inconsistently used - Code U

Shows a list of fields that are not used by any member or which may be used inconsistently, for example a field that is never updated or a descriptor that is never used for a search.

If the parameter Usage is specified, only those fields which are not used as specified are shown. For example: If Usage=U, only fields which are not updated are shown.

Output mode L or S must be specified:

Output Mode | Description
--- | ---
L | Lists fields inconsistently used. Some main attributes are also given, together with a brief description of the possible inconsistency. Examples: - used, but not updated - not used for search. Command: `UNUSED ELEMENT`
S | Shows list of fields used inconsistently with file ID and usage code. Fields can be selected from the list for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.

### Fields not documented - Code O

Shows a list of fields referenced by members but not documented in Predict. Output mode L must be specified:

Output Mode | Description
--- | ---
L | Lists undocumented referenced fields. Member type/language/library, file number, database number and field usage are also indicated. Command: `UNDEFINED ELEMENT`

### On this page

- Retrieval Type, Output Mode and Save Set Option
- Limiting the Scope of Field Active Retrieval
- Retrieval Types