Parameters

This section discusses the use and syntax of File-AID/Batch parameters. Brief descriptions of parameters and the various parameter types are given in Parameter Descriptions. You find the abbreviation and type of each parameter in the following table.

Valid abbreviations are also given in parentheses in the parameter and element headings. Keywords (or abbreviations) must be spelled exactly as shown in this manual. Default values that are assumed when the parameter is not coded are indicated with the syntax and the element descriptions.

Each section describes the use and syntax of a parameter. Example control statements are given for the parameters. Other examples are located in Examples.

Parameter Abbreviations and Types

Parameter	Abbreviation	Type
ABEND	AB	Control
ACCUM	A	Printing
AMODE	(none)	Control
AND	(none)	Selection
AUDIT	AUD	Control
CCSID	(none)	Control
CEM	(none)	Control
CHANGED	CHA	Control
CHARSET	CHR	Control
COMPARERC	CRC	Control
COPTNS	(none)	Control
CPLRO	(none)	Control
CREATED	CRE	Control
DFLT_WRITE	DW	Action
DROP	DR	Limiting
DSNAME	DSN	Control
DUMP	D	Printing
EDIT	E	Action
EDITALL	EA	Action
ELSE	(none)	Selection
ERRS	ERR	Control
EXPAND	(none)	Control
EXPAND_OCCURS	(none)	Control
FEOV	FE	Control
FIELDS	(none)	Control
FILLER	(none)	Control
FORM	F	Control
FPRINT	FP	Printing
IF	(none)	Selection
IFNOT	(none)	Selection
IN	I	Limiting
INVALID	(none)	Control
INVALIDCHAR	IVC	Control
IOEXIT	(none)	Control
KEY	K	Control
LANGTYP	LAN	Control
LAYOUT	(none)	Control
LINKDATE	(none)	Control
LIST	L	Printing
LPI	(none)	Control
MAP	(none)	Control
MAXENT	ME	Control
MAXOUT	MO	Control
MBRNAME	MBR	Control
MEMBER	M	Control
MEMBERS	MS	Control
MEMNAMELENGTH	MNL	Control
MOVE	MV	Action
NEWMEM	NM	Control
NEWMEMS	NMS	Control
NEWNAME	NN	Control
NORECCOPYRC	NRC	Control
ORIF	OR	Selection
ORIFNOT	(none)	Selection
OUT	O	Limiting
PADCHAR	PAD	Control
PANSTAT	PAN	Control
PDSSTAT	MPS	Control
PRESERVE	(none)	Control
PRINT	P	Printing
PRINTMIXEDCASE	PMC	Control
PRTRECS	(none)	Control
RBA	(none)	Control
RDW	(none)	Control
READNEXT	(RN)	Action
REFOUT	RFO	Control
REPL	R	Action
REPLALL	RA	Action
RLM	(none)	Control
RLPRINT	RLP	Printing
RMODE	(none)	Control
RRN	(none)	Control
SELECT	S	Limiting
SHOW	SH	Control
STOP	ST	Control
TRUNCRC	TRC	Control
TYPRUN	(none)	Action
UNIT	(none)	Control
USERID	USR	Control
VOLSER	VOL	Control
VOLSTAT	VST	Control
VPRINT	VP	Printing
WRITE	W	Action
ZERO	(none)	Control

Most parameters can be used with any function, but some are ignored during certain functions. Parameter compatibility with various functions is shown in the following table.

Function Parameter Compatibility

Parameter (Abbreviation)	APRINT (AP)	COMPARE	COPY (C)	DROP (DR)	DUMP (D)	FPRINT (FP)	LIST (L)	LMODCLAS (LMC)	LMODDIR (LMD)	LMODMAPA (LMA)	LMODMAPN (LMN)	PRINT (P)	REFORMAT (R)	RLPRINT (RLP)	SCPRINT (SCP)	SPACE (S)	TALLY (T)	UPDATE (UP)	USER (US)	VPRINT (VP)	VSAMRN (VRN)	VTOCDSN (VTD)	VTOCINFO (VTI)	VTOCMAP (VTM)	XMLGEN	XRPRINT (XRP)
ABEND (AB)			X	X	X	X	X					X				X	X	X	X	X
ACCUM (A)			X	X	X	X	X					X				X	X	X	X	X
AMODE								X	X	X	X
AND			X	X	X	X	X					X				X	X	X	X	X
AUDIT (AUD)			X	X														X
CCSID	X					X														X					X
CEM			X	X
CHANGED (CHA)			X	X	X	X	X		X			X		X	X	X	X	X	X	X						X
CHARSET (CHR)		X	X	X	X	X	X					X	X			X	X	X	X	X					X
COMPARERC		X
COPTNS		X
CPLRO										X	X
CREATED (CRE)			X	X	X	X	X		X			X		X	X	X	X	X	X	X						X
DFLT_WRITE																			X
DROP (DR)				X
DSNAME (DSN)																						X		X
DUMP			X	X												X	X	X	X
EDIT (E)			X	X	X	X	X					X				X		X	X	X
EDITALL (EA)			X	X	X	X	X					X				X		X	X	X
ELSE ¹																	X		X
ERRS (ERR)			X	X	X	X	X					X				X	X	X	X	X
EXPAND			X	X	X	X	X					X				X	X		X	X
EXPAND_OCCURS														X												X
FEOV (FE)			X	X															X
FIELDS																				X
FILLER						X														X
FORM (F)	X	X	X	X	X	X	X					X						X	X	X
FPRINT (FP)			X	X												X	X	X	X
IF (AND)			X	X	X	X	X					X				X	X	X	X	X
IFNOT			X	X	X	X	X					X				X	X	X	X	X
IN (I)			X	X	X	X	X					X				X	X	X	X	X
INVALID																									X
INVALIDCHAR (IVC)																				X
IOEXIT		X	X	X	X	X	X					X	X			X	X	X	X	X
KEY (K)			X	X	X	X	X					X				X	X	X	X	X
LANGTYP (LAN)			X	X	X	X	X					X				X	X	X	X	X					X
LAYOUT						X																			X
LINKDATE								X	X	X	X
LIST (L)			X	X												X	X	X	X
LPI			X	X	X	X	X					X				X	X	X	X	X
MAP						X														X
MAXENT (ME)			X	X	X	X	X					X					X	X	X	X
MAXOUT (MO)																			X
MBRNAME (MBR)			X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X						X
MEMBER (M)			X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X					X	X
MEMBERS (MS)			X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X					X	X
MEMNAMELENGTH(MNL)			X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X					X	X
MOVE (MV)			X	X	X	X	X					X				X			X	X
NEWMEM (NM)			X	X															X
NEWMEMS (NMS)			X	X															X
NEWNAME (NN)																					X
NORECCOPYRC (NRC)			X	X															X
ORIF (OR)			X	X	X	X	X					X				X	X	X	X	X
ORIFNOT			X	X	X	X	X					X				X	X	X	X	X
OUT (O)			X	X	X	X	X					X	X						X	X					X
PADCHAR (PAD)			X	X	X	X	X					X				X			X	X
PANSTAT (STA)			X	X	X	X	X					X				X	X	X	X	X
PDSSTAT (MPS)																		X
PRESERVE			X																X
PRINT (P)		X	X	X												X	X	X	X
PRINTMIXEDCASE (PMC)						X	X					X								X					X
PRTRECS		X
RBA			X	X	X	X	X					X				X	X	X	X	X
RDW			X	X	X	X	X					X				X	X	X	X	X
READNEXT (RN)¹																	X		X
REFOUT (RFO)													X
REPL (R)			X	X	X	X	X					X				X		X	X	X
REPLALL (RA)			X	X	X	X	X					X				X		X	X	X
RLM			X	X															X
RLPRINT (RLP)																										X
RMODE								X	X	X	X
RRN			X	X	X	X	X					X				X	X	X	X	X
SELECT (S)			X	X	X	X	X					X				X	X	X	X	X
SHOW (SH)						X														X
STOP (ST)			X	X	X	X	X					X				X	X	X	X	X
TRUNCRC (TRC)			X	X															X
TYPRUN		X
UNIT																						X	X	X
USERID (USR)			X	X	X	X	X					X		X	X	X	X	X	X	X					X	X
VPRINT (VP)			X	X												X	X	X	X
VOLSER (VOL)																						X	X	X
VOLSTAT (VST)																						X	X	X
WRITE (W)																			X
ZERO						X														X					X

¹: This parameter is also compatible with COPYALL, DUMPALL, FPRINTALL, LISTALL, PRINTALL, UPDATEALL, and VPRINTALL.

ABEND (AB)

The ABEND parameter sets end-of-job (EOJ) processing based on abnormal conditions that occur during execution. The installation default value is active for the ABEND parameter until the $$DD control cards are processed with an override. All data allocation errors will act on the default ABEND value. When a logic error occurs during an open or close operation or at EOV processing, File-AID traps the error, logs it on the SYSPRINT dataset, and continues processing the next valid control card or volume. Because File-AID logs and ignores DCB abends, the ABEND parameter is used to create an external warning that reflects these problems. ABEND specifies whether or not File-AID abends when I/O errors occur.

The syntax of the ABEND parameter is:

ABEND=[n]

n

Value of 0, 1, 2, 3, or 4. The values are defined as:

File-AID completes normal EOJ processing by closing all the files and reflecting the highest return code issued.

(Default) When an I/O error is found (resulting in a return code of 12 or higher), File-AID completes normal EOJ processing by closing all files, then initiates a user abend that reflects the condition code in the user code field. This value flushes the job stream and does not produce a dump.

File-AID initiates an abend when any nonzero return code is found. The condition code is placed in the user code field. This value flushes the job stream and does not produce a dump.

When an I/O error is found, File-AID terminates all processing and produces a dump of user code 12. All subsequent $$DDxx control cards are not processed.

When the number of data checks specified in the ERRS parameter is surpassed, File-AID terminates all processing and produces a dump of user code 12. All subsequent $$DDxx control cards are not processed.

Example:

$$DD01 DUMP ABEND=2

This example causes File-AID to abend if any nonzero return code is generated during execution.

ACCUM (A)

The ACCUM parameter accumulates specified fields in the input records. It can be used at any time and with any function. Accumulations may be used to total fields containing numeric character, packed decimal, or binary data. See SYSTOTAL Output for report examples.

The ACCUM parameter has two syntax forms for accumulating different data types:

Character or binary data accumulation syntax:

ACCUM=(location,length,data-type[,’description’])

Packed decimal data accumulation syntax:

ACCUM=(location[,’description’])

location

Any valid actual or relative input location can be used as long as it does not exceed the record size.

length

Length of the field to accumulate. This element is not specified when the data to accumulate is packed decimal. File-AID automatically determines the length of a packed field (see Packed Data). For character and binary data accumulations, the length must be specified. Maximum length values vary based on the type of data being accumulated as follows:

Character data

31 bytes

Binary data

8 bytes

data-type

Type of data to accumulate. This element is not specified when accumulating packed decimal data. For character and binary data accumulations, the data-type must be specified. Valid data-type values are:

C	Signed or unsigned numeric characters
B	Binary
BS	Binary signed.

When accumulating character data (data-type = C), each record selected for accumulation must have valid numeric character data at the specified location. If invalid numeric data is found, an error is detected and processing is terminated.

When accumulating packed data, length and data-type need not be specified. However, each record selected for accumulation must have valid packed data at the specified location. If invalid packed data is found, an error is detected and processing is terminated.

For a binary data type “B”, a length of 8 is always signed. Lengths 1, 2, 3, and 4 are unsigned. Use a binary data type “BS” to have File-AID treat a length of 1, 2, 3, or 4 as a signed binary integer. The following table shows examples of interpreted data values.

Interpreted Hex Data Values for Sign

Data Value	Decimal Value
Unsigned HEX 80	128
Signed HEX 80	-128
Unsigned HEX 8000	32768
Signed HEX 8000	-32768
Unsigned HEX 800000	8388608
Signed HEX 800000	-8388608
Unsigned HEX FF	255
Signed HEX FF	-1
Unsigned HEX FFFF	65535
Signed HEX FFFF	-1
Unsigned HEX FFFFFF	16777215
Signed HEX FFFFFF	-1

description

Optional description of accumulated fields that appears on the output report. A maximum of 25 alphanumeric characters can be entered; they must be enclosed in single quotes. If no description is specified, File-AID prints the field’s location as the description.

Example 1:

$$DD01 COPYALL IF=(43,EQ,C’100’),ACCUM=(46,’BIN-100-WGT’),
IF=(43,EQ,C’101’),ACCUM=(46,’BIN-101-WGT’)

Example 1 copies the input dataset while selecting records for accumulation that contain the string 100 or 101 in location 43. The records are selected by the IF parameters, and the ACCUM parameters total the packed field beginning in location 46. When executed, the totals appear on the SYSTOTAL dataset, and are labeled BIN-100-WGT and BIN-101-WGT.

Example 2:

$$DD01 TALLY IF=(10,EQ,C’91’),
             IF=(14,EQ,C’01’),
             ACCUM=(18,4,B,’JANUARY-1991’),
             IF=(10,EQ,C’90’),
             IF=(14,EQ,C’01’),
             ACCUM=(18,4,B,’JANUARY-1990’)

Example 2 uses ACCUM with a TALLY function with more than one group of selection parameters. The first group of parameters selects all records that contain the characters 91 in location 10 and the characters 01 in location 14. The selected records are accumulated on the 4-byte binary field beginning in location 18. The resulting total is labeled JANUARY-1991. The second parameter group selects and accumulates the records for the total labeled JANUARY-1990.

Example 3:

$$DD01 TALLY IF=(1,EQ,C'C01'),AND=(178,NE,C'R'),
OR=(1,EQ,C'D01'),AND=(120,NE,C'R'),
ACCUM=(2,2,C,'XYZ TOTALS')

Example 3 includes two selection sets. The first set locates any record with a value of 'C01' in position 1 and does not contain a value of 'R' in position 178. Since there is no action parameter for this first selection set, no accumulation takes place. The second selection set locates records that have a value of 'D01' in position 1 and do not contain a value of 'R'.

AMODE

The AMODE parameter specifies the address mode to select. Valid only with the LMODCLAS, LMODMAPA, LMODDIR, and LMODMAPN functions.

The syntax of the AMODE parameter is:

AMODE={24}
      {31}
      {64}
      {ANY}

Selects modules with an address mode of 24 for mapping.

Selects modules with an address mode of 31 for mapping.

Selects modules with an address mode of 64 for mapping.

ANY

Selects modules with any address mode for mapping.

Example:

$$DD01 LMODMAPA AMODE=24

This example lists all modules in the file with an address mode of 24 in address order.

AND

The AND parameter is a synonym of the IF parameter. It can be used after the inclusion of at least one IF parameter. AND is used for clarity in statements. See IF (AND) for valid syntax forms.

Example:

$$DD01 COPY IF=(1,0,C’ABC’),
IF=(1,0,C’XYZ’)

$$DD01 COPY IF=(1,0,C’ABC’),
AND=(1,0,C’XYZ’)

This example shows two equivalent statements. The first statement uses two IF parameters. The second statement substitutes an AND parameter for the second IF.

AUDIT (AUD)

