Optional

Commands (YADDMDLLE - YCHKMDLOBJ) › YCHKFUNPAR (Check Parameter Interfaces) Command › Optional

Optional

                                 ┌──────► YCHKFUNPAR ──────┐
YCHKFUNPAR ─────── MDLLIB ───────┤                         ├─────►
                                 └── model library name ───┘

Parameter

The following parameter is for the YCHKFUNPAR command:

MDLLIB

The name of the model to be analyzed. Values for this parameter are described in the following:

*MDLLIB—(default) Special value indicating the model library is the first one in the current library list.
model library name—The name of the model to be analyzed may be entered explicitly.

Examples

YCHKFUNPAR processing includes processing to provide feedback on the progress. If the job is running interactively, a message is sent that indicates the current object being processed and the percentage complete. For example:

Processing Object 837 of 2476. 33% Completed.

If the job is running interactively or in batch, a message is sent to the joblog to indicate the total number of objects to be processed, and a message is sent when every 10% block is reached. For example:

YCHKFUNPAR (MYMDL)
Total number of objects to process: 169    
Processing Object 1 of 169. 0% Completed.  
Processing Object 17 of 169. 10% Completed.
Processing Object 34 of 169. 20% Completed.
Processing Object 51 of 169. 30% Completed.
Processing Object 68 of 169. 40% Completed.
Invalid duplicate parameter field on Function 'CHANGE BOOKING' (@@1100454) on File 'BOOKING'. Processing Object 85 of 169. 50% Completed.
Invalid duplicate parameter field on Function 'CANCEL BOOKING' (@@1100541) on File 'BOOKING'.
Non-unique parameter SEQ on Function 'PREPARE LOGIN'   (@@1100562) on File 'SECURITY'.
Processing Object 102 of 169. 60% Completed.
Invalid duplicate parameter field on Function 'PROCESS BILL' (@@1100624) on File 'BILL'.
Invalid duplicate parameter field on Function 'PROCESS TICKET' (@@1100645) on File 'TICKET'.
Processing Object 119 of 169. 70% Completed.
Non-unique parameter SEQ on Function 'VALIDATE ORDER' (@@1100742) on File 'ORDER'.
Processing Object 136 of 169. 80% Completed.
Processing Object 153 of 169. 90% Completed.
Processing Object 169 of 169. 100% Completed.
Non-unique parameter SEQ on Function 'CHECK CUSTOMER'   (@@1100872) on File 'CUSTOMER'. 
4 functions identified that contain an invalid duplicate parameter field.
3 functions identified that contain non-unique parameter SEQ & DUP PARMS=Y.
Model MYMDL examined to identify functions with invalid parameter interfaces. See job log for details.

YCHKJOBLE (Check Job List Entries) Command

Checks whether a source member or i OS object exists for each entry on a job list. Checks your authority to each i OS object found. You can also use the command to check your authority level to each i OS object found. If the object already exists, it is dropped from your job list.

Optional

Parameters

The following are parameters for the YCHKJOBLE command.

JOBLST

Qualified name of a job list where you place entries. Name of the job list whose entries are checked. Values for this parameter are described in the following:

*MDLPRF—(default) The job list name is retrieved from the model profile details for the current user.
*WRKSTN—Defaults job name to job list name of invoking job.
*MDLLIB/—Defaults job list name to user profile name in model library.

UPDLST

List update option. Values for this parameter are described in the following:

*RMVOK—(default) Remove verified items from list; that is, if the corresponding source member (CHKFILE parameter), i OS object (CHKLIB parameter), or specified authorities (CHKAUT parameter) are found.
*RMVERR—Remove items from list that are not verified.

CHKLIB

Name of the library to use when checking for the existence of i OS objects corresponding to each job list entry. Values for this parameter are described in the following:

*NONE—(default) Do not check for any object's existence.
*GENLIB—Check for objects in the generation library of the model (YGENLIB model value).
*CURLIB—Check for objects in the current library.
*LIBL—Use the current job's library list.

CHKGUI

