Parameters of reference summary

Descriptions and values for parameter elements are given in Parameter-elements.

ABEND (AB)

Sets end-of-job (EOJ) processing based on abnormal conditions during execution.

AB=[n]

Values for n are:

ACCUM (A)

Accumulates specified fields in the input records.

Character or Binary Data Accumulation Syntax:

A=(location,length,data-type[,'description'])

Packed Decimal Data Accumulation Syntax:

A=(location[,'description'])

Valid data-type codes are:

Use up to 25 characters in the optional description.

AMODE

Specifies the address mode to select. Valid only with the LMODCLAS, LMODMAPA, LMODDIR, LMODMAPN functions.

AND

See IF (AND, ORIF).

AUDIT (AUD)

Creates an Audit trail dataset and writes before and after images of changed/unchanged records.

x

Value of Y, A, or N. The values are defined as:

CCSID

Defines the CCSID for Unicode conversion when format-printing the record. The value of nnnnn must be numeric (0 through 99999) of valid CCSID. Valid only with the APRINT, FPRINT, VPRINT, and XMLGEN functions

CCSID=nnnnn

CEM

Copies empty members of a partitioned data set.

CEM={N}
    {Y}

CHANGED (CHA)

Selects a group of members from a PDS based on the member’s last modified date. The from or to-date range is specified in the yy/mm/dd format.

CHARSET (CHR)

Defines the character set from the code page table to determine which language set to use. The value of xxxx equals the last four characters of the language code.

CHR=xxxx

COMPARERC (CRC)

The COMPARERC parameter overrides File-AID/MVS configuration parameter UNEQUAL_COMPARE_RETURN_CODE. Valid entries are hexadecimal values 00 through FF.

COMPARERC=nn

COPTNS

Specifies additional options for the condensed Compare reports. This parameter is valid only for condensed compare. Condensed compare is for Character and Hexadecimal print formats.

CPLRO

Specifies whether compiler options for load modules that have CSECTs compiled with any IBM COBOL compiler (excluding OS/VS COBOL) or any IBM Enterprise PL/I for z/OS and OS/390 compiler starting with Release 3.1 will be included in the report. Valid only for LMODMAPA and LMODMAPN functions.

CPLRO=n

CREATED (CRE)

Selects a group of members from a PDS based on the member’s creation date. The from or to-date range is specified in the yy/mm/dd format.

DFLT_WRITE (DW)

Specifies a default output file during a USER function. It is executed when a WRITE parameter has not been executed for the current record. The output dataset is defined on a corresponding JCL DD statement called "anyname".

DW=anyname

DROP (DR)

Controls the number of records dropped from a data set during a DROP function. Use an IF parameter with the DROP parameter.

DR=n

DSNAME (DSN)

Limits the VTOC processing to data set names that match a unique data set or a data set specified with pattern characters.

DSN=dataset-name

DUMP (D)

Prints n records in vertical hexadecimal format while performing a function. DUMP=0 dumps all selected records.

D=n

EDIT (E)

Replaces the first occurrence of a character or hexadecimal data in fixed or variable length records with data of a different length. Remaining data in the record is shifted to accommodate the change.

EDITALL (EA)

Edits all occurrences of data within the area specified by a start location and a length.

EA=(location,length,compare-data,new-data)

ELSE

Enables you to code actions to perform when the preceding conditional statement is false.

ERRS (ERR)

Alters the number of data checks allowed per tape data set during each execution. Specify 0 to 99; 0 specifies unlimited errors.

ERR=n

EXPAND

Specifies whether to expand valid CA Panvalet or Librarian INCLUDE statements.

EXPAND={Y}
       {N}

EXPAND_OCCURS

Specifies whether to print all occurrences (YES) or only the first occurrence of each field when a record layout contains an OCCURS or ODO.

EXPAND_OCCURS={Y}
              {N}

FEOV (FE)

Forces end-of-volume (EOV) processing for an output dataset when the input dataset reaches EOV.

FE={Y}
   {N}

FIELDS

Specifies which field numbers in the record to print in vertical formatted mode. This parameter is valid only for the VPRINT function.

FIELDS=(field-list)

FILLER