The AUDIT parameter creates an Audit trail dataset and writes before and after images of changed/unchanged records.

Important

The AUDIT parameter is not valid with PDSE load libraries.

The space amount of an Audit trail dataset is calculated by File-AID based on the consumption of the data set specified on //DDxx DD and it is suitable for AUDIT=A.

When a greater or lesser amount of space is needed, use the SPACE allocation parameter.

The syntax of the AUDIT parameter is:

AUDIT=(x,SPACE(space-unit,primary-quantity,secondary-quantity),
      STORCLAS(storage-class),DATACLAS(data-class),
      MGMTCLAS(management-class),
      PREFIX(a.b.c),PRINT(format))

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

Create Audit trail for changed record only.

Create Audit trail for all records

(Default) Do not create Audit trail

Example 1:

$$DD01 UPDATE AUDIT=Y

Example 1 writes before and after images of the records that are changed by UPDATE function. Unchanged records are not written in Audit trail dataset.

Example 2:

$$DD01 COPY IF=(6,2,C'A'),REPL=(21,C'XYZ'),AUDIT=A

Example 2 copies only the records which match the condition in the IF parameter with the modification of the REPL parameter, and the before and after images of all records are written to the Audit trail dataset regardless whether or not they are selected or copied. Audit trail dataset will have both changed and unchanged records.

Allocation Parameters

Allocation Information
SPACE
The SPACE parameter allows you to allocate the Audit trail dataset with the desired amount of space. Valid format is:
SPACE(space-unit,primary-quantity,secondary-quantity)
Valid values for SPACE allocation parameter are:
space-unit
TRKS (T), CYLS (C), or BLKS (B)
primary-quantity
A primary quantity in the range 1 to 65535 (in above space-units).
secondary-quantity
A secondary quantity in the range 0 to 65535 (in above space-units).
Important
There is no default for space-unit and primary/secondary quantities must be specified.
Example 3:
$$DD01 UPDATEALL AUDIT=(Y,SPACE(TRKS,10,5))
Example 3 allocates an Audit trail dataset with 10 tracks of primary and 5 tracks of secondary space amount.
SMS Class Information
SMS Class parameters allow you to allocate the Audit trail dataset with desired SMS classes.

STORCLAS

SMS Storage Class. Valid format is:

STORCLAS(storage-class)

DATACLAS

SMS Data Class. Valid format is:

DATACLAS(data-class)

MGMTCLAS

SMS Management Class. Valid format is:

MGMTCLAS(management-class)

For each SMS class, supply 1-8 characters with parentheses.

Example 4:

$$DD01 COPY AUDIT=(A,STORCLAS(STDDODFW),MGMTCLAS(TIMEST@S))

Example 4 allocates an Audit trail dataset with the specified SMS Storage Class and Management Class.

Audit File Prefix Parameter

The Audit File Prefix allows you to replace the first node of the default audit file dataset name.

PREFIX(a.b.c)

a.b.c can be any valid dataset name prefix up to a total length of 23 characters or the symbolic *USERID*. If you use the symbolic *USERID*, File-AID will use the running job's user ID.

This value will replace the first node of the audit file dataset name.

Valid format is:

PREFIX(a.b.c)

PREFIX(*USERID*)

Example 5:

$$DD01 COPY AUDIT=(A,PREFIX(MYAUDIT.GENERAL.EMPDEPT))

Example 5 allocates an Audit trail dataset with an audit file dataset name that starts with the specified prefix: ‘MYAUDIT.GENERAL.EMPDEPT.Dyymmdd.Thhmmss.Msss’.

Important

When no audit trail prefix is specified for a batch job, the audit trail prefix will default to the batch job name minus the last character.

Print Parameter

The PRINT sub-parameter causes an audit report to be printed.

PRINT

Will cause an audit report to be printed in the default format.

PRINT(CHAR)

Will cause a character format audit trail to be printed.

PRINT(HEX)

Will cause a hex format audit trail to be printed.

Example 6:

$$DD01 COPY AUDIT=(Y,PREFIX(MYAUDIT.GENERAL.EMPDEPT),PRINT(HEX))

Example 6 allocates an Audit trail dataset with an audit file dataset name that starts with the specified prefix and prints the audit report in hexadecimal format.

Important

When AUDIT parameter is too long and does not fit within 1 line, you can split up to 2 lines. Do not split in the middle of parameter. Valid example is:
$$DD01 COPY AUDIT=(A,SPACE(TRKS,200,100),STORCLAS(STDDODFW),
MGMTCLAS(TIMEST@S),PREFIX(MYAUDIT.GENERAL.EMPDEPT))
When processing is stopped by a request such as OUT parameter, AUDIT activity is also terminated. The Audit trail dataset includes all records that were processed before processing stopped.

CCSID

The CCSID parameter specifies the valid coded character set identifier (CCSID) for the EBCDIC code page so that File-AID converts Unicode UTF-8 or UTF-16 data to EBCDIC when format-printing characters. Valid only with the APRINT, FPRINT, VPRINT, and XMLGEN functions. This parameter overrides the default CCSID defined during product installation. Refer to File-AID Common Components Parameters Variable CCSID_FOR_UNICODE_COVERSION_SERVICES in the File-AID Advanced Configuration Guide for more detail.

The syntax of the CCSID parameter is:

CCSID=nnnnn

nnnnn

Specify the numeric value (0 through 99999) for the desired code page.

Example:

$$DD01 FPRINT CCSID=500

This example formats and prints the records using CCSID 500.

CEM

The CEM parameter copies empty members of a partitioned dataset. This parameter is valid only with the COPY and DROP functions.

The syntax of the CEM parameter is:

CEM={N}
{Y}

(Default) Do not copy empty members.

Copy empty members.

Example:

$$DD01 COPY CEM=Y

This example copies all of the input dataset records, including the empty members.

CHANGED (CHA)

The CHANGED parameter specifies a date range that selects a subset of members based on their last modified date. This is a PDS statistic that is stored in its directory. Members without PDS statistics, because they were not created (STATS OFF) or the statistics were deleted, are not selected.

Member selection (MEMBER or MEMBERS parameter) is not supported with the CHANGED or CREATED parameters.

The syntax of the CHANGED parameter is:

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

from-date,to-date

Specifies the endpoint from and to-dates, in the format yy/mm/dd, to include in the member list. The dates can be complete or partial. Leading zeros are required when specifying the year, month, and day.

The following date formats are valid:

YY/MM/DD

YY/MM

If the FROM date is omitted and a TO date is specified, File-AID selects all members with modification dates on or before the specified TO date.

If a FROM date is specified and the TO date is omitted, File-AID selects all members with modification dates on or after the specified FROM date.

Entering the same dates in the FROM and TO fields selects members with modification dates that match only that date. The two-character year is assumed between 1960 and 2059. Partial dates are treated positionally (YY/MM/DD) and are padded with default values (01/01 for FROM and 12/31 for TO).

For example, if you omit a date range the default FROM value becomes 1960/01/01 and the default TO value becomes 2059/12/31. If you enter 85, the defaults are 85/01/01 and 85/12/31. If you enter 85/09, the defaults are 85/09/01 and 85/09/30.

Example:

$$DD01 LIST CHANGED=(94/07/19,94/07)

This example prints all members with a last modified date from July 19, 1994 to July 31, 1994.

CHARSET (CHR)

The CHARSET parameter specifies the name of an alternate translate table (code-page table) for File-AID to use when printing characters. The default table supports USA English.

The syntax of the CHARSET parameter is:

CHARSET=xxxx

xxxx

Specify one of the following code-page table values. This value is appended to XVJC and instructs File-AID as to which table to use when printing. Valid code-page tables shipped with File-AID include:

- BELG (Belgian)
- CNBL (Canadian-Bilingual)
- CNFR (Canadian-French)
- CYRL (Cyrillic)
- DFLT (the default USA code-page table)
- FREN (French)
- GREK (Greek)
- HEB (Hebrew pre-aleph)
- HEBO (Hebrew old)
- HEBN (Hebrew new)
- ICLN (Icelandic)
- KANA (Japanese)
- K930 (Japanese (code page 930))
- K939 (Japanese (code page 939))
- LATN (Roece Latin)
- PGSE (Portuguese)
- POL (Polish)
- SPAN (Spanish)
- SWED (Swedish)
- SWFG (Swiss-French/Swiss-German)
- THAI (Thai)
- TURK (Turkish)
- YUGO (Yugoslav)
- 3277 (3277 terminals).

Example:

$$DD01 LIST CHARSET=CNBL

This example prints the records using the Canadian Bilingual character set (code-page table).

COMPARERC (CRC)

The COMPARERC parameter overrides File-AID/MVS configuration parameter UNEQUAL_COMPARE_RETURN_CODE (see also UNEQUAL_COMPARE_RETURN_CODE in the File-AID Advanced Configuration Guide for more detail). This parameter is valid only for the COMPARE function.

Specify a different return code to issue when the COMPARE function finds any differences in the data that you specify to compare from the old to the new data set. Valid entries are hexadecimal values 00 through FF.

Important

We recommend that a non-zero value should NOT be a multiple of 4 to distinguish it from other usual return codes. Depending of the perceived severity of an unequal compare, set the value to either 03, 07, 0B (11), or 0F (15).

The syntax of the COMPARERC parameter is:

COMPARERC=nn

Example:

$$DD01 COMPARE COMPARERC=0B

This example issues return code 11 when the COMPARE function finds any differences in the data that you specify to compare from the old to the new data set.

COPTNS

The COPTNS parameter specifies the additional options for condensed reports. This parameter is valid only for condensed compare. Condensed compare is for Character and Hexadecimal print formats. See FORM (F). The Compare Criteria dataset can override these options.

The syntax of the COPTNS parameter is:

COPTNS=(suppress print,ruler,changed data char,key field char)

suppress print

The values for suppress print are:

Y	(Default) Yes, print only the lines that contain changes or key or sync fields.
N	No, print all lines.

ruler

The values for ruler are:

T	(Default) Top of page. Print ruler only at top of page.
A	Always. Print ruler for every inserted, deleted, and matched record, and every pair of changed records.
N	Never. Do not print ruler.

changed data char

Specify a character to underline the changed data. The default value is an underscore ( _ ).

key field char