Name of shared folder to check for the existence of Synon/TC source objects corresponding to each job list entry. Values for this parameter are described in the following:

*NONE—(default) Do not check for any object’s existence.
*GUIFLR—Check for objects in the Synon/TC shared folder of the model (YGUIFLR).

CHKFILE

Qualified source file name to check for the existence of a source member corresponding to each job list entry. Values for this parameter are described in the following:

*NONE—(default) Do not check for a corresponding source member.
*GENTYPE—Use the default source file name as specified by the edit generation types display; for example, QRPGSRC for RPG III source, QCLSRC for CL source.

CHKAUT

i OS authorities to check after checking for object or source member existence, as specified by the CHKLIB or CHKFILE. The value for this parameter is as follows:

*NONE—Do not check for authorities when checking existence of corresponding source members or i OS objects.

For more information on i OS authority values, refer to the IBM CL Programmers guide.

Notes

The job list must already exist. Job lists are created using either the command Build Job List (YBLDJOBLST) or Convert Model List (YCVTMDLLST) from a command line, or by prompting the command from within a design model.

Example

To check for the existence of i OS objects in the generation library corresponding to the entries on job list MYJOBLST, removing all the entries for which a corresponding i OS object is found:

YCHKJOBLE UPDOPT(*RMVOK) +
CHKLIB(*GENLIB) JOBLST(MYJOBLST)

YCHKMDL (Check Model) Command

This command checks your model for inactive internal records and unresolvable model object references. These can occur, for example, if a power outage results in an incomplete update or if a developer makes an error while using YWKRF to change model file data.

The ACTION parameter lets you specify whether the internal files or the objects in your model are to be checked. It also lets you specify whether the command will run in prepass or update mode. All errors found are reported, and in update mode, inactive internal records are backed up to files in a library you specify before being deleted from the model.

Note: If you need to restore data from a backup file, you should take great care to specify the correct member name. It will be the same as the name of your model library. When copying data back, be sure to specify *ADD for the MBROPT parameter on the Copy File (CPYF) command.

Optional

Parameters

The following are parameters for the YCHKMDL command.

MDLLIB

The name of the model to be analyzed. Values for this parameter are described in the following:

*MDLLIB—(default) Special value indicating the model library is the first one in the current library list.
model library name—The name of the model to be analyzed may be entered explicitly.

ACTION

Specifies the type of check to perform and whether to run in prepass or update mode. A report is produced listing any data in error. Values for this parameter are described in the following:

*ANALYZE—(default) The command checks each object in the model and all objects that use the object (usages) and all objects that it refers to (references). This can be a lengthy process for large models. No update is performed.

This option produces a separate report that shows any unresolvable references that are encountered during the expansion of a given object; for example, if a model object refers to an object that has been deleted from the model.
If the report shows any errors, first attempt to remove them using *UPDATE and run the *ANALYZE analysis again. If there are any entries remaining after running the second analysis, please contact your local product support representative who will assist you with their removal.

*PREPASS—The command analyzes those internal files that can automatically be updated in *UPDATE mode and reports any inactive records. No actual update is performed.
*UPDATE—The command performs the same analysis as in the *PREPASS mode, and also deletes inactive records from the internal files.

BAKLIB

The name of the library that is to receive backup data.

The data is written to a file that has a name similar to that of the originating file; the member name is the same as the name of your model library. For example, an inactive record in the YSCRENTRFP file (screen or report device entries) in model library MYMODEL, would be written to file YSCRENTXXP and member MYMODEL in the backup library. You can therefore specify a single backup library to store all deleted data from all the models on the system.

This parameter is prompted only in *UPDATE mode. Values for this parameter are described in the following:

*MDLLIB—(default) Special value indicating the model library is to be the backup library.
library name—The name of the backup library may be entered explicitly.

UPDOPT

This parameter specifies whether new data written to the backup members should replace or be added to existing data. This parameter is prompted only in *UPDATE mode. Values for this parameter are described in the following:

