List XRef for Third Generation Languages

In addition to documentation objects, which establish the metadata model of an application, XRef data is stored in Predict. XRef data document objects of an application that are already implemented. Data of this type mirror the current implementation status of an application.

This document covers the following topics:

• Creation of XRef Data for 3GL

• Contents of XRef Data for 3GL

• Types of LIST XREF Functions for 3GL

• Calling Functions of LIST XREF for 3GL

• Retrieving Information for Individual Members

• Verify Application

• Operate on Sets

• Maintaining a LIST XREF Profile

Creation of XRef Data for 3GL

XRef data for programs in third generation languages is written by different utilities:

• By Adabas Native SQL (COBOL, FORTRAN, PL/I and ADA).

• During precompilation with the Predict preprocessor (Assembler, COBOL and PL/I). The preprocessor is described in the section Preprocessor in the External Objects in Predict documentation.

• If Natural DB2 is installed, the function CREATE DBRM of Natural for DB2 creates XRef data for Natural programs that use static SQL.

• If a 3GL program is documented in Predict as a system, XRef data is automatically created when the program is documented in the data dictionary as a program in the library *SYSSYS*. The invocation method is CALL.

Where XRef Data for 3GL Members is Stored

With this version of Predict, you can store XRef data for 3GL members in the default library from the table below, or you can define your own library by documenting this library as a Predict object of type system. The Library parameter is also used by the preprocessor.

Contents of XRef Data for 3GL

• Which Invocation Methods are Evaluated

The following information is stored for 3GL members:

• the name of the program and the application it belongs to

• the program type (only main program)

• the date and time the program was last cataloged

• the ID of the user who cataloged the program

• the ID of the terminal from which the program was cataloged (in batch mode: the job name)

• the names of 3GL programs invoked and the methods used to invoke them (only CALL, static SQL)

• the names of external programs invoked

• the names of files used in the program and the type of file usage (deleting, reading or updating)

• the names of fields of files used in the program and the type of field usage (for counting, reading, searching or updating) (3GL precompiled by Adabas Native SQL).

Which Invocation Methods are Evaluated

See table below for the invocation methods evaluated when generating XRef data for third generation languages.

Types of LIST XREF Functions for 3GL

XRef data for third generation languages is retrieved with functions of the Predict XRef menu. There are essentially three groups of functions:

• Functions that retrieve information on specific types of members in an application
  All functions from Invoked programs through Report programs with xref data in the XRef Menu are of this type (see screen below). See Retrieving Information for Individual Members .

• Functions that retrieve information on the consistency of an application as a whole
  The functions are called via a submenu that is called with code A (Verify application). See Verify Application.

• Functions that manage sets
  Sets allow efficient use of information retrieved from XRef data. Most of these functions can be executed only from a menu. See Using Sets.

 13:00:18              *****  P R E D I C T  *****                2007-05-31
                                -   Xref Menu   -
   
                            Code Object
                            ---- -------------------------------
                              I  Invoked programs
                              V  Views and fields
                              C  Copycode
                              X  Report programs with xref data
                              A  Verify application
                              O  Operate on sets
                           ---- -------------------------------
    Code....................:   (./?)
    Library ...............*:
    Library structure ID ...:
    System Id ..............:
   
    Command ===>
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

The following functions are not available for static SQL:

Calling Functions of LIST XREF for 3GL

All LIST XREF Functions for third generation languages can be called from the Predict XRef menu or with a command. The XRef Menu itself can be called with a command ACTIVE XREF or with function code X in a Predict main menu.

A library must be specified, either a default library from the table below or a user-defined library.

Example for PL/I:

LOGON SYSDIC
   MENU
   ACTIVE XREF *SYSPLI* PROGRAM USING VIEW

See LIST XREF Commands for more information on calling LIST XREF function with commands.

Using Sets

The LIST XREF for third generation languages often produces a list of objects that need further processing. To facilitate further processing Predict will save the output list of LIST XREF for third generation languages in a set, if the Save set switch of a Predict LIST XREF function is set to Y. Sets are saved in the same libraries as the active references for those languages. Up to ninety-nine sets of member types and names can be saved at any time in any library.

See Using Sets for more information.

Retrieving Information for Individual Members

All Predict LIST XREF function display information on members written in one specific third generation language. It is not possible to retrieve active reference information for more than one third generation language in one call.

Invoked Programs