Specify a character to underline the key or sync fields. The default value is the pound sign ( # ). To suppress the underline character, enter a blank.

Example:

$$DD01 COMPARE FORM=(C,D,E,C),PRINT=0,COPTNS=(Y,T,_,#)

This example prints a condensed compare detail report in character format, differences only, and single-byte character set (EBCDIC). It uses the default settings for the additional condensed print options: print only changed lines, print the ruler only at the top of each page, an underscore for changed data, and a pound sign for key or sync field underlining.

Important

The four options for the COPTNS parameter are positional. However by coding the trailing comma to maintain positioning of the options, you may omit an option and accept its default setting. For example, COPTNS=(,,,*) uses the default setting for suppress print, ruler, and changed data char, but uses an asterisk (*) for the key field char. Also, you may omit the parenthesis if you want to change only the suppress print default setting. For example, COPTNS=Y.

See COMPARE for information on the COMPARE function. For more information, see File-AID/MVS Online Reference on the COMPARE function.

CPLRO

The CPLRO (compiler options) parameter allows you to specify 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. This parameter is valid only for load module LMODMAPA and LMODMAPN functions. See LMODMAPA (LMA) and LMODMAPN (LMN). Use the compiler options listing as reference when re-compiling COBOL or PL/I modules.

The syntax of the CPLRO parameter is:

CPLRO=n

The valid values for CPLRO=n are:

Y	Yes, include the list of compiler options in the report.
N	(Default) No, don’t include the list of compiler options.

Example:

$$DD01 LMODMAPA CPLRO=Y,MEMBER=(ENTCOB51)

This example includes the list of compiler options for an Enterprise COBOL CSECT in member ENTCOB51 in addition to the regular CSECT MAP reports.

Important

CPLRO is only valid for a CSECT entry with Type SD and a qualifying COBOL or Enterprise PL/I compiler.

CREATED (CRE)

The CREATED parameter specifies a date range that selects a subset of members based on their creation date. This is a PDS statistic that is stored in its directory. Members without PDS statistics, because they were not created (STATS OFF) or the statistics were deleted, are not selected.

Member selection (MEMBER or MEMBERS parameter) is not supported with the CHANGED or CREATED parameters.

The syntax of the CREATED parameter is:

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

from-date,to-date

The following date formats are valid:

YY/MM/DD
YY/MM
YY

If the FROM date is omitted and a TO date is specified, File-AID selects all members created on or before the specified TO date.

If a FROM date is specified and the TO date is omitted, File-AID selects all members created on or after the specified FROM date.

Entering the same dates in the FROM and TO fields selects members created only on that date. The two-character year is assumed between 1960 and 2059. Partial creation dates are treated positionally (YY/MM/DD) and are padded with default values (01/01 for FROM and 12/31 for TO).

For example, if you omit a date range the default FROM value becomes 1960/01/01 and the default TO value becomes 2059/12/31. If you enter 85/09, the defaults are 85/09/01 and 85/09/30.

Example

$$DD01 LIST CREATED=(94/07/01,94/07/15)

This example prints all members created from July 1, 1994 to July 15, 1994.

Example

$$DD01 LIST CREATED=(,90)

This example prints all members created on or prior to December 31, 1990 (90/12/31).

DFLT_WRITE (DW)

The DFLT_WRITE parameter specifies a default output file during a USER function. It is executed when a WRITE parameter has not been executed for the current record (unless the READNEXT parameter has already caused File-AID to skip the DFLT_WRITE). The output dataset is defined on a corresponding JCL DD statement called "anyname".

The syntax of the DFLT_WRITE parameter is:

DW=anyname

anyname

User-defined name that matches the DD name in the JCL of the desired output dataset.

Example:

$$DD01 USER IF=(86,EQ,C'W'),READNEXT,
IF=(86,EQ,C'S'),WRITE=OUTS,READNEXT,
IF=(86,EQ,C'M'),WRITE=OUTM,
DFLT_WRITE=OUTO

In this example records that have a "W" in position 86 are not written to any output file. Records with a "S" in position 86 are written to the OUTS file. Records with a "M" in position 86 are written to the OUTM file. All other records not matching any of the preceding conditions default to the OUTO file.

Guidelines:

The DFLT_WRITE parameter must be immediately preceded by an action parameter.
The DFLT_WRITE parameter may only be coded once per USER function and it must be the last parameter.

DROP (DR)

The DROP parameter controls the maximum number of records eliminated from a data set, before processing stops, when a DROP function is executed. At least one IF parameter must be entered before the DROP parameter is specified.

Important

The DROP parameter is not valid with PDSE load libraries.

The syntax of the DROP parameter is:

DROP=n

Number of records to drop, based on the data contained in one or more data selection parameters. Any number from 1 to 999999999 can be used.

Example:

$$DD01 DROP IF=(6,EQ,C’ABCDE’),DROP=10

This example drops the first ten occurrences of records that contain the string ABCDE beginning in location 6.

DSNAME (DSN)

The DSNAME parameter limits VTOC processing to data sets that match a unique dataset name or data sets that match the specified pattern characters. This parameter is valid only with the VTOCDSN and VTOCMAP functions.

The syntax of the DSNAME parameter is:

DSNAME=dataset-name

dataset-name

Name of the dataset or dataset name mask specified with pattern characters.

Example:

$$DD01 VTOCDSN UNIT=3390,DSNAME=+.FASAMP.*

This example displays summary information about and lists the data sets from unit 3390. The DSNAME parameter limits which dataset names are included in the report based on the pattern dataset name. Based on this pattern, File-AID ignores any number of leading qualifiers and displays all data sets with a qualifier of FASAMP.

DUMP (D)

The DUMP parameter generates a dump of a selected number of records while the primary function (for example, COPY, etc.) continues processing the entire file. SYSLIST DUMP Request Output provides an example of the output produced by the DUMP parameter or function (see also DUMP (D)).

Important

Do not use the DUMP parameter with the DUMP, LIST, PRINT, FPRINT, or VPRINT functions.

The syntax of the DUMP parameter is:

DUMP=n

Number of records to dump. Any number from 0 (zero) to 999999999 can be used. Dumping of records can be based on one or more data selection parameters. Use DUMP=0 to dump all selected records.

Example:

$$DD01 COPY DUMP=25

This example copies the entire data set while dumping the first 25 records.

EDIT (E)

The EDIT parameter replaces character, packed, or hexadecimal data in a record with character, packed, or hexadecimal data of a different length. When EDIT is executed, File-AID shifts the remaining data to adjust for the change. The EDIT parameter only changes the first occurrence of matched compare-data in a record. To change more than one occurrence of compare-data, use multiple EDIT parameters. To change all occurrences, use the EDITALL parameter.

The syntax of the EDIT parameter is:

EDIT=(location,{length },[dupl]compare-data,new-data)
{operator}

location

Location where the search for the data begins. Any valid actual or relative location can be used.

length

Length of the search field. The value must be at least one byte longer than the compare-data length. Any valid number can be entered as long as it does not exceed the record length. Use 0 to search the area between the current actual or relative location and the end of the record.

operator

Any valid operator element listed in Operator Element is allowed.

dupl

Optional duplication factor that defines the number of times File-AID looks for the compare-data to be contiguously repeated, starting at the specified location. A dupl element is valid only when an operator element other than NE is specified. The dupl value is ignored when a length is specified.

Important

The duplication factor is not used to determine the length of the compare-data to replace. Dupl is only used to determine if a condition is present. New-data always replaces compare-data. Dupl is ignored during replacement.

compare-data

Data to search for in the specified location. Most valid data types described in Data Element are allowed, except that data types I and ILn are not accepted in EDIT. Multiple compare-data values, separated by commas, are allowed.

Important

When specifying multiple compare-data values, duplication factors are not allowed. Also, the order of the compare-data element values determines the sequence of new-data replacements. Furthermore, when multiple compare-data values are specified with the EQ operator, the lengths of each compare-data value should be the same. If lengths are not the same, File-AID uses the length of the first compare-data value specified, when determining the length of the data to replace. If a length is specified instead of an operator, each of the multiple compare-data value lengths are used to change to the new-data.

new-data

Data that replaces the compare-data when a match is found. If the new-data length is larger than the compare-data length, the remaining contiguous data is shifted to the right. If the new-data is shorter, the contiguous data to the right is shifted left and kept contiguous to the new-data.

When a packed data element is used as new-data, the number of decimal digits (including leading zeros), entered in the control card, determines the length of the new packed field (see Example 5:).

When EDIT inserts data by replacing a field with another of greater length, File-AID shifts the data to the right to make room (see Example 1:). This shift is done field by field. Fields that are separated by more than one blank may be compressed to a single space to make room for inserted fields (see Example 2:).

Important

When using the UPDATE function, or when using the COPY or USER function to write to a fixed length output record, truncation occurs when shifting to the right extends data beyond the record boundary.

When EDIT replaces a data field with new-data of shorter length, File-AID shifts contiguous data to the left until a blank is found (see Example 3:). File-AID inserts blanks to compensate for the eliminated data. If no blanks are found, blanks are inserted at the end of the record (see Example 4:).

When the EDIT parameter is used with the COPY function to process variable-length files, File-AID lengthens or shortens the output record when necessary.

In an UPDATE function, record lengths must stay the same. When EDIT is used with the UPDATE function, lengthened records are truncated as discussed in Example 1:. Records from which data is eliminated during an UPDATE function remain the same length because File-AID adds trailing blanks to fill any remaining space in the record (see Example 3:).

Important

If the MOVE parameter is used with the EDIT or REPL parameters in one set of actions, specify the EDIT and/or REPL parameters before the MOVE parameter. The EDIT and REPL parameters act on the input record, and if the input data is moved to the output area, the EDIT or REPL changes following a MOVE do not appear in the output dataset.

Example 1:

EDIT=(1,5,C’1234’,C’ABCDE’)

Example 1 uses the UPDATE function and replaces the compare-data string 1234 in a field with the longer new-data string ABCDE. When this statement is executed, the results on two records are:

Before:

----+----1----+----2----+----3
1234 ABCD9999999999999STUVWXYZ
12346ABCD9999999999999STUVWXYZ

After:

----+----1----+----2----+----3
ABCDE ABCD9999999999999STUVWXY
ABCDE6ABCD9999999999999STUVWXY

The last character of each record is truncated because the length of both records is 30 bytes and the UPDATE function was used.

Example 2:

EDIT=(1,6,C’AAAA’,C’BBBBBBBB’)

Example 2 replaces string AAAA with string BBBBBBBB. When the longer new-data string is inserted, the fields are shifted, and when required, compressed. When this statement is executed, the results on two records are:

Before:

----+----1----+----2----+----3
AAAAA 12 34 56 789000
AAAAA 123 456 78 900000

After:

----+----1----+----2----+----3
BBBBBBBBA 12 34 56 789000
BBBBBBBBA 123 456 78 900000

Example 3:

EDIT=(1,5,C’1234’,C’1’)

Example 3 replaces the string 1234 with the shorter string1. When this statement is executed, the results on two records are:

Before:

----+----1----+----2----+----3
1234 ABCD9999999999999ZZZZ
12346ABCD9999999999999ZZZZ

After:

----+----1----+----2----+----3
1 ABCD9999999999999ZZZZ
16ABCD9999999999999ZZZZ

Note that because Record 1 contained a blank after the compare-data string 1234, File-AID inserts blanks immediately after the new-data string 1. However, Record 2 contained no embedded blanks, so the remaining data is shifted to the left.

Example 4:

EDIT=(1,6,C’AAAA’,C’’)

Example 4 totally eliminates data by coding a null entry to replace the string AAAA. When this statement is executed, the results on two records are:

Before:

----+----1----+----2----+----3
AAAAA 12 34 56 789000
AAAAAAAA123 456 78 900000

After:

----+----1----+----2----+----3
A 12 34 56 789000
AAAA123 456 78 900000

Example 5:

EDIT=(1,6,C’123’,P’+00123’)

Example 5 converts a zoned numeric value of 123 to a 3-byte packed value of +123 (X’00123C’). Leading zeros in the packed new-data value are used to calculate the new-data length. The plus sign (+) in the new-data value forces a C sign (positive) for the new packed field. A minus sign (-), if specified, forces a D sign (negative) for the new packed field. If no sign is specified, an F sign is placed in the new packed field. In this example, data does not shift because the compare-data and the new-data are the same length (three bytes). When the statement shown in example 5 is executed, the results on two records are:

Before:

CHAR 123ABC 123
ZONE FFFCCC4FFF
NUMR 1231230123
1...5...10

CHAR AB123C 123
ZONE CCFFFC4FFF
NUMR 1212330123
1...5...10

After:

CHAR    ABC 123
ZONE 013CCC4FFF
NUMR 02C1230123
    1...5...10

CHAR AB C 123
ZONE CC013C4FFF
NUMR 1202C30123
     1...5...10

EDITALL (EA)

The EDITALL parameter is the same as the EDIT parameter, except that it edits all occurrences of data within the area specified by a start location and a length. The EDITALL parameter follows the same shifting rules as the EDIT parameter.

The syntax of the EDITALL parameter is:

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

location

Location where the search for the data begins. Any valid actual or relative location can be used.

length

Length of the search field. The value must be at least one byte longer than the compare-data length. Any valid number may be entered as long as it does not exceed the record length. Use 0 (zero) to search the area between the current actual or relative location and the end of the record.

compare-data

Data to search for in the specified location. Any valid data type described in Data Element is allowed. Multiple compare-data element values, separated by commas, are allowed. Duplication factors are not allowed.

Important

When specifying multiple compare-data element values, File-AID uses the length of each compare-data value to change the new data. The order of the compare-data element values determines the sequence of new-data replacements.

new-data

Example:

EDITALL=(1,50,C’ABC,GHI’,C’’)

This example eliminates all occurrences of the strings ABC and GHI because the new-data is a null entry. When this statement is executed, the results on two records are:

Before:

----+----1----+----2----+----3
ABC 999 ABC 999 GHI999 GHI
ABCABC999GHIGHI999 ABC 999

After:

----+----1----+----2----+----3
999 999 999
999999 999

Note that data is shifted left when no blanks separate the compare-data and the adjacent data.

ELSE

The ELSE parameter enables you to code actions to perform when the preceding conditional statement is false. This parameter is valid with the USER or TALLY functions and COPYALL, DUMPALL, FPRINTALL, LISTALL, PRINTALL, UPDATEALL, and VPRINTALL.

The syntax of the ELSE parameter is:

ELSE

Guidelines:

The ELSE parameter must be subordinate to an IF parameter.
When using the ELSE parameter with the TALLY, COPYALL, DUMPALL, FPRINTALL, LISTALL, PRINTALL, UPDATEALL, or VPRINTALL function, the ELSE must directly follow and precede one or more action parameters.
Valid Example:
$$DD01 COPYALL IF=(1,0,C'ABC'),
                 REPL=(1,C'DEF'),
               ELSE,
                 REPL=(1,C'XYZ')
Invalid Example:
$$DD01 COPYALL IF=(1,0,C'ABC'),
                 REPL=(1,C'DEF'),
               ELSE,
                 IF=(1,0,C'DEF') (not an action)

The ELSE parameter may not immediately precede the DFLT_WRITE parameter.
When using the ELSE parameter with the USER function, it must directly follow and precede an action parameter (ACCUM,EDIT, MOVE, READNEXT, or REPL).

For Example:

$$DD01 USER IF=(1,0,C'ABC'),
                 WRITE=FILE1,
               ELSE,
                 WRITE=FILE2

ERRS (ERR)

The ERRS parameter specifies the number of data errors that File-AID allows before it terminates processing. File-AID automatically traps and reports data checks on tape volumes. The default is 25 data checks per volume. Use the ERRS parameter to set the maximum number of processed data error checks, up to 99.

The syntax of the ERRS parameter is:

ERRS=n

Number of data checks to process per volume. Any number from 0 (zero) to 99 can be used. Use 0 to process unlimited errors. When a data check is encountered, File-AID:

- Logs it on the SYSPRINT dataset. See JCL Required for Execution for information on SYSPRINT.
- Dumps the data on the SYSLIST dataset if SYSLIST is allocated and EROPT=SKP is not coded on the DD statement for the data set containing the errors. See JCL Required for Execution for information on SYSLIST.
- Ignores the data check.
- Skips the erroneous block of data.
- Continues to process the remaining data.

File-AID does not allow transfer of a data check block to an output dataset.

If a block count error occurs at the end of a volume containing data checks, the DCB abend processor adds the number of data check blocks skipped to the DCB count. If the sum is equal to the system count, File-AID ignores the block count error on that volume. If the sum is unequal to the system count, File-AID logs the error on the SYSPRINT dataset and continues with either the next volume or the next control statement.

Important

ERRS is ignored when using File-AID/Batch under TSO.

Example:

$$DD01 COPY ERRS=99

This example copies the input tape and allows as many as 99 data checks during the execution of the statement.

EXPAND

The EXPAND parameter specifies whether to expand valid CA Panvalet or Librarian INCLUDE statements.

The syntax of the EXPAND parameter is:

EXPAND={Y}
{N}

(Default) Expand the INCLUDE statements.

Do not expand the INCLUDE statements.

Example:

$$DD01 LIST EXPAND=Y

This example expands the library INCLUDE statements for this output.

EXPAND_OCCURS

When a record layout contains an OCCURS or ODO, the EXPAND_OCCURS parameter specifies to print all occurrences (YES) or only the first occurrence of each field.

The syntax of the EXPAND_OCCURS parameter is:

EXPAND_OCCURS={Y}
{N}

(Default) Print all occurrences.

Print only the first occurrence.

- Only the first occurrence of an OCCURS/ODO will print
- Each field number is printed once
- Printed FLD START position is for the first occurrence

Example:

$$DD01 XRPRINT RLPRINT=YES,MEMBER=(INVXREF),EXPAND_OCCURS=N

This example only prints the first occurrence of an OCCURS/ODO in the record layouts associated with the specified XREF.

FEOV (FE)

The FEOV parameter forces the start of a new tape when the input dataset reaches End of Volume (EOV). As a result, the output and the input data sets have the same number of volumes (when the output tape holds at least as much data as the input media). The records are split among volumes in the same way as the input.

Important

This parameter is effective on only output tapes. The multi-volume input can be on tape or disk.

The syntax of the FEOV parameter is:

FEOV={Y}
{N}

EOV processing is performed for the output tape data set when the input dataset reaches EOV.

(Default) EOV processing is not performed for the output dataset when the input dataset reaches EOV.

Important

The FEOV parameter is only applicable to multi-volume data sets where the output is tape. Use FEOV only if an output dataset is present (when DDxxO exists) and the output device is tape.

Example:

$$DD01 COPY FEOV=Y

This example forces EOV processing when the input dataset reaches EOV.

FIELDS

The FIELDS parameter specifies which field numbers in the record to print in vertical formatted mode. This parameter is valid only for the VPRINT function. The syntax of the FIELDS parameter is:

FIELDS=(field-list)

field-list

Specify any combination of field numbers and/or field number range. Separate each field number specification by a comma. Specify a range with a hyphen between the starting and ending field numbers. You may specify up to nine field number specifications or 60 characters.

Example:

$$DD01 VPRINT FIELDS=(1,3,10-14)

This example prints fields 1, 3, 10, 11, 12, 13, and 14 of each record in vertical formatted mode.

Important

The FIELDS parameter can only print data in the sequence that it resides in the record, for example FIELDS=(1,2,3,6,5,4) will print fields 1, 2, 3, 4, 5, and 6.
However, you can use File-AID/MVS Option 9, REFORMAT, to create a REFORMAT definition. First, create a Target Record Layout with the fields rearranged in the desired sequence. The REFORMAT definition can then be saved and inserted into a batch job for repeated use.

In the batch job:
Step 1: Execute REFORMAT into the new file with the new field sequence.
Step 2: Execute VPRINT against the new file, using the new layout. The new file can be deleted at the end of the job.

FILLER

The FILLER parameter specifies whether filler fields will be printed or not. This parameter is valid only for the FPRINT (FPRINT (FP) ) and VPRINT (VPRINT (VP)) functions. The syntax of the FILLER parameter is:

FILLER=[ON/OFF]

FILLER=ON prints FILLER fields.

OFF

FILLER=OFF does not print FILLER fields.

Example:

$$DD01 VPRINT FILLER=ON,ZERO=ON

This example prints records in vertical formatted mode, including FILLER fields and leading zeros for numeric fields.

FORM (F)

The FORM parameter has five syntax forms that control five File-AID processing options:

JCL Format Control:

FORM=JCL

Printing Format Control:

FORM={LONG }
{SHORT}

Multiple-Pass Processing Control:

FORM={NOMULTI}
{MULTI}

Audit Trail Print Format Control:

FORM={HEX}
{CHAR}

COMPARE Format Control:

FORM=(print format,report format,data format,report style)

More than one FORM parameter can be used per control card. The use of each syntax is described below.

JCL format control

When JCL format is specified, File-AID internally strings together and logically processes DD, EXEC, JCLLIB, JOB, OUTPUT, PROC, SET, and XMIT statements. All continuations for a JCL statement can be processed as if they were contained in a single record. JCL format control is only valid for PDSs with LRECL=80. When using a length element in a scanning parameter (IF, EDIT, REPL), specify a length of 0 to scan to the end of the logical JCL statement.

FORM=JCL

Important

File-AID does not check JCL syntax.

File-AID ignores data beyond physical location 71 of each record. File-AID looks for a double slash ( // ) in locations 1 and 2 to distinguish between JCL statements and data or comments ( //* ). Comments ( //* in locations 1, 2, and 3) are ignored, even when embedded in a continued JCL statement. Other embedded comments ( //* not in locations 1, 2, and 3) are processed.

FORM=JCL handles JCL statements that span multiple records and must be treated as a single logical record. It is useful when multiple search criteria could be found on different physical records within the same logical JCL statement. You can also use FORM=JCL to make changes to JCL with the EDIT parameter when the lengths of the compare-data and the new-data are not the same.

FORM=JCL is not always necessary when processing JCL. It is unnecessary when searching for a single string, or when the changes do not affect the length of the statement. If you specify FORM=JCL in these cases, File-AID performs extra unneeded processing.

Editing JCL records with the EDIT parameter may shift or truncate data when it is replaced with data of another length. When editing JCL and expansion of data is required due to a larger length replace data value, File-AID adjusts the JCL statement as follows:

If the data on one record does not fit between the original starting location (4 through 16) and location 71, the data is shifted left as far as location 4 until it does fit. Commas remain to adjust the JCL to fit as needed.
When the COPY or USER function is used, JCL expansion that extends beyond physical location 71 of the last physical record of the JCL statement, is placed on a new continuation line. New or expanded records are aligned with location 16 if possible.
When the UPDATE function is used, new records are not inserted. If the JCL expansion cannot be accommodated within the physical records of the JCL statement, truncation occurs and a warning message is printed.

When scanning JCL with the FORM=JCL, and you want to scan until the end of the record, use a length element of 0. If you use any other value, you cannot be sure that you are scanning to the end of the record.

When JCL format is specified, it is effective until a new $$DDxx statement is referenced. A single JCL statement can continue across 255 records.

Important

The FORM=JCL parameter cannot be used when referencing the input record data with the MOVE parameter.

Printing format control

The FORM parameter changes the print format of File-AID when used with the DUMP, LIST, or PRINT functions and parameters. Two options are available: long and short. The long form causes a column scale to print under each line. The short form causes the column scale to appear only at the top and bottom of each page. The syntax for printing format control is:

FORM={LONG}
{SHORT}

LONG (L)

(Default) Long form of print output.

SHORT (S)

Short form of print output.

Examples of short- and long-form print formats are given in SYSLIST Output.

The FORM parameter may be used at any time. It remains in effect until changed by another FORM parameter.

Important

When the LIST function or parameter is used, a column scale is only printed when FORM=SHORT.

Multiple-pass processing control

If you must process more than one function on a given file, use FORM to specify one pass to that file for each function. The FORM parameter is coded on the first function card that references the file. This eliminates the need for multiple DD statements pointing to the same dataset name. The syntax for multiple-pass processing control is:

FORM={NOMULTI}
{MULTI}

MULTI (M)

Allows reprocessing of an input file after end-of-file (EOF) is reached. At EOF, the input file is closed and reopened. Processing continues with the next function at the beginning of the input file.

Important

FORM=MULTI only occurs when EOF is reached by the current function. If EOF is not reached, processing continues with the next function, at the next record in the input file.
FORM=MULTI is not compatible with the COMPARE function.

NOMULTI (N)

(Default) Does not allow reprocessing of the input file, and gives a message when EOF is reached.

Audit trail print format control

Use the FORM parameter with the APRINT function to specify the format of the printed audit trail report. The default format is usually hexadecimal. However, if the audit trail was created with record layouts, the report is printed in a formatted mode according to the COBOL or PL/I record layout. You can override formatted mode by specifying either the HEX or CHAR value on the FORM parameter. The syntax for audit trail print format control is:

FORM={HEX}
{CHAR}

HEX

(Default) Prints the audit trail report in hexadecimal format.

CHAR

Prints the audit trail report in character format.

Example:

$$DD01 APRINT FORM=CHAR

This example prints the audit trail file in character format.

COMPARE format control

You may use the FORM parameter with the COMPARE function to specify the print, report, and data format, and report style. The syntax order must be specified as print format, report format, data format, and report style. The Compare Criteria dataset can override these options.

The syntax for COMPARE format control is:

FORM=(print format,report format,data format,report style)

print format

The values for print format are:

H	Hexadecimal
F	Formatted
C	(Default) Character.

report format

The values for report format are:

D	(Default) Differences
S	Summary
L	Long.

Important

The PRTRECS parameter, if coded, overrides the report format setting of the FORM parameter. See PRTRECS.

data format

The values for data format are:

E	(Default) Single-byte character set (EBCDIC).
M	Mixed format (EBCDIC and DBCS).
D	Double-byte character set (DBCS).

report style

The values for report style are:

S	(Default) Standard. This is the full compare report.
C	Condensed. The condensed report style has reduced heading lines and enables you to specify additional options for condensed report style (valid for only Character or Hexadecimal print format). See COPTNS for a description of these additional print options.

Important

These four options for the FORM parameter are positional. However by coding the trailing comma to maintain positioning of the options, you may omit an option and accept its default setting. For example, FORM=(,,,C) uses the default setting for print format, report format, and data format, but specifies the Condensed report style (C). Also, you may omit the parenthesis if you want to change only the print format default setting. For example, FORM=H.

See COMPARE for information on the COMPARE function. For more information, see File-AID/MVS Online Reference on the COMPARE function.

FPRINT (FP)

The FPRINT parameter prints records in formatted mode, presenting the data according to a COBOL or PL/I record layout, like the formatted display of File-AID. Meanwhile, the primary function continues to process the data set. You must supply a //DDxxRL DD in the JCL, and the LAYOUT or MAP parameter in the control cards, to identify the layout member name to use for the formatted print.

Layout appearance can be controlled with the optional SHOW parameter. SHOW=FORMAT, SHOW=NUMBER, SHOW=OFFSET, and SHOW=PICTURE are valid options for the SHOW parameter.

Important

Do not use the FPRINT parameter with the DUMP, LIST, PRINT, FPRINT, or VPRINT function.

The syntax of the FPRINT parameter is:

FPRINT={number}

number

Number from 0 (zero) to 999999999 specifying the number of records to print. Printing of records can be based on one or more data selection parameters. Use FPRINT=0 to print all selected records in formatted mode.

Example FPRINT output is shown in FPRINT Request.

Example:

$$DD01 COPY FPRINT=15,MAP=SMFA,SHOW=OFFSET

This example copies the input dataset while printing the first 15 records, formatted according to the record layout in the SMFA member in the DD01RL DD.

Note

If the DDxxXR is present to identify a File-AID XREF member, each record type is automatically formatted using the record layout in the DDxxRL member as specified in the XREF logic.
Installations using alternate copy libraries, such as LIBRARIAN and PANVALET, and installations using Hiragana, Katakana, or Kanji character sets are supported only when the appropriate File-AID/Batch installation options are set as described in the File-AID Advanced Configuration Guide.
The FPRINT function does not list redefinitions.

IF (AND)

The IF parameter selects specific records to be processed by the function being executed. AND is a synonym of IF; AND can be used after the inclusion of at least one IF parameter (see AND ). The maximum number of IF parameters that can be entered is limited by the value of the MAXENT parameter (see MAXENT (ME)).

IF has three syntax forms based on three record selection criteria:

Record Selection by Data Content:

IF=(location,{length },[dupl]data[,loc2,{len2 },[dupl]data2]...)
{operator} {oper2}

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)

The syntax for each record selection method is given below.

Record selection by data content

When selecting a record based on specific data content, the syntax of the IF parameter is:

IF=(location,{length },[dupl]data[,loc2,{len2 },[dupl]data2]...)
{operator} {oper2}

location

Starting location of the data to search. Any valid actual or relative location can be used.

length

Length of the search field. The value must be at least one byte longer than the data element length. It can be any number from 0 (zero) to 255. Use 0 to scan to the end of the record.

operator

Operator element that represents the condition to test. Any valid operator element listed in Operator Element is allowed.

dupl

Optional duplication factor that defines the number of times File-AID finds the data to be contiguously repeated, starting at the specified location. A dupl element is valid only when an operator element is specified. Otherwise, the dupl value is ignored.

data

Data to search for in the specified location or scan length. Any valid data type listed in Data Element is allowed.

Important

Code multiple location, length or operator, and data elements by separating them with commas, resulting in a logical OR condition.

loc2

Location of second entry of multiple entry.

len2

Length of second entry of multiple entry.

oper2

Operator of second entry of multiple entry.

data2

Data of second entry of multiple entry.

Example 1:

$$DD01 DUMP IF=(23,EQ,C’TEST FILE’)

Example 1 generates a hexadecimal print of records that contain the string TEST FILE beginning in location 23.

Example2:

$$DD01 PRINT IF=(1,EQ,C’A’,17,EQ,C’1,2,3’)
$$DD01 PRINT IF=(1,EQ,C’A’,17,EQ,C’1’,17,EQ,C’2’,17,EQ,C’3’)

Example 2 shows two types of coding to print records that contain the character A in location 1, OR have the character 1, 2, or 3 in location 17.

Example 3:

$$DD01 PRINT IF=(1,EQ,C’A’),IF=(17,EQ,C’1,2,3’)

Example 3 prints records that have the character A in location 1, AND have the characters 1, 2, or 3 in location 17.

Example 4:

$$DD01 DUMP IF=(23,0,C’TEST FILE’)

Example 4 generates a hexadecimal print of records that contain the string TEST FILE beginning in location 23, or beyond.

Record selection by valid numeric or packed data

When selecting a record based on the presence or absence of valid numeric or packed data in a given location, the syntax of the IF parameter is:

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

location

Starting location of the data to examine. Any valid actual or relative location can be used.

length

Length of the packed or numeric field to check. When numeric data is specified in data-type, you must use a length greater than 0 and less than or equal to 256. When packed data is specified in data-type, you may use a length value of 0 through 16. The 0 length tells File-AID to verify the presence or absence of a packed field of any length (1 to 16 bytes), beginning at the specified location.

Important

Code dupl, operator, and data-type elements with no blanks between them.

dupl

Optional duplication factor that defines the number of times File-AID checks for the condition to be contiguously repeated, starting at the specified location.

operator-data-type

The following operator-data-types are valid:

EQP	Equal packed
NEP	Not equal packed
EQN	Equal numeric
NEN	Not equal numeric

A value of EQP or NEP checks for packed data. A valid packed field must be signed with C, F, or D.

A value of EQN or NEN checks for numeric data. Valid numeric data must have each byte of the field in zoned decimal format (F0 - F9). The last byte can be signed positive (C0 - C9), negative (D0 - D9), or unsigned (F0 - F9).

Important

When a duplication factor is specified, File-AID checks all fields, before applying the operator element, to determine if the record is selected. For example, 5NEP, means the record is selected if there is NOT five contiguous valid packed fields.

Example 5:

IF=(20,5,10EQP)

Example 5 checks for ten contiguous packed fields of five bytes each beginning in location 20.

Example 6:

IF=(6,10,EQN)

Example 6 checks for numeric data beginning in location 6 and continuing for ten bytes.

Example 7:

IF=(20,0,5EQP)

Example 7 selects records that have five contiguous packed fields of any length beginning in location 20.

Example 8:

IF=(20,0,5NEP)

Example 8 selects records that do NOT have five contiguous packed fields of any length beginning in location 20.

Record selection by timestamp

When selecting a record based on the presence or absence of a timestamp in a given location, the syntax of the IF parameter is:

IF=(location,operator,TS[+nn],length,timezone)

Timestamp is a 21 byte field in the format yyyymmddThhmmssffffff.

yyyymmdd is the 8 digit year, month and day.

The T is the actual letter T.

hhmmss is the 6 digit hour, minute, and second.

ffffff represents fractions of a second.

location

Starting location of the data to search. Any valid actual or relative location can be used.

operator

Operator element that represents the condition to test. Any valid operator element listed in Operator Element is allowed.

TS[+nn]

Identifies the parameter as a timestamp (TS or TIMESTAMP). TS may have an offset of +0 through +20 specified. If no offset is specified, the default is zero (0) which points at yyyy. TS+4 would point at the 5th position (mm - month).

length

Length (number of timestamp bytes to process) of the timestamp field. Valid values 1-21.

timezone

timezone is the fifth parameter (value following the length) specifies the time zone to use:

LOC or LOCAL specifies local time zone.

UTC specifies Universal Time Coordinated.

GMT specifies Greenwich Meridian Time.

If none is specified, the default is local time.

Example 9:

$$DD01 LIST IF=(34,EQ,TS,04,LOC)

Example 9 lists records that contain the local timestamp year (yyyy) in positions 34-37.

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.

The maximum number of IFNOT parameters that can be entered is limited by the value of the MAXENT parameter (see MAXENT (ME)).

The syntax of the IFNOT parameter is:

IFNOT=(location,length[,dupl],data[,loc2,len2[,dupl],data2]...)

location

Starting location of the data to search. Any valid actual or relative location can be used.

length

Length of the search field. The value must be at least one byte longer than the data element length. It can be any number from 0 (zero) to 255. Use 0 to scan to the end of the record.

dupl

Optional duplication factor that defines the number of times File-AID checks for the condition to be contiguously repeated, starting within the search field.

data

Data to search for in the specified search field. Only Character/Text or Hex data (C,T, or X) is valid.

Important

Code multiple location, length, and data elements by separating them with commas, resulting in a logical OR condition.

loc2

Location of second entry of multiple entry.

len2

Length of second entry of multiple entry.

data2

Data of second entry of multiple entry.

Example 1:

$$DD01 DUMP IFNOT=(23,100,C’TEST FILE’)

Example 1 generates a hexadecimal print of records that do not contain the string TEST FILE in the search field beginning in location 23 and ending in location 122.

Example2:

$$DD01 PRINT IFNOT=(1,10,C’A’,17,0,C’1,2,3’)
$$DD01 PRINT IFNOT=(1,10,C’A’,17,0,C’1’,17,0,C’2’,17,0,C’3’)

Example 2 shows two types of coding to print records that do not contain the character A in location 1 through 10, OR do not have the character 1, 2, or 3 beginning in location 17 to the end of the record.

Important

Data can only be Character/Text or Hex data (C,T, or X):
IFNOT=(1,0,T'ABC')
is correct.IFNOT=(1,0,P'+123')
is wrong.
Multiple data is allowed:
IFNOT=(1,0,C'ABC,DEFG,HI')
Can be used with ORIF/ELSE. Also IF/ORIF can be used with IFNOT/ORIFNOT.
IFNOT does not have ANDIFNOT.

IN (I)

The IN parameter controls the number of input records that File-AID processes before stopping.

The syntax of the IN parameter is:

IN=n

Any number from 1 through 999999999.

Example:

$$DD01 COPY IN=200

This example copies the first 200 input records to the output file.

INVALID

The INVALID parameter specifies how to process invalid data fields. This parameter is valid only with the XMLGEN function.

The syntax of the INVALID parameter is:

INVALID={HEX}
{DATA}
{SKIP}

HEX

Data is displayed in a hex dump format.

DATA

Data is displayed exactly as it is in the file with no formatting.

SKIP

Data portion of the field is omitted.

Example:

$$DD01 XMLGEN INVALID=HEX,LAYOUT=EMPLOYEE

This example generates an XML document for all records in the input file using the EMPLOYEE record layout member and it prints the field data that is invalid in hex dump format.

INVALIDCHAR (IVC)

The INVALIDCHAR (IVC) parameter specifies whether character fields that include unprintable characters will be printed as ‘INVALID’ or not. This parameter is valid only for the VPRINT function (see VPRINT (VP)).

The syntax of the INVALIDCHAR parameter is:

INVALIDCHAR=[ON/OFF]

INVALIDCHAR=ON prints the character fields that include unprintable characters as ‘INVALID’.

OFF

INVALIDCHAR=OFF prints the printable characters and replaces unprintable characters with spaces.

Example:

$$DD01 VPRINT INVALIDCHAR=ON

This example prints records in vertical formatted mode with ‘INVALID’ for the character fields that include unprintable characters.

IOEXIT

The IOEXIT parameter specifies the input and output I/O exit names. The IOEXIT parameter must be the first parameter following the function and it must be on the same line as the function.

The syntax of the IOEXIT parameter is:

IOEXIT=(input exit name,output exit name)
(,output exit name)
input exit name

input exit name

Specifies the name of the exit for the input file. You can specify up to eight characters. If you do not specify an output exit name, you can specify the input exit name without the parentheses.

output exit name

Specifies the name of the exit for the output file. You can specify up to eight characters. If you do not specify an input exit name, you must preface the output exit name with a comma and surround the value with parentheses.

Example 1:

$$DD01 COPY IOEXIT=(USXTYP1,USXTYP2)

This example copies a file using the input exit, USXTYP1, and the output exit, USXTYP2. Note that IOEXIT exit program names are user-defined.

Example 2:

$$DD01 USER IOEXIT=USXTYP1,WRITE=EXTRACT,OUT=25

This example creates a new data set by copying the input dataset using exit USXTYP1, and creates an extract data set called EXTRACT. A maximum of 25 records are written to the output extract file.

Example 3:

$$DD01 COPY IOEXIT=(,USXTYP2),OUT=20

This example copies the first 20 records to the output dataset using output exit USXTYP2.

KEY (K)

Two KEY parameter syntax forms control two File-AID process options:

Key Print Control:

KEY={NO }
{YES}

Random Key Record Control:

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

Key print control

File-AID prints the key portion of all keyed data sets when the KEY parameter is set to YES. File-AID does not print key information when the KEY parameter is set to NO. When Key Print Control is not specified, key information is only shown when printing a keyed BDAM file. See SYSLIST VSAM Retrieval PRINT Output for an example of key information printing.

Important

KEY=YES does not have any effect on FPRINT.

Random key Record Control

The KEY parameter can also initiate processing at a record containing a specific key with the syntax:

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

key-value

A character (C) or hexadecimal (X) data element as described in Data Element.

The specified key can be the complete or partial key for retrieval purposes. A partial key is considered a generic key. The KEY parameter is considered in error if used with a data set that has no key length.

Because the KEY parameter controls two processing options, it can be used twice in one control card.

Important

To begin processing at a specific relative block address (RBA), see “RBA”.

Example:

$$DD01 DUMP KEY=NO,KEY=C’ABC’

This example generates a hexadecimal print of a keyed file’s records, beginning with the first record having a key of ABC or higher. The key field is not printed.

LANGTYP (LAN)

The LANGTYP parameter selects members based on CA Panvalet language type. This parameter is valid only for Panvalet members.

The syntax of the LANGTYP parameter is:

LANGTYP=xxxxx

xxxxx

Specify a valid language type value (maximum of 5 characters). For example, the following standard language type values are valid:

Language Type	Synonyms
AUTOC	AUTOCODER
ASMB	BAL, ALC, ASM, Assembler
COBOL	COBOL
COB72	COBOL-72
ANSCB	ANSCOBOL
FORT	FORTRAN, FORTG, FORTGI, FORTH, GOFORT
PL/I	PL1, PL/I, PLI, PLIF, IPLI
RPG	RPG
OBJCT	OBJECT, OBJ
JCL	JCL, CNTL
DATA	DATA
OTHER	OTHER
USER1	USER180
USER2	USER780

Example:

$$DD01 LIST LANGTYP=COBOL

This example prints all Panvalet members with a language type of “COBOL”.

LAYOUT

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

The specified member must be a valid COBOL or PL/I record layout. The LAYOUT parameter is required if the DDxxRL DD defines a PDS, LIBRARIAN, or PANVALET library. (See FPRINT (FP) for information regarding the use of alternate copy libraries.)

If the DDxxRL DD defines a specific PDS member, or is a sequential file, the LAYOUT parameter is not required. The LAYOUT parameter is an alias for the MAP parameter.

The syntax of the LAYOUT parameter is:

LAYOUT=name

name

Valid member name of up to eight characters.

Important

File-AID supports ten character member names if the DDxxRL DD defines a PANVALET library.

Example:

$$DD01 FPRINT LAYOUT=TAPELOG

This example prints the data set in formatted mode according to the record layout in the TAPELOG member of the DD01RL DD.

LINKDATE

The LINKDATE parameter selects a group of members from a PDS based on the member's link date. The from or to-date range is specified in the ccyy/mm/dd format. Valid only with the LMODCLAS, LMODMAPA, LMODDIR, and LMODMAPN functions.

The syntax of the LINKDATE parameter is:

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

from-date,to-date

Specifies the endpoint from and to-dates, in the format ccyy/mm/dd to select modules for mapping. The dates can be complete or partial. Leading zeros are required when specifying the year, month, and day.

If the FROM date is omitted and a TO date is specified, File-AID selects all members linked on or before the specified TO date.
If a FROM date is specified and the TO date is omitted, File-AID selects all members linked on or after the specified FROM date.

Entering the same dates in the FROM and TO fields selects members linked only on that date.

Example:

$$$DD01 LMODMAPN LINKDATE=(2000/01/01,2000/06/30)

This example lists all modules in the data set with a link date on or between January 1, 2000 and June 30, 2000 in name order.

LIST (L)

The LIST parameter prints a list of selected records while the function continues to process the entire data set. Any packed or binary data is printed as blanks. Records printed using the LIST parameter do not have record number, record length, or column scale displayed. Example LIST output is shown in the SYSLIST LIST Request Output and Tags SYSLIST LIST Request Output and Tags.

Note

Do not use the LIST parameter with the LIST function.

The syntax of the LIST parameter is:

LIST=n

Number of records to list. Any number from 0 (zero) to 999999999 can be used. Listing of records can be based on one or more data selection parameters. Use LIST=0 to list all selected records.

Example:

$$DD01 COPY OUT=100,LIST=10

This example copies 100 records to DD01O and lists ten records to SYSLIST.

LPI

The LPI parameter overrides the default SYSLIST line count within File-AID. The line count for line-type printers can be set to either 6 or 8 lines per inch (LPI). These values convert to 8 and 12 LPI, respectively, when used for page-type (laser) printers.

The syntax of the LPI parameter is:

LPI={6}
{8}

Although the LPI parameter can be used at any time, it should not be used after printing begins on SYSLIST.

Important

LPI is ignored when using File-AID/Batch under TSO.

Example:

$$DD01 LIST LPI=8

This example sets the LPI to 8 on a line printer, or 12 on a laser printer.

MAP

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

The specified member must be a valid COBOL or PL/I record layout. The MAP parameter is required if the DDxxRL DD defines a PDS, LIBRARIAN, or PANVALET library. (See FPRINT (FP) for information regarding the use of alternate copy libraries.) If the DDxxRL DD defines a specific PDS member, or is a sequential file, the MAP parameter is not required. The MAP parameter is an alias for the LAYOUT parameter.

The syntax of the MAP parameter is:

MAP=name

name

Valid member name of up to eight characters.

Important

File-AID supports ten character member names if the DDxxRL DD defines a PANVALET library.

Example:

$$DD01 FPRINT MAP=TAPELOG

This example prints the data set in formatted mode according to the record layout in the TAPELOG member of the DD01RL DD.

MAXENT (ME)

The MAXENT parameter changes the default maximum entry of 1,024 parameters permitted per execution of File-AID. However, the MAXENT parameter cannot increase the maximum number (65,535) of logical sets. A logical set is created by the first IF statement in a series of IF statements, or by an ORIF statement.

MAXENT must be coded as the first entry of a control card after the function identifier, unless the IOEXIT parameter is also specified. If the IOEXIT parameter is specified, it must be coded as the first entry of the control card followed by MAXENT. The MAXENT parameter can be used only once per execution.

When modifying the MAXENT parameter, keep in mind that File-AID allocates 48 bytes of storage space for each condition coded in an IF parameter. A single IF parameter coded with 3 conditions (for example, IF=(1,0,C’A,B,C’)) uses 144 bytes of storage space.

EDIT, EDITALL, REPL, and REPLALL parameters use 64 bytes of storage space per condition.

The syntax of the MAXENT parameter is:

MAXENT=n

Number of parameter entries required. The maximum allowed value is 999999 (six digits). The default value is 1,024.

Example:

$$DD01 USER MAXENT=5000,
IF=( ... ),

This example reserves space for 5000 parameters requiring 240,000 bytes of storage. If sufficient memory is not available to accommodate the specified number of parameters, an error occurs and File-AID proceeds to the next control card.

To avoid memory/storage problems when increasing the MAXENT parameter, you should also increase the region size.

MAXOUT (MO)

The MAXOUT parameter changes the default value of eight output data sets that can be created with a USER function in conjunction with the WRITE parameter.

The syntax of the MAXOUT parameter is:

MAXOUT=n

Number of output data sets to create. It can be any number from 0 (zero) through 99. The default value is 8.

Important

If a large number of data sets will be created, adjust the JCL to reduce block sizes and the number of buffers acquired. This reduces the possibility of exceeding region size.

Example:

$$DD01 USER MAXOUT=10,WRITE=(A,B,C,D,E,F,G,H,I,J)

This example performs a USER function while concurrently creating ten output data sets.

Use the MAXOUT parameter only once per jobstep. The MAXOUT setting is passed to other File-AID function that refer to the same input DD statement.

Example:

$$DD01 USER MAXOUT=99,WRITE=(...
$$DD01 USER WRITE=(...

In this example the MAXOUT setting of 99 continues in effect for the second USER function.

$$DD01 USER MAXOUT=99,WRITE=(...
$$DD02 USER WRITE=(...

In this example the MAXOUT setting of 99 is in effect for the $$DD01 USER function. The $$DD02 USER function is limited to the MAXOUT default of eight data sets.

MBRNAME (MBR)

The MBRNAME parameter specifies a member name range that selects a subset of members based on the characters in the member name.

The syntax of the MBRNAME parameter is:

MBRNAME=(from-value,to-value)
        (,to-value)
        (from-value)
        from-value

from-value,to-value

Specifies the FROM and TO endpoint member names to include in the member list. The member names can be complete or partial. Pattern characters are not allowed.

As with the USERID parameter, the from-value is padded with low values, and the to-value is padded with high values. Entering the same characters in the from-value and to-value selects all members beginning with those characters.

The from or to-value member name can be up to eight characters for a PDS, PDSE, or CA Librarian library, and 10 for CA Panvalet library.

Example:

$$DD01 LIST MBRNAME=(EMPL,EMPL)

This example prints all members that begin with the characters EMPL.

Example:

$$DD01 LIST MBRNAME=(,ACCTBZZY)

This example prints all members from the beginning of the directory through member ACCTBZZY.

Example:

$$DD01 LIST MBRNAME=ACCTBZZY

This example prints member ACCTBZZY and the remaining members through the end of the directory.

MEMBER (M)

The MEMBER parameter selects one or more specific members within a PDS for processing. If a PDS is accessed and no member is given, File-AID reads the entire data set. When the MEMBER parameter is used, File-AID processes only the named member(s).

The syntax of the MEMBER parameter is:

MEMBER={name }
{(name1,name2,...)}

name

Valid member name of up to eight characters.

You can specify multiple member names by separating each one with a comma and enclosing them in parentheses. If you specify only one member name, it is recommended that you do not enclose it in parentheses.

Example 1:

$$DD01 COPY MEMBER=PROG241

Example 1 copies the single member PROG241.

Example 2:

$$DD01 COPY MEMBER=(PROG241,PROG242,PROG243)

Example 2 copies members PROG241, PROG242, and PROG243 to the output dataset DD01O.

MEMBERS (MS)

The MEMBERS parameter selects groups of members from a PDS. File-AID uses a mask field to search the PDS directory for any member names that conform to the characters in the mask.

The syntax of the MEMBERS parameter is:

MEMBERS={ALL}
{mask-name}

ALL

(Default) Specifies File-AID to select all members of the PDS.

mask-name

Mask for a specified group of members that can be any string of up to eight characters. Enter a - (hyphen), % (percent sign), * (asterisk), or ? (question mark) in each appropriate location to have File-AID ignore insignificant characters in the string.

Important

Specifying number of characters and wildcards in mask does not select only members with the exact number of characters in mask.

Example 1:

$$DD01 LIST MEMBERS=GE

Example 1 lists any member in the input PDS with a name that begins with the characters GE.

Example 2:

$$DD01 PRINT MEMBERS=GE-----P

Example 2 prints any member in the input PDS with a name that begins with the characters GE, and has a P in location 8. All other characters in the name are ignored.

MEMBERX (MX)

The MEMBERX parameter excludes groups of members from a PDS/PDSE. File-AID uses a mask field to search the PDS directory for any member names that conform to the characters in the mask and excludes them from processing.

The syntax of the MEMBERX parameter is:

MEMBERX={mask-name}

mask-name

Tip

Specifying a number of characters and wildcards in mask does not select only members with the exact number of characters in mask.
Specifying other filters such as MNL, or CREATED, ETC are allowed.

Example 1

$$DD01 LIST MEMBERX=GE

This example lists all members in the input PDS excluding names that begin with the characters GE.

Example 2

$$DD01 PRINT MEMBERX=GE-----P

Example 2 prints all members in the input PDS excluding names that begin with the characters GE, and has a P in location 8. All other characters in the name are ignored.

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.

The syntax of the MEMNAMELENGTH parameter is:

MEMNAMELENGTH=n

Specifies the length of the member name.

Example 1:

$$DD01 LIST MNL=3

Example 1 lists all members in the input PDS with a name length equal to 3, for example, members A10, B2A, ABC, etc.

Example 2:

$$DD01 COPY MEMBERS=(P1),MNL=3

Example 2 copies all members from the input PDS with a name that begins with the characters P1 and with a member name length equal to 3, for example, members P10, P1A, P17, etc.

MOVE (MV)

The MOVE parameter builds an output record by moving data to it. The data can be supplied from either the input record, control cards, or timestamps.

Three syntax forms are used for the three data sources:

Input Record Data:

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

Control Card Data:

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

Timestamp Data:

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

When a MOVE parameter is executed, data is moved from the input area, where input records reside, to the output area, where the output records reside. The output area is initialized to the PADCHAR value (which has a default of X’00’); any output location that does not have data moved to it retains the PADCHAR value. The initialization is performed prior to the first record being read and only at that time. (See PADCHAR (PAD).) You must build the entire output record.

Data that has been moved to an output location remains there until overlaid by another MOVE. This allows locations to be initialized once and left alone through successive iterations of the current function and/or successive functions. This also permits the merging of data from multiple input records into one output record.

During a move, File-AID maintains two relative locations, called the input and output relative locations, that correspond to the input and output areas. The input relative location advances whenever a scanning parameter results in a hit. The output relative location changes to where the last MOVE ended. Both the input and output relative location are reset to 1 (one) when File-AID reads a new input record.

When building variable-length records, File-AID keeps track of the highest location to which data has been moved, and writes a record containing the greatest length achieved. This feature allows the coding of MOVE parameters that reference locations in any order or combination of both actual and relative locations. However, you should code actual locations from left to right or enter primarily relative locations. This eliminates confusion as to whether the entire record has been filled.

When multiple variable-length records are created with multiple MOVE and WRITE parameters, the length of each record created from a single input record can only be equal to or greater than the preceding created record.

When creating one output variable-length record from multiple input records, the length of the fully merged record is determined by the data moved to the highest location of the output record for the final iteration for each output record.

When records are copied to an output dataset with a MOVE parameter, and a DUMP, LIST, or PRINT parameter is also used, File-AID prints both the input and output records on the SYSLIST dataset. File-AID labels the output record as OUTPUT, and prints the logical record number and record length. The entire output record is printed, including the RDW for variable length records depending on the setting of the RDW parameter (see RDW).

When the MOVE parameter is used with a DUMP, LIST, or PRINT function, File-AID treats the function as a request to display only part of the input record. File-AID keeps track of the highest output record location used and displays an output record equal to that length. However, the RDW for variable length records is not printed for these functions when the MOVE parameter is present regardless of the setting of the RDW parameter. This option is useful when a small portion of data in a large record must be examined.

The syntax of the MOVE parameter is based on whether the input data is received from an input record or control cards. Each syntax is described below.

Important

You cannot use the Input Record Data syntax of the MOVE parameter with the FORM=JCL parameter.
If the MOVE parameter is used with the EDIT or REPL parameters in one set of actions, specify the EDIT and/or REPL parameters before the MOVE parameter. The EDIT and REPL parameters act on the input record, and if the input data is moved to the output area, the EDIT or REPL changes following a MOVE do not appear in the output dataset.

Input record data

When moving data from the input record, the syntax of the MOVE parameter is:

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

to-location

Location in the output record that the data is to occupy. Any valid actual or relative location can be used. Use a relative location of +0 to have File-AID use the current relative location in the output record.

length

Length of the data to move. Valid values are 0 (zero) to 256. Use 0 (zero) to tell File-AID to calculate the length, from the specified from-location in the input record, to the end of the input record, and to use the result as the length of the data to move.

Important

If the length specified (or calculated) is greater than the remaining output record length, the remaining output record length is used.

from-location

Location in the input record where the data to move originates. It can be an actual or relative location. Use a relative location of +0 to reference the current relative location (first byte or last scan match location) in the input record. (See Relative Location.)

Important

The input record data format of the MOVE parameter is not supported when the FORM=JCL parameter is specified.

Example 1:

$$DD01 LIST MOVE=(+0,10,+0)

Example 1 lists the first ten locations of the input record. This use of the MOVE parameter avoids the printing of unneeded data.

Example 2:

$$DD01 COPY MOVE=(1,10,15)

Example 2 moves ten bytes of data from location 15 in the input record to location 1 in the output record.

Example 3:

$$DD01 USER MOVE=(1,0,10),WRITE=A

Example 3 moves data, beginning in location 10 of the input record, to the output record. Because the length specified is zero (0), as much of the input record data, starting from location 10, as can fit into the remaining space of the output record, is moved.

Example 4:

$$DD01 USER MOVE=(10,5,30),WRITE=A

Example 4 moves five bytes of data beginning in location 30 of the input area to the output area beginning at location 10. Since only the MOVE parameter is coded with the function, the remaining locations in the output record area remain the current PADCHAR parameter value.

Control card data

When control cards provide the data to place into an output record, the syntax of the MOVE parameter is:

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

to-location

Location in the output record that the data is to occupy. Any valid actual or relative location can be used. Use a relative location of +0 to reference the next available location in the output record.

dupl

Optional duplication factor that defines the number of times File-AID replicates the data string to move, starting at the specified to-location.

data

Data to move into the output record. Any valid data type listed in Data Element is allowed. The length of the MOVE is determined by the length of the data element entered, including the value of the dupl element.

Important

When packed data is used, high-order zeros must be specified to give the desired field length.

Example 5:

$$DD01 COPY MOVE=(1,C’ABC’)

Example 5 moves the string ABC to the output locations 1, 2, and 3.

Example 6:

$$DD01 COPY MOVE=(1,10C’ABC’)

Example 6 moves ten repetitions of the string ABC to output locations 1 through 30.

Example 7:

$$DD01 COPY MOVE=(+0,P’+00001’)

Example 7 moves a three-byte packed field, with a value of positive 1 (equivalent to X’00001C’), to the next available output location. The length of this packed field is determined by the number of decimal digits specified, including the leading zeros.

Timestamp data

When moving timestamp data into a given location, the syntax of the MOVE parameter is:

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

Timestamp is a 21 byte field in the format yyyymmddThhmmssffffff.

yyyymmdd is the 8 digit year, month and day.

The T is the actual letter T.

hhmmss is the 6 digit hour, minute, and second.

ffffff represents fractions of a second.

to-location

TS[+nn]

length

Length (number of timestamp bytes to process) of the timestamp field. Valid values 1-21.

timezone

timezone is the fourth parameter (value following the length) specifies the time zone to use:

LOC or LOCAL specifies local time zone.

UTC specifies Universal Time Coordinated.

GMT specifies Greenwich Meridian Time.

If none is specified, the default is local time.

Example 8:

MOVE=(34,TS+00,21,LOC)

Example 8 replaces record positions 34-54 with the entire local timestamp.

NEWMEM (NM)

The NEWMEM parameter assigns a name to a member on an output PDS or PDSE during execution of a COPY, DROP, or USER function. The name assigned by NEWMEM becomes the new member name. File-AID accepts only one NEWMEM parameter per DD statement.

Important

The NEWMEM parameter is also valid for PDSE load libraries.

When using the USER function with multiple PDS or PDSE outputs, File-AID writes only one member per PDS or PDSE per USER function. That is, multiple NEWMEM parameters may be specified per USER function, but each must be associated with a separate library. Use multiple USER functions to write multiple members to the same library. In this case, you must specify FORM=MULTI on the first USER function statement in order to reprocess the input file.

The syntax of the NEWMEM parameter is:

NEWMEM=name

name

New name to assign to the member. A maximum of eight characters can be entered.

Example:

$$DD01 COPY MEMBER=OLDNAME,NEWMEM=NEWNAME

This example copies member OLDNAME to the output dataset and renames it NEWNAME. If the member NEWNAME already exists, its contents are overwritten by OLDNAME, unless the RLM=NO parameter is specified.

NEWMEMS (NMS)

The NEWMEMS parameter assigns names to multiple members of an output PDS or PDSE using a mask that overwrites the input member names during execution of a COPY, DROP, or USER function.

Important

The NEWMEMS parameter is also valid for PDSE load libraries.

The syntax of the NEWMEMS parameter is:

NEWMEMS=mask-name

mask-name

A mask of up to eight characters. Use a hyphen ( - ) in each appropriate location to have File-AID ignore insignificant locations in the input name. When the mask is longer than the input member name, unused hyphens are deleted.

Important

For NEWMEMS, both the input and output data sets must be the same format, either PDS or PDSE.
If the newly constructed member name already exists on the output PDS or PDSE, the old member is replaced unless the RLM=NO parameter is specified.

Example:

$$DD01 COPY NEWMEMS=GA-----P

This example alters member names as follows:

Input	Mask	Output
MEMBERA	GA-----P	GAMBERAP
ABC	GA-----P	GACP
Z	GA-----P	GAP
PROGRAMA	GA-----P	GAOGRAMP

NEWNAME (NN)

The NEWNAME parameter provides the new name for the VSAMRN function that renames a VSAM dataset. The syntax of the NEWNAME parameter is:

NEWNAME=name

name

New name to assign to the VSAM dataset.

Example:

$$DD01 VSAMRN NN=USERID09.FASAMP.EMPLOYEE.RENAME

This example renames VSAM cluster FASAMP.EMPLOYEE to FASAMP.EMPLOYEE.RENAME

NORECCOPYRC (NRC)

The NORECCOPYRC parameter overrides File-AID/MVS and File-AID/Data Solutions configuration parameter NO_RECORDS_COPIED_RETURN_CODE (see also NO_RECORDS_COPIED_RETURN_CODE in the File-AID Advanced Configuration Guide for more detail). This parameter is valid only for the COPY (C), DROP (DR), and USER (US) functions.

Specify a different return code that File-AID is to issue when records are not selected for copying to any output dataset in a copy operation. The value 08 reflects the current return code issued. Any number from 00 (issue no return code) through 99 is valid. File-AID always reflects the highest return code issued during an execution.

Values - Decimal number 00 - 99

The syntax of the NORECCOPYRC parameter is:

NORECCOPYRC=nn

Example:

$$DD01 COPY NORECCOPYRC=11

This example issues return code 11 when records are not selected for copying to any output dataset in the copy operation.

ORIF (OR)

The ORIF parameter allows contiguous IF parameters to be logically ORed with preceding IF parameters. ORIF permits record selection based on more than one selection criterion. The maximum number of ORIF parameters that can be entered is limited by the value of the MAXENT parameter, with a maximum of 65,534 logical sets. See MAXENT (ME)for logical set definition.

Important

ORIF statements are ORed together, only in regard to the $$DDxx function. Action parameters (see Parameter Types) are executed only when the preceding (OR)IF condition is true. In order to specify that an action occur, when any one of multiple IF conditions evaluate as TRUE, repeat that parameter after each IF or ORIF clause.

ORIF has two syntax forms based on two selection criteria:

Record Selection by Data Content:

ORIF=(location,{length },[dupl]data[,loc2,{len2 },data2]...)
{operator} {oper2}

Record Selection by Valid Numeric or Packed Data:

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

where the elements of each syntax form are the same as those defined for the two syntax forms of the IF parameter. See IF (AND)for a description of each element.

Example 1:

$$DD01 COPY IF=(25,EQ,C’1’),
            AND=(30,EQ,C’2’),
           ORIF=(16,EQ,C’3’),
            AND=(50,EQ,C’7’)

This example copies records that have a number1 in location 25 and a 2 in location 30, or a 3 in location 16 and a 7 in location 50. An AND condition exists between the first two IF parameters. The ORIF creates the second set of AND conditions.

Example 2:

$$DD01 COPY IF=(21,EQ,C’ABC’),
ORIF=(41,EQ,C’XYZ’),
REPL=(61,C’DEF’)

This example copies records that have the characters ABC in location 21 or XYZ in location 41. If location 41 contains the characters XYZ, the characters DEF overlay the data at location 61.

If the intent is to overlay DEF at location 61, if either of the two conditions is true (ABC in location 21 or XYZ in location 41), insert the REPL clause after each IF and ORIF clause:

$$DD01 COPY IF=(21,EQ,C’ABC’),
              REPL=(61,C’DEF’),
            ORIF=(41,EQ,C’XYZ’),
              REPL=(61,C’DEF’)

Example 3:

$$DD01 TALLY IF=(1,EQ,C'C01'),AND=(178,NE,C'R'),
OR=(1,EQ,C'D01'),AND=(120,NE,C'R'),
ACCUM=(2,2,C,'XYZ TOTALS')

ORIFNOT

The ORIFNOT parameter allows contiguous IFNOT parameters to be logically ORed with preceding IFNOT parameters. ORIFNOT permits record selection based on more than one selection criterion.

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

The maximum number of ORIFNOT parameters that can be entered is limited by the value of the MAXENT parameter (see MAXENT (ME)).

The syntax of the ORIFNOT parameter is:

ORIFNOT=(location,length[,dupl],data[,loc2,len2,data2]...)

location

Starting location of the data to search. Any valid actual or relative location can be used.

length

Length of the search field. The value must be at least one byte longer than the data element length. It can be any number from 0 (zero) to 255. Use 0 to scan to the end of the record.

dupl

Optional duplication factor that defines the number of times File-AID checks for the condition to be contiguously repeated, starting at the specified location.

data

Data to search for in the specified location or scan length. Only Character/Text data (C,T, or X) is valid.

Important

Code multiple location, length, and data elements by separating them with commas, resulting in a logical OR condition.

loc2

Location of second entry of multiple entry.

len2

Length of second entry of multiple entry.

data2

Data of second entry of multiple entry.

Example 1:

$$DD01 DUMP IFNOT=(23,100,C’TEST FILE’)
ORIFNOT=(1,0,C’QA FILE’)

Example 1 generates a hexadecimal print of records that do not contain the string TEST FILE beginning in location 23 and ending in location 123, or that do not contain the string QA FILE. In other words, the records containing both TEST FILE, at location 23 through 123, and QA FILE, at any location in the record, are not printed.

Example 2:

$$DD01 COPY IF=(21,EQ,C’ABC’),
ORIFNOT=(41,0,C’XYZ’),
REPL=(61,C’DEF’)

This example copies records that have the characters ABC in location 21 or do not contain the characters XYZ in location 41 through the end of the record. If the record in location 41 through the end of the record does not contain the characters XYZ, the characters DEF overlay the data at location 61.

Important

Data can only be Character/Text or heXadecimal data (C,T, or X):
(ORIFNOT=(1,0,T'ABC')
is correct.
ORIFNOT=(1,0,P'+123')
is wrong.
Multiple data is allowed:
ORIFNOT=(1,0,C'ABC,DEFG,HI')
Can be used with ORIF/ELSE. Also IF/ORIF can be used with IFNOT/ORIFNOT.

OUT (O)

The OUT parameter controls the number of records that are written or printed before processing stops. OUT can be used to limit the output, or to extend the amount of printed output past the default of 250 records.

The syntax of the OUT parameter is:

OUT=n

Number from 0 (zero) to 999999999. Use OUT=0 to process the entire file.

Important

The OUT parameter is ignored when the UPDATE function is specified, but the OUT parameter is not ignored when used with an IF.

Example:

$$DD01 DUMP OUT=25

This example generates a hexadecimal print of the first 25 records.

PADCHAR (PAD)

The PADCHAR parameter specifies the value to use for padding.

Important

PADCHAR is only applicable for sequential files.

Specify this parameter only once per function. The PAD value initializes output areas when creating records using the MOVE parameter. The initialization is performed prior to the first record being read and only at that time.

Padding also occurs when:

Record length decreases during EDIT or MOVE processing
A record is copied to a larger fixed-length record
Record length is updated and increased.

The syntax of the PADCHAR parameter is:

PADCHAR={C’c’ }
{X’nn’}

The c may be any single character-data value.

The nn may be any valid two-digit hexadecimal-data value.

The default value for PADCHAR is X’00’.

Example:

$$DD01 COPY PADCHAR=C’*’

Assuming the output data set’s record length is larger than that of the input dataset, this example pads the remainder of the output dataset records with asterisks.

PANSTAT (STA)

The PANSTAT parameter selects members based on CA Panvalet status type. This parameter is valid only for Panvalet members.

The syntax of the PANSTAT parameter is:

PANSTAT=x

Specify one of the following valid status types:

A	Active
D	Disabled
E	Enabled
I	Inactive
P	Production
T	Test.

Example:

$$DD01 LIST PANSTAT=T

This example prints all Panvalet members with a status type of “T”.

PDSSTAT (MPS)

The PDSSTAT parameter maintains PDS member statistics when updating partitioned data sets. It maintains only standard PDF directory entries. The parameter is valid only with the UPDATE function.

The syntax of the PDSSTAT parameter is:

PDSSTAT=x

Valid values for the x parameter are:

Y	Update PDS statistics if they exist
N	Do not update PDS statistics
A	Update PDS statistics if they exist, or add statistics if they do not exist.

Example:

UPDATE MEMBER=EMPLOYEE,PDSSTAT=A,EDIT=(1,0,C’ABC’,C’XYZ’)

In this example, File-AID updates existing statistics or adds new statistics for the member EMPLOYEE.

PRESERVE

Maintains trailing blanks (spaces) in variable length records. Valid only for COPY and USER. To change the status issue the PRESERVE command.

PRESERVE={ON}
{OFF}

Maintains trailing blanks (spaces) in variable length records. With PRESERVE=ON, File-AID will include all trailing blanks in the record up to the defined record length and the RDW will be adjusted to include the blanks.

OFF

When PRESERVE=OFF is set File-AID will not include any trailing blanks in the record, and the RDW for this record will be adjusted to omit the blanks.

Example:

$$DD01 COPY PADCHAR=X’00’,PRESERVE=OFF

In this example, File-AID trims trailing blanks and adjusts the RDW accordingly.

PRINT (P)

The PRINT parameter generates a print of a selected number of records while the primary function continues processing the file. Packed and binary data are printed as blanks. Example PRINT output is shown in SYSLIST PRINT Request Output. (See also PRINT (P).)

The syntax of the PRINT parameter is:

PRINT=n

Number of records to print. Any number from 0 (zero) to 999999999 is valid. Printing of records can be based on one or more data selection parameters. Use PRINT=0 to print all selected records.

Important

Do not use the PRINT parameter with the PRINT function.

Example:

$$DD01 COPY PRINT=15

This example copies the input dataset while printing the first 15 records.

PRINTMIXEDCASE (PMC)

The PRINTMIXEDCASE parameter overrides the File-AID/MVS and File-AID/Data Solutions configuration parameter PRINT_UPPERCASE_OR_MIXED (see also PRINT_UPPERCASE_OR_MIXED in the File-AID Advanced Configuration Guide for more detail). This parameter is valid only for the FPRINT (FP), PRINT (P), VPRINT (VP), PRINT (P), and XMLGEN functions.

The syntax of the PRINTMIXEDCASE parameter is:

PRINTMIXEDCASE=x

Valid values for the x parameter are:

Y	Prints mixed case and special characters
N	Prints upper case only

Example:

$$DD01 PRINT PRINTMIXEDCASE=Y

This example prints mixed case and special characters.

PRTRECS

The PRTRECS parameter specifies whether to include changed, inserted, deleted, and matched records in the Compare Detail Report.

The PRTRECS parameter, if coded, overrides the report format setting of the FORM parameter. (If you do not code the PRTRECS parameter the report format is controlled by the FORM parameter.) See COMPARE Format Control in the FORM (F)parameter description. The Compare Criteria dataset can override these options.

The syntax of the PRTRECS parameter is:

PRTRECS=(C,I,D,M)

The following PRTRECS options may be coded in any sequence. If only one option is coded, the parenthesis may be omitted.

Print changed records.

Print inserted records.

Print deleted records.

Print matched records.

Example:

$$DD01 COMPARE FORM=(C,D,E,S),PRINT=0,PRTRECS=(C,I,D,M)

This example prints a standard compare detail report in character format, and single-byte character set (EBCDIC). It includes all four types of print records: Changed, inserted, deleted, and matched. The D (Differences) report format option of the FORM parameter is overridden by the PRTRECS parameter.

See COMPARE for information on the COMPARE function. For more information, see File-AID/MVS Online Reference on the COMPARE function.

RBA

The RBA parameter is used to enter a starting byte address for VSAM ESDS or KSDS files, or a relative record number for VSAM RRDS files.

The syntax of the RBA parameter is:

RBA={n }
{X’hh’}

Decimal value.

The hh may be any valid hexadecimal value enclosed in quotes (’hh’). Hex values are specified by using pairs of the digits 0-9 and A-F.

Important

When the specified value exceeds the size of the data set, the function ends. RBA values for VSAM ESDS or KSDS data sets must correspond to the beginning of the record.

Example:

$$DD01 COPY RBA=30
or
$$DD01 COPY RBA=X’1E’

The process performed by this example depends on the access method of the input dataset. A VSAM ESDS or KSDS input dataset is copied beginning at the starting byte address of 30. A VSAM RRDS input dataset is copied beginning at the relative record number of 30.

RDW

The RDW (Record Descriptor Word) parameter controls the inclusion or exclusion of the RDW for variable-length record processing. RDW permits logical access to a variable-length record without accounting for the four-byte system RDW at the beginning of each record.

The default for this parameter is set by an installation option which has an initial setting of 0(zero). Coding this parameter for a function overrides the installation-defined default setting for the duration of the job step unless a new RDW parameter is encountered.

The syntax of the RDW parameter is:

RDW=n

Value of 0, 1, 2, or 3, which are defined as:

0	Include the RDW during record processing and display it on output. 0 (zero) is the initial default setting
1	Include the RDW during record processing, but do not display it on output.
2	Do not include the RDW during record processing, but display it on output.
3	Do not include the RDW during record processing and do not display it on output.

Important

The RDW parameter must be coded before any IF, EDIT, REPL, or MOVE parameters in the control card. The RDW parameter only affects the input position, never the output location specified in a MOVE parameter. Output location 1 always refers to the first position of data.
When the MOVE parameter is used with a DUMP, LIST, or PRINT function, File-AID treats the function as a request to display only part of the input record. File-AID keeps track of the highest output record location used and displays an output record equal to that length. However, the RDW for variable length records is not printed for these functions when the MOVE parameter is present regardless of the setting of the RDW parameter. This option is useful when a small portion of data in a large record must be examined.

Example 1:

$$DD01 LIST RDW=3,IF=(1,EQ,C'A'),MOVE=(1,100,1)

Example 1 lists the first 100 bytes of all records of this variable-length data set that contain the character A in the first data byte of the record (not including the 4-byte system RDW). The RDW is not included during record processing as specified by the RDW parameter and is not printed since the MOVE parameter is present with the LIST function.

Example 2:

$$DD01 LIST RDW=1,IF=(5,EQ,C’A’),MOVE=(1,100,5)

Example 2 produces the same results as Example 1. The RDW setting requires the first byte of input data to be specified as 5 while the first output location is always 1. The RDW setting does not apply to output record positions during MOVE processing.

READNEXT (RN)

The READNEXT parameter enables you to code the action to end processing of the current record and start the function over with the next record. This parameter is valid with the USER or TALLY functions and COPYALL, DUMPALL, FPRINTALL, LISTALL, PRINTALL, UPDATEALL, and VPRINTALL.

READNEXT must be coded both subordinate to and immediately followed by an IF, ORIF, or ELSE parameter.

The syntax of the READNEXT parameter is:

READNEXT

REFOUT (RFO)

The REFOUT parameter specifies which records to copy when executing a reformat definition. This parameter is used only with the REFORMAT function.

The syntax of the REFOUT parameter is:

REFOUT={SEL}
{ALL}

SEL

(Default) Specifies that only those records being reformatted are copied.

ALL

Specifies that all records are copied.

Example:

$$DD01 REFORMAT REFOUT=SEL

In this example, only those records that are being reformatted are copied to the output dataset.

REPL (R)

Use REPL or REPLALL to conditionally or unconditionally replace data at a specific location, or to replace data at an alternate location depending on a condition. REPL replaces the first occurrence of data in a record; REPLALL replaces all occurrences of the data in the record.

Important

REPL accepts data types CL, TL, PL, I and ILn.

The REPL parameter has three syntax forms for replacing data in an input record based on different selection criteria:

Replace by Location:

REPL=(location,[dupl]new-data)

Replace by Condition:

REPL=(location,{length },[dupl]compare-data,[dupl]new-data)
{operator}

Replace at Alternate Location Depending on a Condition:

REPL=(location,{length },[dupl]compare-data,replace-location,
{operator}
[dupl]new-data)

The Replace by Location syntax unconditionally replaces all data at a given location. The Replace by Condition syntax checks to see if a specific condition is present at a given location, before replacing the data at that location. The Replace at Alternate Location Depending on a Condition syntax checks for a specific condition at a given location, and if the condition is present, replaces the data at an alternate location.

Warning

All REPL syntax forms replace data at the given location with new-data. Existing data at the replace location is overlaid with the full length of the new-data specified.

Note

If special characters such as commas or single quotes are part of the compare-data, enclose the data and special characters in double quotes. For example:
REPL=(6,EQ,C"634,21",C’634521’)
If the MOVE parameter is used with the EDIT or REPL parameters in one set of actions, specify the EDIT and/or REPL parameters before the MOVE parameter. The EDIT and REPL parameters act on the input record, and if the input data is moved to the output area, the EDIT or REPL changes following a MOVE do not appear in the output dataset.
When binary new-data is specified, File-AID processes the control card in one of three ways:
- Turn on (OR) specified bits -- B'10000000’ (Sets bit on without respect to previous condition).
- Turn off (NOT-AND) specified bits -- BM’10000000’ (Sets bit off if it is on).
- Reverse the current setting (exclusive OR) of bits -- BX’10000000’ (Sets bit on if it is off; sets bit off if on).
The second and third methods require using alternate forms of the binary data-type code as a part of the new-data value. The second method specifies the new-data as binary minus (BM’80’) to turn off the specified bits. The third method specifies the new-data as a binary exclusive OR (BX’80’) to reverse the bits (turn off if on, turn on if off). These alternate forms of the binary data-type code are considered errors in all other parameters.
When character or hexadecimal data is specified as new-data, the new-data length is based on the length of the data value specified (times the optional dupl value). No data shifting occurs. New-data overlays existing data at the specified location.
When packed data is specified as new-data, the data at the replace location must also be a valid packed field of any length (1 to 16 bytes). The new-data length is based on the length of the packed field at the replace location. High order truncation of the new-data packed value may occur if the packed field at the replace location is not large enough to accept all significant decimal digits specified. Leading zeros in the packed new-data value are ignored. High-order zeros are automatically inserted, as needed, when padding a smaller new-data value to replace an existing larger length packed field (at the replace location). No data shifting occurs. New-data overlays existing data at the specified location. If a dupl factor is specified for packed new-data, File-AID performs the replacement, and expects that there are dupl number of contiguous packed fields at the replace location. For more information, see Packed Data.

Replace by Location

The syntax of the REPL parameter when used to unconditionally replace data in a given location is:

REPL=(location,[dupl]new-data)

location

Starting location of the data to replace. Any valid actual or relative location can be used.

dupl

Optional duplication factor that defines the number of times File-AID repeats the new-data, starting at the specified location.

new-data

New data to place in the specified location. Any data format may be entered.

Example 1:

$$DD01 COPY REPL=(4,C’6’)

Example 1 copies the input dataset and replaces the data in location 4 of each record with a character 6.

Replace by condition

The syntax of the REPL parameter when used to replace data based on the truth of a condition is:

REPL=(location,{length },[dupl]compare-data,[dupl]new-data)
{operator}

location

Starting location of the data to check and/or replace. Any actual or relative location can be used.

length

Length of the area to check. The value must be at least one byte longer than the compare-data length. Use 0 to scan until the end of the record.

operator

Any valid operator element listed in Operator Element is allowed.

dupl

Optional duplication factor that defines the number of times File-AID finds the compare-data to be contiguously repeated, starting at the specified location. A dupl element is valid only when an EQ operator element is specified. Otherwise, the dupl value is ignored. When a dupl element is specified for new-data, the dupl value is the number of times File-AID repeats the new-data at the replace location.

compare-data

Data to compare to the data at the specified location. Any valid data type listed in Data Element is allowed.

new-data

New data to place in the specified location if the condition described by the location, operator or length, and compare-data elements is true. Any valid data type can be used.

Example 2:

$$DD01 COPY REPL=(4,EQ,C’2’,C’6’)

Example 2 finds each input record that contains a character 2 in location 4, and replaces it with a character 6.

Replace at alternate location by condition

The syntax of the REPL parameter when used to replace data at an alternate location based on the truth of a condition in a given location is:

REPL=(location,{length },[dupl]compare-data,replace-location,
{operator}
[dupl]new-data)

location

Starting location of the data to check. Any actual or relative location can be used.

length

Length of the area to check. The value must be at least one byte longer than the compare-data length. Use 0 to scan to the end of the record.

operator

Any valid operator element listed in Operator Element is allowed.

dupl

compare-data

Data to compare to the data at the specified location. Any valid data type listed in Data Element is allowed.

replace-location

Location in the input record in which the new-data is placed if the condition described by the location, length or operator, and compare-data elements is true. Any actual or relative location can be used.

new-data

New data to place in the replace-location if the condition described by the location, operator or length, and compare-data elements is true. Any valid data type can be used.

Example 3:

$$DD01 COPY REPL=(4,EQ,C’222’,16,C’400’)

Example 3 copies the input dataset and locates any record that contains the compare-data string 222 beginning in location 4. When such a record is found, File-AID replaces the data in locations 16 through 18 with the new-data string 400.

REPLALL (RA)

The REPLALL parameter is the same as the REPL parameter except that it replaces all occurrences of data within the area specified by a start location and a length.

REPLALL has two syntax forms:

Replace by Condition:

REPLALL=(location,length,compare-data,[dupl]new-data)

Replace at Alternate Location Depending on a Condition:

REPLALL=(location,length,compare-data,replace-location,
[dupl]new-data)

The elements of each syntax form are the same as those defined for the REPL parameter. For a description of each element, see REPL (R).

Important

dupl is not allowed on compare-data with REPLALL.

Example 1:

$$DD01 COPYALL IF=(10,10,NEN),
RA=(10,10,C’ ’,C’0’)

Example 1 copies all input records while the IF parameter locates any record that contains non-numeric data in locations 10-19. The REPLALL parameter then scans locations 10-19 of each of the located records, and replaces all blanks in locations 10 through 19 with zeros.

Example 2:

$$DD01 COPY RA=(15,18,C’WXYZ’,2C’XY’)

Example 2 copies all input records while the REPLALL parameter scans locations 15-32 of each record, and replaces all occurrences of the string WXYZ with XYXY.

RLM

The RLM (replace-like-members) parameter controls the replacement of identically-named members during a copy from one PDS to another.

The syntax of the RLM parameter is:

RLM={YES}
{NO }

YES (Y)

(Default) Specifies that a member already present in the output PDS is replaced.

NO (N)

Specifies that an existing output PDS member is not replaced.

RLPRINT (RLP)

The RLPRINT parameter prints the associated record layouts when printing XREFs using the XRPRINT function. The parameter is valid only with the XRPRINT function. The data set containing the record layouts must be specified in the DDxxRL DD statement.

The syntax of the RLPRINT parameter is:

RLPRINT=Y

Print the record layouts.

Example:

$$DD01 XRPRINT RLPRINT=Y,MEMBER=ORDRFILE

In this example, File-AID prints the associated record layouts when it prints the XREF dataset (DD01) member ORDRFILE.

RMODE

The RMODE parameter specifies the residency mode to select.Valid only with the LMODCLAS, LMODMAPA, LMODDIR, and LMODMAPN functions.

The syntax of the RMODE parameter is:

RMODE={24}
{ANY }

Selects modules with an address mode of 24 for mapping.

ANY

Selects modules with any address mode for mapping.

Example:

$$DD01 LMODMAPN RMODE=24

This example lists all modules in the file with a residency mode of 24 in name order.

RRN

The RRN parameter specifies the relative record number for VSAM RRDS and BDAM files. When the specified value exceeds the size of the data set, the function ends.

The syntax of the RRN parameter is:

RRN=n

A decimal value.

Example:

$$DD01 COPY RRN=30

In this example, File-AID copies a VSAM RRDS or BDAM file beginning at the relative record number of 30.

SELECT (S)

The SELECT parameter selects a given occurrence of a record for processing. SELECT can be entered at any time, but is only valid for the function in which it is entered. When SELECT is used with selection criteria (see Record and Member Selection Logic), it is subordinate to those selections.

When multiple SELECT parameters are used with multiple IF parameters in a control card, they are subordinate to the IF parameter that they follow. This feature is useful when building random test data sets.

The syntax of the SELECT parameter is:

SELECT=n

Occurrence to select. Any number from 1 to 999999999 can be used.

Example 1:

$$DD01 PRINT OUT=10,IF=(1,EQ,P’50’),SELECT=3

Example 1 prints the third record that has a packed 50 beginning in location 1, and prints every third occurrence thereafter, up to a total of 10 records.

Example 2:

$$DD01 COPY IF=(12,EQ,P’50’),OUT=50,S=5,
IF=(12,EQ,P’60’),OUT=30,S=4

Example 2 selects every fifth record that contains a packed 50 in location 12, and copies up to 50 records. The example also selects every fourth record that contains a packed 60 in location 12, and copies up to 30 records. Thus, up to 80 records are copied to the output dataset DD01O.

SHOW (SH)

The SHOW parameter specifies the type of field information that is displayed for formatted print (FPRINT) output or changes the column header information for vertical formatted print (VPRINT) output. Example FPRINT output is shown in FPRINT Request.

The syntax of the SHOW parameter is:

SHOW={FORMAT }
     {NUMBER }
     {OFFSET }
     {PICTURE}

FORMAT (F)

(Default) Displays field length and current field format, separated by a slash (/), and changes the field description heading of the report to FORMAT. The field length is expressed in bytes. File-AID displays the actual number of bytes occupied by the field, rather than the data item size (which can be determined with the PICTURE value).

A special form (length:bits/format) is used for unaligned bit fields where the number of complete bytes and the number of additional bits are listed, separated by a colon ( : ). File-AID provides a field format abbreviation to describe the way the internal record data is interpreted and formatted on the report. The format abbreviations vary depending on the language in which the record layout is described. For additional information, see Data Format Abbreviations.

OFFSET (O)

Reports the offset of each layout field from the beginning of the record, in bytes relative to zero (0), and changes the field description heading to RELATIVE.

NUMBER (N)

Shows the numbers that File-AID assigns to each layout field, and changes the field description heading to NUMBER.

PICTURE (P)

Shows the PICTURE clause of the original data declaration for each elementary item and changes the field description heading to PICTURE. The information under the heading is presented to accurately represent the data declaration (within the constraints of the column width). Therefore, the information displayed with the PICTURE parameter varies, depending on the language used to define record layouts.

STOP (ST)

The STOP parameter stops processing of a function when a specified criteria is met. The next function, if any, then begins processing with the record at which the stop occurred. STOP can be used to execute different functions on different portions of sequential data sets.

The syntax of the STOP parameter is:

STOP=(location{,length },[dupl]data,[loc2{,len2 },[dupl]data2]...)
{ operator} { oper2}

location

Starting location of the data to scan. Any valid actual or relative location can be used.

length

Length of the area to scan. The value must be at least one byte longer than the data element length. Use 0 to scan to the end of the record.

operator

Operator element that represents the conditions to test. Any valid operator element listed in Operator Element is allowed.

dupl

Optional duplication factor that defines the number of times File-AID finds the data to be contiguously repeated, starting at the specified location. A dupl element is valid only when an operator element is specified. Otherwise, the dupl value is ignored.

data

Data to search for in the specified location. Any valid type listed in Data Element is allowed.

Important

Coding multiple location, length or operator, and data entries in one STOP parameter results in a logical OR condition. Coding multiple contiguous STOP parameters results in a logical AND condition between parameters.

loc2

Location of second entry of multiple entry.

len2

Length of second entry of multiple entry.

oper2

Operator of second entry of multiple entry.

data2

Data of second entry of multiple entry.

Important

Code the STOP parameter ahead of any data-entry parameters, such as ACCUM, IF, REPL, EDIT or ORIF.

Example 1:

$$DD01 COPY STOP=(25,EQ,C’ABC COMPANY’)

Example 1 copies the input data set, and stops at the first record that contains the string ABC COMPANY beginning in location 25.

Example 2:

$$DD01 COPY STOP=(1,EQ,P’123’,6,EQ,C’XYZ’)

Example 2 copies the input data set, and stops at the first record that contains a packed 123 beginning in location 1 or string XYZ beginning in location 6.

Example 3:

$$DD01 SPACE STOP=(1,0,C’ABC’)
$$DD01 LIST IN=6

Example 3 prints the record with ABC and the next five records.

TRUNCRC (TRC)

The TRUNCRC (TRC) parameter overrides File-AID/MVS configuration parameter RECORD_TRUNCATION_RETURN_CODE (see also RECORD_TRUNCATION_RETURN_CODE in the File-AID Advanced Configuration Guide for more detail). This parameter is valid only for the COPY (C), DROP (DR), and USER (US) functions.

Specify a different return code that File-AID is to issue when records are truncated in a copy operation. The value 04 is default to issue RC=4. 0C would issue RC=12, 10 would issue RC=16. Any HEX number 00 through FF is valid.

The syntax of the TRUNCRC parameter is:

TRUNCRC=nn

Example:

$$DD01 COPY TRUNCRC=10

This example issues return code 16 when records are truncated in a copy operation.

TYPRUN

The TYPRUN parameter specifies to validate the compare criteria file without comparing the data. Valid only with the COMPARE function.

The syntax of the TYPRUN parameter is:

TYPRUN=SCAN

UNIT

The UNIT parameter specifies one or more generic unit names for the VTOCDSN, VTOCINFO, and VTOCMAP functions. You must specify the UNIT parameter if the VOLSER or VOLSTAT parameter is not specified for these VTOC functions.

You can combine the UNIT parameter with the VOLSER and VOLSTAT parameters for multi-volume processing.

The syntax of the UNIT parameter is:

UNIT=(unit-name)

unit-name

A unique 8-character alphanumeric generic unit name. You can specify multiple generic units, up to 48 characters total, by enclosing them in parenthesis and separating each one with a comma.

Example:

$$DD01 VTOCMAP UNIT=(SYSDA,3880,3890)

In this example, File-AID displays volume information and data sets for three units (SYSDA, 3880, and 3890).

USERID (USR)

The USERID parameter specifies a user identification range that selects a group of members based on the user ID that last updated and saved a member. This information is a PDS statistic that is stored in the directory. Members without PDS statistics, because they were not created (STATS OFF) or the statistics were deleted, are not selected.

The syntax of the USERID parameter is:

USERID=(from-value,to-value)
       (,to-value)
       (from-value)
       from-value

from-value,to-value

Specifies the FROM and TO endpoints for user IDs to include in the member list. The user IDs can be complete or partial. Pattern characters are not allowed. As with MBRNAME parameter, the from-value is padded with low values, and the to-value is padded with high values.

Example:

$$DD01 LIST USERID=(USERID1,USERID5)

This example prints all members that were last updated and saved by user ID USERID1, USERID2, USERID3, USERID4, or USERID5.

Example:

$$DD01 LIST USERID=(USERID2,USERID2)

This example prints all members that were last updated and saved by user ID USERID2.

Example:

$$DD01 LIST USERID=USERID2

This example prints all members that were last updated and saved by user ID USERID2 or user IDs of higher values.

VOLSER (VOL)

The VOLSER parameter specifies one or more volume serial numbers for the VTOCDSN, VTOCINFO, and VTOCMAP functions. You must specify the VOLSER parameter if the UNIT parameter is not specified for these VTOC functions.

You can combine the VOLSER parameter with the UNIT and VOLSTAT parameters for multi-volume processing.

The syntax of the VOLSER parameter is:

VOLSER=(volume-serial)

volume-serial

A unique 6-character alphanumeric volume serial number You can also use an asterisk (*) or specify a partial volume serial number. You can specify multiple volume serial numbers, up to 48 characters total, by enclosing them in parenthesis and separating each one with a comma.

Example:

$$DD01 VTOCINFO VOLSER=(WORK01,TSO,PRD9*)

In this example, File-AID displays volume information for volume serial name WORK01 and for all volume serial names that start with TSO and PRD9.

VOLSTAT (VST)

The VOLSTAT parameter specifies the volume status for the VTOCDSN, VTOCINFO, and VTOCMAP functions. This parameter is optional; if you do not specify a volume status, all three volume statuses are assumed. If you specify the VOLSTAT parameter, you can specify only one status.

The syntax of the VOLSTAT parameter is:

VOLSTAT={PUB}
{PRV}
{STG}

PUB

Specifies a volume status of public

PRV

Specifies a volume status of private

STG

Specifies a volume status of storage

Example:

$$DD01 VTOCDSN VOLSTAT=PUB,UNIT=3390

In this example, File-AID displays VTOC summary information and data set names for those data sets on public volumes on 3390 units.

VPRINT (VP)

The VPRINT parameter prints records in vertical formatted mode, presenting the data according to a COBOL or PL/I record layout, like the formatted display of File-AID. Meanwhile, the primary function continues to process the data set. You must supply a //DDxxRL DD in the JCL, and the LAYOUT or MAP parameter in the control cards, to identify the layout member name to use for the formatted print.

Column heading appearance can be controlled with the optional SHOW parameter. SHOW=FORMAT, SHOW=NUMBER, SHOW=OFFSET, and SHOW=PICTURE are valid options for the SHOW parameter.

Important

Do not use the VPRINT parameter with the DUMP, LIST, PRINT, FPRINT, or VPRINT function.

The syntax of the VPRINT parameter is:

VPRINT={number} {FIELDS=(field-list)}
{ALL}

number

Number from 0 (zero) to 999999999 specifying the number of records to print. Printing of records can be based on one or more data selection parameters. (VPRINT=0 prints all selected records in vertical formatted mode.)

ALL

Specifies to print all selected records in vertical formatted mode

FIELDS

Specify the field numbers you want to include in the vertical formatted mode print. See FIELDS.

Example VPRINT output is shown in VPRINT Request.

Example:

$$DD01 COPY VPRINT=15,MAP=SMFA,FIELDS=(1,2,3)

This example copies the input dataset while printing the first three fields of the first 15 records, formatted according to the record layout in the SMFA member in DD01RL DD.

Important

Installations using alternate copy libraries, such as LIBRARIAN and PANVALET, and installations using Hiragana, Katakana, or Kanji character sets are supported only when the appropriate File-AID/Batch configuration parameters are set as described in the File-AID Advanced Configuration Guide.
The VPRINT function does not list redefinitions.
File-AID only allows for one OCCURS DEPENDING ON (ODO) in the record layout and it must be the last item in the record layout. Otherwise, File-AID would not be able to produce column headings appropriate for every record.

WRITE (W)

The WRITE parameter is used only with the USER function. All parameters associated with a WRITE must precede the WRITE parameter. The WRITE parameter can be used as often and in as many places on a control card as required. However, File-AID limits you to 250 WRITE parameters per single selection parameter group. See Parameter Processing Logic. If you need more than 250 WRITE parameters, repeat the selection parameters (IF, ORIF) before the next set of WRITE parameters.

The WRITE parameter can create a data set of any access method and any record structure. A maximum of eight output data sets can be created on a single WRITE parameter execution, unless a MAXOUT parameter is entered on the control card to override this number.

The WRITE parameter has two syntax forms:

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

anyname

User-defined name that matches the DD name in the JCL of the desired output dataset.

The first form of the WRITE command is used when only one output dataset is to receive a record. The second form is used to write to multiple data sets or multiple writes to a single data set. If the same anyname is coded twice in the second syntax form, two identical records are written to the //anyname DD data set. This is not considered an error.

The DD names DDxxM, DDxxRL, DDxxSC, DDxxXR, FAPRINT, FAUDCTL, FAUDWKF, SYSLIST, SYSPRINT, and SYSTOTAL are reserved for use by File-AID. Do not use for ANYNAME.

Important

Unless the input file is a PDS or PDSE, Compuware recommends not writing to the input file because the possibility exists of writing to a portion of the file before that portion is read.

Example:

//OUTFILE DD DSN=XX.XXX
//NEWFILE DD DSN=YY.YYY
    .
    .
    .

WRITE=(NEWFILE,OUTFILE)

This example writes a record to both output files.

ZERO

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

ZERO=[ON/OFF]

ZERO=ON prints numeric fields with leading zeros.

OFF

ZERO=OFF prints numeric fields without leading zeros.

Example:

$$DD01 VPRINT FILLER=ON,ZERO=ON

This example prints records in vertical formatted mode, including FILLER fields and leading zeros for numeric fields.