YDOCMDLFLD (Document Model Fields) Command

Documents the fields within a design model.
ca2e87
Documents the fields within a design model.
Contents
 
Optional
YDOCMDLFLD-Optional (132) YDOCMDLFLD-Optional (133) YDOCMDLFLD-Optional (134)
Parameters
The following are parameters for the YDOCMDLFLD command.
MDLFLD
Specifies whether you want to omit system fields from the listing. Values for these parameters are as follows:
  • *USER
    -- (default) List all user-defined fields in the model.
  • *ALL
    -- List all fields in the model, including system fields.
PRTTEXT
Specifies whether narrative text for the fields should be 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.
PRTFLDDTL
Specifies whether you want to include full details for the fields in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include field details.
  • *YES
    -- Include field details.
PRTCND
Specifies whether the names of any field conditions referenced by the fields are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include conditions.
  • *YES
    -- Include conditions.
Notes
A library containing the model files must be present in the library list of the job that executes the YDOCMDLFLD command.
Example
To print all details about the model fields in a model library:
YDOCMDLFLD PRTTEXT(*FUNC) PRTFLDDTL(*YES) + PRTCND(*YES)