*ADD—(default) Special value indicating that the new data should be added to any existing data in the backup members.
*REPLACE—The existing data should be cleared during processing.

TEXT

The text to be attached to any new members added to the backup files. This parameter is prompted only in *UPDATE mode. Values for this parameter are described in the following:

*DFT—(default) Special value indicating that a standard message will be used as new member text.
member text—The user may specify the text to be used when adding new members to the backup files.

Example

To examine internal files in model library GR5MDL and to produce a report without updating data:

YCHKMDL  MDLLIB(GR5MDL)  ACTION(*PREPASS)

Additional Processing

YCHKMDL processing now includes some additional processing to provide feedback on the progress of YCHKMDL.

If the job is running interactively, a message is sent to the screen to indicate the current object being processed and the percentage complete. For example:

Processing Object 837 of 2476. 33% Completed.

If the job is running interactively or in batch, a message is sent to the joblog to indicate the total number of objects to be processed, and a message is sent when every 10% block is reached. For example:

Total number of objects to process: 2476
Processing Object 1 of 2476. 0% Completed.
Processing Object 248 of 2476. 10% Completed.
Processing Object 496 of 2476. 20% Completed.
Processing Object 743 of 2476. 30% Completed.
Processing Object 991 of 2476. 40% Completed.
Processing Object 1238 of 2476. 50% Completed.
Processing Object 1486 of 2476. 60% Completed.
Processing Object 1734 of 2476. 70% Completed.
Processing Object 1981 of 2476. 80% Completed.
Processing Object 2229 of 2476. 90% Completed.
Processing Object 2476 of 2476. 100% Completed.

YCHKMDLLST (Check a Model Object List) Command

This command allows a user to simultaneously check model object list entries and to remove certain, unwanted entries. The command also allows entry details to be refreshed from the originating object.

An outlist capability allows users to filter entries to an alternative list leaving the input list unchanged by the filtering process. In other words, if you specify an output list, the input list will not be updated.

Optional

Parameters

The following are parameters for the YCHKMDLLST command.

MDLLST

The qualified name of the model object list that is checked. Values for this parameter are described in the following:

*MDLPRF—(default) Special value meaning that the model object list name is retrieved from the model profile details for the current user in the specified model library.
*USER—Special value meaning that the user profile name of the current user is used as the list name for the target of the command.
*SELECT—Special value indicating that the model object list is selected using an interactive display function.
list name—The name of the list.
*MDLLIB—(default) Special value meaning that the first model library found in the user's current library list is used.
library name—The name of the model library.

CHKTYPE

Check list entry method. Values for this parameter are described in the following:

*BYSGT—(default) The list entries are checked by object surrogate number.
*BYNAME—The list entries are checked by object name.

UPDLST

List update option. Values for this parameter are described in the following:

*RFSALL—(default) The data contained in each list entry are refreshed from the corresponding model object details.
*RFSSGT—Only the surrogate number of each list entry is refreshed from the corresponding model object details. The CHKTYPE parameter must be *BYNAME for this option.
*FLAGERR—If an error occurs during processing of a list entry, the entry is flagged. The value to use is specified by the OUTFLAGVAL parameter. This value may be the subject of a later filtering operation. Note that if entries are flagged, then the OUTFLAGVAL parameter must be set to the desired value.
*FLAGOK—If an error does not occur during processing of a list entry, the entry is flagged. The value to use is specified by the OUTFLAGVAL parameter. This value may be the subject of a later filtering operation.
*RMVERR—If an error occurs during processing of a list entry, the entry is removed from the list.
*RMVOK—If the processing of a list entry completes without error, the entry is removed from the list.

Note: The updating of model lists is controlled by the UPDLST parameter. For example, it must specify *RMVERR if invalid entries are deleted from the input list or omitted from copy to the output list. Users should also note that the flagging of entries occurs if the UPDLST parameter instructs the program to do so. However, the appropriate value to use should be specified in the OUTFLAGVAL parameter to avoid the default value of blank.
When an output list is specified the input list is not updated.
If *RMVERR is specified together with an output list, it has the effect of not copying input list entries to the output list. Such entries are not removed if they already exist on the output list.

