YDOCMDLREL (Document Model Relations) Command

Documents the relations within a design model.
ca2e87
Documents the relations within a design model.
Contents
Optional
YDOCMDLREL-Optional (150) YDOCMDLREL-Optional (151) YDOCMDLREL-Optional (152) YDOCMDLREL-Optional (153)
Parameters
The following are parameters for the YDOCMDLREL command.
MDLREL
Listed relations. Values for these parameters are as follows:
  • *USER
    -- (default) List only the user-defined relations in the model.
  • *ALL
    -- List all relations in the model including the relations that define internal objects.
APPCDE
Name of an application area that the files referenced by the listed relations belong to. The value for this parameter is as follows:
  • *ALL
    -- (default) Include relations that use files from all application areas.
PRTTEXT
Specifies whether narrative text for the relations 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.
RELPRTLVL
Specifies which types of relations you want to include in the generated documentation. Values for these parameters are as follows:
  • *ALL
    -- (default) Include all relations.
  • *FIL
    -- Include only file level relations.
  • *KEY
    -- Include only key level relations.
  • *ATR
    -- Include only field level relations.
  • *DF
    -- Include only Defined as relations.
PRTENT
Specifies whether the entries from file-to-file relations are included in the generated documentation. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not list entries.
  • *RDR
    -- List only redirected entries.
  • *ALL
    -- All entries from file-to-file relations (Owned by, Refers to) are listed after the relations that give rise to them.
PRTCHGDAT
Specifies whether the change dates for relations are printed. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any change dates.
  • *ALL
    -- Print all change dates.
  • Otherwise, PRTCHGDAT is a list parameter made up of two elements:
    • Date operator:
  • *EQ
    -- (default) Equal to.
  • *LT
    -- Less than.
  • *GT
    -- Greater than.
    • Date (entered in system date format)
Notes
A library containing the model files must be present in the library list of the job that executes the YDOCMDLREL command.
Example
To print details about all model files in a model library, including the functional narrative text:
YDOCMDLREL PRTTEXT(*FUNC) RELPRTLVL(*ALL)