File Active Retrieval

The File Active Retrieval screen is displayed with function code A and object code FI in a main menu or the command ACTIVE FILE.

    13:58:15             *****  P R E D I C T  *****              2007-05-31
    Plan   3               - (FI) File Active Retrieval -               Profile HNO
   
                       Retrieval type
   
                       D  Files
                       R  Files referenced by members
                       U  Files inconsistently used
                       O  Files not documented
                       V  Files accessed via dynamic SQL
   
    Retrieval type ...
    Output mode .....*
   
    File ID ..........                                  Files of type ...*
    in database ......                                  File number ......
                                                        Usage ...........*
    Restrictions ....*   Profile HNO,used               For master files . 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

File Active Retrieval functions retrieve information from Predict file objects and XRef data on the use of implemented files. A file is regarded as implemented

if a DDM has been generated for the file, or
if at least one 3GL program using the field has been processed by the Predict Preprocessor, Adabas Native SQL or the Adabas SQL Precompiler

Retrieval types R, O and V consider only implemented files.

This document covers the following topics:

Retrieval Type, Output Mode and Save Set Option
Limiting the Scope of File 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
Retrieval Type	Code	select	list	disp	count	Save Set
Files	D	X	X	X
Files referenced by members	R	X	X		X	X
Files inconsistently used	U	X	X
Files not documented	O		X			X
Files accessed via dynamic SQL	V	X	X			X

The results of retrieval types R, O and V can be saved in sets and processed with the Natural command LIST XREF. See Using Sets .

Limiting the Scope of File Active Retrieval

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

Parameter	Retrieval Type
	D	R	U	O	V
File ID	Y	Y	Y	Y	Y
Files of type	Y	Y	Y		Y
in database	Y	Y	Y		Y
File number	Y	Y	Y		Y
Usage		Y	Y		Y
Restrictions	Y	Y	Y		Y
For master files		Y	Y
Output options	Y	Y	Y		Y

Parameter	Description
File ID	ID of Predict files to be processed. Use asterisk to specify range.
in database	Restricts operation to file(s) in database specified. Use asterisk to specify range of databases.
Files of type	Restricts operation to files of type specified. Enter asterisk for valid values. Enter blank for all file types.
File number	If a file number is entered, the operation is restricted to this file number. If no number is entered, all files are considered. It is not possible to enter a range of values.
Usage	This parameter applies to retrieval types R, U and V. Valid values: A, S, R, O, M, N, U, D, blank.
	A	Defined in area. A view of the file is defined in a Natural data area.
	S	Search.
	R	Read. The file is used in a FIND or READ statement.
	O	Read only. The file is read but not modified.
	M	Modify. The file is used in an UPDATE, STORE or DELETE statement.
	N	Store. The file is used in a STORE statement.
	U	Update. The file is used in an UPDATE statement.
	D	Delete. The file is used in a DELETE 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 files	Retrieval types R and U can be restricted to show only the references to master files. For each master file the members using the master file either directly or via a userview are listed.
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 Output Options for more information.

Retrieval Types

Files - Code D

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

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

Files referenced by members - Code R

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

Output Mode	Description
L	Shows for every referenced file the list of all members using the file. Member type/language/library, file number, database number and file usage are also indicated. Command: `REFERENCED FILE`.
S	Shows a list of referenced files for selection indicating how many members use each file. Files can be selected for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.
C	Shows for every referenced file a summary list which indicates for each library how many members use the file and the file usage, for example read or update. If members of more than one library use the file, the total usages are also given. Command: `COUNT FILE`.

Files inconsistently used - Code U

Shows a list of files that are not used by any member or which may be used incorrectly.

Example: a file that is never updated or never deleted

If the parameter Usage is specified, only those files which are not used as specified are shown.

Example: If Usage=U, only files which are not updated are shown. Only implemented files are considered with this retrieval type.

Output mode L or S must be specified:

Output Mode	Description
L	Lists files not used in the manner specified. 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 FILE`
S	Produces list as above, from which files can be selected for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.

Files not documented - Code O

Shows a list of files that are referenced by members but are not documented in Predict and have no DDM. To find out which DDMs are not documented in Predict, use the function Incorporate DDM.

Command: UNDEFINED FILE

Output mode L must be specified:

Output Mode	Description
L	Lists undocumented referenced files. Member type/language/library, file number, database number and file usage are also indicated.

Files accessed via dynamic SQL - Code V

Lists DB2 tables and views (file types D or E) that are used by Natural members but not via static SQL.

Output mode L or S must be specified:

Output Mode	Description
L	Lists the specified files. Member type/language/library, file number, database number and file usage are also indicated. Command: `DYNAMIC FILE`
S	Shows a list as above, from which files can be selected for further processing or commands added to the workplan. Enter an asterisk in field Cmd for list of possible functions.