FLAGVAL

This parameter allows model object list entries to be filtered by the model object list entry flag value. Values for this parameter are described in the following:

*ANY—(default) No filtering on flag value is to be performed.
*ERROR—Only entries flagged as being in error satisfy the filter. Other entries are ignored.
*SELECTED—Only explicitly selected model objects satisfy the filter. Other entries are ignored.

CHKMDL

Check model library name. This parameter enables objects from one model to be checked against objects of the same name in another model. Values for this parameter are described in the following:

*MDLLIB—(default) The list entries are checked against objects in the same model.
model name—The model that entries are checked against.

CUROBJ

This parameter identifies whether the objects on the list are current. Values for this parameter are described in the following:

*ANY—(default) Objects are not checked.
*YES—Only current objects satisfy the check.

CHKLST

The checked out to list may be examined with this parameter. Values for this parameter are described in the following:

*ANY—(default) Any value for checked out to list is acceptable.
*MDLLST—List entries must be checked out to the current list.
*MDLPRF—List entries must be checked out to the model object list specified on the current user's model profile.
*USER—Entries must be checked out to the model list that has the same name as the current user.
list name—A list name may be specified.

CHKSTS

The check out status of list entries may be checked. Values for this parameter are described in the following:

*ANY—(default) Check out status is not examined.
*NONE—Special value meaning that entries should have no value for check out status.
status value—User-defined value. Up to five values may be specified for check out status.

CHKMDLLCK

This parameter allows the lock status of each object on the list to be examined. Values for this parameter are described in the following:

*NONE—(default) No examination of object locks is made.
*YES—Objects on the list must not be locked.

OUTFLAGVAL

This parameter specifies the value used in combination with the UPDLST parameter. Selected list entries are updated with this value if UPDLST is specified as *FLAGERR or *FLAGOK. Values for this parameter are described in the following:

*NONE—(default) No updating of the flag value is performed.
*ERROR—Entries which satisfy the filtering criteria are flagged as *ERROR if UPDLST is specified as *FLAGERR or *FLAGOK.
*SELECTED—Entries that satisfy the filtering criteria are flagged as selected if UPDLST is specified as *FLAGERR or *FLAGOK.

OUTLST

The name of the model object list which is the target for entries that satisfy any filter. Values for this parameter are described in the following:

*NONE—(default) Special value meaning that no outlist processing is performed.
*MDLPRF—Special value meaning that the model object list name is retrieved from the model profile record for the current user in the specified model library.
*USER—Special value meaning that the user profile name of the current user is used as the list name.
list name—The name of the target list.

OUTLSTOPT

This parameter specifies the action taken if the outlist specified in the OUTLST parameter already exists in the model. Values for this parameter are described in the following:

*REPLACE—(default) The existing model object list is replaced with the output from this command.
*ADD—The existing model object list is augmented with the output from this command.

Notes

The input model object list must already exist prior to running this command.
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 changed back after execution.
If an error is detected during processing of the list entries, a diagnostic message is sent for each error encountered, and an escape message is sent at the end of processing. When using this command in CL programs, users may monitor for the escape message which is sent. The message id for this message is Y2E0328.
The OUTLSTOPT parameter is ignored if *NONE is specified for OUTLST. If the specified OUTLST does not exist prior to running this command, it is created.
If the CHKMDL parameter is specified (i.e., other than *NONE) then the CHKTYP must specify *BYSGT, since it is not possible to compare objects between models by surrogate key number.

Example

To refresh model object list OLDLST so that all the list entries are completely up to date:

YCHKMDLLST MDLLST( *MDLLIB/OLDLST ) + UPDLST( *RFSALL )

To check model object list FUNLST to determine that all objects on the list still exist in the model:

YCHKMDLLST MDLLST( *MDLLIB/FUNLST ) + UPDLST( *RMVERR )

Using the *RMVERR option for UPDLST will ensure that only valid objects remain on the list.

Tell Technical Publications how we can improve this information