The FILLER parameter specifies whether filler fields will be printed or not. This parameter is valid only for the FPRINT and VPRINT functions.

FORM (F)

JCL format syntax processes the input data as JCL. Print format syntax specifies the print format for DUMP, LIST, and PRINT functions and parameters. Multiple-pass processing syntax specifies whether File-AID allows multiple-pass processing. Audit trail print syntax specifies the print format for the APRINT function.

Compare format syntax specifies the print, report, and data format, and report style for the COMPARE function. The syntax order must be specified as print, report, and data format, and report style. More than one FORM parameter can be used per control card.

JCL Format Control:

Print Format Control:

F={LONG }
  {SHORT}

Multiple-Pass Processing Control:

F={NOMULTI}
  {MULTI }

Audit Trail Print Format Control:

F={HEX}
  {CHAR}

COMPARE Format Control:

F={print format,report format,data format,report style}

The values for print format are:

The values for report format are:

The values for data format are:

report style: The values for report style are:

FPRINT (FP)

Prints n records of formatted alphanumeric data based on a supplied (DDxxRL) COBOL or PL/I layout. The LAYOUT or MAP parameter is required. The SHOW parameter is optional.

FP=n

IF (AND, ORIF)

IF selects specific records to be processed. AND is a synonym of IF; AND can be used after the inclusion of at least one IF parameter. ORIF begins a new set of selection.

Record Selection by Data Content:

Record Selection by Valid Numeric or Packed Data:

IF=(location,length,[dupl] operator-data-type)

Record Selection by Timestamp:

IF=(location,operator,TS,offset,timezone)

IFNOT

The IFNOT parameter selects specific records that do NOT contain the specified data value. It scans the specified field for the absence of a data value. IFNOT works on a not equal condition.

IN (I)

Limits the number of input records to be processed.

I=n

INVALID

Specifies how to process invalid data fields. Valid only with the XMLGEN function.

INVALIDCHAR (IVC)

Specifies whether the character fields that include unprintable characters will be printed as ‘INVALID’ or not. This parameter is valid only for the VPRINT function.

IOEXIT

Specifies the input and output I/O exit names. This parameter must be the first parameter following the function and must be on the same line as the function. The exit names can be up to eight characters long.

IOEXIT={input-exit-name,output-exit-name}

KEY (K)

The Key Print syntax controls whether the key from a keyed data set is printed. Random Key Record syntax specifies the key at which processing begins.

Key Print Control:

Random Key Record Control:

KEY=C’key-value’
    X’key-value’

LANGTYPE (LAN)

Selects members based on CA Panvalet language type. This parameter is valid only for Panvalet members.

LANGTYP=xxxxx

LAYOUT

Specifies the DDxxRL dataset member used to format data for the FPRINT and VPRINT function or parameter. For the Compare function, LAYOUT specifies the member name for DDxxRL and DDxxRLN. The LAYOUT parameter is an alias for the MAP parameter.

LAYOUT=name

LINKDATE

Selects a group of members from a PDS based on the members’ link date. The from or to-date range is specified in the ccyy/mm/dd format. Valid only with the LMODCLAS, LMODMAPA, LMODDIR, LMODMAPN functions.

LINKDATE=(from-date,to-date)
         (,to-date)
         (from-date)
         from-date

LIST (L)

Prints n records of alphanumeric data without displaying record number or record length. LIST=0 prints all selected records.

L=n

LPI

Overrides the default SYSLIST line count.

MAP

Specifies the DDxxRL dataset member used to format data for the FPRINT or VPRINT function or parameter. The MAP parameter is an alias for the LAYOUT parameter.

MAP=name

MAXENT (ME)

Changes the default maximum (1024) of input parameters permitted per execution of File-AID. Maximum entry is 999999. Must be the first parameter specified after the function name, unless the IOEXIT parameter is specified. If IOEXIT is specified, IOEXIT must immediately follow the function name followed by MAXENT.

ME=n

MAXOUT (MO)

Overrides the default (8) number of output data sets created with a USER function in conjunction with WRITE parameters. Maximum override is 99 data sets.

MO=n

MBRNAME (MBR)