The functions of the Invoked Programs screen display XRef data about programs that are invoked from 3GL programs. The functions do not apply to static SQL. The screen is displayed by selecting code I in the XREF menu.

   13:23:13             *****  P R E D I C T  *****               2007-05-31
    Library:  LIBRARY          - Invoked Programs -                               
    
                  Code Function                                               
                  ---- -----------------------------------                    
                    D  Count references in program                            
                    C  Count references to program                            
                    U  Program using programs                                 
                    R  Program referenced in programs                         
                    E  Program using programs recursively                     
                    I  Program referenced in programs recursively             
                    X  Xref program using programs                            
                    Y  Xref program referenced in programs                    
                  --- -----------------------------------                     
    Code...........: ? (./?)                          Save set..: N (Y,N)          
    
    Using program..:                                                               
    Referenced prg.:                                                               
    External.......:                                  Rec. depth: 7 (1-7)          
     
    Command ===>                                                                   
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

Function Codes

Truncating the Output - Functions E and I

In some cases the listing of a LIST XREF function is truncated and marked as follows:

• Recursion is marked with rec and the output is terminated.

• The output can be truncated and marked with trunc at a level (up to seven) selected by the user.

• The user can enter other parameters that limit the output (for example, to programs of a particular type or with IDs beginning with a particular letter). Output terminated in this way or terminated by a reference to a 3GL program is marked stop.

• A program that has already been displayed at a higher level in the retrieval hierarchy is not repeated at a lower level. Instead the program is suppressed and marked suppr.

Limiting the Scope of the Functions

The following parameters limit the scope of the functions.

Views and their Fields

The functions of the Views and Fields screen display XRef data about views and fields. The screen is displayed by selecting code V in the XRef menu for a 3GL.

    13:24:19             *****  P R E D I C T  *****              2007-05-31
     Library:  LIBRARY        -    Views and Fields   -
   
   
                       Code Function
                       ---- -----------------------------------
                         C  Count references to view
                         D  Count references to field of view
                         U  Program using views
                         R  View referenced in programs
                         F  Program using fields of views
                         G  Field of view referenced in programs
                       ---- -----------------------------------
    Code...........: ? (./?)
                                                      Save set....: N (Y,N)
    Program........:
    View...........:                                  View usage..:   (?)
    Field..........:                                  Field usage.:   (?)
   
   
    Command ===>
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

Function Codes

Parameters Limiting the Scope of the Functions

Copy Code

The functions of the Copy Code screen display XRef data about copy code. The functions do not apply to static SQL. The screen is displayed by selecting C in the XRef menu.

For programs in third generation languages, XRef data is only stored for copy code if is used directly (not via any other copy code).

     13:04:13            *****  P R E D I C T  *****              2007-05-31
     Library:  LIBRARY              - Copycode -
   
   
   
                         Code Function
                         ---- -------------------------------
                           C  Count references to copycode
                           U  Program using copycodes
                           R  Copycode referenced in programs
                         ---- -------------------------------
   
    Code...........: ? (./?)
                                                      Save set.... N (Y,N)
    Program........:
    Copycode.......:
   
   
   
   
    Command ===>
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

Report Programs with XRef Data

The function Report Program retrieves and displays a summary of active reference information about programs. The screen is displayed by selecting code X in the XRef menu for a 3GL.

     13:07:26            *****  P R E D I C T  *****              2007-05-31
     Library:  LIBRARY           - Report  Program -
   
   
             Program: ________  (?)
             User Id: ________  Terminal Id : ________
           from date: __________     to date: 2007-05-31
          short list: N (Y,N) save set: N (Y,N)
   
          Report                          Nr   Report                          Nr
          ------------------------------- --   ------------------------------- --
          Statistical data                 1   Predict description              2
          Using / Referenced programs      4   Views and fields                 5
          Copycodes                        7
   
          Format extended description      N   Suppress empty reports           Y
          ------------------------------- --   ------------------------------- --
   
    Command ===>
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

Up to five types of information can be retrieved and displayed by the function:

Verify Application

The following screen is displayed by selecting code A in the XRef menu for a 3GL (not available for static SQL):

    13:08:58             *****  P R E D I C T  *****              2007-05-31
     Library:  LIBRARY       - Verify Appl. Integrity -
   
   
   
   
   
                       Code Function
                       ---- -----------------------------------
                         R  Programs not referenced
                         E  Externals not impl. but referenced
                       ---- -----------------------------------
    Code...........: ? (./?)
   
   
    Save set.......: N (Y,N)
   
   
   
   
    Command ===>
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Invp  GDAV  Quit  Sets  Rule  Copy  Xref  View  OSet  SPfk  Main  Exit  

Operate on Sets

The names and object types of 3GL objects can be saved in sets for further processing. The information contained in the section Operate on Sets also applies to 3GL sets.

Maintaining a LIST XREF Profile

Three types of settings can be changed in a LIST XREF profile:

• PF key assignments

• the information to be included in reports created with the Report program function, and the sequence in which the information is to be displayed.

• the functions to be executed by the Verify all function.

See Maintaining a LIST XREF Profile.