YDOCMDLACP (Document Model Access Paths) Command

Documents the access path files within a design model.
ca2e87
Documents the access path files within a design model.
Contents
Optional
YDOCMDLACP - optional YDOCMDLACP - Optional
YDOCMDLACP - Optional YDOCMDLACP - Optional
YDOCMDLACP - Optional
 
Parameters
The following are parameters for the YDOCMDLACP command.
MDLFILE
Types of files whose access paths are documented. Values for these parameters are as follows:
  • *USER
    -- (default) List the access paths of all user-defined files in the model.
  • *ALL
    -- List the access paths of all files in the model, including system files.
APPCDE
Name of an application area to which the files whose access paths are listed belong. The value for this parameter is as follows:
  • *ALL
    -- (default) List the access paths of files from all application areas.
PRTTEXT
Specifies whether narrative text for the access path is included in the generated documentation, and if so, which type of text. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not include narrative text.
  • *FUNC
    -- Include functional text.
  • *OPER
    -- Include operational text.
PRTACPDTL
Specifies whether the details of the access path are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include full details.
  • *YES
    -- Include full details.
PRTACPTYP
Specifies the types of access path that are included in the generated documentation. Values for these parameters are as follows:
  • *ALL
    -- (default) Include all access path types.
  • *PHY
    -- Include only physical access paths.
  • *UPD
    -- Include only update access paths.
  • *RTV
    -- Include only retrieval access paths.
  • *RSQ
    -- Include only resequence access paths.
  • *SPN
    -- Include only span access paths.
  • *QRY
    -- Include only query access paths
BGNNEWPAG
Specifies whether documentation for a function or file starts on a new page or not. Values for these parameters are as follows:
  • *DFT
    -- (default) Do not start a new page.
  • *FILE
    -- Start a new page for each file whose functions are documented.
Notes
A library containing the model files must be present in the library list of the job that executes the commands.
Example
To print all details about the model files in a model library:
YDOCMDLACP