YDSPMDLREF (Display Model References) Command

This command allows a user to display references to a list of model objects. References can be displayed, printed or converted to a model object list.
ca2e87
This command allows a user to display references to a list of model objects. References can be displayed, printed or converted to a model object list.
Contents
Required
YDSPMDLREF-Required (48) YDSPMDLREF-Required (49) YDSPMDLREF-Required (50) Required (51) YDSPMDLREF-Required (52) YDSPMDLREF-Required (53) YDSPMDLREF-Required (54) YDSPMDLREF-Required (55) YDSPMDLREF-Required (56) YDSPMDLREF-Required (57) YDSPMDLREF-Required (58) YDSPMDLREF-Required (59)
Parameters
The following are parameters for the YDSPMDLREF command.
MDLLST
The qualified name of the model object list containing the objects whose references are displayed. Values for these parameters are as follows:
  • *MDLPRF
    -- Special value meaning that the model object list name is retrieved from the user defaults for the current user in the specified model library.
  • list name
    -- The model object list name.
  • *MDLLIB
    -- (default) Special value meaning that the first model library found in the user's current library list is used as the model library.
  • library name
    -- The model library name for the list.
OUTPUT
This parameter determines how the references are presented. Values for these parameters are as follows:
  • *
    -- (default) References are displayed.
  • *MDLLST
    -- References are directed to a model object list. This option enables users to perform further list operations on the list entries.
  • *PRINT
    -- References are printed.
 If referenced objects are subject to filtering, then the primary object details are only printed if at least one referenced object satisfies the filtering criteria specified. This reduces the volume of output.
OUTMDLLST
The name of the model object list that receives output from the command. Values for these parameters are as follows:
  • *MDLLST
    -- (default) Special value meaning that the output should be placed in the input list.
  • *USER
    -- Special value meaning that the model object list name is the same as the name of the current user.
  • *MDLPRF
    -- Special value meaning that the model object list name is retrieved from the user defaults for the current user in the specified model library.
  • list name
    -- The target model object list name.
OUTLSTOPT
This parameter specifies the action to be taken if the output list already exists. Values for these parameters are as follows:
  • *REPLACE
    -- (default) The existing model object list should be replaced with the output from this command.
  • *ADD
    -- The existing model object list should be augmented with the output from this command.
EDIT
This parameter specifies whether the resulting output list is edited as part of processing. Values for these parameters are as follows:
  • *NO
    -- (default) Editing of the list is not performed.
  • *YES
    -- Editing of the list is performed.
JOBLST
Qualified name of job list that contains the names of source members to be generated and/or compiled. If the nominated job list does not already exist, it will be created. Values for these parameters are as follows:
  • *MDLPRF
    -- (default) Retrieve the job list name from the model profile details of the current user.
  • *USER
    -- The job list name is the same name as the current user.
  • *WORKSTN
    -- Use device name of current work station as list name.
  • *SELECT
    -- Display a list of existing job lists, one of which may be selected. The name of the job list may be entered
  • *MDLLIB/
    -- The job list library is the first model library found in the library list.
  • *GENLIB/
    -- Use the generation library specified in the first model found in the library list.
  • *SRCLIB/
    -- Use the source library specified on the model profile of the current user.
  • *LIBL/
    -- The job list library is the first model found in the library list.
  • *CURLIB/
    -- The model library is found in the current library for the current job.
  • The job list library can be entered.
SSNLST
This parameter specifies the session list to use while editing the model. Values for these parameters are as follows:
  • *MDLPRF
    -- (default) The session list is to be retrieved from the model profile details for the current user.
  • *USER
    -- The session list has the same name as the current user.
  • *SELECT
    -- An interactive display is used to select a model object list to be used as the session list.
The name of the list can be entered.
For more information on the purpose of SSNLST, refer the Change Model Profile command (YCHGMDLPRF).
SCOPE
This parameter allows the user to control the extent to which references are traced. Values for these parameters are as follows:
  • *NOMAX
    -- (default) No maximum level of expansion.
  • *NEXT
    -- Expansion proceeds to the next level only.
  • *EXTFUN
    -- This option is intended for use with objects of type FUN. Expansion proceeds up to and including the first external function on each chain of references. This enables the user to determine the functions referenced by a given program.
FILTER
This parameter allows the user to specify filtering on the objects displayed. Values for these parameters are as follows:
  • *ANY
    -- (default) No filtering of objects is performed.
  • *GENOBJ
    -- Only generatable objects are displayed.
  • *DBFFUN
    -- Only database functions are displayed.
  • *ERR
    -- Only references to deleted objects are displayed.
  • *EXTFUN
    -- Expand references down to and including the first generated function.
  • *INTFUN
    -- Only internal functions are displayed.
  • Object type
    -- A specific object type may be entered for filtering purposes. They are: *ACP, *ARR, *APP, *CND, *FIL, *FLD, *FUN, and *MSG
