MF Reference Summary
MF Reference Summary
Reference Summary
Release 9.3
ii File-AID/MVS Reference Summary
http://frontline.compuware.com/
This document and the product referenced in it are subject to the following legends:
This product contains confidential information and trade secrets of Compuware Corporation.
Use, disclosure, or reproduction is prohibited without the prior express written permission of
Compuware Corporation. Access is limited to authorized users. Use of this product is subject
to the terms and conditions of the user’s License Agreement with Compuware Corporation.
IBM, MVS, z/OS, and RACF are trademarks or registered trademarks of International Business
Machines Corporation.
Adobe ® Reader® is a trademark of Adobe Systems Incorporated in the United States and/or
other countries.
All other company and product names are trademarks or registered trademarks of their
respective owners.
Doc. CWFAQX9D
November 30, 2010
iii
Contents
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Notation Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Reading the Syntax Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
File-AID Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Recursive Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Catalog Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
File-AID Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
JCL Specification Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Member List Processing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Primary Command Availability Browse and Edit . . . . . . . . . . . . . . . . . 13
Primary Command Availability Windowed Edit. . . . . . . . . . . . . . . . . . 16
Primary Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Line Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
File-AID/Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Control Cards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Sample JCL Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Function/Parameter Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Function Modifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Parameter Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
iv File-AID/MVS Reference Summary
1
Introduction
File-AID Reference Summary is an overview of File-AID’s functions and summarizes
information such as pattern name notation, primary and line commands, and
batch parameters. For more information, refer to the File-AID/MVS Online
Reference Manual, or the File-AID/MVS Batch Reference Manual and the product’s
online help.
Notation Rules
A parameter is either a keyword or a variable. All keywords are shown in
UPPERCASE characters and must be spelled exactly as shown. You cannot
substitute another value. All variables are user-specified values and are printed in
lowercase italics. For example, dataset-name indicates you are to substitute a value.
COMMAND parameter
Read the diagrams from left to right and from top to bottom. These symbols help
you follow the path of the syntax:
COMMAND REQUIRED-KEYWORD
2 File-AID/MVS Reference Summary
Optional parameters appear below the main path. Default parameters that appear
above the main path are optional; including or excluding them in the command
has the same effect on the execution.
DEFAULT KEYWORD
COMMAND REQUIRED KEYWORD
optional-var
default-var1
COMMAND KEYWORD1
KEYWORD2 optional-var1 var1
optional-var2 var2
3
File-AID Options
This section lists the options available for each File-AID function and
summarizes the parameters used with these functions. For detailed information,
refer to the File-AID/MVS Online Reference Manual. File-AID uses the same
selection values for its functions as ISPF/PDF.
0 — PARAMETERS
0.0 ISPF parameters and File-AID PF keys
0.1 File-AID system parameters
0.2 Selection criteria default parameters
0.3 Print default parameters
0.4 Processing option default parameters
0.5 Audit file allocation parameters
0.6 Hierarchical File System Options
1 — BROWSE
2 — EDIT
3 — UTILITIES
3.1 Library Utility
A Map CSECTs in address order
E Edit member of non-load library
N Map CSECTs in name order
I Display directory entry of member
blank Display member list
B Browse member
D Delete member
R Rename member
3.2 Dataset Utility
A Allocate SEQ/PDS dataset, including SMS dataset
B Allocate BDAM dataset
C Catalog dataset
G Define generation data group
D Delete dataset
R Rename dataset
U Uncatalog dataset
4 File-AID/MVS Reference Summary
5 — PRINT
5.1 Print the contents of a data file
5.2 Print the contents of a record layout XREF member
5.3 Print the contents of a selection criteria member
5.4 Print a record layout in formatted mode
5.5 Print the contents of an audit trail file
6 — SELECTION
7 — XREF
8 — VIEW
9 — REFORMAT
blank Create a new or change an existing reformat definition
D Dynamically create and execute a temporary reformat definition
E Execute a previously saved reformat definition
10 — COMPARE
Compare file contents.
F Formatted mode
J JCL mode
L Load Library mode
S Source Code mode
U Unformatted mode
C — CHANGES
Display a summary of File-AID changes.
T — TUTORIAL
Display information about File-AID.
X — EXIT
Terminate File-AID.
6 File-AID/MVS Reference Summary
Recursive Commands
Online File-AID provides productivity commands that let you recursively invoke
all File-AID functions. While in any File-AID screen, you can enter a recursive
command on the COMMAND line. File-AID suspends the current display and
immediately presents the requested function panel. When you exit the function
panel, you are returned to the suspended display.
Table 1 summarizes the File-AID recursive commands. The optional dataset-name
can be an unqualified dataset name without quotes, or a fully qualified dataset
name with single quotes.
Table 1. Recursive Commands
Command Description Optional Parameter
BR, IB Browse (ISPF/PDF)
ED, IE Edit (ISPF/PDF)
F0 0 File-AID Parameters
FB, F1 1 Browse dataset-name
FE, F2 2 Edit dataset-name
F3 3 Extended Utilities Menu
F31 3.1 Library Utility dataset-name
F32 3.2 Dataset Utility dataset-name
F33 3.3 Copy Utility dataset-name
F34 3.4 Catalog Utility
F35 3.5 VSAM Utility dataset-name
F36 3.6 Search/Update Utility dataset-name
F37 3.7 VTOC Utility
F38 3.8 Interactive Utility dataset-name
F39 3.9 Batch Submit Utility
F5 5 Print Menu
F51 5.1 Print Data File dataset-name
F52 5.2 Print Record/Layout XREF
F53 5.3 Print Selection Criteria
F54 5.4 Print Record Layout
F55 5.5 Print Audit Trail
F6 6 Selection
F7 7 XREF
F8 8 View
F9 9 Reformat
F10 10 Compare dataset-name
FALISTA LISTALC ALL Command
7
In this example, File-AID lists all the datasets that have a first-level qualifier of
USERID1, a second-level qualifier of TEST, and one or more subsequent qualifiers.
The first-level qualifier of the pattern dataset name must be an explicit qualifier
with no pattern characters. If you leave the Search name field blank in File-AID’s
Catalog Utility (Option 3.4) Search name field, File-AID lists all datasets
beginning with your user ID plus any VSAM clusters conforming to the default
naming convention, as described in “Unqualified Dataset Names” on page 8.
File-AID’s VTOC utility (Option 3.7) allows pattern characters at any level,
including the first level, within the pattern dataset name for the Search name
field.
Valid pattern characters for pattern dataset names include: * (asterisk), / (slash),
+ (plus), ? (question mark), and % (percent sign).
• The * (asterisk) pattern character is a qualifier-name wildcard. It represents
any single-level qualifier, or partial-level qualifier when preceded by 1 to 7
explicit characters. When used as the last character it represents one or more
remaining qualifiers.
• The ? (question mark) and the % (percent sign) pattern characters are both
single-character wildcards. Either character represents a single character in
the specified position of the qualifier. You can use a single-character qualifier
up to 8 times within a qualifier, but a character must exist in that position.
• The / (slash) pattern character specifies the number of levels in the dataset
name. Dataset names with more levels than those specified in the pattern
dataset name are not listed. The / must be the last element in the pattern
dataset name.
• The + (plus) pattern character tells File-AID to ignore any intermediate-level
qualifiers. Use the + after the high-level qualifier and before the lowest-level
qualifier to have File-AID ignore any intermediate qualifiers. In effect, it
matches zero or more qualifiers in the name. In only the VTOC utility (3.7),
the + (plus) may be used as the high-level qualifier in a search name.
10 File-AID/MVS Reference Summary
• You can use only one + per name. The portion of the name before the +
represents a pattern for the high-level qualifier(s) of the dataset name; the
portion after the + represents a pattern for the low-level qualifier(s). When
the + is used, only dataset names that begin and end exactly as the pattern
does are displayed.
• You cannot use both the / and the + in the same pattern dataset name. The +
implies a / at the end of the pattern dataset name.
Primary commands enable you to sort by filename or referenced date and locate
an entry by filename. Line commands allow you to select a file for processing,
lock, unlock, and delete entries from the list, display the complete HFS path
name, and display related dataset information. The related dataset information
includes the Record Layout/XREF and Selection Criteria files that you associated
with the referenced files.
If you specify a pathname for an HFS file that does not exist on the Edit
Dataset Specification or Copy Dataset Specification screen (with a disposition
of NEW), File-AID creates and opens the new HFS file with the following
permissions:
• Read, Write and Search or Execute for the file owner
• Read and Search or Execute for the file group
• Read and Search or Execute for all others.
Catalog Names
You can specify a catalog dataset name on some File-AID screens. The specified
value is always considered to be a qualified name, whether or not the name is
enclosed within single quotes ( ’ ’ ).
File-AID Commands
This section summarizes the primary and line commands available in File-AID.
For detailed information, refer to the File-AID/MVS Online Reference Manual.
CANCEL : The CANCEL command cancels the function and returns to the
original screen.
CANCEL
JCL : The JCL command displays the Generated JCL Edit screen with the Job
Control Language that File-AID generates to process the function. This
enables you to edit the JCL.
JCL
12 File-AID/MVS Reference Summary
SUBMIT
SUB
CANCEL
LOCATE string
L
RESET : The RESET command reconstructs the current display with the entire
member list, negating any processing or selection options, condense
operations, and exclude line commands that have been specified.
RESET
SELECT : The SELECT command selects the specified member name for
processing.
SELECT member-name
S
13
SORT : The SORT command sorts the member list. Any column header on the
member list display is a valid keyword parameter for SORT. In the Library
utility, the SORT command is valid for non-load libraries.
NAME
SORT
VV
CRE
CHA
SIZE
INIT
MOD
ID
Selection Criteria
matted Browse
Formatted Edit
(2) Formatted Edit
(2) Character Edit
(1) Unformatted
(2) Unformatted
(1) Vertical For-
(1) Formatted
(6) Formatted
(7) Formatted
(1) Character
(2) Vertical
Browse
Browse
Browse
XREFs
Edit
Command
ADD X
ALIGN X X X X
ARRAY X X X X
AUTOSAVE X X X X
BACK X X X X X X X X X X
BOUNDS X X
CANCEL X X X X X X
CAPS X X X X X X
CHANGE X X X X
CHAR X X X X X X
CHG X
COLS X X X
COMPILE X X X X
COMPLEX X X X X
COPY X X
CREATE X X
CUT X X
DELETE X X X X X X
DISPLAY X X X X X X
14 File-AID/MVS Reference Summary
Selection Criteria
matted Browse
Formatted Edit
(2) Formatted Edit
(2) Character Edit
(1) Unformatted
(2) Unformatted
(1) Vertical For-
(1) Formatted
(6) Formatted
(7) Formatted
(1) Character
(2) Vertical
Browse
Browse
Browse
XREFs
Edit
Command
DISPLAY MAXREFER X
DISPLAY REDEF X X X X
DOWN X X X X X X X X X X
END X X X X X X X X X X
EXCLUDE X X X X X X X X
FBROWSE X X X X X X X X X X
FEDIT X X X X X X X X X X
FILLER X X X X X X
FIND X X X X X X X X
FLIP X X X X X X X X
FMT X X X X X X
FORWARD X X X X X X X X X X
FPRINT X X
GLOBAL X
GO X X X X X X X X
GROUP X X X X
HEX X X X X X X
HIDE X X X X
HOLD X X X X
INFO X X X X
INIT X
INPUT X X X X
INSERT X X X X
INVALIDCHAR X X
KEY X X X X X X X X
LEFT X X X X X X X X X X
LEVEL X
LISTALC X X X X X X X X
LOCATE X X X X X X X X X X
LR X X X X X
MAP X X X X X X
MERGE X X
MESSAGE X X X X X X X X X X
NEXT X X
OCCURS X X X X
OFFSET X X X X X X
OPT X
OVERLAY X X
PAD X X
PASTE X X
15
Selection Criteria
matted Browse
Formatted Edit
(2) Formatted Edit
(2) Character Edit
(1) Unformatted
(2) Unformatted
(1) Vertical For-
(1) Formatted
(6) Formatted
(7) Formatted
(1) Character
(2) Vertical
Browse
Browse
Browse
XREFs
Edit
Command
PICTURE X X
PRESERVE X X X X
PREV X X
PROFILE X X X X X X X X
PROTECT X X
RBA* X X X X X X X X
RCHANGE X X X X
REBUILD X
RECORD X
REDEFINES X X X X X X
REFLNG X X X X
REMOVE X
REPEAT X X X X
REPLACE X X
RESET X X X X X X X X X X
RETURN X X X X X X X X X X
RFIND X X X X X X X X
RIGHT X X X X X X X X X X
RLOC X X X X
SAVE X X X X X
SELECT X
SETUNDO X X X X
SHOW X X X X X X
SORT X X X X X X X X
STATS X
SUBMIT X X
SYNC X X X X
TOP X X X
UNDO X X X X
UNFMT X X X X X X X
UP X X X X X X X X X X
USE X X X X X X
VERSION X
VFMT X X X X X X
VIEW X X
VPRINT X X
XMLGEN X X
ZERO X X X X X X
* Valid only for ESDS files.
16 File-AID/MVS Reference Summary
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
ADD X
ALIGN X
ARRAY X
AUTOSAVE X X X X
BACK X X X X
BOUNDS X X
CANCEL X X X X
CAPS X X X X
CHANGE X X X X
CHAR X X X
COMPILE X X
COMPLEX X
DELETE X X
DISPLAY X X
DISPLAY REDEF X X
DOWN X X X X
END X X X X
FBROWSE X X X X
FEDIT X X X X
FILLER X X
FIND X X X X
FMT X X X
FORWARD X X X X
FPRINT X
GROUP X
HEX X X X
INFO X X
INIT
INPUT X X
17
Table 3. Windowed Edit Primary Command Availability - VSAM / IAM Files (Continued)
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
INSERT X X
INVALIDCHAR X
KEY X X X X
LEFT X X X X
LISTALC X X X X
LOCATE X X X X
LR X
MAP X X X
MESSAGE X X
NEXT X
OCCURS X
OFFSET X X
OVERLAY
PICTURE X X
PRESERVE X X X X
PREV X
PROFILE X X X
RCHANGE X X X X
REDEFINES X X
REFLNG X
REMOVE X
REPEAT X X
REPLACE
RESET X X X X
RETURN X X X X
RFIND X X X X
RIGHT X X X X
RLOC X X X
SAVE X X X X
SHOW X X
SYNC X
TOP X
UNDO X X X X
UNFMT X X X
18 File-AID/MVS Reference Summary
Table 3. Windowed Edit Primary Command Availability - VSAM / IAM Files (Continued)
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
UP X X X X
USE X X
VFMT X X X
VPRINT X
ZERO X X
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
ADD
ALIGN X
ARRAY X
AUTOSAVE X X X X
BACK X X X X
BOUNDS X X
CANCEL X X X X
CAPS X X X X
CHANGE X X X X
CHAR X X X
COMPILE X X
COMPLEX X
DELETE
DISPLAY X X
DISPLAY REDEF X X
DOWN X X X X
END X X X X
FBROWSE X X X X
FEDIT X X X X
FILLER X X
FIND X X X X
FMT X X X
19
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
FORWARD X X X X
FPRINT X
GROUP X
HEX X X X
INFO X X
INIT
INPUT
INSERT
INVALIDCHAR X
KEY
LEFT X X X X
LISTALC X X X X
LOCATE X X X X
LR X
MAP X X X
MESSAGE X X
NEXT X
OCCURS X
OFFSET X X
OVERLAY
PICTURE X X
PRESERVE X X X
PREV X
PROFILE X X X
RBA* X X X X
RCHANGE X X X X
REDEFINES X X
REFLNG X
REMOVE
REPEAT
REPLACE
RESET X X X X
RETURN X X X X
RFIND X X X X
20 File-AID/MVS Reference Summary
Formatted
Formatted
formatted
Character
Vertical
Command
Un-
RIGHT X X X X
RLOC X X
SAVE X X X X
SHOW X X
SYNC X
TOP X
UNDO X X X X
UNFMT X X X
UP X X X X
USE X X
VFMT X X X
VPRINT X
ZERO X X
Primary Commands
Primary commands are entered in the COMMAND field.
HERE
ADD
record-layout AFTER
HERE : Specifies that the new segment is to be inserted prior to the currently
displayed segment.
AFTER : Specifies that the new segment is to be inserted after the current
segment.
ON
ALIGN
AL OFF
21
ON
ARRAY
AR OFF
ALL
ANY
EVERY
ALL : Displays all occurrences separately with the subscript(s) and any
criteria entered on a specific occurrence will only be applied to that
occurrence.
ANY : Displays a single entry for the occurrences and any criteria entered for
the ANY occurrence will be applied to all occurrences. The record will
meet the Selection Criteria if any of the occurrences meet the specified
criteria. ANY is applied for initial display of Selection Criteria.
EVERY : Displays a single entry for the occurrences and any criteria entered
for the EVERY occurrence will be applied to all occurrences. The record
will meet the Selection Criteria if all of the occurrences meet the
specified criteria.
AUTOSAVE : Controls whether a modified dataset is saved when the user exits.
ON
AUTOSAVE
OFF
BACK : Scrolls display to the previous record in formatted mode. Scrolls the
display up in character or vertical formatted mode.
BACK
scroll-number
M
M (maximum) : Scrolls the display to the first (selected) record of the file.
22 File-AID/MVS Reference Summary
BOUNDS
BNDS left-column right-column
BND
CANCEL : Exits from current display mode and ignores all changes made to the
dataset since the last SAVE command.
CANCEL
CAN
ON
CAPS
OFF
CHANGE : Changes data that meets specified conditions. When you enter the
CHANGE command without parameters, File-AID displays the CHANGE
Command screen. The screen field names are shown in parentheses next to
their corresponding parameter terms.
NEXT
PREV col1
FIRST col2
LAST / field-name
ALL / field-number
rel (Operator) : Relational operator that specifies the relationship the edit
data must have to the val1 parameter in order to be changed. Valid
entries for this parameter are:
EQ: Matches any string equal to val1 (default)
NE: Matches any string not equal to val1
23
* (asterisk) : Enter an asterisk (*) in place of the val1 parameter to reuse the
last value specified in a CHANGE, EXCLUDE, or FIND command.
val2 (To string) : Specifies the new value to be substituted for data matching
the condition specified by the rel and val1 parameters. Data item length
described by val2 and val1 must be the same.
* (asterisk) : Value for the val2 parameter that specifies File-AID to reuse the
last value entered in a CHANGE command.
If a single line label or line number is specified (or the same line is
specified twice), File-AID limits the search to the specified line.
col1, col2 (Start column, End column) : Specifies a valid single column
(col1) or column range (col1 and col2). File-AID defaults to the current
bounds settings if col1 and col2 are not specified. Specify a single
column or column range to override the default column range. Data
specified for a single column must begin at the col1 position. Data
specified for a column range must be found within the specified range.
Specify the col1 and col2 parameters as integers. If the val1 or val2
parameters consist of the numbers 0 (zero) through 9, delimit the value
of the val1 and/or val2 parameter to distinguish it from column
numbers. Do not use col1 or col2 when the /field-name or /field-number
parameter is used.
CHANGE (CHG or C) : Displays the Data Replace Criteria panel. Only valid
on the Global Selection Criteria panel.
CHANGE
CHG
C
CHAR
COLS
COL
25
COMPILE : Displays the Record Layout Specification screen which allows you
to reload or switch a record layout or XREF.
COMPILE
ON
COMPLEX
CMPLX OFF
COPY
dataset AFTER line-label
dataset (member) BEFORE line-label
(member)
CREATE : Creates a new member of a PDS. Specify source records with the C or
M line command.
CUT : Creates a temporary copy of a file (or portion of a file) that you are
editing with File-AID/MVS Edit. Use the C or CC (copy) line command to
specify the source of the 'cut'.
CUT
APPEND
26 File-AID/MVS Reference Summary
APPEND (A) : Use the A or APPEND parameter to add to the existing cut
file.
DELETE
DEL lrange ALL X
ALL NX
ALL X : Causes all excluded lines within the specified line range to be
deleted.
ALL NX : Causes all non excluded lines within the specified line range (or
the entire dataset) to be deleted.
ON
DISPLAY field-list
DIS OFF ALL
ONLY
ALL : Selects every field in the record. Enter DISPLAY ALL to display all
fields. Enter DISPLAY OFF ALL to eliminate all fields from the display.
The ALL parameter is mutually exclusive with the field-list parameter.
27
RESET (RES) : Restores the display of each listed field to the format specified
by the record layout. The RESET parameter is mutually exclusive with the
format parameter.
ALL : Selects every field in the current layout. Enter DISPLAY format ALL to
set the format of all fields to the specified format.
DISPLAY REDEF
DIS RED field-number
DOWN : Scrolls the display down. Default is the value in the SCROLL field.
Scroll values include CSR, DATA, HALF, and PAGE.
DOWN
scroll-number
M
M : Scrolls down the maximum amount. The effect of this parameter varies
by mode:
• Character and Vertical Formatted: Scrolls down to show the last
lines of the dataset.
• Formatted: Scrolls down to display the last fields of the record
layout.
END
EXCLUDE : Removes from display items that meet specified conditions. When
you enter the EXCLUDE command without parameters, File-AID displays the
29
NEXT
EXCLUDE val1
EX rel lrange X PREV
E * NX FIRST
X VALID LAST
INVALID ALL
col1
col2
/ field-name
/ field-number
rel (Operator) : Relational operator that specifies the relationship the edit
data must have to the val1 parameter in order to qualify a line for
exclusion. Valid entries for this parameter are:
EQ: Matches any string equal to val1 (default)
NE: Matches any string not equal to val1
LT: Matches any string less than val1
GT: Matches any string greater than val1
LE: Matches any string less than or equal to val1
GE: Matches any string greater than or equal to val1.
The rel parameter may be used with a val1 parameter (or a substitute
asterisk), but not with the parameters VALID and INVALID. When val1 is
a character string, the comparison is executed according to the EBCDIC
collating sequence.
* (asterisk) : Value for the val1 parameter that specifies to reuse the last
value specified in a CHANGE, EXCLUDE, or FIND command.
VALID, INVALID : Excludes valid or invalid data in a specified field. A /field-
name or /field-number parameter is required when VALID or INVALID is
used.
NEXT, PREV, FIRST, LAST, ALL (Modifier) : Use the NEXT, PREV, FIRST, or
LAST values to specify the starting point and search direction.
Use the ALL parameter to exclude all lines that contain the specified data
(within the lines defined by the lrange and X, NX parameters).
col1, col2 (Start column, End column) : Specifies a valid single column
(col1) or column range (col1 and col2). File-AID defaults to the current
bounds settings if col1 and col2 are not specified.
Specify a single column or column range to override the default column
range. Data specified for a single column must begin at the col1 position.
Data specified for a column range must be found within the specified
range.
Specify the col1 and col2 parameters as integers. If the val1 parameter
consists of the numbers 0 (zero) through 9, delimit the value of the val1
parameter to distinguish it from the column values.
FBROWSE
FB dataset name
F1
FEDIT
FE dataset name
F2
ON
FILLER
FILL OFF
FI
FIND : Searches for and displays items that meet specified conditions. When
you enter the FIND command without parameters, File-AID displays the
FIND Command screen. The screen field names are shown in parentheses
next to their corresponding parameter terms.
NEXT
FIND val1
F rel lrange X PREV
* NX FIRST
VALID LAST
INVALID ALL
col1
col2
/ field-name
/ field-number
rel (Operator) : Relational operator that specifies the relationship the data
must have to the val1 parameter in order to be found. Valid entries for
this parameter are:
EQ: Matches any string equal to val1 (default)
32 File-AID/MVS Reference Summary
* (asterisk) : Value for the val1 parameter that specifies File-AID to reuse the
last value specified in a CHANGE, EXCLUDE, or FIND command.
The ALL value searches for all occurrences of the specified data (within
the lines defined by the lrange, X, and NX parameters).
col1, col2 (Start column, End column) : Specifies a valid single column
(col1) or column range (col1 and col2). File-AID defaults to the current
bounds settings if col1 and col2 are not specified. To override the
default, specify either a single column or column range. Data specified
for a single column must begin at the col1 position. Data specified for a
column range must be found within the specified range.
Specify the col1 and col2 parameters as integers. If the val1 parameter
consists of the numbers 0 (zero) through 9, delimit the value of the val1
parameter to distinguish it from the column values. Do not use col1 or
col2 when the /field-name or /field-number parameter is used.
FLIP : Reverses the exclude status of all the records in the file.
FLIP
FMT
FMT
F
2
FORWARD : Scrolls the display to the next record in formatted mode. Scrolls
the display down in character or vertical formatted mode.
FORWARD
FWD scroll-number
M
M (maximum) : Scrolls the display to the last (selected) record of the file.
FPRINT : Prints one or more records in formatted mode, presenting the data
according to a COBOL or PL/I record layout. Use the DISPLAY primary
command to tailor the current display of fields.
FPRINT
FP number
ALL
ALL : Prints the current record and all subsequent records in the file.
GLOBAL (GBL) : Displays the GLOBAL Selection Criteria panel listing all
defined variables. Only valid on the formatted Selection Criteria panel.
GLOBAL
GBL
GO : The GO command switches your session into Browse (from Edit) or Edit
(from Browse) while retaining your current record and cursor position.
However, when using the GO command in a segmented record while positioned
in a segment, the record will be re-positioned to the BASE.
GO
BROWSE
EDIT
ON
GROUP
G OFF
ON
HEX
OFF
HIDE
field-number
field-number-range
ALL
ALL : Hides all fields and displays the HIDE and HOLD Settings pop-up.
HOLD : Specifies the ORDER of data items to HOLD on the screen while
scrolling in Formatted and Vertical Format modes.
HOLD
field-number
field-number-range
INFO
INIT : Initializes and displays all fields of the current record, according to the
specified record layout. Each field is initialized to a null value appropriate to
the field format.
INIT
record-layout
36 File-AID/MVS Reference Summary
record-layout : Specifies the record layout with which you want File-AID to
initialize and display the current record.
Do not specify the record-layout parameter while a segmented record is
being edited, unless the base (first) segment is being displayed. If the
base segment is displayed, the record is initialized to contain a single
segment of the specified type and any other segments are eliminated
from the record.
Specifying the record-layout parameter while a segment other than the
base segment is displayed produces the error message CANNOT USE
NAME and prevents initialization.
INPUT
INSERT record-layout
I
After
INPUT
INSERT AND Before
I
After : Inserts a set or subset after (default) the current criteria set or subset.
Before : Inserts a set or subset before the current criteria set or subset.
ON
INVALIDCHAR
INVCHAR OFF
IVC
37
KEY : Scrolls to the record with the specified key (VSAM-KSDS only). If you omit
the key-value, File-AID displays the Key Specification screen.
KEY NEXT
K key-value
'key-value'
"key-value"
X'key-value'
C'key-value'
C"key-value"
F'key-value'
H'key-value'
key value : Scrolls to the record with the specified key value. Use the
following prefixes to distinguish the key value format:
X - Hex
C - Character (Case-sensitive)
F - Fullword (4 bytes).
H - Halfword (2 bytes).
NEXT : Retrieves the first record with a key greater than or equal to the key-
value parameter.
LEFT : Scrolls the display to the left in character and vertical formatted modes
and to the previous record in formatted mode. In character and vertical
formatted modes, the default is the value in the SCROLL field. Scroll values
include CSR, DATA, HALF, and PAGE.
LEFT
scroll-number
M
LEVEL number
LEV
38 File-AID/MVS Reference Summary
LISTALC
ALL
ALL : Modifies the Current DDNAME Allocation List to include all datasets
allocated to your user ID.
LOCATE line-label
LOC line-number
L
line-label : Searches for a specific line label. If the line label is found, File-
AID positions that line at the top of the display. The remainder of the
screen is filled, depending on the current display mode. Valid entries are
a user-defined label and the File-AID-defined labels SEQ, DUP, ERR, and
NEW.
NEXT
LOCATE line-type
LOC PREV lrange
L FIRST
LAST
NEXT, PREV, FIRST, LAST : Specifies the starting point and direction of a
line search.
line-type : Searches for a specific type of line. If found, positions the line at
the top of the display. This parameter is required.
Valid entries for line-type are: CHANGE (CHG), COMMAND
(COM,CMD), DUPKEY (DUP), ERROR (ERR), EXCLUDED (X), LABEL
(LAB), NEW, SEQERR (SEQ), and SPECIAL (SPE).
lrange : Confines the search to a specified range of lines (records). For the
line range limits, use any combination of user-defined labels, system
labels, or valid line numbers, prefixed by a period.
39
NEXT
LOCATE field-name
LOC field-number PREV
L * FIRST
LAST
NEXT, PREV, FIRST, LAST : Specifies the starting point and direction of a
field search.
LR record-number
label
NEXT
LABEL
LAB PREV
FIRST
LAST
record-number : Specifies the record to which you want to scroll. You can
enter a record number of up to 10 digits. If you enter a value that exceeds
the number of records in the file, File-AID displays the last record in the
file.
label : Specifies the label to which you want to scroll. In character and
vertical formatted modes, assign a label by scrolling to any line and
entering a label in the sequence number field. In formatted mode, assign
a label by entering the label on the command line. The label is a period
followed by up to five characters.
NEXT, PREV, FIRST, LAST : Use the NEXT, PREV, FIRST, or LAST values to
locate the next, previous, first, or last occurrence of a labeled record.
MAP
40 File-AID/MVS Reference Summary
MERGE : Imports records from another dataset and inserts them in the correct
key order.
MERGE
dataset
dataset : Specifies the name of the dataset to use as a source of new records.
Entering the MERGE command while editing a nonkeyed dataset
produces the message COMMAND NOT SUPPORTED. The command is
ignored.
MESSAGE : Controls the display of the mode prompt message line available at
the bottom of the browse and edit screens.
ON
MESSAGE
MSG OFF
NEXT : Relocates the display to the segment after the currently displayed
segment in the same record.
NEXT
n record-layout
n : Specifies the number of segments to advance the display. The default for
the n parameter is 1 (advance one segment).
record-layout : Specifies that a segment matching the XREF criteria for the
specified record layout is to be displayed. If the specified record layout
does not match the name of a currently loaded record layout, the
message RECORD LAYOUT NOT FOUND is displayed.
ON
OCCURS
OCC OFF
ALL
ANY
EVERY
ALL : Displays all occurrences separately with the subscript(s) and any
criteria entered on a specific occurrence will only be applied to that
occurrence.
ANY : Displays a single entry for the occurrences and any criteria entered for
the ANY occurrence will be applied to all occurrences. The record will
meet the Selection Criteria if any of the occurrences meet the specified
criteria. ANY is applied for initial display of Selection Criteria.
EVERY : Displays a single entry for the occurrences and any criteria entered
for the EVERY occurrence will be applied to all occurrences. The record
will meet the Selection Criteria if all of the occurrences meet the
specified criteria.
OFFSET : Use the SHOW OFFSET command to display the field offsets. Then use
the OFFSET primary command to set the format for the display of field offset
information.
OFFSET
OFST COLUMNS
HEX
RELATIVE
COLUMNS (COL, C) : Lists the column in which each data field begins,
starting in record column 1. Changes the field description heading to
COLUMNS. The offset of the first field is displayed as 1, and the offsets
of all fields that follow are also greater by 1 than the offsets displayed
when the OFFSET option is set to REL(HEX).
HEX (H, X) : Displays the offset of each field from the beginning of the
record in hexadecimal form. Changes the field description heading to
REL(HEX).
RELATIVE (REL, R) : Displays the offset of each field from the beginning of
the record. Changes the field description heading to RELATIVE. The
offset of the first field is zero.
OPT : In Selection Criteria (Option 6), displays the Selection Criteria Options
screen.
OPT
O
1
OVERLAY
OVLY CLEAR col1 col2
PAD char
X'nn'
char : Specifies a new value for the pad character. If the new value is a blank
or a comma, it must be enclosed in apostrophes (').
X'nn' : Sets the pad character to a nondisplayable value, where nn is two
hexadecimal digits enclosed in apostrophes (').
PAIR : The PAIR command scrolls the top and bottom portions of the panel to
the same associated field. Type PAIR in the COMMAND line and position the
cursor on the associated field you want to locate, then press ENTER. Both the
top and bottom portions of the panel position to the field where the cursor is
positioned.The command is only available in the “Compare - Associate Field
Names” panel in Formatted Compare mode.
PASTE : Copies the “CUT file” sequentially into the current File-AID Edit file.
Specify the destination with the A (after), B (before), or H (here) line
command or the AFTER <label> or BEFORE <label> parameter. When the
Edit file is empty, you do not need to enter the destination.
PASTE
AFTER label
BEFORE label
AFTER/BEFORE label : Paste the cut file after or before a specific user-
defined line label (.label).
PICTURE : Controls the display of the PICTURE or DISPLAY line for numeric
data.
ON
PICTURE
PICT OFF
PIC
ON
PRESERVE
OFF
PREV
43
PROFILE : Displays profile information lines. Use the RESET primary command
to delete the profile information lines from the display.
PROFILE
PROF line-count
PR
PROTECT : Sets the protection of key fields for the currently displayed segment
or record to prevent the fields from being modified.
ON
PROTECT
PROT OFF
P
RBA : Locates a relative byte/block address (RBA) value in Browse and Edit
functions for ESDS files. It positions the display to a specific record within a
VSAM-ESDS file based on the record's RBA.
RBA n
RCHANGE
REBUILD
RECORD (REC) : Closes the Global Selection Criteria panel and returns to the
Formatted Selection Criteria panel. Only valid on the Global Selection
Criteria panel.
RECORD
REC
ON
REDEFINES
REDEF OFF
RED
44 File-AID/MVS Reference Summary
ON
REFLNG
REF OFF
REMOVE
REM
REPEAT : Inserts one or more copies of a record immediately after the record.
REPEAT
REP n
R
REPEAT
REP AND
R
AND : Inserts a copy of the current set or subset of selection criteria after the
current set or subset as an ANDed subset. The criteria set number is NOT
incremented but the subset number is (AND SET 3.3 of 4).
REPLACE dataset
dataset (member)
(member)
RESET
RES lrange line-type
RETURN
RFIND
RIGHT : Scrolls the display to the right in character and vertical formatted
modes, and to the next record in formatted mode. In character and vertical
formatted modes, the default is the value in the SCROLL field. Scroll values
include CSR, DATA, HALF, and PAGE.
RIGHT
scroll-number
M
RLOC
46 File-AID/MVS Reference Summary
SAVE
SELECT (SEL) : Closes the Data Replace Criteria panel and returns to the
Global Selection Criteria panel. Only valid on the Data Replace Criteria
panel.
SELECT
SEL
SETUNDO
SETU ON
OFF
SHOW
S LEVEL
NUMBER
LEVEL (L) : Displays the record’s hierarchical level number at the left of
each data item name, and changes the heading of the Field Name area to
FIELD LEVEL/NAME. File-AID indents each successive level two character
positions to emphasize the record structure. When this parameter is
used, the Field Name area closely resembles the original (source) record
layout declaration.
NUMBER (N) : Displays the field numbers assigned by File-AID, and changes
the heading of the Field Name area to FIELD NUMBER/NAME. Field
numbers are assigned sequentially, beginning at the top of the record
layout. Each elementary or group data item name is assigned a unique
field number. Each occurrence of a data item that has multiple
occurrences is assigned the same field number, since all occurrences
share the same data name.
Field Description Syntax:
FORMAT
SHOW
S OFFSET
PICTURE
47
FORMAT (F) : Displays field length and current field format, separated by a
slash (/), and changes the heading of the Field Description area to
FORMAT. The field length is expressed in bytes.
OFFSET (O) : Displays the offset of each field from the beginning of the
record. The offset can be expressed in three ways: relative, hexadecimal,
or columns. Specify the offset format with the OFFSET command.
SORT
lrange X sort-field
NX
KEY D
col1 col2
/ field-name
/ field-number
sort-field : Specifies from one to five sort fields. If no sort-field parameters are
specified, the data within the edit bounds is used and the data is sorted
in ascending sequence.
KEY: Used as one of the five sort fields when editing a keyed dataset,
RRDS or BDAM dataset. Specifying KEY is equivalent to specifying
the two-column numbers delimiting the record key. The letters A or
D may not be used to define the sorting sequence with KEY because
the sort is always in ascending sequence. RRDS and BDAM records
are sorted in RRN (or RBN for BDAM) order.
If other sort-field parameters are specified along with KEY, they
cannot overlap the key field. The remaining sort-field parameters
may also be modified by the A or D parameters.
col1, col2: Specifies column numbers for each sort-field parameter.
The two column numbers must be listed together; the second
48 File-AID/MVS Reference Summary
ON
STATS
OFF
SUBMIT : Submits the file you are browsing or editing as a batch job for
backgroundprocessing. SUBMIT is valid in Character mode only.
SUBMIT
SUB
SYNC : Controls the display of the SYNC term for fields in a COBOL record
layout.
ON
SYNC
AL OFF
TOP
UNDO : Restores the dataset to its condition prior to the last accepted change
entry. Valid in the Edit function in all modes and the Field-to-Field Selection
Criteria screen.
UNDO
49
UNFMT
UNFMT
U
3
UP : Scrolls the display up. Default is the value in the SCROLL field. Scroll
values include CSR, DATA, HALF, and PAGE.
UP
scroll-number
M
USE : Formats a record or specifies another record layout for the current record.
USE
offset record-layout
NEXT *
PREV
offset : Specifies either a column (absolute) offset from the beginning of the
record, or an offset relative to the currently displayed position in the
record. You must preface a relative offset number with a plus or minus
sign (+ or -). If you do not specify an offset, the position of the currently
displayed record is used.
NEXT : Directs File-AID to use the offset of the position immediately after
the current segment, that is, the end of the currently selected record
layout.
PREV : Specifies that File-AID is to display the previous segment. Using this
parameter is subject to the same restrictions as those for the PREV
command.
Note: The parameters offset, NEXT, and PREV are not valid in VFMT mode.
50 File-AID/MVS Reference Summary
VERSION number
VERS
VER
number : Specifies the PDS version number when a PDS member is edited.
VFMT
VIEW : In the Selection Criteria function (Option 6), VIEW displays a screen
summarizing the specified options and all the sets of formatted and
unformatted selection criteria in a scrollable display. In the XREF function
(Option 7), VIEW is valid on the Define XREF screen and displays the entire
XREF in a scrollable display.
In Option 3.5 (VSAM utility), the VIEW command displays IDCAMS
messages generated by the IDCAMS utility.
VIEW
VPRINT : Prints one or more records in vertical formatted mode, presenting the
data according to a COBOL or PL/I record layout. Use the DISPLAY primary
command or the FIELDS parameter to tailor the current display of fields.
VPRINT
VP TRUNC number FIELDS field-list
NOTRUNC ALL
TRUNC : It TRUNC processes the VPRINT request online and truncates each
print line if the vertically formatted record exceeds the print width. The
default is set in Option 0.3 with the “Truncate for VPRINT cmd”
parameter. This is the standard form that has been part of the product
prior to Release 9.0. Unless you have pre-allocated a print dataset
VPRINT TRUNC continues with the “Print Parameters Screen” Screen
where you specify more output options.
ALL : Prints the current record and all subsequent records in the file.
number : For VPRINT TRUNC, specifies the number of records to print. The
default is 0 or ALL. 0 (zero) prints the current and all subsequent records
in the file.
For VPRINT NOTRUNC, specifies the number of records to print, starting
with the first record in the file. The default is 0 or ALL. 0 (zero) prints the
first and all subsequent records in the file.
ALL : For VPRINT TRUNC, prints the current record and all subsequent
records in the file. Prior records are not printed.
For VPRINT NOTRUNC, prints all records in the file.
FIELDS field-list : Specifies any combination of field numbers and/or field
number range. Separate each field number specification by a space or 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.
XMLGEN
n
ALL
blank : The current record and all following records are used to generate the
XML document.
ALL : The current record and all following records are used to generate the
XML document.
Notes:
• The XMLGEN command uses the record fields as they are displayed
on the screen (see DISPLAY/HIDE commands to change the display
formats).
• Excluded records and fields are never used when generating the XML
document.
• When the file has segmented records defined with an XREF member,
File-AID internally issues NEXT commands to format each segment
of each record.
52 File-AID/MVS Reference Summary
ON
ZERO
Z OFF
Line Commands
Enter line commands in the sequence number field. They execute after data
modifications have been processed, but before primary commands are executed.
Double characters define a block command. A single character or a block with a
number specifies multiple iterations of the command.
Standard Edit Line Commands
The line commands listed in Table 5 are available in character and vertical
formatted modes of the Edit function:
Table 5. Standard Edit Line Commands
A[ n ] Marks one or more destination(s) after which one or more records is placed.
B[ n ] Marks a destination before which one or more records is placed.
BNDS Displays the column boundary information line.
C[ n ], CC Copies a line or block of records to a marked destination.
CHAR Invokes character mode from vertical formatted mode.
COLS Displays the column number’s information line.
D[ n ], DD Deletes a line or block.
Requests that the first record(s) of an excluded range of lines be unexcluded
F[ n ]
and displayed.
FMT Displays the record in formatted mode.
H[ n ] Marks one or more destinations after which one or more records is placed.
I[ n ] Inserts one or more records.
Requests that the last record(s) of an excluded range of lines be unexcluded
L[ n ]
and displayed.
M[ n ], MM Moves a line or block to a marked destination.
MAP Displays the record in formatted mode.
MASK Displays the input mask.
O[ n ], OO Marks a destination over which copied or moved data is overlaid.
OVLY Displays the overlay mask information line.
P[ n ], PP Protects a line or block from key modification.
R[ n ], RR[ n ] Repeats a line or block.
Requests that an entire group (range) of excluded records be unexcluded
and displayed.
S Displays the specified record in formatted mode when entered on a line that
is not excluded. Also selects a member from a member list.
In the Compare function, the S line command selects a line for comparison.
53
File-AID/Batch
This section summarizes File-AID/Batch functions and parameters. For detailed
information, refer to the File-AID/MVS Batch Reference Manual.
Control Cards
Control cards determine the process to be performed on the input file. Control
card continuation must begin in column 2. The basic format is:
$$DD xx FUNCTION PARAMETER(S) COMMENT(S)
$$DDxx is the dataset identifier used to connect the control statement to the
input file. Specify the input file in the JCL as //DDxx. xx is a value from 00 to 99.
FUNCTION specifies what is to happen to the input file.
54 File-AID/MVS Reference Summary
Function/Parameter Compatibility
Most parameters can be used with any function, but some are ignored during
certain functions. The following table shows parameter availability by function.
LMODMAPN
LMODMAPA
REFORMAT
VTOCINFO
VTOCMAP
VTOCDSN
COMPARE
LMODDIR
CONVERT
XMLGEN
XRPRINT
SCPRINT
RLPRINT
UPDATE
Parameter APRINT
VPRINT
FPRINT
DUMP
SPACE
PRINT
TALLY
DROP
COPY
USER
LIST
ABEND X X X X X X X X X X X
ACCUM X X X X X X X X X X X
AMODE X X X
AND X X X X X X X X X X X X
AUDIT X X X
CCSID X X X X
CEM X X
CHANGED X X X X X X X X X X X X X X X
CHARSET X X X X X X X X X X X X X
COPTNS X
CREATED X X X X X X X X X X X X X X X
DFLT_WRITE X
DROP X
DSNAME X X
DUMP X X X X X X
EDIT X X X X X X X X X X
EDITALL X X X X X X X X X X
ELSE* X X
ERRS 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 X X X
FIELDS X
FILLER X X
FORM X X X X X X X X X X X
FPRINT X X X X X X
IF X X X X X X X X X X X
IN X X X X X X X X X X X
INVALID X
INVALIDCHAR X
IOEXIT X X X X X X X X X X X X X
KEY X X X X X X X X X X X
KEYINFO X
LANGTYP X X X X X X X X X X X X
LAYOUT X X
LINKDATE X X X
LIST X X X X X X
LPI X X X X X X X X X X X
56 File-AID/MVS Reference Summary
LMODMAPN
LMODMAPA
REFORMAT
VTOCINFO
VTOCMAP
VTOCDSN
COMPARE
LMODDIR
CONVERT
XMLGEN
XRPRINT
SCPRINT
RLPRINT
UPDATE
Parameter
APRINT
VPRINT
FPRINT
DUMP
SPACE
PRINT
TALLY
DROP
COPY
USER
LIST
MAP X X
MAXENT X X X X X X X X X X
MAXOUT X
MBRNAME X X X X X X X X X X X X X X X X X
MEMBER X X X X X X X X X X X X X X X X X X
MEMBERS X X X X X X X X X X X X X X X X X X
MOVE X X X X X X X X X
NEWMEM X X X
NEWMEMS X X X
ORIF X X X X X X X X X X X
OUT X X X X X X X X X X
PADCHAR X X X X X X X X X
PANSTAT X X X X X X X X X X X
PDSSTAT X
PRESERVE X X
PRINT X X 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
READ NEXT * X X
REFOUT X
REPL X X X X X X X X X X
REPLALL X X X X X X X X X X
RLM X X X
RLPRINT X
RMODE X X X
RRN X X X X X X X X X X X
SELECT X X X X X X X X X X X
SHOW X X
STOP X X X X X X X X X X X
TYPE X
TYPRUN X
UNIT X X X
USERID X X X X X X X X X X X X X X
VOLSER X X X
VOLSTAT X X X
VPRINT X X X X X X
WRITE X
ZERO X X X
* This parameter is also compatible with COPYALL, DUMPALL, FPRINTALL, LISTALL,
PRINTALL, UPDATEALL, and VPRINTALL.
57
Functions
APRINT (AP)
Prints the audit trail file in formatted, character, or hexadecimal format. The
audit trail file is created by File-AID online. Must be the last control card. The
input audit trail dataset must be DD01.
COMPARE
Compares the contents of two files. Specify the old dataset in DDxx, the new
dataset in DDxxC, and the compare criteria in DDxxCP. The compare criteria
dataset can be created from File-AID online Option 10 (Compare) or coded in
batch.
CONVERT
Converts existing File-AID Release 6 selection tables and Release 7 XREFs to File-
AID Release 8’s XREF format. It also converts File-AID Release 7.0 saved selection
criteria to File-AID Release 8’s saved selection criteria format. In addition,
CONVERT is used to convert File-AID for IMS and File-AID for DB2 XREFs to the
File-AID/MVS Release 8 XREF format.
COPY (C)
Copies data selectively or nonselectively. Parameters specify selective or limited
copying. Records can be copied as is or modified.
DROP (DR)
Eliminates unwanted records from a dataset while copying it. Parameters specify
records to be dropped.
DUMP (D)
Prints datasets in vertical hexadecimal format. Parameters select records for
printing. Uses the system default limit unless overridden by the OUT parameter.
FPRINT (FP)
Prints one or more records in formatted mode, showing the data according to a
COBOL or PL/I record layout.
LIST (L)
Prints alphanumeric data. Packed, binary, and other unprintable data are shown
as blanks. Uses the system default limit unless overridden by the OUT parameter.
LMODDIR (LMD)
Lists directory entry(ies) of member(s). Optional parameters CHANGED,
CREATED, MBRNAME, MEMBER, and MEMBERS enable you to select specific
members for processing.
LMODMAPA (LMA)
Lists modules (maps CSECTS) in address order. Optional parameters AMODE,
RMODE, and LINKDATE select specific modules based on address or residency
mode and/or link date range. Optional parameters MBRNAME, MEMBER, and
MEMBERS select specific members for processing.
LMODMAPN (LMN)
Lists modules (maps CSECTS) in names order. Optional parameters AMODE,
RMODE, and LINKDATE select specific modules based on address or residency
mode and/or link date range. Optional parameters MBRNAME, MEMBER, and
MEMBERS select specific members for processing.
58 File-AID/MVS Reference Summary
PRINT (P)
Prints alphanumeric data and labels each record with its record number and RBA.
Packed, binary, and other unprintable data are shown as blanks. Parameters
control selective processing and the number of records. Uses the system default
limit unless overridden by the OUT parameter.
REFORMAT (R)
Reformats data as it is being copied. This function requires a reformat definition
created with File-AID’s Reformat utility (Option 9).
RLPRINT (RLP)
Prints a COBOL or PL/I record layout displaying the field level, field name,
format, field number, start location, end location, and field length.
SCPRINT (SCP)
Prints the dataset containing selection criteria created from File-AID online
functions.
SPACE (S)
Moves the current record pointer through the input file. The IN or STOP
parameter limits the function.
TALLY (T)
Allows selection parameters to be combined with ACCUM parameters to provide
audit-type totals for files. If a SYSTOTAL DD statement is not present, the report
appears on the SYSPRINT DD.
UPDATE (UP)
Alters records on a file. Parameters such as EDIT or REPL specify data values to be
changed. Files are updated in place. Runs only on DASD files.
USER (US)
Performs a copy function that provides greater control over the writing of output
records and datasets. USER can insert new records at any point in a dataset,
repeat records with changed data, and write multiple output datasets from a
single input dataset.
VPRINT (VP)
Prints one or more records in vertical formatted mode, showing the data
according to a COBOL or PL/I record layout.
VTOCDSN (VTD)
Displays VTOC summary information and dataset names in alphabetical
sequence. This function is equivalent to File-AID’s online VTOC Utility (3.7)
option BLANK (List VTOC entries in dataset name sequence).
VTOCINFO (VTI)
Displays volume information including volume serial number, device type,
mount status, percentage of volume allocated, VTOC statistics, VTOC index
indicator, and DSCB and free space statistics. This function is equivalent to File-
AID’s online VTOC Utility (3.7) option I (List volume information).
59
VTOCMAP (VTM)
Displays volume and dataset information in address location sequence. This
function is equivalent to File-AID’s online VTOC Utility (3.7) option M (Map
VTOC entries in pack location sequence).
XMLGEN
Creates XML documents from existing files using COBOL or PL/I layout fields as
the tag names.
XRPRINT (XRP)
Prints record layout cross reference (XREF) dataset.
Function Modifiers
ALL (A)
Processes all occurrences of selection criteria and all records on the file.
• COPYALL (CA)
• DUMPALL (DA)
• FPRINTALL (FPA)
• LISTALL (LA)
• PRINTALL (PA)
• UPDATEALL (UA)
• VPRINTALL (VPA)
BACK (B)
Processes sequential or VSAM datasets backwards.
• COPYBACK (CB)
• DUMPBACK (DB)
• FPRINTBACK (FPB)
• LISTBACK (LB)
• PRINTBACK (PB)
• SPACEBACK (SB)
• VPRINTBACK (VPB)
MEMBER (MEM)
Processes a PDS on a member level; if a record meets the selection criteria, the
function is performed on the entire member.
• COPYMEM (CM)
• DUMPMEM (DM)
• FPRINTMEM (FPM)
• LISTMEM (LM)
• PRINTMEM (PM)
• VPRINTMEM (VPM)
60 File-AID/MVS Reference Summary
Parameters
Descriptions and values for parameter elements are given in “Parameter
Elements” on page 71.
ABEND (AB)
Sets end-of-job (EOJ) processing based on abnormal conditions during execution.
AB=[n]
Values for n are:
ACCUM (A)
Accumulates specified fields in the input records.
Character or Binary Data Accumulation Syntax:
A=(location,length,data-type[,'description'])
AND
See “IF (AND, ORIF)” on page 64.
AUDIT (AUD)
Creates an Audit trail dataset and writes before and after images of
changed/unchanged records.
CCSID
Defines the CCSID for Unicode conversion when format-printing the record. The
value of nnnnn must be numeric (0 through 99999) of valid CCSID. Valid only
with the APRINT, FPRINT, VPRINT, and XMLGEN functions
CCSID=nnnnn
CEM
Copies empty members of a partitioned dataset.
CEM={N}
{Y}
CHANGED (CHA)
Selects a group of members from a PDS based on the member’s last modified date.
The from or to-date range is specified in the yy/mm/dd format.
CHA=(from-date,to-date)
(,to-date)
(from-date)
from-date
CHARSET (CHR)
Defines the character set from the code page table to determine which language
set to use. The value of xxxx equals the last four characters of the language code.
CHR=xxxx
COPTNS
Specifies additional options for the condensed Compare reports. This parameter
is valid only for condensed compare. Condensed compare is for Character and
Hexadecimal print formats.
COPTNS=(suppress print,ruler,changed data char,key field char)
CREATED (CRE)
Selects a group of members from a PDS based on the member’s creation date. The
from or to-date range is specified in the yy/mm/dd format.
CRE=(from-date,to-date)
(,to-date)
(from-date)
from-date
DFLT_WRITE (DW)
Specifies a default output file during a USER function. It is executed when a
WRITE parameter has not been executed for the current record. The output
dataset is defined on a corresponding JCL DD statement called "anyname".
DW=anyname
62 File-AID/MVS Reference Summary
DROP (DR)
Controls the number of records dropped from a dataset during a DROP function.
Use an IF parameter with the DROP parameter.
DR=n
DSNAME (DSN)
Limits the VTOC processing to dataset names that match a unique dataset or a
dataset specified with pattern characters.
DSN=dataset-name
DUMP (D)
Prints n records in vertical hexadecimal format while performing a function.
DUMP=0 dumps all selected records.
D=n
EDIT (E)
Replaces the first occurrence of a character or hexadecimal data in fixed or
variable length records with data of a different length. Remaining data in the
record is shifted to accommodate the change.
E=(location,{length },[dupl]compare-data,new-data)
{operator}
EDITALL (EA)
Edits all occurrences of data within the area specified by a start location and a
length.
EA=(location,length,compare-data,new-data)
ELSE
Enables you to code actions to perform when the preceding conditional
statement is false.
ELSE
ERRS (ERR)
Alters the number of data checks allowed per tape dataset during each execution.
Specify 0 to 99; 0 specifies unlimited errors.
ERR=n
EXPAND
Specifies whether to expand valid CA-Panvalet or Librarian INCLUDE statements.
EXPAND={Y}
{N}
EXPAND_OCCURS
Specifies whether to print all occurrences (YES) or only the first occurrence of
each field when a record layout contains an OCCURS or ODO.
EXPAND_OCCURS={Y}
{N}
63
FEOV (FE)
Forces end-of-volume (EOV) processing for an output dataset when the input
dataset reaches EOV.
FE={Y}
{N}
FIELDS
Specifies which field numbers in the record to print in vertical formatted mode.
This parameter is valid only for the VPRINT function.
FIELDS=(field-list)
FILLER
The FILLER parameter specifies whether filler fields will be printed or not. This
parameter is valid only for the FPRINT and VPRINT functions.
FILLER=[ON/OFF]
FORM (F)
JCL format syntax processes the input data as JCL. Print format syntax specifies
the print format for DUMP, LIST, and PRINT functions and parameters. Multiple-
pass processing syntax specifies whether File-AID allows multiple-pass
processing. Audit trail print syntax specifies the print format for the APRINT
function.
Compare format syntax specifies the print, report, and data format, and report
style for the COMPARE function. The syntax order must be specified as print,
report, and data format, and report style. More than one FORM parameter can be
used per control card.
JCL Format Control:
F=JCL
H (Default) Hexadecimal
F Formatted
C Character.
64 File-AID/MVS Reference Summary
D (Default) Differences
S Summary
L Long.
FPRINT (FP)
Prints n records of formatted alphanumeric data based on a supplied (DDxxRL)
COBOL or PL/I layout. The LAYOUT or MAP parameter is required. The SHOW
parameter is optional.
FP=n
IF (AND, ORIF)
IF selects specific records to be processed. AND is a synonym of IF; AND can be
used after the inclusion of at least one IF parameter. ORIF begins a new set of
selection.
Record Selection by Data Content:
IF=(location,{length },[dupl]data[,loc2,{len2 },[dupl]data2]...)
{operator} {oper2}
IN (I)
Limits the number of input records to be processed.
I=n
INVALID
Specifies how to process invalid data fields. Valid only with the XMLGEN
function.
INVALID={HEX}
{DATA}
{SKIP}
INVALIDCHAR (IVC)
Specifies whether the character fields that include unprintable characters will be
printed as ‘INVALID’ or not. This parameter is valid only for the VPRINT
function.
65
INVALIDCHAR=[ON/OFF]
IOEXIT
Specifies the input and output I/O exit names. This parameter must be the first
parameter following the function and must be on the same line as the function.
The exit names can be up to eight characters long.
IOEXIT={input-exit-name,output-exit-name}
KEY (K)
The Key Print syntax controls whether the key from a keyed dataset is printed.
Random Key Record syntax specifies the key at which processing begins.
Key Print Control:
K={NO }
{YES}
KEYINFO (KIF)
Specifies whether to provide key information when converting File-AID for IMS
XREFs. This parameter is valid only with the CONVERT TYPE=IMSXREF
function.
KIF={ON}
{OFF}
LANGTYPE (LAN)
Selects members based on CA-Panvalet language type. This parameter is valid
only for Panvalet members.
LANGTYP=xxxxx
LAYOUT
Specifies the DDxxRL dataset member used to format data for the FPRINT and
VPRINT function or parameter. For the Compare function, LAYOUT specifies the
member name for DDxxRL and DDxxRLN. The LAYOUT parameter is an alias for
the MAP parameter.
LAYOUT=name
LINKDATE
Selects a group of members from a PDS based on the members’s link date. The
from or to-date range is specified in the ccyy/mm/dd format. Valid only with the
LMODMAPA, LMODDIR, LMODMAPN functions.
LINKDATE=(from-date,to-date)
(,to-date)
(from-date)
from-date
LIST (L)
Prints n records of alphanumeric data without displaying record number or
record length. LIST=0 prints all selected records.
L=n
66 File-AID/MVS Reference Summary
LPI
Overrides the default SYSLIST line count.
LPI={6}
{8}
MAP
Specifies the DDxxRL dataset member used to format data for the FPRINT or
VPRINT function or parameter. The MAP parameter is an alias for the LAYOUT
parameter.
MAP=name
MAXENT (ME)
Changes the default maximum (1024) of input parameters permitted per
execution of File-AID. Maximum entry is 999999. Must be the first parameter
specified after the function name, unless the IOEXIT parameter is specified. If
IOEXIT is specified, IOEXIT must immediately follow the function name
followed by MAXENT.
ME=n
MAXOUT (MO)
Overrides the default (8) number of output datasets created with a USER function
in conjunction with WRITE parameters. Maximum override is 99 datasets.
MO=n
MBRNAME (MBR)
Selects a group of members from a PDS based on a range of member names. The
from or to member name can be up to eight characters for a PDS, PDS/E, or CA-
Librarian file, 10 for CA-Panvalet file, and 16 for GEM libraries.
MBR=(from-name,to-name)
(,to-name)
(from-name)
from-name
MEMBER (M)
Selects a specific member in a PDS. The member name can be up to eight
characters long. Separate multiple member names with a comma and surround
the names with parentheses.
M={member-name }
{(member-name1,member-name2...)}
MEMBERS (MS)
Selects a group of members from a PDS. The mask name can be up to eight
characters. Use a - (hyphen), % percent sign, * (asterisk), or ? (question mark) to
specify wildcard characters.
MS={ALL }
{mask-name}
MOVE (MV)
Builds an output record by moving data to it from either the input record or
control cards. The output area is initialized to the PADCHAR value (default of
67
X’00’). You must build the entire output record. Syntax 1 moves input record
data to an output record. Syntax 2 moves data contained in a control card to an
output record.
Input Record Data:
MV=(to-location,length,from-location)
NEWMEMS (NMS)
Assigns new names to multiple members of an output PDS during a COPY
function. Use a hyphen (-) to specify the characters to retain from the original
member name.
NMS=mask-name
ORIF (OR)
See “IF (AND, ORIF)” on page 64.
OUT (O)
Limits the number of records written to the output dataset or SYSLIST DD
statement. OUT=0 processes the entire file.
O=n
PADCHAR (PAD)
Specifies a pad value. PADCHAR is only applicable for sequential files. Initializes
output areas when used with the MOVE parameter. Use C to specify character
data, or X for hexadecimal data. X'00' is the default.
PAD={C'c' }
{X'nn'}
PANSTAT (STA)
Selects members based on CA-Panvalet status type. This parameter is valid only
for Panvalet members.
STA=x
PDSSTAT (MPS)
Maintains PDS member statistics when updating partitioned datasets. It
maintains only standard directory entries. Valid only with the UPDATE function.
MPS=x
Values for x are:
PRESERVE
Maintains trailing blanks (spaces) in variable length records. Valid only for COPY
and USER.
PRESERVE={ON}
{OFF }
PRINT (P)
Prints n records of alphanumeric data with record number and record length
displayed. PRINT=0 prints all selected records.
P=n
PRTRECS
Specifies whether to include changed, inserted, deleted, and matched records in
the Compare Detail Report.
PRTRECS=(C,I,D,M)
RBA
Specifies a starting block address for BDAM, a starting byte address for VSAM
ESDS or KSDS, or a relative record address for VSAM RRDS.
RBA={n }
{X'nn'}
RDW
Controls the inclusion or exclusion of the record descriptor word for variable-
length record processing. Must be the first parameter specified after a function.
RDW=n
0 (Default) Include the RDW during record processing and display it on output.
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.
READNEXT (RN)
Ends processing of the current record and starts over with the next record.
READNEXT must be coded both subordinate to and immediately followed by an
IF, ORIF, or ELSE parameter.
RN
REFOUT (RFO)
Specifies which records to copy when executing a reformat definition. This
parameter is used with the REFORMAT function. REFOUT=SEL copies only those
records that are being reformatted.
69
RFO={SEL}
{ALL}
REPL (R)
Replaces the first occurrence of data. Syntax 1 replaces by location. Syntax 2
replaces based on a condition at a location. Syntax 3 replaces at an alternate
location based on a condition.
1. Replace by Location:
R=(location,[dupl]new-data)
2. Replace by Condition:
R=(location,{length },[dupl]compare-data,[dupl]new-data)
{operator}
REPLALL (RA)
Replaces all occurrences of data within the area specified by start location and
length. Syntax 1 replaces by condition. Syntax 2 replaces at an alternate location
depending on a condition.
1. Replace by Condition:
RA=(location,length,compare-data,[dupl]new-data)
RLM
(Replace Like Members) Controls the copying of identically-named members
from one PDS to another.
RLM={YES}
{NO }
RLPRINT (RLP)
Prints the associated record layouts when printing XREFs using the XRPRINT
function. The dataset containing the record layouts must be specified in the
DDxxRL DD statement.
RLP=Y
RMODE
Specifies the residency mode to select. Valid only with the LMODMAPA,
LMODDIR, and LMODMAPN functions.
RMODE={24}
{ANY}
70 File-AID/MVS Reference Summary
RRN
Specifies the relative record number for VSAM RRDS and BDAM. When the
specified value exceeds the size of the dataset, the function ends. Specify n as a
decimal value.
RRN=n
SELECT (S)
Selects every nth occurrence of a record for processing.
S=n
SHOW (SH)
Specifies the type of field information reported for formatted print (FPRINT)
output or changes the column header information for vertical formatted print
(VPRINT) output.
SH={FORMAT }
{NUMBER }
{OFFSET }
{PICTURE}
STOP (ST)
Stops processing of a function when specified criteria are met. The next function
then begins processing at that record.
T=(location{,length },[dupl]data,[loc2{,len2 },[dupl]data2]...)
{ operator} { oper2}
TYPE (TYP)
Specifies the type of conversion to invoke. Valid only with the CONVERT
function.
TYP={MAPSEL}
{SELCRIT}
{XREF}
{IMSXREF}
TYPRUN
Specifies to validate the compare criteria without comparing the data. Valid only
with the Compare function.
TYPRUN=SCAN
UNIT
Specifies generic unit names for the VTOCDSN, VTOCINFO, and VTOCMAP
functions. The parameter must specify a unique unit. Separate multiple generic
units with a comma. Up to 48 characters can be specified per unit name. The
parameter is required if the VOLSER parameter is not specified for the VTOCDSN,
VTOCINFO, or VTOCMAP functions. Combine UNIT with VOLSER and VOLSTAT
parameters for multi-volume processing.
UNIT=(unit-name)
USERID (USR)
Selects a group of members from a PDS based on a range of user IDs.
71
USR=(from-value,to-value)
(,to-value)
(from-value)
from-value
VOLSER (VOL)
Specifies volume serial numbers for the VTOCDSN, VTOCINFO, and VTOCMAP
functions. Can contain a unique six-character name or a mask value (*). Separate
multiple volume serial numbers with a comma. Up to 48 characters can be
specified. Combine VOLSER with UNIT and VOLSTAT parameters for multi-
volume processing. VOLSER is required if UNIT is not specified for the
VTOCDSN, VTOCINFO, and VTOCMAP functions.
VOL=(volume-serial-number)
VOLSTAT (VST)
Specifies the volume status for the VTOCDSN, VTOCINFO, and VTOCMAP
functions. The parameter is optional; if it is not specified, all three volume
statuses are assumed.
VST={PUB}
{PRV}
{STG}
VPRINT (VP)
Prints n records of vertical formatted alphanumeric data based on a supplied
(DDxxRL) COBOL or PL/I layout. The LAYOUT or MAP parameter is required. The
FIELDS and SHOW parameters are optional.
VP=n
WRITE (W)
Sends a record to an output file during a USER function. Datasets are defined on
a corresponding JCL DD statement called “anyname”.
W={anyname }
{(anyname1,anyname2...)}
ZERO
The ZERO parameter specifies whether numeric fields will be printed with
leading zeros or not. This parameter is valid only for the FPRINT, VPRINT, and
XMLGEN functions.
ZERO=[ON/OFF]
Parameter Elements
Location (loc)
Actual location or relative location address.
Operator (oper)
Binary (with binary data):
EQ Equal to
NE Not equal to
GT Greater than
GE Greater than or equal to
LE Less than or equal to
LT Less than.
Length (len)
A number from 0 to 255 that does not exceed the record size. 0 searches until the
end of the record.
Data
The actual data must follow one of the following data identifiers and be enclosed
by single or double quotes:
C’10A11’ Character
X’10CF00’ Hexadecimal
P’001’ Packed
T’ABC’ Text
B’01001000’ Binary mask (used for selection)
B’01001000’ Binary OR (REPL new-data only)
BM’C8’ Binary Minus (REPL parameter only new-data)
BS’01001000’ Binary Signed (ACCUM parameter only)
BX’C8’ Binary Exclusive (REPL parameter only new-data)