Program Retrieval

This document covers the following topics:

Program-Specific Retrieval Parameters

The following program-specific parameters determine the scope of reports.

Program of type Restrict report to programs of the given type. See Program Types for a list of valid types.
Language Restrict report to programs of the given language. See Languages for a list of valid languages.
Member Restrict report to programs documenting the given member.
Library Restrict report to programs documenting a member in the given library. See Program-Specific Libraries for a list of standard libraries.
User system Fnr Restrict report to program objects documenting implemented programs in this user system file.
User system DBnr Restrict report to program objects documenting implemented programs in this database.
Belongs to SY Restrict report to programs belonging to this system object.

Function Programs with Children with Child Type Program

The Retrieval function Program with Children with association "Uses PR concept." evaluates only documentation data. If you need information on the implementation of a program, use the Active Retrieval function Programs using programs.

Layout of Program Lists 

13:54:04             *****  P R E D I C T  *****               2007-05-31
                              - List Program -

-------------------------------------------------------------------------------
Cnt  Program ID                         Type Lang Member   Library    Fnr   DBnr

  14 STK-PR-O                            P    O   CP1E     ST-PRDE
  15 STK-PR-STATIC-SQL                   P    Q   HUXEL    HUXEL      255    255
  16 STK-PR-1                            O
  17 * STK-PR-2                          N    N   N-SECCHC
                                  Implementation: N-SECCHC GMA         54    180
                                                  N-SECCHC NEWDICCO    54    180
  18 STK-PROC                            R    S   KSTK     KKKKK
  19 * STK-REDOC                         P    N   Z-HI1    STK
                                  Implementation: Z-HI1    STK         54    180
Meaning of Columns
Program ID The ID of the program object.

Note:
An asterisk in the first column indicates that the program is implemented. Implemented in this sense means that XRef data exists for the documentation object.

Type Program type. See Program Types for a list of valid types and codes.
Lang. The language in which the program is written. See Languages for list of valid languages and codes.
Member, Library, Fnr, DBnr Implementation pointer of the program object, or - if the object is implemented - the physical implementation of the member(s) documented by the program.
In the sample screen above, program STK-PR-2 has implementation pointer N-SECCHK (for member) and documents member N-SECCHK in libraries GMA and NEWDICCO.

Output Options for Program Retrieval

Note:
Unless output mode is S, the option Cover page is always valid. Page size is only applicable when printing or if general default parameter Use SAG Editor for output is set to Y. Page size is not applicable in batch mode.

Retrieval type D B O T
dummies=Y|N dummies=D|P
Output Mode D L D L D L D L D L
Current/Related c c c r c r c c c r c r c r c r
Association attributes     Y Y Y Y     Y Y Y Y        
Attributes Y   Y       Y   Y       Y      
Connecting character       Y           Y            
Description Y   Y Y     Y   Y Y     Y      
Display modifier Y   Y       Y   Y       Y      
Dummy/Placeholder                   Y   Y   Y   Y
Entry points Y   Y       Y   Y       Y      
Extract Y   Y Y     Y   Y Y     Y Y    
Keywords Y   Y Y     Y   Y Y     Y      
Mark implementation Y Y Y Y Y Y Y Y Y Y Y Y Y   Y  
No. abstract lines Y Y Y Y Y Y Y Y Y Y Y Y Y   Y  
Owner Y   Y Y     Y   Y Y     Y      
With users Y   Y Y     Y   Y Y     Y      
Procedure code Y   Y       Y   Y       Y      
Show implementation Y Y Y       Y   Y       Y      
Use Con-form Y   Y Y     Y   Y Y     Y      
User exit Y   Y       Y   Y       Y      

Output Options for Program Retrieval - Continued

Retrieval Type U E C
Output Mode D L T X L D
Current/Related c c c r c r c r c r
Association attributes     Y Y            
Attributes Y     Y   Y        
Connecting character       Y   Y        
Description Y         Y       Y
Display modifier Y                  
Dummy/Placeholder       Y   Y Y   Y  
Entry points Y                  
Extract Y     Y   Y     Y Y
Keywords Y     Y   Y       Y
Mark implementation Y Y Y Y Y Y   Y   Y
No. abstract lines Y Y   Y   Y   Y   Y
Owner Y     Y   Y       Y
With users Y                 Y
Procedure code Y                  
Show implementation Y                  
Use Con-form Y         Y       Y
User exit Y