CMTCDE
This parameter allows the inclusion of inactive AD code in the analysis:
  • *YES --
    Inactive code is included.
  • *NO
    -- Inactive code is not included.
  • *IGN
    -- Code is not examined for active/inactive status. The WRN field will not be populated. Processing of *IGN is typically much faster.
  • *MDLVAL
    -- Retrieve the value from the
    CA 2E
    model value (YCMTCDE).
EXCSYS
This parameter allows the exclusion of system objects from the analysis. System objects are the internal objects used by
CA 2E
such as the ‘*Standard Header/Footer’ internal file. The value for this parameter is as follows:
  • *YES
    -- (default) System objects are excluded.
  • *NO
    -- Include system objects.
CUROBJ
This parameter allows the exclusion of non-current versions from the analysis. Currency only applies to objects that are supported for versioning. Values for these parameters are as follows:
  • *YES
    -- (default) Only current objects are included.
  • *NO
    -- Include system objects.
REASON
This parameter allows the reason for the dependency between objects to be part of the filtering process. Values for these parameters are as follows:
  • *FIRST
    -- (default) The processing program will note the first reason when an object is encountered.
  • *ALL
    -- All subsequent encounters with a given object are included.
  • REASON
    -- A specific reason may be entered. The processing program will search for dependencies of the specified reason.
FLAGVAL
This parameter allows the input list entries to be filtered according to the value of the object selected indicator for each entry. Values for these parameters are as follows:
  • *ANY
    -- No selection processing is performed.
  • *ERROR
    -- Only process entries flagged in error are considered.
  • *SELECTED
    -- Only process selected entries are considered.
Notes
The model library specified must be a valid model library.
A value other than *MDLLIB for MDLLST may result in the library list being changed. If the user is currently editing a model, the switching of the library list will not occur and the command will fail. If changed during processing, the library list is not changed back after execution.
If the output model list does not exist prior to running the command, it is created.
If the list is printed, the display model references panel is used. This panel is described below.
If the resulting list is printed, the Document Model Object list command (YDOCMDLLST) is called.
The edit parameters are ignored if the running job is a batch job.
The filtering parameter is applied to the expanded details. Thus, if the output is to display, the filtering may be adjusted without having to rebuild the expansion. If output is to a model list, the filtering is performed when the entries are written to the list.
An indented output format is used for the *PRINT option whenever this is appropriate. If the default of *FIRST is used for the REASON filter, the objects are sorted in a keyed sequence. It would be inappropriate to indent this sequence because the relationships between the objects are purely arbitrary. However, any other value for REASON will cause the processing program to examine objects strictly in the order of expansion; the indented format here clearly shows the hierarchy of dependencies to assist developers.
The reason code *DSLDBF signifies that the function object is used or referred as a default database Function. But the option was not selected in the Function options of the referring Function. For example, Create record, Change record, or Delete Record were set to 'N'. You can control the display of this reason code by changing the data area named "YDSLDBFRFA" in the model library. The command to change the data area is as follows:
CHGDTAARA DTAARA(model-library/YDSLDBFRFA *ALL) VALUE(N)
Reference Table
The Ref level value refers to the level of reference by a given object to the original object that is displayed on the subfile control. This value may be changed by the user and will control the data shown in the subfile. By manipulating the range of levels available, all possible reference levels can be viewed individually or in combination.
The Ref type column in the subfile refers to the reason for the reference. The following table shows the possible reasons for references between model objects. Actual references to a given model object will depend upon the model object type.
Obj Type
To Type
Ref Code
Reason
Note
All
 
*ENTRY
Displayed only on the first panel when you access the YDSPMDLREF panel for a model object list rather than for a single list entry; for example, by using the YDSPMDLREF command or F22 from the YEDTMDLLST panel. It indicates that each list entry displayed has simply been updated to reflect its current state in the model; no references have been expanded. Your original list is not changed. You can now perform impact analysis on single list entries using the selection options. See also the online Help for the panel and the Impact Analysis topic in article 1 of Generating and Implementing Applications.
 
ACP
ACP
*ASSACP
For associated access path, such as the UPD access path for a given RTV.
 
 
ACP
*REFACP
For referenced access path, such as the RTV access path on a file-to-file relation of a referring access path.
 
 
AUX
*ACPAUX
For access path auxiliaries.
1
 