Selects a group of members from a PDS based on a range of member names. The from or to member name can be up to eight characters for a PDS, PDSE, or CA Librarian file, and 10 for CA Panvalet file.

MBR=(from-name,to-name)
    (,to-name)
    (from-name)
     from-name

MEMBER (M)

Selects a specific member in a PDS. The member name can be up to eight characters long. Separate multiple member names with a comma and surround the names with parentheses.

M={member-name }
{(member-name1,member-name2...)}

MEMBERS (MS)

Selects a group of members from a PDS. The mask name can be up to eight characters. Use a - (hyphen), % percent sign, * (asterisk), or ? (question mark) to specify wildcard characters.

MS={ALL }
   {mask-name}

MEMNAMELENGTH (MNL)

The MEMNAMELENGTH parameter limits the member selection from a PDS to members that have a name length equal to the value given for MEMNAMELENGTH. MNL can be used with or without a mask.

MNL=n

MOVE (MV)

Builds an output record by moving data to it from either the input record or control cards. The output area is initialized to the PADCHAR value (default of X’00’). You must build the entire output record. Syntax 1 moves input record data to an output record. Syntax 2 moves data contained in a control card to an output record.

Input Record Data:

MV=(to-location,length,from-location)

Control Card Data:

MV=(to-location,[dupl]data)

Timestamp Data:

MOVE=(to-location,TS[+nn],length,timezone)

NEWMEM (NM)

Assigns a new name to a member of an output PDS during a COPY function. The member name can be up to eight characters.

NM=member-name

NEWMEMS (NMS)

Assigns new names to multiple members of an output PDS during a COPY function. Use a hyphen (-) to specify the characters to retain from the original member name.

NMS=mask-name

NEWNAME (NN)

The NEWNAME parameter provides the new name for the VSAMRN (VRN) function that renames a VSAM cluster.

NORECCOPYRC (NRC)

The NORECCOPYRC parameter overrides configuration parameter

NO_RECORDS_COPIED_RETURN_CODE. Values - decimal number 00 - 99

NORECCOPYRC=nn

ORIF (OR)

See IF (AND, ORIF).

ORIFNOT

See IFNOT.

OUT (O)

Limits the number of records written to the output dataset or SYSLIST DD statement. OUT=0 processes the entire file.

O=n

PADCHAR (PAD)

Specifies a pad value. PADCHAR is only applicable for sequential files. Initializes output areas when used with the MOVE parameter. Use C to specify character data, or X for hexadecimal data. X'00' is the default.

PAD={C'c' }
    {X'nn'}

PANSTAT (STA)

Selects members based on CA Panvalet status type. This parameter is valid only for Panvalet members.

STA=x

PDSSTAT (MPS)

Maintains PDS member statistics when updating partitioned data sets. It maintains only standard directory entries. Valid only with the UPDATE function.

MPS=x

Values for x are:

PRESERVE

Maintains trailing blanks (spaces) in variable length records. Valid only for COPY and USER.

PRESERVE={ON}
         {OFF }

PRINT (P)

Prints n records of alphanumeric data with record number and record length displayed. PRINT=0 prints all selected records.

P=n

PRINTMIXEDCASE (PMC)

The PRINTMIXEDCASE parameter overrides the configuration parameter

PRINT_UPPERCASE_OR_MIXED. Values are Y or N.

PRINTMIXEDCASE=x

PRTRECS

Specifies whether to include changed, inserted, deleted, and matched records in the Compare Detail Report.

RBA

Specifies a starting block address for BDAM, a starting byte address for VSAM ESDS or KSDS, or a relative record address for VSAM RRDS.

RBA={n }
    {X'nn'}

RDW

Controls the inclusion or exclusion of the record descriptor word for variable-length record processing. Must be the first parameter specified after a function.

RDW=n

Values for n are:

READNEXT (RN)

Ends processing of the current record and starts over with the next record. READNEXT must be coded both subordinate to and immediately followed by an IF, ORIF, or ELSE parameter.

REFOUT (RFO)

Specifies which records to copy when executing a reformat definition. This parameter is used with the REFORMAT function. REFOUT=SEL copies only those records that are being reformatted.

RFO={SEL}
     {ALL}