CND
*ACPCND
For access path condition.
 
 
FIL
*REFFIL
For owning FIL.
 
 
FLD
*PHYENT
For access path physical entries.
2
 
FUN
*SELRCD
For select record override function. No references.
 
CND
CND
*LSTCND
For list condition.
 
 
FLD
*REFFLD
For owning field.
 
APP
-
 
No references.
 
ARR
ACP
*ARRDTL
For array entry details.
 
 
FIL
*REFFIL
For associated FIL.
 
 
FLD
*ARRENT
For array entries.
 
FIL
FIL
*REFFIL
For referenced FIL.
 
 
FIL
*SHRFIL
For file defining a sharing level.
 
 
FLD
*FILENT
For field appearing as an entry.
 
 
FLD
*MAPFLD
For field mapping (user-defined field types).
 
 
FLD
*PARFLD
For field mapping (user-defined field types).
 
 
FLD
*SRCFLD
For field mapping (user-defined field types).
 
 
FLD
*RNMFLD
For renamed entry.
 
 
FLD
*VRTENT
For field as virtual entry.
 
 
MSG
*RCDEXS
For record exists message.
 
 
MSG
*RCDNFD
For record not found message.
 
FLD
CND
*FLDCND
For condition.
 
 
FLD
*REFFLD
For domain definition.
 
 
FUN
*EXTINT
For external/internal conversion function (user-defined field type).
 
 
FUN
*FLDUSR
Field-attached user source function (enabled)
 
 
FUN
*INTEXT
For internal/external conversion function (user-defined field type).
 
FUN
ACP
*BASED
For based-on access path.
 
 
ACP
*FUNPAR
For function/message parameter definition.
 
 
ARR
*BASED
For based-on array.
 
 
ARR
*FUNPAR
For function/message parameter definition.
 
 
CND
*ABOCND
For action bar condition.
 
 
CND
*ACTCND
For action diagram condition.
 
 
CND
*DEVCND
For screen entry condition.
 
 
CND
*VLDCND
For field validation condition.
 
 
DSP
*DSPDTA
For display file details.
1
 
FIL
*REFFIL
For owning FIL.
3
 
FLD
*ACTION
For action diagram compares.
 
 
FLD
*DEVENT
For device fields.
 
 
FLD
*FUNPDT
For function/message parameter details.
 
 
FLD
*PARAM
For action diagram parameter fields.
 
 
FLD
*REFFLD
For derived field.
4
 
FLD
*SCRMAP
For screen field mapping (user-defined field types).
 
 
FLD
*SCRPAR
For screen field mapping (user-defined field types).
 
 
FLD
*SCRSRC
For screen field mapping (user-defined field types).
 
 
FLD
*SCRTXT
For screen text field.
5
 
FUN
*ACTION
For action diagram functions.
 
 
FUN
*DFTDBF
Default database function.
 
 
FUN
*DSLDBF
Deselected database function.
 
 
FUN
*DEVSTR
For device structure reference.
 
 
FUN
*DEVUSR
Device-attached user source function
 
 
FUN
*ENTUSR
Entry-attached user source function
 
 
FUN
*FLDUSR
Field-attached user source function (disabled)
 
 
FUN
*FMTUSR
Format-attached user source function
 
 
FUN
*RPTUSR
Report-attached user source function
 
 
FUN
*SCRUSR
Screen-attached user source function
 
 
FUN
*SELRCD
For select record override function.
 
 
HLP
*HLPDTA
For help file details.
1
 
MSG
*ACTION
For action diagram message.
 
 
SRV
*FUNAUX
For function auxiliary.
 
The Note column indicates whether or not there is a reciprocal entry in the usage table by the referenced object. The numbers in the column refer to the following explanations as to why there will not be a corresponding usage entry:
The referenced object is not a primary object.
Reference is for object redefinition only, the relationship is already noted using *FILENT.
The usage of FIL to FUN is not a useful piece of information. The usage might, however, be discernible via ACP. In other words, usage on a FIL will display any ACP objects attached to the FIL. These in turn will display any using FUN objects.
The relationship between FLD and FUN represents the interdependency of these two objects on each other. The FLD object actually uses the FUN. However, the FUN is not a primary object. It is not treated as a function in its own right and is not accessible except through the FLD object.
The reference of FUN to FLD for screen text is not treated as a bona fide usage since the fields involved are internal product objects only.
Example
To edit the list of generatable object references to objects existing on model object list TMPLST:
YDSPMDLREF MDLLST( *MDLLIB/TMPLST ) + OUTPUT( *MDLLST ) EDIT( *YES ) +
FILTER( *GENOBJ )