REPL (R)

Replaces the first occurrence of data. Syntax 1 replaces by location. Syntax 2 replaces based on a condition at a location. Syntax 3 replaces at an alternate location based on a condition.

1. Replace by Location:
   R=(location,[dupl]new-data)
2. Replace by Condition:
   R=(location,{length },[dupl]compare-data,[dupl]new-data)
             {operator}
3. Replace at Alternate Location Depending on a Condition:
   R=(location,{length },[dupl]compare-data,replace-location, 
                {operator} 
     [dupl]new-data)

REPLALL (RA)

Replaces all occurrences of data within the area specified by start location and length. Syntax 1 replaces by condition. Syntax 2 replaces at an alternate location depending on a condition.

1. Replace by Condition:
   RA=(location,length,compare-data,[dupl]new-data)

2. Replace at Alternate Location Depending on a Condition:
   RA=(location,length,compare-data,replace-location,

       [dupl]new-data)

RLM

(Replace Like Members) Controls the copying of identically-named members from one PDS to another.

RLM={YES}
     {NO }

RLPRINT (RLP)

Prints the associated record layouts when printing XREFs using the XRPRINT function. The data set containing the record layouts must be specified in the DDxxRL DD statement.

RMODE

Specifies the residency mode to select. Valid only with the LMODCLAS, LMODMAPA, LMODDIR, and LMODMAPN functions.

RRN

Specifies the relative record number for VSAM RRDS and BDAM. When the specified value exceeds the size of the data set, the function ends. Specify n as a decimal value.

RRN=n

SELECT (S)

Selects every nth occurrence of a record for processing.

S=n

SHOW (SH)

Specifies the type of field information reported for formatted print (FPRINT) output or changes the column header information for vertical formatted print (VPRINT) output.

SH={FORMAT }
   {NUMBER }
   {OFFSET }
   {PICTURE}

STOP (ST)

Stops processing of a function when specified criteria are met. The next function then begins processing at that record.

TRUNCRC (TRC)

The TRUNCRC (TRC) parameter overrides configuration parameter RECORD_TRUNCATION_RETURN_CODE. Any HEX number 00 through FF is valid.

TRUNCRC=nn

TYPRUN

Specifies to validate the compare criteria without comparing the data. Valid only with the Compare function.

UNIT

Specifies generic unit names for the VTOCDSN, VTOCINFO, and VTOCMAP functions. The parameter must specify a unique unit. Separate multiple generic units with a comma. Up to 48 characters can be specified per unit name. The parameter is required if the VOLSER parameter is not specified for the VTOCDSN, VTOCINFO, or VTOCMAP functions. Combine UNIT with VOLSER and VOLSTAT parameters for multi-volume processing.

UNIT=(unit-name)

USERID (USR)

Selects a group of members from a PDS based on a range of user IDs.

VOLSER (VOL)

Specifies volume serial numbers for the VTOCDSN, VTOCINFO, and VTOCMAP functions. Can contain a unique six-character name or a mask value (*). Separate multiple volume serial numbers with a comma. Up to 48 characters can be specified. Combine VOLSER with UNIT and VOLSTAT parameters for multi-volume processing. VOLSER is required if UNIT is not specified for the VTOCDSN, VTOCINFO, and VTOCMAP functions.

VOL=(volume-serial-number)

VOLSTAT (VST)

Specifies the volume status for the VTOCDSN, VTOCINFO, and VTOCMAP functions. The parameter is optional; if it is not specified, all three volume statuses are assumed.

VST={PUB}
    {PRV}
    {STG}

VPRINT (VP)

Prints n records of vertical formatted alphanumeric data based on a supplied (DDxxRL) COBOL or PL/I layout. The LAYOUT or MAP parameter is required. The FIELDS and SHOW parameters are optional.

VP=n

WRITE (W)

Sends a record to an output file during a USER function. Data sets are defined on a corresponding JCL DD statement called “anyname”.

W={anyname }
  {(anyname1,anyname2...)}

ZERO

The ZERO parameter specifies whether numeric fields will be printed with leading zeros or not. This parameter is valid only for the FPRINT, VPRINT, and XMLGEN functions.