Académique Documents
Professionnel Documents
Culture Documents
Release 8.8
ii File-AID/MVS Batch Reference Manual
1-800-538-7822
This document and the product referenced in it are subject to the following legends:
Copyright 1983-2001 Compuware Corporation. All rights reserved. Unpublished rights reserved under the
Copyright Laws of the United States.
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/SP, MVS/XA, MVS/ESA, and RACF are trademarks or registered trademarks of International
Business Machines Corporation.
Adobe ® Acrobat ® Reader copyright © 1987-2001 Adobe Systems Incorporated. All rights reserved.
Adobe and Acrobat are trademarks of Adobe Systems Incorporated.
All other company or product names are the trademarks or registered trademarks of their respective
owners.
Doc. CWFARB8I
September 4, 2001
iii
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
What’s In This Manual? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
System Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Notation Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
FrontLine Support Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Online Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
World Wide Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
File-AID/MVS Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . xii
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Accumulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Data Type Accumulations Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
Negative Accumulation Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Glossary-1
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-1
ix
Introduction I nt ro
• Chapter 1, “Product Overview”: Explains the basic components for accessing File-
AID/Batch, the product’s general capabilities and features.
• Chapter 2, “Product Conventions” Discusses control statements and coding
conventions, access method rules, input and output dataset requirements, and the
job control language (JCL) statements required to execute File-AID/Batch.
• Chapter 3, “Functions and Modifiers” Defines each File-AID/Batch function and
corresponding modifiers and provides example function statements.
• Chapter 4, “Parameters”Defines each File-AID/Batch parameter and provides
examples.
• Chapter 5, “Record and Member Selection Logic” Discusses how to define record and
member selection criteria.
• Chapter 6, “Execution Methods and Parameters” Describes the procedures and
screens displayed when executing File-AID/Batch in the IBM Time Sharing Option
(TSO) environment.
• Chapter 7, “Compare Criteria Control Cards”: Describes the Compare Criteria coding
conventions, control statements, and JCL used for processing the Compare function.
• Chapter 8, “Output Reports”: Describes the output report information provided after
executing File-AID/Batch.
• Chapter 9, “Message Codes” Defines the error codes and return codes used in File-
AID/Batch.
• Appendix A, “Examples” Provides example statements that use various functions and
parameters.
• Appendix B, “Data Format Abbreviations”: Describes the data format abbreviations
used by File-AID when you use the FPRINT function or parameter to print records
with the SHOW=FORMAT parameter.
System Environment
File-AID/SPF and File-AID/XE operate in the IBM Time Sharing Option (TSO)
environment under Version 3 Release 5 or above of the Interactive System Productivity
Facility/Program Development Facility (ISPF/PDF).
Note: Increase the region size to 6MB when running File-AID/Batch or when using the
File-AID/Data Solutions call with the File-AID Compare function.
x File-AID/MVS Batch Reference Manual
File-AID/Batch requires MVS/ESA version 5.2.2 and above or any version of OS/390
operating system.
Running File-AID under ROSCOE requires the installation of Release 5.4 or above of the
ROSCOE product with the ETSO option. See the File-AID/MVS ROSCOE Users Installation
Addendum on the File-AID documentation CD for instructions on installing File-AID
under ROSCOE/ETSO.
If a previous release of File-AID is installed, you must reinstall the entire File-AID
product.
Notation Rules
This manual uses the following notation rules when describing File-AID/Batch control
card syntax:
For control statement examples, information that is entered on control cards is printed
in boldface in the text that describes the example.
The names of special function keys on the terminal are shown in initial uppercase letter.
For example: Enter and Attn.
Related Publications
• File-AID MVS Online Reference Manual (SPF and XE): Detailed reference document
for users of File-AID. This manual describes the online product features, screens,
options, fields, and commands.
• File-AID Batch Reference Manual: Detailed reference document for users of File-
AID/Batch. This manual provides information necessary to fully use the batch
features of File-AID.
• File-AID Installation Guide: Step-by-step description of the process necessary to
install File-AID. It is intended for the systems group responsible for File-AID at your
installation. The installation guide provides the information you need to tailor the
online and batch products. It describes the security, I/O, and audit exits. In addition,
it describes the SMF recording function and the Release 8 conversion utility.
Introduction xi
Online Documentation
Documentation for this product is provided on CD-ROM in several electronic formats.
PDF files can be viewed with the free Adobe Acrobat Reader, available at
http://www.adobe.com. HTML files can be viewed with any standard web browser.
BookManager softcopy files can be viewed with any version of IBM BookManager READ
or the IBM Library Reader. To learn more about BookManager or download the free
Library Reader, go to http://booksrv2.raleigh.ibm.com.
Getting Help
At Compuware we strive to make our products and documentation the best in the
industry. Feedback from our customers helps us to maintain our quality standards.
If problems arise, consult your manual or the File-AID technical representative at your
site for assistance. If problems persist, please obtain the following information before
calling Compuware for assistance. This information helps us to efficiently determine the
cause of the problem.
1. Identify the release number and release date of File-AID being used. If possible,
identify your Compuware client number. The SYSPRINT heading produced from a
File-AID/Batch execution contains your client number and release information.
2. Identify the operating system being used to help determine operating system
dependencies.
3. If an abend occurs, note the displacement and the module in which it occurs. If
possible, obtain a copy of the system dump.
4. Note the sequence of issued commands that resulted in the problem, and the data
type involved.
1-800-538-7822
Outside the USA and Canada, please contact your local Compuware office or agent.
xiv File-AID/MVS Batch Reference Manual
1-1
Chapter 1.
Product Overview C ha p 1
This chapter describes how to access File-AID/Batch and introduces the functions and
parameters.
In File-AID, you use functions to process a file to your specifications. Parameters can
limit the parts of the file that are processed and can direct secondary processes. File-AID
has nine functions that provide hardcopy output of records: APRINT, DUMP, LIST,
FPRINT, PRINT, RLPRINT, SCPRINT, VPRINT and XRPRINT. In addition, the DUMP, LIST,
FPRINT, PRINT, and VPRINT functions have corresponding parameters that let you
generate hardcopy while another function processes a file. The output of the printing
parameters is identical to that of the printing functions. The printing parameters are
never used with the printing functions.
• BACK: Permits backward processing of all record formats of sequential and VSAM
datasets.
• MEM: Selects members within a PDS based on the content of the member.
Table 1-1shows a brief description of each function and the modifiers that apply to it.
Detailed descriptions and examples of functions and their modifiers are discussed in
Chapter 3, “Functions and Modifiers”
Parameter Descriptions
Parameters are code words that control or limit processing actions. Table 1-2 gives a brief
description of each parameter. Detailed descriptions and examples are given in Chapter
4, “Parameters”
Forces end-of-volume (EOV) processing for the output tape dataset when the input
FEOV
tape dataset reaches EOV.
Defines the fields to include from each record in the VPRINT vertical formatted print
FIELDS
report.
Controls processing when JCL is read, updated, or printed. Also controls whether
FORM
multiple passes are made on a dataset, audit report format, and other options.
FPRINT Prints data formatted according to a COBOL or PL/I record layout.
ORIF (OR) Creates a logical OR condition when used with a preceding IF parameter.
OUT Controls maximum number of records written to output dataset.
WRITE Writes newly created record to output dataset (USER function only).
Parameters are grouped according to type. The following parameter types are used:
Product Features
This section describes the capabilities and features of File-AID/Batch. Specific product
functions are detailed in subsequent chapters.
Product Capabilities
File-AID offers a variety of ways to perform typical data manipulation functions. File-
AID/Batch statements let you copy, delete, print, change data, compare data, reformat
data, accumulate values, create extract files, insert records, modify JCL, and generate
VTOC information. This section provides a brief summary of these capabilities.
Copying Data: File-AID copies data with the COPY, DROP, REFORMAT, and USER
functions. You can combine IF and OUT parameters with a COPY function to copy
selected records. You can also combine a DROP function with selection parameters to
copy desired records while dropping unwanted records. Both COPY and DROP functions
require input and output datasets. The COPY function combined with MOVE parameter
lets you restructure records while copying.
The USER function is a copy process that gives you more control when writing output
records and datasets. The USER function can insert new records at any point within a
1-6 File-AID/MVS Batch Reference Manual
dataset, repeat records with changed data, delete records by writing them to a dummy
file, and write to multiple output datasets from a single input dataset.
The REFORMAT function is a copy process that lets you reformat the input file while it is
being copied. REFORMAT can reorganize fields within a record, add new fields, and
convert numeric fields.
Deleting Data: Use the DROP function to delete unwanted records by specifying
selection parameters to identify the records you want dropped. You must specify both an
input and an output dataset.
Printing Data: File-AID/Batch provides the APRINT, DUMP, LIST, FPRINT, PRINT,
RLPRINT, SCPRINT, VPRINT, and XRPRINT functions for printing. An APRINT statement
prints an audit trail file formatted in character, formatted, or hexadecimal format. A
DUMP statement produces a character and vertical hexadecimal print of a dataset,
including all record numbers and record lengths. An FPRINT statement prints a report
showing record data next to, and formatted according to, the specifications in a COBOL
or PL/I record layout. A LIST statement prints only alphanumeric character data without
printing record numbers or lengths. A PRINT statement prints only alphanumeric
character data along with record numbers and record lengths. An RLPRINT statement
prints a COBOL or PL/I record layout. An SCPRINT statement prints the dataset
containing the selection criteria created from File-AID online functions. A VPRINT
statement prints a report showing record data vertically formatted according to the
specifications in a COBOL or PL/I record layout. An XRPRINT statement prints a record
layout cross reference (XREF) dataset.
Parameters control the selection of records for printing. The DUMP, LIST, FPRINT, and
PRINT functions can be used with the EDIT and REPL (replace) parameters without using
an IF selection parameter. Output generated in this way shows the changes specified by
REPL or EDIT without changing the real data in the dataset.
You can also use the DUMP, LIST, FPRINT, and PRINT parameters to print data while
performing another function. When you print data, your previous selection and limiting
parameters are used.
Changing Data: File-AID/Batch changes data while copying records to a new output
dataset (copy mode), and while updating original dataset records (update mode). In the
copy mode, the output dataset attributes, organization, and record length can differ from
those of the input dataset. In the update mode, the input file is updated in place, and all
changes are permanent.
Four parameters change data in File-AID/Batch: EDIT, EDITALL, REPL, and REPLALL. In
the copy mode, use the COPY, DROP, or USER function with one of these parameters to
change data. In the update mode, only the UPDATE function operates with these
parameters.
Use EDIT or EDITALL to replace data in a record with data of different lengths.
Remaining data is shifted by deleting or inserting blanks. EDIT replaces the first
occurrence of data in a record; EDITALL replaces all occurrences of the data in the record.
Use REPL or REPLALL to replace data of the same length. You can base replacement on a
location, condition, or an alternate location based on a specified condition. REPL
replaces the first occurrence of data in a record; REPLALL replaces all occurrences of the
data in the record.
Comparing Data: Use the COMPARE function to compare the contents of two files. You
must specify the names of the two datasets that you want to compare and the name of
the dataset that contains the compare criteria. This function requires a compare criteria
control file created with the online Compare utility.
Reformatting Data: The REFORMAT function is an enhanced copy facility that lets you
reformat or initialize a file as you copy and select which records you want in the file. This
function requires a reformat definition created with the online Reformat utility.
Product Overview 1-7
Changing JCL: The FORM parameter lets you indicate that the data you are changing is
JCL. When using JCL format, File-AID strings together and logically processes the JOB,
EXEC, PROC, and data definition (DD) statements. All continuations for a JCL statement
process and print as if one record.
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 and handles
all continuations.
Accumulating Values: File-AID can accumulate data to give totals of fields containing
binary, packed decimal, or numeric character data. You can take accumulations any time
during execution of any File-AID/Batch function. The ACCUM parameter describes the
field to be accumulated. Selection parameters specify the records for accumulation. Use
the TALLY function when your selection requires more than one group of IF parameters.
Creating Extract Files: Use the COPY, DROP, or USER function with selection criteria
and limiting parameters to create files that contain random samplings of production data
for system and program testing. Extracted data can be printed using the DUMP, LIST,
PRINT, or FPRINT parameters.
Inserting Records: Use the USER function to construct and insert new records at any
point in a dataset. The IF, MOVE, and WRITE parameters work with the USER function
for these tasks.
General Features
File-AID/Batch has the following general features:
All Access Methods: Files created through any standard MVS access method can be
processed using File-AID. Currently, the File-AID the VSAM utility (option 3.5) only
allocates, deletes, and renames VSAM-LINEAR datasets.
For records that extend beyond 32 K, specify LRECL=X and File-AID/Batch provides
limited support (COPY, DUMP, and LIST) for a record length up to 64 K.
All Record Formats: File-AID processes all record types including fixed or variable
length, spanned, and unformatted formats.
All Boolean Operators: Use any Boolean operators to enhance your selection processing.
Specify your record conditions and only those records process and display, eliminating
unwanted data. Use the AND/OR operator to connect multiple selection conditions.
JCL Format: File-AID processes JCL statements as logical statements. File-AID recognizes
the comma as a continuation in JCL, and treats the physical records that contain the
continued data as one logical JCL record.
Bidirectional Processing: File-AID reads sequential and VSAM files either forward or
backward. This capability lets you quickly retrieve and analyze data.
Record Key/RBA: You can indicate a specific starting point in a file, by specifying a
record KEY, or by indicating a relative byte/block address (RBA) value.
Chapter 2.
Product Conventions C ha p 2
This chapter discusses the control cards used with File-AID/Batch, dataset requirements,
and the JCL to execute the product.
• Coding conventions
• Control cards and their elements
• Dataset and access requirements
• JCL required to execute File-AID/Batch.
Coding Conventions
Use the following conventions to code control cards:
• You can have information in location 1 through location 80 of your control cards.
• To specify a continuation line, code a comma after the last complete parameter entry
on a control card.
• To code continuation cards, place a blank in location 1 and make sure the next
parameter entry starts before location 26 of the card.
• Separate the function/dataset organization identifier and the parameter identifiers
with at least one blank space.
• Do not split an individual parameter entry element between cards.
• You can code more than one parameter identifier following a single function/dataset
organization identifier. The order that you code the parameters determines the logic
of the statement.
• Separate multiple parameter identifiers by commas.
• You may code multiple parameter identifiers on a continuation line.
You can use abbreviations instead of full function, function modifier, or parameter
names. For example, a control card with full names is coded as follows:
$$DD01 CA R=(6,50,C’TEST’,C’PROD’)
Function and function modifier abbreviations are described in Chapter 3, “Functions and
Modifiers”. Parameter abbreviations are described in Chapter 4, “Parameters”.
Control Cards
Control cards are the main communication tool in File-AID/Batch. Control cards let you
identify the functions to perform on the input data, the method to use for record
selection, and the specific changes to make to the data.
• Dataset identifier
• Function/Dataset organization identifier
• Parameter identifiers
• Comments.
The first two elements are required; the last two are optional. Figure 2-1 shows the format
of a control card.
Note: In this chapter, statements in figures may be spaced differently than the actual
control card format to help you delineate the components of control cards.
Dataset Identifier
The first element on a File-AID control card is the dataset identifier. This identifier
connects an input dataset to a function that you want to perform. The dataset identifier
begins with $$DD in location 1 of the control card as follows:
$$DDxx
Note: If File-AID is executed without control cards, it defaults to a COPY function for
every pair of input and output datasets (DDxx and DDxxO) specified in the JCL.
You can attach a dataset organization identifier (DSORG ID) to any function identifier; it
defines the access method used to process the input dataset. For example, the “DA”
DSORG ID can force File-AID to process a QSAM dataset as a BDAM dataset. Any logical
Product Conventions 2-3
errors created in this way produce unpredictable results in the output dataset. Valid
DSORG IDs are listed in Table 2-1.
The function/DSORG identifier must begin before location 16. Leave at least one blank
position between the function/DSORG identifier and the preceding dataset identifier.
Table 2-2 shows a function/DSORG identifier in a control statement.
$$DD01 COPYDA
$$DD01 COPYDA
This example copies the input dataset as if it is a BDAM file, regardless of the original
access method used when the dataset was created.
Parameter Identifier
Parameters define how to select and manipulate records. They are discussed in
“Parameter Descriptions” on page 1-3. Parameter identifiers define parameters and
consist of a parameter name and one or more elements. Elements define input data,
output data, and data handling components of a parameter. The four most common
elements used in parameter identifiers are:
• Location
• Length
• Operator
• Data.
Format rules for these four elements are listed below. The format used to code each
parameter is explained in Chapter 4, “Parameters”. Figure 2-3 shows the format of a
typical control card using parameters.
2-4 File-AID/MVS Batch Reference Manual
Location Element
The location element defines where the desired data can be found in the record. You can
specify an actual location or a relative location.
Actual Location
The actual location can be any number from 1 to 32,767 (32 KB), but it cannot exceed
the record size. You can use the Record Descriptor Word (RDW) in locations 1 through 4
as the actual location in variable-length records. If you use the RDW as an actual
location, the first valid data position is location 5. If you set the RDW parameter to 2 or
3, the data begins in position 1. (See “RDW” on page 4-43.)
Relative Location
Distinguish a relative location from an actual location by placing a plus sign (+) or a
minus sign (-) before the value. For example, to reference the next relative location in a
record, use +1 for the location element. To reference three bytes before the current
location, use -3 for the location element.
File-AID has two types of relative locations: one references the input record; the other
references the output record. When File-AID retrieves an input record, the input relative
location value is set to the beginning of the input record. This value is incremented by
the IF, EDIT, and REPL scanning parameters. Subsequent relative location references are
relative (+ or -) to this value.
When an input relative location exceeds the current record boundary, File-AID skips the
record and reports it on the statistics line. The statistics line is directed to SYSPRINT after
each function executes.
The output relative location is used only with the MOVE parameter while creating
records with the COPY or USER functions. When data is moved to an output location,
the output relative location advances to the next available output location. This allows
File-AID to calculate the record length of variable-length output records that you
construct.
The output relative location is reset to zero after the next input record is read.
Operator Element
The operator element sets conditional tests on data in the location identified by the
location element. Use operator elements with the EDIT, IF, ORIF, REPL, and STOP
parameters.
File-AID has two sets of operator elements. One set is for character, packed decimal, or
hexadecimal data; the other set is for binary data.
Product Conventions 2-5
Operator elements for character, packed decimal, and hexadecimal data represent
conditions that can occur after a compare instruction is applied to the input data using
the data element specified. These operator elements are listed in Table 2-2.
Table 2-2. Character, Packed Decimal, and Hexadecimal Data Operator Elements
Element Condition
EQ Equal to
NE Not equal to
GT Greater than
LT Less than
GE Greater than or equal to
LE Less than or equal to
Binary operator elements represent conditions that can occur after a test-under-mask
instruction is applied to the input byte using the binary data mask element specified. The
binary operator elements are listed in Table 2-3.
Length Element
The length element sets the length of the field that File-AID must examine. The length
element is used instead of the operator element when the specific location of the
compare data is not known. Using a length element changes the IF, EDIT, and REPL
parameters to scanning parameters. The value of the length element may be any number
from 0 (zero) through 255 (excluding one), but the length added to the current location
cannot exceed the record size.
If you use a 0 (zero) for the length element, File-AID calculates the length of the search
field that begins at the specified location and ends at the end of the record.
Note: The length element is not allowed with packed or binary data elements.
Data Element
The data element lets you specify data to File-AID in three ways:
Table 2-4 identifies the data types that you can specify with the data element. When you
code a data element, make sure the actual data follows one of the data identifiers and is
2-6 File-AID/MVS Batch Reference Manual
enclosed by single quotes (apostrophes) or double quotes. Table 2-4 provides examples of
each data type.
Japanese Data
DBCS and single byte Katakana data is accepted as data element values. File-AID removes
leading or trailing shift characters from DBCS data unless the value is enclosed in double
quotes.
When the KANA install option is specified for the Character Set Table in the Batch
Product Option Variables, C (Character) and T (Text) identifiers are both treated as case-
sensitive C (Character) data.
Character Data
Character data can be any length in the control card, but cannot extend past location 80.
Character data is case-sensitive. Enclose all character data in either single quotes
(apostrophes) or double quotes. Use single quotes to delimit multiple values separated by
commas. Unless commas are enclosed in double quotes, commas indicate an OR
condition for selecting records based on matching a list of two or more data values.
This example shows a character data element that tests for the number 10 or11:
C’10,11’
Use double quotes to include special characters such as commas and quotes. This
example shows a character data string that contains 10,’11’,12:
C"10,’11’,12"
Text Data
Text data can be any length in the control card, but cannot extend past location 80. Text
data is non-case-sensitive. Enclose all text data in either single quotes (apostrophes) or
double quotes. Use single quotes to delimit multiple values separated by commas. Unless
commas are enclosed in double quotes, commas indicate an OR condition for selecting
records based on matching a list of two or more data values.
This example shows a text data element that tests for any combination of upper and
lowercase characters ABCD:
T’abcd’
Use double quotes to include special characters such as commas and quotes.
Product Conventions 2-7
Hexadecimal Data
Hexadecimal data can be any length that is a multiple of two, but cannot extend past
location 80.
X’10000F’
Packed Data
Packed data can be up to 31 digits or a packed length of 16 bytes. Sign packed data by
inserting a positive or negative sign directly after the first quote. Leading zeros are not
required when testing for packed values.
File-AID/Batch determines the length of the packed field by scanning from the location
you specify until it finds a valid sign (F, C, or D). All hexadecimal digits that begin at the
location you specify and ending at the valid sign must be between zero and nine.
Notes:
• When you use a packed data element to test for a condition in a record, each record
tested must have a valid packed data field at the specified location. If invalid packed
data is discovered, File-AID/Batch stops processing, reports the condition on
SYSPRINT, and dumps the record.
• The length element is not allowed when testing for packed data elements. Only
operator elements are valid when using the packed data element.
Binary Data
Binary data checks or sets the ON or OFF condition of bit settings. A binary data element
always describes one byte of data. You can represent it one of two ways:
Binary data elements are used to check the condition of bit settings by using one of the
valid binary data operator elements as described in Table 2-3 on page 2-5. Binary data
elements are applied with a test-under-mask instruction to the byte you reference. Truth
of the condition is based on the binary data operator element specified.
Note: An operator element is required for testing binary data elements. Only one byte is
tested, therefore the length element is not allowed.
The binary data element may also be used as new data in a REPL parameter. When a
binary data element is used with the REPL parameter, individual target bits can be set ON
or OFF by using one of the valid data element types as shown in Table 2-4 on page 2-6.
Duplication Factor
Use a duplication factor to avoid coding repetitive data elements. Code it as any number
from 2 through 255 and place it directly before the data element. If you do not code a
value, the default is 1. The value corresponds to the number of times File-AID finds the
2-8 File-AID/MVS Batch Reference Manual
data contiguously repeated, beginning at the location you specify in the location
element.
Note: File-AID does not support using a duplication factor with the NE operator
element.
Scanning Parameters
Use scanning parameters to search for a sequence of characters within a range of
locations in a record. The scan length can be any number from 0 (zero) through 255
(excluding 1) as long as it is greater than the length of the data element. If you use 0
(zero), File-AID calculates a scan length from your specified location to the end of the
record. Scanning repositions the input relative location pointer when the data value is
found.
Note: A scanning parameter can test only for an equal (EQ) condition. The data element
of a scanning parameter is limited to character or hexadecimal data.
Example 1:
Example 1 generates a hexadecimal print of any record that contains the character string
CLIPS in the scan field between locations 22 and 31.
Example 2:
Example 2 copies the input dataset while locating any record that contains the character
string TEST in the scan field between locations 6 and 55. When File-AID locates the string
TEST, it replaces it with the string PROD.
Comments
Comments are used on control cards as a form of documentation. Comments appear on
the SYSPRINT output when all other control cards are printed.
Code comments by leaving at least one blank position after the final parameter on a
control card. If you do not specify parameters, the comment cannot begin before
location 27. You can code a comment by itself on a control card by placing an asterisk (*)
in location 1. Comments with an asterisk (*) in location 1 are also written to the optional
SYSTOTAL DD if one is provided in the JCL. An example of coding comments is:
Dataset Requirements
This section discusses the dataset requirements for File-AID/Batch, including access
method rules, load module copying rules, and input and output dataset requirements.
Product Conventions 2-9
• QSAM
• ISAM
• BDAM
• VSAM
• BPAM
• UNIX HFS
Zero
Negative Relative Positive
Relative Location Relative
Location Location
Key Data
Portion Portion
To locate the key portion of the record, use a negative relative location. To locate the data
portion of the record, use a zero or positive relative location. When copying these records
to nonkeyed output datasets, use the MOVE parameter with a negative relative location
to transfer both the key and data to the output dataset.
For example, if a record has a 15-byte key and a 100-byte data portion, use a MOVE
parameter to copy both the key and the data portion of the records as follows:
2-10 File-AID/MVS Batch Reference Manual
MOVE=(1,115,-15)
If the dataset is variable length and unblocked, code the MOVE parameter as follows:
MOVE=(1,0,-15)
This format is required for variable-length, unblocked datasets because the individual
record length is unknown.
Note: If the ISAM file has imbedded keys (RKP>0), you cannot reference the key with a
negative relative location.
When copying to a BDAM file, and the number of input records is less than the number
of available output slots, File-AID does not write null (binary zeros) records to the unused
slots.
Keyed BDAM output datasets should be written in ascending key sequence. The key is
expected to begin in input record location one (1), followed by the data.
VSAM datasets are always considered fixed length and contain no RDW. When File-AID
copies variable-length VSAM datasets to variable-length sequential output datasets,
RDWs are automatically added to the output records. When the output dataset is another
VSAM dataset, File-AID copies the input record length to the output VSAM record length.
When File-AID creates VSAM datasets, they are initially opened with the reset option
(load mode). If an error is returned from the open macro, the reset option is turned off
and another open macro is tried. If an error is still found, the return code is reported and
processing of the dataset ceases.
Datasets not opened with the reset option become dataset extensions for ESDS or RRDS
datasets, and inserts or extensions for KSDS datasets. File-AID provides messages that tell
you how the output datasets are opened.
File-AID creates VSAM control blocks during execution with the generate-control-block
(GENCB) macro. These control blocks provide transparency between operating systems,
and the ability to accept access method changes, which may be implemented by IBM.
One set of control blocks is used for input VSAM datasets and another set is used for
output VSAM datasets, except outputs created with the WRITE parameter.
Currently, File-AID/Batch does not support the IBM AMP parameter for defining buffer
space for VSAM datasets.
Members can also be selected by using the MBRNAME parameter to identify a range of
PDS members by member name.
PDSs with standard ISPF statistics can be processed by testing the statistics using the
range parameters: CREATED, CHANGED, and USERID.
When no member filter parameters are specified, File-AID processes all members of all
specified concatenated input PDSs.
When processing a PDS with a printing function, File-AID starts a new page and prints
the name of each selected member. If you specify PARM=TSO on the EXEC statement,
File-AID does not start a new page for each new member name. (See “TSO Execution
Parameters” on page 6-1 for more information.)
Currently File-AID does not support the concatenation of UNIX HFS files.
Refer to an IBM JCL Reference Manual for the use of the PATH, PATHDISP, PATHOPTS,
and PATHMODE parameters.
Note: The UPDATE function and the BACK modifier cannot be used with UNIX HFS
files.
• Both the output and the input dataset must be partitioned and must have an
undefined record format.
• Reblocking is not supported. The block size of the output dataset must be equal to or
larger than the block size of the input dataset. The logical record length is ignored.
• Copying load modules created for planned overlay, scatter-loaded, or note listed
modules is not supported.
• Copying aliases is not supported. If an alias is copied, the main module that the alias
refers to is copied and the alias name is stored.
Variable-Blocked-Spanned Datasets
File-AID automatically processes variable-blocked-spanned (VBS) datasets in their
completed format. If VBS datasets must be processed as segments, code the RECFM on the
2-12 File-AID/MVS Batch Reference Manual
input DD statement (//DDxx) as RECFM=VB. File-AID does not process VBS BDAM
datasets in the completed format.
• CA-Panvalet
• CA-Librarian.
Note: File-AID enables you to COPY from (but not to) a CA-Panvalet or CA-Librarian
dataset. The CA-Panvalet o CA-Librarian dataset cannot be the destination
dataset (DDxxO) in a COPY statement.
Some additional installation steps may be required to activate support. Refer to the File-
AID Installation Guide.
Tape Datasets
File-AID processes tape input using the dataset information on the tape label. If the tape
is unlabeled or non-standard labeled, File-AID uses the DCB defaults RECFM=U and
BLKSIZE=32767. If needed, use JCL parameters to override label information.
File-AID works with each dataset separately; it always closes the current dataset before
opening the next one. Therefore, multiple input or output datasets can logically occupy
the same physical units to reduce excessive unit allocation. To do this, code the unit
affinity statement in the input DD statements as shown in the following example:
//DD01 DD DSN=NAME1,UNIT=TAPE
//DD02 DD DSN=NAME2,UNIT=AFF=DD01
Note: If you intend to write the USER function output to tape, please read Appendix A,
“Examples” examples 35 and 36.
You can write output datasets to tape, disks, cards, or printers. File-AID copies basic DCB
information from the input dataset when no DCB information is specified for the output
dataset.
Product Conventions 2-13
The JCL used to execute File-AID/Batch is listed in Figure 2-5 on page 2-13. Each
statement of the JCL is described below.
EXEC: Required statement that tells the operating system to execute program FILEAID.
If you specify PARM=TSO when printing PDS members, print output is formatted in 80
character mode and a new page is not started for each member. (See “TSO Execution
Parameters” on page 6-1 for additional information.)
STEPLIB: Optional statement to use only when program FILEAID is not present in the
normal link libraries of your system.
STEPCAT: Optional statement that points to a catalog that contains the datasets when
the datasets reside in a catalog other than the system catalog. In most cases, STEPCAT
may be eliminated or replaced with a JOBCAT statement.
2-14 File-AID/MVS Batch Reference Manual
SYSPRINT: Lists all submitted control cards, and all error and completion messages
issued during execution. If SYSPRINT is not provided, File-AID dynamically allocates it.
Define SYSPRINT as an output writer class (SYSOUT=*) or a sequential file.
SYSLIST: Optional statement to use when selecting data for hardcopy output. Define
SYSLIST as an output writer class. If SYSLIST is not provided, File-AID dynamically
allocates it. SYSLIST may optionally be defined as a sequential file.
SYSTOTAL: Optional statement used to receive a report showing comments and totals
produced by any ACCUM parameters. Define SYSTOTAL as an output writer class
(SYSOUT=*), or a sequential file.
Note: To direct SYSPRINT, SYSLIST, or SYSTOTAL to a dataset, the DCB attributes are
RECFM=FBM, LRECL=133 and BLKSIZE=n*133. Using an LRECL of 80 forces File-
AID/Batch to produce output in 80 character mode. If PARM=TSO is specified,
print dataset attributes are modified to LRECL=80. (See “TSO Execution
Parameters” on page 6-1 for additional information.) Any LRECL larger than 80
and less than 133 can truncate print lines and should be avoided. If the RECFM
of the dataset is not FBM, it will be modified to FBM by File-AID at execution
time, unless install option displacement X’22’ is set to A, in which case the
RECFM is changed to FBA.
DDxx: Describes the input datasets to File-AID. The xx value can be any number from 00
to 99 that matches a corresponding control card ($$DDxx). Access a maximum of 100
input datasets per execution. You must use at least one DDxx statement.
DDxxRF: Defines a reformat definition dataset created with File-AID online Reformat
utility. Specify the PDS member name in parentheses. This DD is only required when
using the REFORMAT function. The DD is generated from File-AID online option 9,
Reformat, when processing in batch is requested.
DDxxRL: Defines a record layout dataset, a COBOL or PL/I copybook source, PDS, or a
PANVALET or LIBRARIAN library to use with the FPRINT function or parameter or a
formatted Compare function. You may specify the member name with the LAYOUT
parameter or in the Compare Criteria dataset. This DD is required when using the FPRINT
function or parameter and the RLPRINT parameter.
DDxxRLN: Defines a record layout dataset, a COBOL or PL/I copybook source, PDS, or a
PANVALET or LIBRARIAN library to use with a formatted COMPARE for the COMPARE
NEW dataset. You may specify the member name with the LAYOUT parameter or in the
Compare Criteria dataset.
DDxxXR: Defines a record layout cross reference (XREF) dataset. Enclose the XREF
member name in parens after the dataset name. This DD is generated from File-AID
online option 5.1, Print Data, when layout usage is X (Use XREF).
DDxxXRN: Defines a record layout cross reference (XREF) dataset to use with a formatted
Compare for the Compare New dataset. Enclose the XREF member name in parens after
the dataset name.
DDxxSC: Defines a File-AID selection criteria dataset. Enclose the selection criteria
member name in parens after the dataset name. This DD is generated from File-AID
online options, such as Search/Update, Print and Compare, when using selection criteria.
DDxxSCN: Defines a File-AID selection criteria dataset to use for the Compare New
dataset. Enclose the selection criteria member name in parens after the dataset name.
This DD is generated from File-AID online option 10, Compare.
Product Conventions 2-15
Note: When using selection criteria with JCL created prior to release 8.7.0, you must
duplicate the DDxxSC statement to a DDxxSCN statement. This DDxxSCN
statement will then apply the selection criteria to the new file. See Figure 2-5 on
page 2-13.
DDxxCP: Defines a dataset containing the key information and compare criteria to be
applied during a compare. This DD is generated from File-AID online option 10, Compare
or coded per the instructions in Chapter 7, “Compare Criteria Control Cards”.
DDxxC: Defines the new dataset and member to be compared. This DD is generated from
File-AID online option 10, Compare.
DDxxCHG: Defines a File-AID/Data Solutions dataset to use with the COMPARE function
Call to Data Solutions. This DD is generated from File-AID online option 10, Compare.
MSGLIB: Defines the File-AID/Data Solutions message library to use with the Compare
function Call to Data Solutions. This DD is generated from File-AID online option 10,
Compare.
ANYNAME: Optional statement that is only required with the USER function. Defines
any output dataset specified by the WRITE parameter of the USER function. Use any
name. File-AID can create a default maximum of eight datasets per execution. To change
the default value, and to allow the WRITE parameter to reference up to 99 datasets, see
parameter “MAXOUT (MO)” on page 4-33. Basic DCB information (RECFM, LRECL,
BLKSIZE) is copied from the current open input dataset unless otherwise specified.
SYSIN: Defines the input control cards to process. Place all File-AID control cards after
the SYSIN card. They must be in 80-character format, but may be stored on any type of
physical sequential device. If no control cards are submitted, File-AID defaults to a COPY
function for every pair of input and output datasets (DDxx and DDxxO) specified in the
JCL.
The control statement ($$DD01) corresponds to the input dataset (//DD01) and the
output dataset (//DD01O) because both contain the same value in the DDxx field.
2-16 File-AID/MVS Batch Reference Manual
3-1
Chapter 3.
Functions and Modifiers C ha p 3
This chapter discusses the File-AID/Batch functions and how to append modifiers to
functions. Brief descriptions of each function and modifier are discussed in “Function
and Modifier Descriptions” on page 1-1.
Selection Criteria
Selection criteria can be used in conjunction with most functions. See the File-AID/MVS
Online Reference Manual for further information.
Abbreviations
To save time, you can abbreviate functions on control cards. Table 3-1 shows the
abbreviation for each function and its applicable modifiers.
Functions
This section describes each File-AID/Batch function, discusses its applications and
restrictions, and provides examples of its use. Many of the examples use parameters; each
parameter is defined in “Parameter Descriptions” on page 1-3 and fully explained in
Chapter 4, “Parameters”. Other examples of functions are provided in Appendix A,
“Examples”.
APRINT (AP)
The APRINT function prints the audit trail file in formatted, character, or hexadecimal
format. The audit trail file is created from File-AID online option 2 (Edit) or option 3.6
(Search/Update). If the audit trail file was created using record layouts or XREFs, File-AID
prints the audit trail file in formatted format by default. Use the FORM parameter with
the option CHAR or HEX to override the default printing format. The input DD (DD01)
must specify an existing valid audit trail file. The report is written to the SYSLIST DD.
Example:
Note: The APRINT function must be the last function specified in the control card
concatenation. Any function following the APRINT function is ignored. The
audit trail dataset must be specified as DD01.
COMPARE
The COMPARE function compares the contents of two files. You can compare a dataset of
any file organization supported by File-AID to any other supported file organization.
Specify the name of the old dataset in DDxx and the name of the new dataset in DDxxC.
You must also specify the compare criteria against which these files are compared in
DDxxCP. You can create the compare criteria dataset from File-AID online option 10
(Compare) or code it per the specifications in Chapter 7, “Compare Criteria Control
Cards”.
Example:
In this example, $$DD01 runs the COMPARE function and creates the compare detail
report. The FORM, PRINT, PRTRECS, and COPTNS parameters specify the report format
and style, and the number of records, record type, and amount of information to include
in the report.
Refer to the File-AID MVS Online Reference Manual (SPF and XE) for more information on
the Compare function and its features. The FORM, PRINT, PRTRECS, and COPTNS
parameters are described in Chapter 4, “Parameters”.
Note: When using selection criteria with JCL created prior to release 8.7.0, you must
duplicate the DDxxSC statement to a DDxxSCN statement. This DDxxSCN
statement will then apply the selection criteria to the new file. See Figure 2-5 on
page 2-13.
CONVERT
The CONVERT function is used to perform the following conversions:
• Copies existing File-AID Release 6 selection tables to the new File-AID Release 8 XREF
format.
• Copies existing File-AID Release 7 XREFs to the new File-AID Release 8 XREF format.
• Copies File-AID Release 7 saved selection criteria to the new Release 8 saved selection
criteria format.
• Copies and combines File-AID for IMS and File-AID for DB2 XREFs to the File-AID
Release 8 XREF format.
Specify the TYPE parameter to indicate the type of File-AID information you want to
convert. The TYPE parameter is required.
Note: For sample JCL and instructions on how to use the CONVERT function for each
type of conversion, see the File-AID/MVS Installation Guide or the File-AID/MVS
User’s Guide.
Release 8 XREF members can contain the dataset name of its associated layouts. Release 6
selection tables and Release 7 XREFs do not contain the associated layouts’ dataset
names. CONVERT does not compensate for this discrepancy. Instead, File-AID Release 8
prompts you on an as needed basis for a layout dataset name.
Example:
This example converts File-AID Release 6 selection tables to File-AID Release 8 record
layout cross reference (XREF) format.
COPY (C)
The COPY function lets you copy data. To copy specific dataset areas, record types, or
number of records, use selection and limiting parameters with the COPY function. Use
COPY with action parameters, such as EDIT, REPL, or MOVE, to copy a dataset and
change the content of its records. Specify the CEM parameter to copy empty members of
a partitioned dataset.
After completing a COPY function, File-AID reports on SYSPRINT the number of PDS
members processed and/or the total number of copied records, the output dataset name,
and the output volume serial numbers.
Notes:
• If File-AID is executed without any control statements, it defaults to a COPY function
for every pair of input and output datasets (DDxx and DDxxO) specified in the JCL.
• To process multiple conditional updates (IF REPL, IF EDIT, IF MOVE), while copying
all records, use the ALL function modifier (COPYALL(CA)).
• File-AID/Batch does not support copying a PDS to and from a tape.
• File-AID enables you to COPY from (but not to) a CA-Panvalet, CA-Librarian, or GEM
dataset. The CA-Panvalet, CA-Librarian, or GEM dataset cannot be the destination
dataset (DDxxO) in a COPY statement.
• When the dataset is multi-volume, the input and output datasets for the COPY
function cannot be the same. File-AID issues the message: OUTPUT DATASET SAME
AS INPUT DATASET NOT ALLOWED.
Example 1:
Example 1 copies the first 60 input records that contain the string 12345 beginning in
location 6, to the output dataset, and prints the first five records selected.
Example 2:
Example 2 copies the input dataset, replaces any character X located in location 12 with
a character Z, and dumps the first 100 records copied.
Example 3:
Example 3 copies the input dataset while accumulating five bytes of zoned numeric
character data beginning in location 8. The resulting total is labeled QUANTITY FIELD,
and is printed on the SYSTOTAL DD if it is defined. If no SYSTOTAL DD is provided, the
totals appear on SYSPRINT.
Example 4:
Example 4 creates an extract file of every fourth input record that contains a hexadecimal
value of 010C beginning in location 1. A maximum of 100 records are copied.
Functions and Modifiers 3-5
DROP (DR)
The DROP function eliminates unwanted records from a dataset while copying it. Use the
IF, AND, and ORIF selection parameters to specify the records to be dropped. Specify the
CEM parameter to copy empty members of a partitioned dataset. Use the IN, OUT, or
DROP limiting parameters to stop DROP processing. After completing a DROP function,
File-AID reports the number of dropped records on the SYSPRINT output.
Note: The DROP function is not an update-in-place. The input and output files cannot
be the same file.
Example 1:
Example 1 copies all of the input dataset records and drops any record that does not
contain a valid 7-byte packed field beginning in location 4.
Example 2:
Example 2 copies the input dataset to the output dataset, and stops after dropping the
first 200 records containing a valid packed field of any length, that begins in location 15,
and has an arithmetic value equal to 1 or 2. For more information on packed data testing,
see “Packed Data” on page 2-7Example 3:
To create an extract file, Example 3 copies the input dataset and drops any record that
either contains the letter A or the letter B in location 1, or contains a packed data value
less than 101 in location 19. Processing stops when 15 records are copied.
DUMP (D)
The DUMP function prints datasets or portions of datasets in character and vertical
hexadecimal format. It also displays record number, record length, RBA address (VSAM)
or RRN (VSAM RRDS and BDAM), block size, and physical location (disk files). Figure 8-25
on page 8-11 is an example of the output produced by the DUMP function. DUMP output
is presented 100 characters at a time, on four lines (CHAR, ZONE, NUMR and scale). A
column scale is printed under each 100 characters to help you locate data. The column
scale print is controlled by the FORM parameter.
Use parameters to control the number, or selection, of records to print. When no limiting
parameters are specified, an installation default maximum of 250 records are dumped.
This default prevents you from accidentally generating a large volume of print. Use the
OUT=n parameter to override the default. Use the MOVE parameter to print only selected
portions of each record.
Example 1:
Example 1 prints the first five records from the input dataset in a format that shows both
the character and hexadecimal data. This application of DUMP is useful for packed and
other nonprintable data.
Example 2:
Example 2 prints the first 25 records containing a packed value of 50 in location 110. The
print shows the replacement of the value 50 with the value 200 without actually
3-6 File-AID/MVS Batch Reference Manual
changing the input data. Using the DUMP function instead of the UPDATE function lets
you see your changes before you apply them.
FPRINT (FP)
The FPRINT function prints records in formatted mode, presenting the data according to
a COBOL or PL/I record layout like the formatted display of online File-AID Browse or
Edit. Use the SHOW parameter to control the format of the information presented for
each layout field. SHOW=FORMAT, SHOW=NUMBER, SHOW=OFFSET, and
SHOW=PICTURE are valid options for the SHOW parameter. Example FPRINT output is in
“FPRINT Request” on page 8-13.
Use parameters to control the number, or selection, of records to print. When no limiting
parameters are specified, an installation default maximum of 250 records is printed in
format mode. This default prevents you from accidentally generating a large volume of
print. Use the OUT=n parameter to override the default.
You must supply a DDxxRL DD JCL statement to define a record layout. Use the LAYOUT
or MAP parameter to specify the DDxxRL dataset member containing the source record
layout. Optionally, if you want to use a File-AID XREF member to automatically select
layouts to format the data, include the DDxxXR DD JCL statement identifying the XREF
dataset and member to use. The DDxxRL is still required when using an XREF and it must
identify a valid source library not an explicit member.
Example:
This example prints the first 20 records in formatted mode, using the EMPLOYEE layout
from the DD01RL DD.
Notes:
• 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 Installation Guide.
• The FPRINT function does not list redefinitions.
LIST (L)
The LIST function prints alphanumeric input data only and does not show record
number or any other record information. It is generally used to list JCL, card images, and
other character data. The LIST function prints packed and binary data as blanks. Because
File-AID lists 100 bytes of data per line, LIST displays records larger than 100 bytes on
multiple lines. Example LIST output is shown in Figure 8-28 on page 8-12. No column
scale is printed under each line when using the LIST function. However, a column scale
heading may be requested with the FORM=SHORT parameter.
Use parameters with the LIST function to control the number, or selection, of records to
list. When no limiting parameters are specified, an installation default maximum of 250
records is listed. This default prevents you from accidentally generating a large volume of
print. Use the OUT=n parameter to override the default. Use the MOVE parameter to
print only selected portions of each record.
When listing input records that are 80 bytes or smaller, File-AID can be directed to format
80 character print lines. Either direct SYSLIST to a dataset with an LRECL=80, or specify
PARM=TSO (see “TSO Execution Parameters” on page 6-1) on the EXEC JCL statement.
Functions and Modifiers 3-7
Example:
This example prints the first five records from the input dataset in a format that shows
only the character data.
LMODDIR (LMD)
The LMODDIR function lists the directory entry(ies) of member(s). It supports both data
and load PDSs. The optional parameters enable you to select specific members for
processing. The parameters that are valid depend on the data type of the PDS.
MBRNAME, MEMBER, and MEMBERS are valid for both data and load files. CHANGED
and CREATED are valid only for data PDSs. AMODE, LINKDATE, and RMODE are valid
only for load PDSs. The report is written to the SYSLIST DD.
Example:
This example lists all directory entries of members in the dataset with a creation date on
or between January 1, 2000 and March 31, 2000.
LMODMAPA (LMA)
The LMODMAPA function lists modules (maps CSECTs) in address order. Optional
parameters AMODE, RMODE, and LINKDATE enable you to select specific modules based
on address or residency mode and/or link date range. Optional parameters MBRNAME,
MEMBER, and MEMBERS enable you to select specific members for processing. The input
DD (DD01) must specify an existing valid load module file. The report is written to the
SYSLIST DD.
Example:
This example lists all modules in the dataset with an address mode of 32 in address
order.
LMODMAPN (LMN)
The LMODMAPN function lists modules (maps CSECTs) in name order. Optional
parameters AMODE, RMODE, and LINKDATE enable you to select specific modules based
on address or residency mode and/or link date range. Optional parameters MBRNAME,
MEMBER, and MEMBERS enable you to select specific members for processing. The input
DD (DD01) must specify an existing valid load module file. The report is written to the
SYSLIST DD.
Example:
This example lists all modules in the dataset with a link date on or between January 1,
2000 and June 30, 2000 in name order.
PRINT (P)
The PRINT function prints alphanumeric data and labels each record with its record
number, record length, RBA address (VSAM) or RRN (VSAM RRDS and BDAM), block size,
and physical location (disk files). The PRINT function prints packed or binary data as
blanks. Because File-AID prints 100 bytes of data per line, the PRINT function displays
3-8 File-AID/MVS Batch Reference Manual
records larger than 100 bytes on multiple lines. A column scale is printed under each line
to help you locate data. The column scale print is controlled by the FORM parameter.
Example PRINT output is shown in Figure 8-26 on page 8-11.
Use parameters with the PRINT function to control the number, or selection, of records
to print. When no limiting parameters are specified, an installation default maximum of
250 records is printed. This default prevents you from accidentally generating a large
volume of print. Use the OUT=n parameter to override the default. Use the MOVE
parameter to print only selected portions of each record.
Example:
This example prints the first five records from the input dataset in a format that shows
the character data, the record number, record length, and other information about each
record.
REFORMAT (R)
The REFORMAT function reformats data as it is being copied. This function requires a
reformat definition created with the Reformat utility of File-AID. You must supply a
DDxxRF DD statement to point to the PDS member containing the reformat definition.
The OUT and REFOUT parameters are the only parameters that can be specified with the
REFORMAT function. For more information on the Reformat utility, see the File-AID MVS
Online Reference Manual (SPF and XE).
RLPRINT (RLP)
The RLPRINT function prints a COBOL or PL/I record layout displaying the field level,
field name, format, field number, start location, end location, and field length. You must
specify a DDxx DD JCL statement to define the record layout input dataset. You must
specify the MEMBER parameter. You can print the record layouts of multiple members by
specifying additional members on the MEMBER parameter.
Example:
This example prints record layout information for the member EMPLOYEE.
SCPRINT (SCP)
The SCPRINT function prints the dataset containing the selection criteria created from
File-AID online functions. You must specify a DDxx DD JCL statement to define the
selection criteria primary input dataset. You must specify the MEMBER parameter. You
can print multiple selection criteria members by specifying additional member names on
the MEMBER parameter.
Example:
SPACE (S)
The SPACE function moves the current record pointer forward or backward
(SPACEBACK), skipping over sections of any dataset, and positioning the pointer at a
specific record for a subsequent function. This position is maintained only if the
subsequent function processes the file in the same direction. Reversing the processing
direction causes File-AID to reset the pointer to either the beginning or end of the file.
Example:
In this example, File-AID opens the dataset for input and reads the first 100 records. Any
function (except UPDATE) can now be coded to begin processing with record 101.
Following the SPACE or SPACEBACK function with an UPDATE function also causes File-
AID to reset its record pointer and lose its position in the file. Positioning in the file
cannot be maintained because the UPDATE function requires the dataset to be closed and
reopened for update. To establish position in a file before applying an UPDATE function,
the following example coding may be used:
The SPACE function can also be used for counting occurrences of data in a file (when
used with the EDIT or REPL parameters) without updating the file.
TALLY (T)
The TALLY function lets you combine groups of selection parameters with ACCUM
parameters to provide audit-type totals for entire files. To place the titles and totals
produced by a TALLY function on a separate output dataset, define the SYSTOTAL dataset
in the JCL job stream. If SYSTOTAL is undefined, the TALLY output appears on the
SYSPRINT dataset along with the other program messages. The TALLY function always
processes all parameter groups for each input record, as if the ALL modifier had been
specified. Thus, TALLYALL is not valid.
Example:
This example locates any record that has a value of 90 in locations 10 and 11, and
accumulates the packed field that begins in location 16. If locations 6 and 7 contain a
value of 08, File-AID takes a second accumulation. After execution, the resulting
accumulation totals are labeled TOTALS l990 and AUGUST 1990 when printed on the
SYSTOTAL dataset.
Example:
File-AID prints the accumulation comment cards first. It then produces a two-line dataset
identification message after the comment and before the accumulation.
The second line is the input dataset name and volume serial number.
The next line contains the accumulation output totals. See “SYSTOTAL Output” on page
8-17 for examples of accumulation output.
UPDATE (UP)
The UPDATE function updates records in place that have been altered with action
parameters such as EDIT or REPL. Use UPDATE to make permanent changes to an existing
dataset rather than to a copy of that dataset. The OUT parameter is ignored when used
with the UPDATE function.
You can use the optional hardcopy print parameters, DUMP or PRINT, to produce a report
of your changes. You can preview a report of your changes by first using a printing
function (such as DUMP, LIST, PRINT, FPRINT, or VPRINT) with your EDIT and REPL
change parameters. Then, if all changes look good, change the printing function to
UPDATE and resubmit the job to apply the changes.
CAUTION:
File-AID allows multiple update access on a dataset when the input file is allocated
with DISP=SHR. To avoid updates to a dataset by more than one user at the same
time, use DISP=OLD in the JCL.
When the UPDATE function is used on a PDS, a member or group of members can be
specified with the MEMBER or MEMBERS parameters. To specify one or more specific
members, use the MEMBER parameter. The entire dataset is read for update when
MEMBER or MEMBERS are not used. After UPDATE is executed, the number of updated
members and records are listed on the function statistics lines printed on the SYSPRINT
dataset.
Notes:
• The UPDATE function requires that a parameter be specified on the first control card.
• The UPDATE function is not supported for concatenated datasets.
• To process multiple conditional updates (IF REPL, IF EDIT), use the ALL function
modifier (UPDATEALL(UA)). See “ALL (A)” on page 3-15.
• The UPDATE function cannot be used with UNIX HFS files.
USER (US)
The USER function is a form of COPY that creates new records or datasets. USER allows
greater control when writing output records and datasets. USER can perform three tasks:
New records are built by copying the input record, or by moving data to the output
record with the MOVE parameter. File-AID automatically copies the input record to the
output when executing a USER function, except when a MOVE parameter is used. With
the MOVE parameter, File-AID initializes the output area to binary zeros, and assumes
that the parameter statements build the entire record. (Use the PADCHAR parameter to
Functions and Modifiers 3-11
override the default initialization value of binary zero.) If a location has no data moved
to it, binary zeros remain. The output area is not reinitialized between writes.
The USER function always processes all parameter groups for each input record, as if the
ALL modifier had been specified. Thus, USERALL is not valid.
Notes:
• An installation default forces the USER function to close all of its output datasets
after each use. This allows the output from a USER function to be used as input to
another function in the same job step. See the File-AID Installation Guide for
information on changing this default.
• If you intend to write the USER function output to tape, please read Appendix A,
“Examples” examples 35 and 36.
Example 1:
Example 1 copies the input dataset and writes it to the dataset defined with a DD name
of OUTPUT.
Example 2:
Example 2 creates an extract file with the DD name of EXTRACT. This dataset contains
every tenth record on the input dataset that contains a value not equal to the characters
X,Y, or Z in location 40. A maximum of 25 records are written to the output extract file.
Example 3:
Example 3 repeats a record. The first WRITE parameter writes all input records to the
output dataset with the DD name of A. The IF parameter selects any input record that
contains the string CANCEL. The second WRITE parameter writes the record a second
time.
Example 4:
Example 4 repeats a record with changed data. The first WRITE parameter reads in a
record and writes it out. The IF parameter checks to see if the record contains a packed
decimal value of 5 beginning in location 21. The first MOVE parameter copies the input
record to the output area. The second MOVE parameter moves the two-byte packed
decimal value 155 to location 21. The second WRITE parameter then writes the newly
built record to the output dataset with the DD name of NEWDSN.
Example 5:
Example 5 builds and inserts new records at specific locations in an output dataset as it is
copied from the input dataset. The IF, MOVE, and WRITE parameters are used to insert a
SYSUDUMP DD statement after each EXEC statement in a JCL job stream.
The F(FORM) parameter tells File-AID to expect JCL data. The first WRITE parameter
copies a complete JCL statement from the input dataset to the output dataset. The IF
parameter locates any JCL statement that contains a character string EXEC in the first 20
3-12 File-AID/MVS Batch Reference Manual
locations of the statement. When an EXEC is found, the first MOVE parameter places 80
blanks in the output area. The second MOVE parameter loads the required data into the
record. The second WRITE parameter writes the newly built record to the dataset with the
DD name of NEWJCL.
Note: FORM=JCL is not valid with all syntax forms of the MOVE parameter. See “MOVE
(MV)” on page 4-36 for more information.
VPRINT (VP)
The VPRINT function prints records in vertical formatted mode, presenting the data
according to a COBOL or PL/I record layout like the vertical formatted display of online
File-AID Browse or Edit.
The VPRINT report output width is 132 characters. The report format includes spaces
separating the fields. When the VPRINT output exceeds the report width, File-AID writes
the VPRINT DATA TRUNCATION informational message, VP001-Data truncation
occurred while processing VPRINT request to the SYSPRINT log. Use the FIELDS
parameter to specify which fields to include in the VPRINT output. See “FIELDS” on page
4-20.
The SHOW parameter controls the format of the column headings presented for each
layout field. SHOW=FORMAT, SHOW=NUMBER, SHOW=OFFSET, and SHOW=PICTURE
are valid options for the SHOW parameter.
Use parameters to control the number, or selection, of records to print. When no limiting
parameters are specified, an installation default maximum of 250 records is printed in
vertical format mode. This default prevents you from accidentally generating a large
volume of print. Use the OUT=n parameter to override the default.
You must supply a DDxxRL DD JCL statement to define a record layout. Use the LAYOUT
or MAP parameter to specify the DDxxRL dataset member containing the source record
layout.
Example:
This example prints the first 20 records in vertical formatted mode, using the EMPLOYEE
layout from the DD01RL DD. The FIELDS parameter specifies to include only field
numbers 1,2,3,6, and 10 in the output.
Notes:
• 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 Installation Guide.
• The VPRINT function does not list redefinitions.
VTOCDSN (VTD)
The VTOCDSN function displays VTOC summary information and dataset names in
alphabetical sequence based on the specified parameters. The summary information
identifies the volume serial number and includes VTOC statistics, DSCB, and free space
statistics. For each dataset name, the report lists the file organization, the number of
tracks, the percentage of tracks used, and the number of extents.
Functions and Modifiers 3-13
This function is equivalent to File-AID’s online VTOC utility (3.7) option BLANK (List
VTOC entries in dataset name sequence). Refer to the File-AID MVS Online Reference
Manual (SPF and XE) for additional information on the VTOC utility.
You must specify either the VOLSER or UNIT parameter. The VOLSTAT and DSNAME
parameters are optional. If you want to limit the number of datasets within a volume or
unit, use the DSNAME parameter to specify a pattern dataset or fully-qualified dataset
name. If you want to perform multi-volume processing, combine the VOLSER, UNIT, and
VOLSTAT parameters.
Example 1:
This example lists the datasets from and displays summary information about volume
PRD902.
Example 2:
This example lists the datasets from and displays summary information about 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 high-level qualifiers
and displays only those datasets ending in FASAMP.anything.
VTOCINFO (VTI)
The VTOCINFO function displays volume information including the volume serial
number, device type, mount status, percentage of the volume allocated, VTOC statistics,
DSCB, and distributed free space statistics. The VTOC statistics include volume size in
tracks, percentage of tracks used, and whether or not the volume is indexed. DSCB and
distributed free space statistics include the number of dataset control blocks, the number
of free cylinders, the maximum number of contiguous free cylinders, the number of free
tracks, and the maximum number of contiguous free tracks.
You must specify either the VOLSER or UNIT parameter. The VOLSTAT parameter is
optional.
The VTOCINFO function is equivalent to File-AID’s online VTOC utility (3.7) option I
(List Volume Information). Refer to the File-AID MVS Online Reference Manual (SPF and
XE) for additional information on the VTOC utility.
Example:
This example displays volume information for all volumes with volume serial numbers
that start with the first four letters PROD and for volume serial number WORK02. The
information is further limited to those volumes with a volume status of STG (storage).
VTOCMAP (VTM)
The VTOCMAP function displays volume and dataset information in address location
sequence based on the specified parameters. The summary information identifies the
volume serial number and includes VTOC statistics, DSCB, and free space statistics. For
each dataset name, the report lists the file organization, the number of tracks, the
percentage of tracks used, and the number of extents.
You must specify either the VOLSER or UNIT parameter. Use the VOLSTAT parameter to
limit the information to volumes with a specified volume status. Use the DSNAME
3-14 File-AID/MVS Batch Reference Manual
parameter to limit the VTOC processing to dataset names that match a unique dataset or
pattern characters.
This function is equivalent to File-AID’s online VTOC utility (3.7) option M (Map VTOC
entries in pack location sequence). Refer to the File-AID MVS Online Reference Manual
(SPF and XE) for additional information on the VTOC utility.
Example:
In this example, File-AID displays volume information and datasets that match the
userid.FASAMP.* dataset name pattern in the SYSDA unit.
XMLGEN
The XMLGEN function creates XML documents from existing files using COBOL or PL/I
layout fields as the tag names. The XML document is output to an existing, or new,
dataset using any number of subsequent records.
If your input file is a PDS, you must use the MEMBER or MEMBERS parameter to identify
the member(s) to process.
Use the OUT parameters with the XMLGEN function to control the number of records to
generate as an XML document. The default is all records. The INVALID parameter
specifies how to process data that is inconsistent with the format of the layout field.
Example:
In this example, File-AID generates an XML document for all records in the input file
using the EMPLOYEE record layout member and it skips the field data that is invalid.
XRPRINT (XRP)
The XRPRINT function prints members of the record layout cross reference (XREF)
dataset. The XREF dataset must be specified as the primary input dataset (DDxx). You
must specify the MEMBER or MEMBERS parameter to identify the XREF member(s) to
print. Use the RLPRINT parameter to print the associated record layouts. If you use the
RLPRINT parameter, specify the record layout dataset name in the DDxxRL DD
statement.
Example:
This example prints the XREF member ORDRFILE and the associated record layouts
found in the DDxxRL DD statement.
Function Modifiers
Function modifiers alter or control the way functions operate. Three function modifiers
are available: ALL, BACK, and MEMBER. Brief descriptions of function modifiers are
given in “Function and Modifier Descriptions” on page 1-1. This section discusses the use
and format of the three function modifiers and provides example control statements.
Functions and Modifiers 3-15
ALL (A)
The ALL modifier allows a function to process an entire dataset, regardless of selection
criteria. In addition, groups of parameters may be used to perform multiple subfunctions
against a single record. You can form these groups by contiguously coding IF parameters
separated by action or limiting parameters.
The ALL modifier has no effect on the number of records that are printed. Refer to “OUT
(O)” on page 4-40 to control the printing of output records.
• COPYALL (CA)
• DUMPALL (DA)
• FPRINTALL (FPA)
• LISTALL (LA)
• PRINTALL (PA)
• UPDATEALL (UA).
• VPRINTALL (VPA)
Note: The ALL modifier cannot be specified on the APRINT, COMPARE, CONVERT,
DROP, RLPRINT, SCPRINT, SPACE, TALLY, USER, VTOCDSN, VTOCINFO,
VTOCMAP, and XRPRINT functions. The TALLY and USER functions always
process all parameter groups for each record.
Example:
This example copies the entire dataset whether any record matches the criteria or not. A
REPL operation is applied to any record that matches either of the IF criteria.
BACK (B)
The BACK modifier allows backward processing of all record formats within any
sequential or VSAM dataset. All parameters may be used with this modifier.
• COPYBACK (CB)
• DUMPBACK (DB)
• FPRINTBACK (FPB)
• LISTBACK (LB)
• PRINTBACK (PB)
• SPACEBACK (SB).
• VPRINTBACK (VPB)
The BACK modifier cannot be specified with the APRINT, COMPARE, CONVERT, DROP,
RLPRINT, SCPRINT, TALLY, UPDATE, USER, VTOCDSN, VTOCINFO, VTOCMAP, and
XRPRINT functions.
Notes:
• The BACK modifier is not supported for generation data groups (GDGs) or
concatenated datasets.
3-16 File-AID/MVS Batch Reference Manual
Example:
$$DD01 DB OUT=100
This example dumps the last 100 records of the input dataset.
When a function that uses the BACK modifier is followed by another function that uses
the BACK modifier, the second function begins where the first function stopped.
For example, when the following control cards are run against a 100-record input file,
File-AID lists records 90 through 81.
However, when a function that uses the BACK modifier is followed by another function
that does not use the BACK modifier, the second function begins with the first record in
the file.
In the following example, a common misunderstanding is that it will list the last 10
records of the file. Instead, File-AID lists the first 10 records of the input file.
When File-AID’s processing direction is reversed (that is, from forward to backward or
backward to forward), it must close and reopen the file which loses the file position of
the previous function.
MEM (M)
The MEM modifier selects members in a PDS based on the content of the member. MEM
allows File-AID to search for specific data conditions within each member, and then to
process the entire member if the condition is found.
• COPYMEM (CM)
• DUMPMEM (DM)
• FPRINTMEM (FPM)
• LISTMEM (LM)
• PRINTMEM (PM).
• VPRINTMEM (VPM)
Note: The MEM modifier cannot be specified on the APRINT, COMPARE, CONVERT,
DROP, RLPRINT, SCPRINT, SPACE, TALLY, UPDATE, USER, VTOCDSN,
VTOCINFO, VTOCMAP, and XRPRINT functions.
Example:
This example lists all records of any member that contains a JCL statement with the
string DSN=PROD. and either of the strings DISP=SHR or DISP=OLD.
4-1
Chapter 4.
Parameters C ha p 4
This chapter discusses the use and syntax of File-AID/Batch parameters. A brief
description of parameters and the various parameter types are given in “Parameter
Descriptions” on page 1-3. The abbreviation and type of each parameter is given in Table
4-1.
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 of this chapter describes the use and syntax of a parameter. Example control
statements are given for the parameters. Other examples are located in Appendix A,
“Examples”.
Most parameters can be used with any function, but some are ignored during certain
functions. Parameter compatibility with various functions is shown in Table 4-2.
LMODMAPN(LMN)
LMODMAPA(LMA)
VTOCMAP (VTM)
VTOCDSN (VTD)
LMODDIR(LMD)
VTOCINFO (VTI)
XRPRINT (XRP)
SCPRINT (SCP)
REFORMAT (R)
RLPRINT (RLP)
UPDATE (UP)
APRINT (AP)
VPRINT (VP)
FPRINT (FP)
DROP (DR)
DUMP (D)
USER (US)
COMPARE
SPACE (S)
CONVERT
PRINT (P)
TALLY (T)
COPY (C)
XMLGEN
LIST (L)
Parameter
(Abbreviation)
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
AND X X X X X X X 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 (CHAR) X X X X X X X X X X X X X
COPTNS 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
FEOV (FE) X X X
FIELDS 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
IN (I) X X X X X X X X X X X
INVALID X
4-4 File-AID/MVS Batch Reference Manual
LMODMAPN(LMN)
LMODMAPA(LMA)
VTOCMAP (VTM)
VTOCDSN (VTD)
VTOCINFO (VTI)
LMODDIR(LMD)
XRPRINT (XRP)
SCPRINT (SCP)
REFORMAT (R)
RLPRINT (RLP)
UPDATE (UP)
APRINT (AP)
VPRINT (VP)
FPRINT (FP)
DROP (DR)
DUMP (D)
USER (US)
COMPARE
CONVERT
PRINT (P)
SPACE (S)
TALLY (T)
COPY (C)
XMLGEN
LIST (L)
Parameter
(Abbreviation)
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
KEYINFO (KIF) X
LANGTYP (LAN) X X X X X X X X X X X X
LAYOUT X
LINKDATE 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
MEMBER (M) 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
MOVE (MV) X X X X X X X X X
NEWMEM (NM) X X X
NEWMEMS (NMS) X X X
ORIF (OR) X X X X X X X X X X X
OUT (O) X 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
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
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
Parameters 4-5
LMODMAPN(LMN)
LMODMAPA(LMA)
VTOCMAP (VTM)
VTOCDSN (VTD)
VTOCINFO (VTI)
LMODDIR(LMD)
XRPRINT (XRP)
SCPRINT (SCP)
REFORMAT (R)
RLPRINT (RLP)
UPDATE (UP)
APRINT (AP)
VPRINT (VP)
FPRINT (FP)
DROP (DR)
DUMP (D)
USER (US)
COMPARE
CONVERT
PRINT (P)
SPACE (S)
TALLY (T)
COPY (C)
XMLGEN
LIST (L)
Parameter
(Abbreviation)
TYPE (TYP) X
TYPRUN X
UNIT X X X
USERID (USR) 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
ABEND (AB)
The ABEND parameter sets end-of-job (EOJ) processing based on abnormal conditions
that occur during execution. 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.
ABEND=[n]
0: File-AID completes normal EOJ processing by closing all the files and reflecting the
highest return code issued.
1: (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.
2: 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.
3: 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.
4: 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:
4-6 File-AID/MVS Batch Reference Manual
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” on page 8-17
for report examples.
The ACCUM parameter has two syntax forms for accumulating different data types:
ACCUM=(location,length,data-type[,’description’])
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” on page 2-7). 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:
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:
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 4 is always signed. Lengths 1, 2, and 3 are
unsigned. Use a binary data type “BS” to have File-AID treat a length of 1, 2, or 3 as a
signed binary integer. Table 4-2 shows examples of interpreted data values.
Example 1:
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:
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.
AMODE
The AMODE parameter specifies the address mode to select. Valid only with the
LMODMAPA, LMODDIR, and LMODMAPN functions.
AMODE={24}
{31}
{ANY}
Example:
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)” on page
4-25 for valid syntax forms.
Example:
This example shows two equivalent statements. The first statement uses two IF
parameters. The second statement substitutes an AND parameter for the second IF.
CEM
The CEM parameter copies empty members of a partitioned dataset. This parameter is
valid only with the COPY and DROP functions.
CEM={N}
{Y}
Example:
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.
Parameters 4-9
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.
YY/MM/DD
YY/MM
YY
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:
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.
CHARSET=xxxx
xxxx: Specify one of the following code-page table values. This value is appended to
FAXT 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)
4-10 File-AID/MVS Batch Reference Manual
Example:
This example prints the records using the Canadian Bilingual character set (code-page
table).
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)” on page 4-20. The Compare Criteria dataset
can override these options.
Y (Default) Yes, print only the lines that contain changes or key or sync fields.
A Always. Print ruler for every inserted, deleted, and matched record, and every
pair of changed records.
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:
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.
Note: 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” on page 3-3 for information on the COMPARE function. Refer to the File-
AID MVS Online Reference Manual (SPF and XE) for more information on the COMPARE
function.
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.
CREATED=(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.
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
4-12 File-AID/MVS Batch Reference Manual
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/09/01 and
85/09/30.
Example
This example prints all members created from July 1, 1994 to July 15, 1994.
Example
This example prints all members created 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".
DW=anyname
anyname: User-defined name that matches the DD name in the JCL of the desired
output dataset.
Example:
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
dataset, before processing stops, when a DROP function is executed. At least one IF
parameter must be entered before the DROP parameter is specified.
DROP=n
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:
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 datasets that match a unique dataset
name or datasets that match the specified pattern characters. This parameter is valid only
with the VTOCDSN and VTOCMAP functions.
DSNAME=dataset-name
dataset-name: Name of the dataset or dataset name mask specified with pattern
characters.
Example:
This example displays summary information about and lists the datasets 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 datasets 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. Figure 8-
25 on page 8-11 provides an example of the output produced by the DUMP parameter or
function. (See also “DUMP (D)” on page 3-5.)
Note: Do not use the DUMP parameter with the DUMP, LIST, PRINT, FPRINT, or
VPRINT functions.
DUMP=n
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:
This example copies the entire dataset while dumping the first 25 records.
4-14 File-AID/MVS Batch Reference Manual
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.
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” on page 2-4 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.
Note: 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. Any valid data type described
in “Data Element” on page 2-5 is allowed. Multiple compare-data values, separated by
commas, are allowed.
Note: 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:” on page 4-16).“Example 1:” on page 4-15
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:” on page 4-15). 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:” on page 4-15).
Parameters 4-15
Note: 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:” on page 4-16). 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:” on page 4-16).
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:” on page
4-15. 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:” on page 4-16).
Note: 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:
4-16 File-AID/MVS Batch Reference Manual
----+----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 imbedded 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:
Parameters 4-17
After:
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.
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” on page 2-5 is allowed. Multiple compare-data element values,
separated by commas, are allowed. Duplication factors are not allowed.
Note: 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: 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.
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:
4-18 File-AID/MVS Batch Reference Manual
----+----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.
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:
Invalid Example:
• 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:
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
Parameters 4-19
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.
ERRS=n
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” on page 2-13 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 dataset containing the errors. See “JCL Required
for Execution” on page 2-13 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.
Example:
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.
EXPAND={Y}
{N}
Example:
This example expands the library INCLUDE statements for this output.
4-20 File-AID/MVS Batch Reference Manual
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 datasets 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.
Note: This parameter is effective on only output tapes. The multivolume input can be
on tape or disk.
FEOV={Y}
{N}
Y: EOV processing is performed for the output tape dataset when the input dataset
reaches EOV.
N: (Default) EOV processing is not performed for the output dataset when the input
dataset reaches EOV.
Note: The FEOV parameter is only applicable to multivolume datasets where the output
is tape. Use FEOV only if an output dataset is present (when DDxxO exists) and
the output device is tape.
Example:
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:
This example prints fields 1, 3, 10, 11, 12, 13, and 14 of each record in vertical formatted
mode.
FORM (F)
The FORM parameter has five syntax forms that control five File-AID processing options:
FORM=JCL
Parameters 4-21
FORM={LONG }
{SHORT}
FORM={NOMULTI}
{MULTI}
FORM={HEX}
{CHAR}
More than one FORM parameter can be used per control card. The use of each syntax is
described below.
FORM=JCL
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 ( //* ).
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.
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 all data on one record does not fit between locations 16 and 71, it is shifted as far
as location 4 until it does. 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.
4-22 File-AID/MVS Batch Reference Manual
• 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.
Note: The FORM=JCL parameter cannot be used with the input record data syntax of
the MOVE parameter.
FORM={LONG}
{SHORT}
Examples of short- and long-form print formats are given in “SYSLIST Output” on page
8-9.
The FORM parameter may be used at any time. It remains in effect until changed by
another FORM parameter.
Note: When the LIST function or parameter is used, a column scale is only printed when
FORM=SHORT.
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.
Notes:
• 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.
Parameters 4-23
FORM={HEX}
{CHAR}
Example:
H Hexadecimal
F Formatted
C (Default) Character.
D (Default) Differences
S Summary
L Long.
Note: The PRTRECS parameter, if coded, overrides the report format setting of the
FORM parameter. See “PRTRECS” on page 4-42.
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” on page 4-10 for a
description of these additional print options.
Note: 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” on page 3-3 for information on the COMPARE function. Refer to the File-
AID MVS Online Reference Manual (SPF and XE) for more information 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 dataset. 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.
Note: Do not use the FPRINT parameter with the DUMP, LIST, PRINT, FPRINT, or
VPRINT function.
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:
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.
Notes:
• 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
Parameters 4-25
when the appropriate File-AID/Batch installation options are set as described in the
File-AID Installation 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” on page 4-8). The maximum number of IF parameters that can be entered is
limited by the value of the MAXENT parameter.
IF=(location,length,[dupl] operator-data-type)
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” on page 2-4 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” on page 2-5 is allowed.
Note: Code multiple location, length or operator, and data elements by separating them
with commas, resulting in a logical OR condition.
Example 1:
Example 1 generates a hexadecimal print of records that contain the string TEST FILE
beginning in location 23.
Example2:
Example 2 shows two types of coding to print records that contain the character A in
location 1, OR have the character 1, 2, or3 in location 17.
Example 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:
Example 4 generates a hexadecimal print of records that contain the string TEST FILE
beginning in location 23, or beyond.
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.
Note: 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.
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).
Parameters 4-27
Note: 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.
IN (I)
The IN parameter controls the number of input records that File-AID processes before
stopping.
IN=n
Example:
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.
INVALID={HEX}
{DATA}
{SKIP}
Example:
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.
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.
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:
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 3:
This example creates a new dataset by copying the input dataset using exit USXTYP1, and
creates an extract dataset called EXTRACT. A maximum of 25 records are written to the
output extract file.
Example 3:
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={NO }
{YES}
Parameters 4-29
KEY=C’key-value’
X’key-value’
KEY=C’key-value’
X’key-value’
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 dataset
that has no key length.
Because the KEY parameter controls two processing options, it can be used twice in one
control card.
Note: To begin processing at a specific relative block address (RBA), see “RBA” on page
4-44.
Example:
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.
KEYINFO
The KEYINFO parameter specifies whether to provide key information when converting
File-AID for IMS XREFs. Specifying the KEYINFO=ON parameter enables File-AID/MVS or
File-AID/Data Solutions to age, encrypt or otherwise process IMS key information. This
parameter is valid only with the CONVERT TYPE=IMSXREF function.
KEYINFO={ON}
{OFF}
ON: Include key information for File-AID for IMS XREF CONVERT. This parameter is
valid for extracts created by File-AID for IMS Release 6.1 and above.
Example:
4-30 File-AID/MVS Batch Reference Manual
This example copies File-AID for IMS XREFs to File-AID/MVS Release 8 XREFs format.
LANGTYP (LAN)
The LANGTYP parameter selects members based on CA-Panvalet language type. This
parameter is valid only for Panvalet members.
LANGTYP=xxxxx
xxxxx: Specify a valid language type value (maximum of 5 characters). For example, the
following standard language type values are valid:
Example:
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)” on page 3-6 for information regarding the use of alternate copy
libraries.)
Parameters 4-31
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.
LAYOUT=name
Note: File-AID supports ten character member names if the DDxxRL DD defines a
PANVALET library.
Example:
This example prints the dataset 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 LMODMAPA, LMODDIR, and LMODMAPN functions.
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
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.
Example:
This example lists all modules in the dataset 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 dataset. 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 Figure 8-28 on page 8-12.
Note: Do not use the LIST parameter with the LIST function.
4-32 File-AID/MVS Batch Reference Manual
LIST=n
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:
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.
LPI={6}
{8}
Although the LPI parameter can be used at any time, it should not be used after printing
begins on SYSLIST.
Example:
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)” on page 3-6 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.
MAP=name
Note: File-AID supports ten character member names if the DDxxRL DD defines a
PANVALET library.
Example:
This example prints the dataset 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. 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 32 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 96 bytes of storage space. EDIT,
EDITALL, REPL, and REPLALL parameters use 64 bytes of storage space per condition.
MAXENT=n
n: Number of parameter entries required. The maximum allowed value is 999999 (six
digits). The default value is 1,024.
Example:
This example reserves space for 5000 parameters requiring 160,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 datasets that can be
created with a USER function in conjunction with the WRITE parameter.
MAXOUT=n
n: Number of output datasets to create. It can be any number from 0 (zero) through 99.
The default value is 8.
Note: If a large number of datasets 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:
This example performs a USER function while concurrently creating ten output datasets.
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.
4-34 File-AID/MVS Batch Reference Manual
Example:
In this example the MAXOUT setting of 99 continues in effect for the second USER
function.
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 datasets.
MBRNAME (MBR)
The MBRNAME parameter specifies a member name range that selects a subset of
members based on the characters in the member name.
MBRNAME=(from-value,to-value)
(,to-value)
(from-value)
from-value
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, PDS/E, or CA-
Librarian file, 10 for CA-Panvalet file, and 16 for a GEM library.
Example:
This example prints all members that begin with the characters EMPL.
Example:
This example prints all members from the beginning of the directory through member
ACCTBZZY.
Example:
This example prints member ACCTBZZY and the remaining members through the end of
the directory.
Parameters 4-35
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 dataset.
When the MEMBER parameter is used, File-AID processes only the named member(s).
MEMBER={name }
{(name1,name2...)}
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:
Example 2:
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.
MEMBERS={ALL}
{mask-name}
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.
Example 1:
Example 1 lists any member in the input PDS with a name that begins with the
characters GE.
Example 2:
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.
4-36 File-AID/MVS Batch Reference Manual
MOVE (MV)
The MOVE parameter builds an output record by moving data to it. The data can be
supplied from either the input record or control cards.
Two syntax forms are used for the two data sources:
MOVE=(to-location,length,from-location)
MOVE=(to-location,[dupl]data)
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)” on page 4-40.) 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
functions.
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 advances when data is moved to any location. Both the input and output
relative location are reset to 0 (zero) 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 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.
When the MOVE parameter is used with a DUMP, LIST, or PRINT function, File-AID treats
the function as a request to display only the data that was moved. File-AID records all
MOVE locations and displays a record equal to the highest location used. 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.
Notes:Notes:
• 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
Parameters 4-37
the output area, the EDIT or REPL changes following a MOVE do not appear in the
output dataset.
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.
Note: 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” on page 2-4.)
Note: The input record data format of the MOVE parameter is not supported when the
FORM=JCL parameter is specified.
Example 1:
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:
Example 2 moves ten bytes of data from location 15 in the input record to location 1 in
the output record.
Example 3:
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:
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.
4-38 File-AID/MVS Batch Reference Manual
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”
on page 2-5 is allowed. The length of the MOVE is determined by the length of the data
element entered, including the value of the dupl element.
Note: When packed data is used, high-order zeros must be specified to give the desired
field length.
Example 5:
Example 6:
Example 6 moves ten repetitions of the string ABC to output locations 1 through 30.
Example 7:
NEWMEM (NM)
The NEWMEM parameter assigns a name to a member on an output PDS during
execution of a COPY or USER function. The name assigned by NEWMEM becomes the
new member name. File-AID accepts only one NEWMEM parameter per DD statement.
When using the USER function with multiple PDS outputs, File-AID writes only one
member per PDS 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.
NEWMEM=name
name: New name to assign to the member. A maximum of eight characters can be
entered.
Example:
Parameters 4-39
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 using a
mask that overwrites the input member names.
NEWMEMS=mask-name
Notes:
• Use NEWMEMS only when both the input and output datasets are PDSs.
• If the newly constructed member name already exists on the output PDS, the old
member is replaced unless the RLM=NO parameter is specified.
Example:
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.
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)” on page 4-25 for a description of each element.
4-40 File-AID/MVS Batch Reference Manual
Example 1:
This example copies records that have a number1 in location 25 and a 2 in location 30,
or a3 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:
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.
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.
OUT=n
n: Number from 0 (zero) to 999999999. Use OUT=0 to process the entire file.
Note: The OUT parameter is ignored when the UPDATE function is specified.
Example:
PADCHAR (PAD)
The PADCHAR parameter specifies the value to use for padding. 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.
PADCHAR={C’c’ }
{X’nn’}
Example:
Assuming the output dataset’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.
PANSTAT=x
A Active
D Disabled
E Enabled
I Inactive
P Production
T Test.
Example:
This example prints all Panvalet members with a status type of “T”.
PDSSTAT (MPS)
The PDSSTAT parameter maintains PDS member statistics when updating partitioned
datasets. It maintains only standard PDF directory entries. The parameter is valid only
with the UPDATE function.
PDSSTAT=x
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.
4-42 File-AID/MVS Batch Reference Manual
PRESERVE
Maintains trailing blanks (spaces) in variable length records. Valid only for COPY and
USER. The PRESERVE status is stored in your profile. To change the status issue the
PRESERVE command.
PRESERVE={ON}
{OFF}
ON: 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:
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 Figure 8-26 on page 8-11. (See also “PRINT (P)” on
page 3-7.)
PRINT=n
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.
Note: Do not use the PRINT parameter with the PRINT function.
Example:
This example copies the input dataset while printing the first 15 records.
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” on page 4-23 in the “FORM (F)”
parameter description. The Compare Criteria dataset can override these options.
PRTRECS=(C,I,D,M)
Parameters 4-43
The following PRTRECS options may be coded in any sequence. If only one option is
coded, the parenthesis may be omitted.
Example:
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 “CONVERT” on page 3-3 for information on the COMPARE function. Refer to the
File-AID MVS Online Reference Manual (SPF and XE) for more information 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.
RBA={n }
{X’hh’}
n: Decimal value.
X: 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.
Note: When the specified value exceeds the size of the dataset, the function ends. RBA
values for VSAM ESDS or KSDS datasets must correspond to the beginning of the
record.
Example:
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.
4-44 File-AID/MVS Batch Reference Manual
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.
RDW=n
0 Includes the RDW during record processing and displays it on output. 0 (zero)
is the initial default setting
1 Includes the RDW during record processing and does not display it on output.
2 Does not include the RDW during record processing but displays it on output.
3 Does not include the RDW during record processing and does not display it on
output.
Notes:
• The RDW parameter must be coded before any IF, EDIT, REPL, or MOVE parameters in
the control card.
• When the RDW is not displayed on output (RDW=1 or 3), and no output records are
created, the MOVE parameter output location should reference location 5 first. The
MOVE parameter may be used with the DUMP, LIST, or PRINT printing functions to
show only portions of a record. Since no actual output record is created with the
printing functions, File-AID assumes that the first four bytes of the output area are
the RDW and does not print them.
Example 1:
Example 1 lists all records of this variable-length dataset that contain the character A in
the first byte of the data (not including the 4-byte system RDW).
Example 2:
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.
READNEXT
Parameters 4-45
REFOUT (RFO)
The REFOUT parameter specifies which records to copy when executing a reformat
definition. This parameter is used only with the REFORMAT function.
REFOUT={SEL}
{ALL}
SEL: (Default) Specifies that only those records being reformatted are copied.
Example:
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.
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}
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.
CAUTION:
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.
4-46 File-AID/MVS Batch Reference Manual
Notes:
• 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. See “Packed Data” on page 2-7 for
more information.
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:
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” on page 2-4 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” on page 2-5 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:
Example 2 finds each input record that contains a character 2 in location 4, and replaces
it with a character 6.
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” on page 2-4 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.
4-48 File-AID/MVS Batch Reference Manual
compare-data: Data to compare to the data at the specified location. Any valid data type
listed in “Data Element” on page 2-5 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:
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.
Replace by Condition:
REPLALL=(location,length,compare-data,[dupl]new-data)
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.
See “REPL (R)” on page 4-45 for a description of each element.
Example 1:
Example 1 copies all input records while the IF parameter locates any record that
contains nonnumeric 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:
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.
Parameters 4-49
RLM
The RLM (replace-like-members) parameter controls the replacement of identically-
named members during a copy from one PDS to another.
RLM={YES}
{NO }
YES (Y): (Default) Specifies that a member already present in the output PDS is 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
dataset containing the record layouts must be specified in the DDxxRL DD statement.
RLPRINT=Y
Example:
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
LMODMAPA, LMODDIR, and LMODMAPN functions.
RMODE={24}
{ANY }
Example:
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 dataset, the function ends.
4-50 File-AID/MVS Batch Reference Manual
RRN=n
n: A decimal value.
Example:
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 Chapter 5, “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 datasets.
SELECT=n
Example 1:
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:
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”
on page 8-13.
SHOW={FORMAT }
{NUMBER }
{OFFSET }
{PICTURE}
Parameters 4-51
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. See Appendix B, “Data Format
Abbreviations” for additional information.
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
datasets.
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” on page 2-4 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”
on page 2-5 is allowed.
Note: 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.
Note: Code the STOP parameter ahead of any data-entry parameters, such as ACCUM,
IF, REPL, EDIT or ORIF.
Example 1:
Example 1 copies the input dataset, and stops at the first record that contains the string
ABC COMPANY beginning in location 25.
Example 2:
Example 2 copies the input dataset, and stops at the first record that contains a packed
123 beginning in location 1 or string XYZ beginning in location 6.
Example 3:
Example 3 prints the record with ABC and the next five records.
TYPE (TYP)
The TYPE parameter specifies the type of conversion to implement. The parameter is
valid only with the CONVERT function.
TYPE={MAPSEL}
{SELCRIT}
{XREF}
{IMSXREF}
MAPSEL: Copies Release 6 selection tables to Release 8 record layout cross reference
(XREF) format.
SELCRIT: Copies Release 7 saved selection criteria to Release 8 selection criteria format.
IMSXREF: Copies and combines File-AID for IMS XREFs to Release 8 XREF format.
Note: The TYPE=IMSXREF value enables the use of the KEYINFO=ON parameter.
Example:
This example copies File-AID Release 6 selection tables to File-AID Release 8 record layout
cross references (XREFs).
TYPRUN
The TYPRUN parameter specifies to validate the compare criteria file without comparing
the data. Valid only with the COMPARE function.
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.
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:
In this example, File-AID displays volume information and datasets 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.
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:
This example prints all members that were last updated and saved by user ID USERID1,
USERID2, USERID3, USERID4, or USERID5.
Example:
This example prints all members that were last updated and saved by user ID USERID2.
Example:
4-54 File-AID/MVS Batch Reference Manual
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.
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:
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.
VOLSTAT={PUB}
{PRV}
{STG}
Example:
In this example, File-AID displays VTOC summary information and dataset names for
those datasets on public volumes on 3390 units.
Parameters 4-55
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 dataset. 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.
Note: Do not use the VPRINT parameter with the DUMP, LIST, PRINT, FPRINT, or
VPRINT function.
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.)
FIELDS: Specify the field numbers you want to include in the vertical formatted mode
print. See “FIELDS” on page 4-20.
Example:
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 the DD01RL
DD.
Notes:
• 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 Installation Guide.
• The VPRINT function does not list redefinitions.
WRITE (W)
The WRITE parameter is used only with the USER function. It 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” on
page 5-1. 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 dataset of any access method and any record structure.
A maximum of eight output datasets can be created on a single WRITE parameter
4-56 File-AID/MVS Batch Reference Manual
execution, unless a MAXOUT parameter is entered on the control card to override this
number.
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 datasets or multiple writes to a
single dataset. If the same anyname is coded twice in the second syntax form, two
identical records are written to the //anyname DD dataset. This is not considered an
error.
Note: 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)
Chapter 5.
Record and Member Selection Logic C ha p 5
File-AID enables you to select and process records and PDS members using logic as a
selection tool. The logic is created with parameter statements that define the selection
criteria. This chapter discusses:
Control parameters (such as FORM, KEY, etc.) should be coded before any selection
parameters. See Table 1-1 on page 1-2 for a chart listing parameters by their type.
Action, limiting, and print parameters may be coded before any selection parameters to
act globally against all input records. However, if limiting or printing parameters are
specified as global parameters, then the same parameter cannot be used again in the
current control statement.
Selection parameter groups can be defined by coding contiguous selection parameters (IF,
AND, ORIF) separated by action, limiting or printing parameters. Examples are provided
in “Coding Logical OR Conditions” on page 5-2. Actions within a parameter group are
applied, in order, when the selection criteria matches a record. Printing parameters in a
parameter group operate until the number of selected records specified is reached. Once a
printing parameter limit has been reached, no additional records are printed for a
parameter group, but actions continue to be applied.
Limiting parameters (IN, OUT, SELECT, DROP) control action processing of the current
function when used as global parameters. When used with parameter groups, they stop
all action or print parameters associated with that selection. This does not apply to the
IN parameter; it is always considered global and does not depend on meeting selection
criteria.
Selection parameter groups are processed in the order that they are coded. As soon as the
selection criteria matches a record, the action, printing, and limiting parameters coded
after the selection, and before the next IF parameter, are processed. All following
parameter groups are bypassed, and the next input record is read. The ALL function
modifier (see “ALL (A)” on page 3-15) can be applied to most functions.
It forces File-AID to process all selection parameter groups for each input record. The
TALLY and USER functions process all selection parameter groups by default.
5-2 File-AID/MVS Batch Reference Manual
The DROP function drops a record when a selection matches a record. Action, printing,
and limiting parameters associated with the selection parameter group for dropping a
record are processed. After a record is dropped, no further processing of any subsequent
parameter groups is done until the next record is read.
This statement copies any record that contains the characters 01 beginning in location
12 and the characters 84 beginning in location 14.
Example 1:
Example 1 selects any input record that contains the characters ABC beginning in
location 40, or the characters DEF beginning in location 52.
The second OR format uses multiple data entries separated by commas within a single IF
parameter, as shown in Example 2.
Example 2:
Example 2 selects any input record that contains either the characters XYZ or ABC
beginning in location 40.
The third OR format uses the IF and ORIF parameters, as shown in Example 3.
Example 3:
Example 4:
This example copies any member which contains a record that has a number 100
beginning in location 15.
The MEMBER parameter selects a specific member within a PDS for processing when
coded as follows:
MEMBER=name
The value for name can be up to eight characters. You can specify more than one member
per control card by separating each member name with a comma and enclosing the
names in parentheses. If you specify only one member name, it is recommended that you
do not enclose it in parentheses. Examples 1 and 2 show coding for single- and multiple-
member selection.
Example 1:
Example 1 copies only member MEM1 to the output file labeled DD01O.
Example 2:
Example 2 copies members MEM1, MEM2, and MEM3 to the output file labeled DD01O.
The MEMBERS parameter can be used to select groups of members from a PDS. A mask
field is used to search the PDS directory for any member names that contain the
characters in the mask. The mask field can contain up to eight characters. Any
insignificant character in the string is ignored by coding a hyphen ( - ) in the appropriate
location. The MEMBERS parameter is coded:
MEMBERS=mask-field
Examples 3 and 4 show the use of the MEMBERS parameter for member selection.
Example 3:
Example 3 lists any member in the input PDS with a name that begins with the
characters ZA.
Example 4:
Example 4 prints any member in the input PDS with a name that begins with the
characters TEST and contains a letter P in location 8. All other characters in the name are
ignored.
5-4 File-AID/MVS Batch Reference Manual
Example 5 shows the use of the MBRNAME parameter for selecting a group of members
based on a name range. (See “MBRNAME (MBR)” on page 4-34.)
Example 5:
Example 5 lists any member in the input PDS with a member name that begins with the
characters ABC through DEF.
Chapter 6.
Execution Methods and Parameters C ha p 6
This chapter discusses several ways to execute File-AID/Batch. It includes screen formats
and input procedures for interactive execution within TSO. It also includes information
about optional execution parameters and the conventions for calling File-AID/Batch
from another program. The following topics are presented:
• Execution methods
• TSO execution parameter
• TSO interactive execution
– TSO screen format
– Control card entry
– Stopping processing
– Continuing processing
• Overriding SYSIN or SYSPRINT DD names
• Calling File-AID/Batch from another program.
Execution Methods
File-AID/Batch is a general purpose, stand-alone utility program. It can be executed in
any of the following ways:
• Code JCL and submit a job for background batch execution. See “JCL Required for
Execution” on page 2-13.
• Use online File-AID option 3.8 (Interactive utility). See “TSO Interactive Execution”
on page 6-2.
• Call File-AID/Batch from a program as a subroutine. See “Calling File-AID/Batch from
Another Program” on page 6-4.
• Invoke optional CLIST “FABATCH” to interactively execute File-AID/Batch at your
TSO terminal. (See “TSO Interactive Execution” on page 6-2.) Installation procedures
for the FABATCH CLIST are provided in “Step 7 - Make File-AID CLISTS Available” in
the “Installing File-AID Manually” chapter of the File-AID Installation Guide. Usage
information for the FABATCH CLIST is described in “Optional CLISTs” in the “Product
Conventions” chapter of the File-AID MVS Online Reference Manual (SPF and XE).
• No page headings or page breaks are generated for print output. Printed PDS
members are identified with a special member identification line preceding each
member printed as follows:
• Print output is reformatted to fit an 80 character print line. DUMP, LIST, and PRINT
output is presented 50 characters per line instead of the usual 100 characters per line.
Exception: LIST output for a dataset with an LRECL of 80 or less is left justified to
show up to 80 characters per line.
• The FORM=SHORT parameter turns off the default column scale print lines normally
shown on each record with the PRINT and DUMP functions. Instead, File-AID prints
the column scale print line as header at the top of each page.
• If no SYSLIST DD is present, SYSLIST is not dynamically allocated, and SYSLIST
output is directed to SYSPRINT.
• No printer control characters are written to SYSLIST, SYSPRINT, or SYSTOTAL.
• If SYSPRINT, SYSLIST, or SYSTOTAL is assigned to a file instead of to SYSOUT, DCB
attributes of the file are modified as follows:
DCB=(RECFM=FB,LRECL=80,BLKSIZE=b)
• Use online File-AID option 3.8 (Interactive utility). See the File-AID MVS Online
Reference Manual (SPF and XE) for more information.
When accessing PDSs for update under TSO, either the MEMBER or MEMBERS parameters
should be used to specify the member(s) to be opened for update. The UPDATE function
usually requires that control card input be provided in a dataset. You cannot enter the
UPDATE function at an interactive prompt.
Execution Methods and Parameters 6-3
This statement is displayed after each control card is entered and processed.
Control statements should follow all standard File-AID/Batch coding rules, except that
the dataset identifier ($$DDxx) is optional. File-AID defaults to DD01 if no dataset
identifier is entered.
All functions require at least one input dataset. Although File-AID/Batch can access 100
datasets in TSO mode, you must explicitly allocate and free any dataset other than DD01
or DD01O. The dataset identifier ($$DDxx) is required only when any dataset other than
DD01 is accessed.
If a coding error is found, File-AID reports the error on your screen and asks for re-entry.
For example, if you enter:
DUMP OUT=1,IF=(10,QQ,C’1’)
a message is displayed on the screen, echoing your input, describing the error and
prompting you to reenter the control card as follows:
DUMP OUT=1,IF=(10,QQ,C’1’)
1...5...10...15...2
INVALID LENGTH OR OPERATOR IN IF, CHECK DATA STARTING IN COLUMN 19
....ENTER NEXT FUNCTION OR END
If the control card you entered is still visible on the screen, you can overtype your
control card to correct it and then press Enter. File-AID then continues processing as if no
error had occurred.
Stopping Processing
To stop processing during entry of control statements:
1. Press the Attn or PA1 key. File-AID then displays the message:
2. Either enter another function, or enter END to close all datasets and stop execution.
6-4 File-AID/MVS Batch Reference Manual
Continuing Processing
By default, File-AID prompts for the next input line after parameter entry by displaying
the message:
This message is displayed whether or not a comma followed the last entered parameter.
Execution can then be started by entering GO.
To bypass the message, enter ,GO (including the comma) after the last parameter on the
control statement as follows:
DUMP IF=(10,EQ,C’16,14,37’),GO
In this example, File-AID executes the DUMP function immediately after you press Enter.
The PRINT=ddname parameter in the PARM field causes the normal SYSPRINT and
SYSLIST output to be written to the designated DD name.
Example:
Execute File-AID/Batch and have it read all control statements from the INPUT DD, and
write all output to the FA1 DD.
// EXEC PGM=FILEAID,PARM=’PRINT=FA1,SYSIN=INPUT’
Note: Some installation default options for File-AID/Batch execution can be overridden
at run-time. See “Install Option Variables” in the File-AID/MVS Installation Guide
for information on the OPT= parameter.
Assembler Sample:
Address 1 points to the EXEC PARM data (CTL1). It is used to pass PARM information
(TSO, SYSIN=, PRINT=, and/or OPT=).
The CTL1 sample tells File-AID to send SYSPRINT and SYSLIST output to the FA1 DD
statement.
Note: CTL1 is required. When you are concerned with only CTL2, use an existing
default for CTL1 to avoid changing File-AID processing.
Execution Methods and Parameters 6-5
Address 2 points to the File-AID function control statements. CTL2 is the File-AID
function control statements which must be 80-byte card images conforming to the rules
of File-AID/Batch. The final card must contain the END statement.
COBOL Sample
The following example shows you the information that is required in your COBOL
program to call File-AID/Batch.
*---------------------------------------------------------------*
* CALL FILE-AID TO PRINT A FILE *
*---------------------------------------------------------------*
WORKING-STORAGE SECTION.
01 WS-CTL1.
01 WS-CTL2.
03 WS-CTL2-VALUE1.
05
WS-CTL2-FUNCTION PIC X(12).
05
FILLER PIC X(68).
03 WS-CTL2-VALUE2.
05 WS-CTL2-END PIC X(12).
05 FILLER PIC X(68).
PROCEDURE DIVISION.
0100-HOUSEKEEPING.
Chapter 7.
Compare Criteria Control Cards C ha p 7
This chapter discusses the control cards used with File-AID/Batch Compare and the JCL
to execute it. The control cards described in this chapter are used as input to the DDxxCP
JCL statement. Execution of these control cards is invoked by the COMPARE function.
• Coding conventions
• Control cards and their elements
• Compare criteria keywords
• Field SET keywords
• JCL required to execute File-AID/Batch Compare.
Coding Conventions
Use the following conventions to code Compare control cards:
• Compare control cards (other than comment or continuation cards) must begin with
a SET identifier in locations 1 through 4, followed by a blank.
• The SET identifier must be followed by one and only one keyword beginning in
location 6.
• Multiple keyword values, sub-keywords, or sub-keyword values may be coded as a
card or continued onto another card.
• To continue a control card onto another card, code a comma after the last complete
keyword or sub-keyword.
• To code continuation cards, place a blank in location 1 and make sure the next
keyword, sub-keyword, or value starts before location 26.
• A control card ends when a blank is encountered immediately after a keyword or sub-
keyword value. Any information after the blank is ignored.
• Separate multiple keyword or sub-keyword values by commas.
• Comment cards must have asterisk (*) in location 1. All other locations on a
comment card are ignored.
• Blank cards are ignored.
• Set Identifier
• Keyword Identifier(s)
• Sub-Keyword identifier
• Comments.
7-2 File-AID/MVS Batch Reference Manual
The first two elements are required. Sub-keywords are optional and only valid for certain
keywords. Comments are optional. Figure 7-1 shows the format of a control card.
SET Identifier
The SET Identifier is the first element in a Compare control card. It is a four-digit number
(0001-0767) and must be in locations 1 through 4. The SET Identifier must also be in
ascending sequence, right-justified, and zero-filled. There are two types of SET Identifiers:
GLOBAL and FIELD.
The GLOBAL SET Identifier is 0000. FIELD SET Identifiers may be 0001-0767. The SET
Identifier indicates the scope of the keyword associated with it. The GLOBAL “set”
pertains to the entire Compare run and must precede all FIELD “sets.”
FIELD “sets” pertain to a particular layout. Multiple FIELD SETs are used to describe
multiple layout Compare runs as described by an XREF.
Keyword Identifier
Keywords specify the values that control Compare options. One and only one keyword is
permitted on a control card. Keywords are always either GLOBAL or FIELD (i.e., a
GLOBAL keyword can never be used in a FIELD set).
Keywords are always followed immediately by an equal sign (=) and then the desired
keyword value. When the keyword value is omitted, its default value is assumed.
Compare keywords are described in “Compare Criteria Keyword Definitions” on page 7-3.
Sub-keyword Identifier
Some keywords have a sub-keyword or multiple sub-keywords associated with them. Sub-
keywords are described with the keyword(s) they modify. The keyword must be specified
before any sub-keywords.
Multiple sub-keywords (if applicable) may be coded on a control card or continued onto
another control card. Sub-keywords and their associated values must be coded
immediately after the previous keyword or sub-keyword value (no embedded blanks) and
separated by commas.
Comments
Comments are used on control cards as a form of documentation. Comments are listed
on the SYSPRINT output when all other control cards are printed.
Code comments by leaving at least one blank position after the final parameter on a
control card.
Compare Criteria Control Cards 7-3
You can code a comment by itself on a control card by placing an asterisk (*) in location
1.
File-AID performs a sequential Compare for sequential input files or PDS (PDSE) files with
a single member name. If one of the input files is sequential or a PDS with a single
member name, the other input file must also be sequential or a PDS with a single member
name.
File-AID performs a PDS Compare for PDS datasets without a specified member name,
with a member list, or with a member name mask specified. A member name mask can be
specified online in the OLD dataset member name field or in batch with the MEMBER=
control card.
PDS COMPARE
A PDS compare provides two output reports. The PDS_COMPARE keyword allows you to
specify which report is printed. The default is both. This keyword is valid only for PDS
compares.
0000 PDS_COMPARE=NAME
DETAIL
BOTH
The NAME report is the member name report which lists the member names in columnar
format and flags them as inserted deleted, changed, matched, or not found. A not found
condition exists if a member name is coded in a MEMBER= control card and the member
does not exist in either the OLD or NEW dataset. The DETAIL report is the normal
compare detail report for the data compared between members on the OLD and NEW
files with matched names.
MEMBER
The MEMBER keyword can be used to explicitly select a member or members or using a
standard File-AID member name mask. This keyword is valid for both OLD and NEW
input files. If this keyword is specified as an asterisk (*), blank, or is omitted, the
Compare function selects all members from the input files. This keyword is valid only for
PDS Compare.
0000 MEMBER=name
(name,name...)
blank, *, or mask
0000 MEMBER_NAME_REPORT_COLUMNS=number
7-4 File-AID/MVS Batch Reference Manual
COMPARE MODE
The COMPARE_MODE keyword controls the mode used for compare processing.
FORMATTED requires a valid record layout member specified in the FIELD SET, on the
LAYOUT parameter of the COMPARE function, or on the DDxxRL/DDxxRLN JCL card.
0000 COMPARE_MODE=FORMATTED
UNFORMATTED
LOAD_LIBRARY
0000 USE_DATA_SOLUTIONS_CHANGE_CRITERIA=YES
NO
YES
USE File-AID/Data Solutions to modify the data in the OLD file. When you specify
YES for USE_DATA SOLUTIONS CHANGE CRITERIA, you must specify the change
criteria dataset name with DDnnCHG and optionally the business rules dataset with
DDnnBR.
DDnnCHG DD DISP=SHR,DSN=your.DASAMP.CHNGCRIT(member)
DDnnBR DD DISP=SHR,DSN=your.DASAMP.BUSINESS.RULES
NO
Do not use File-AID/Data Solutions.
0000 DATA_SOLUTIONS_MAXIMUM_INVALID_FIELDS=ALL
number
number
Valid entries for number are the values 1-65532. The default is ALL or 0.
COMPARE TYPE
The COMPARE TYPE keyword specifies the type of compare to perform. The value
SORTED is functionally equivalent to KEYED. This default is KEYED if both input files
have the same key length and location and have the same format. Otherwise, the default
is READAHEAD.
Compare Criteria Control Cards 7-5
0000 COMPARE_TYPE=SORTED
KEYED
READAHEAD
1-TO-1
SORTED/KEYED
This indicates the input files are in sequence as defined by ASSOCIATION
DESCRIBED in the SYNC/KEY keyword.
READAHEAD
This parameter specifies to perform a READAHEAD compare and the file has no
defined sequence.
1-TO-1
File-AID compares OLD record 1 to NEW record 1, OLD record 2 to NEW record 2,
etc.
The value SORTED is functionally equivalent to KEYED. The default is KEYED if both
input files have the same key length and location and have the same format. Otherwise,
the default is READAHEAD.
When comparing non-sorted files that are essentially in the same sequence
(READ_AHEAD_SEQUENCE=ENFORCE; see “READ AHEAD SEQUENCE” on page 7-5), use
this field to specify a number to use to re-synchronize the records after inserted/deleted
records are encountered. This number should be the estimated number of consecutive
inserted/deleted records.
0000 READ_AHEAD_COUNT=number
Valid entries for number are 1-999. The default is 100. (COMPARE_TYPE=READAHEAD
and READ_AHEAD_COUNT=0 are the same as COMPARE_TYPE=1-TO-1). This keyword is
valid only when COMPARE_TYPE=READAHEAD.
0000 READ_AHEAD_SEQUENCE=ENFORCE
E
IGNORE
I
RECORDS TO COMPARE
The RECORDS_TO_COMPARE keyword specifies the maximum number of records to be
compared. If you enter ALL, File-AID compares all records. A numeric value in this field
places a limit on the total number of records that File-AID reads from both files.
0000 DIFFERENCES_TO_COMPARE=ALL
number
7-6 File-AID/MVS Batch Reference Manual
DIFFERENCES TO COMPARE
The DIFFERENCES_TO_COMPARE keyword specifies the maximum changes, inserts, or
deletes that you want to compare. If you enter ALL, File-AID compares all records. A
numeric value in this field helps to avoid a comparison of incorrect datasets by placing a
limit on the differences allowed before the compare process stops.
0000 DIFFERENCES_TO_COMPARE=ALL
number
Valid entries for the number field are 1-999. The default is ALL or 0.
0000 LOAD_LIBRARY_MEMBER_CRITERIA=
(NAME) [,SIZE][,EPA][,ATTRIBUTES][,LINK_DATE]
(OLD_NAME=member,NEW_NAME=member)
NAME/OLD_NAME,NEW_NAME
Specify NAME for a multiple member compare or
OLD_NAME=member,NEW_NAME=member for a single member compare (member
specifies the member name).
SIZE
Specify this parameter for the compare to include load module size.
EPA
Specify this parameter for the compare to include load module entry point address.
ATTRIBUTES
Specify this parameter for the compare to include load module link attributes.
LINK_DATE
Specify this parameter for the compare to include load module link edit date.
0000 LOAD_LIBRARY_CSECT_CRITERIA=NAME[,SIZE][,LANGUAGE][,CSECT_DATE]
[,IDR_ZAP][,TEXT]
NAME
Specify this parameter to compare CSECT names.
SIZE
Specify this parameter to compare CSECT lengths.
LANGUAGE
Specify this parameter to compare CSECT language types.
CSECT_DATE
Specify this parameter to compare CSECT (compile/assembly) dates.
Compare Criteria Control Cards 7-7
IDR_ZAP
0000 LOAD_LIBRARY_TEXT_COMPARE_THRESHOLD=number
ALL
Valid entries for the number field are 0-99999. The default is ALL or 0.
0000 LOAD_LIBRARY_CSECT_SELECTION_LIST_NAME=INCLUDE
EXCLUDE
NONE
0000 LOAD_LIBRARY_CSECT_LIST=(csect-name-list)
csect-name-list
Enter a list of CSECT names or prefixes that identify the CSECT(s) you either want to
include or exclude from the compare. List may be CSECT-prefix*, CSECT range, or full
CSECT name. CSECT names should be separated by a comma (no space) or a hypen (no
space) to indicate a range of CSECTs.
0000 LOAD_LIBRARY_MEMBER_SUMMARY_REPORT=YES
NO
PRINT FORMAT
The PRINT_FORMAT keyword enables you to select the format of the compare report.
0000 PRINT_FORMAT=FORMATTED
CHAR
HEX
MIXED
7-8 File-AID/MVS Batch Reference Manual
FORMATTED
Uses record layouts to show differences field by field. Old fields are printed next to new
fields in two side-by-side columns.
CHAR
Prints each differing record showing only printable characters (default).Differences
are underlined.
HEX
Prints each differing record showing character and vertical hexadecimal values for
each byte of data. Differences are underlined.
MIXED
Prints valid character data as characters and unprintable data is printed in
hexadecimal. Differences are underlined.
0000 MAX_DIFFERENCES_TO_REPORT=ALL
number
0000 RECORD_TYPES_TO_PRINT=CHANGED,INSERTED,DELETED,MATCHED
ALL
NONE
CHANGED
Prints the changed records.
INSERTED
Prints the inserted records.
DELETED
Prints the deleted records.
MATCHED
Prints the matched records.
ALL
Prints all records.
NONE
Generates a Summary Report only (default).
Compare Criteria Control Cards 7-9
0000 FORMATTED_REPORT_STYLE=ENTIRE
ASSOCIATED
COMPARED
ENTIRE
Prints the entire report (default).
ASSOCIATED
Prints all associated fields (including COMPARED) and SYNC/KEYS, if any.
COMPARED
Prints only the compared fields and SYNC/KEYS, if any.
0000 COMPARED_FIELDS_PRINT_OPTION=ALL
CHANGED
ALL
Prints all fields that are selected for comparison.
CHANGED
Prints only the fields that are selected for comparison that have changed.
0000 FIELD_STATISTICS_REPORT=YES
NO
0000 UNFORMATTED_REPORT_STYLE=ULTRA-CONDENSED
CONDENSED
STANDARD
ULTRA-CONDENSED
(Default) Ultra-condensed report style produces the minimum number of report print
lines. It enables you to specify the following additional report options:
• CONDENSED_REPORT_SUPPRESS_PRINT_WITHOUT_CHANGES
• CONDENSED_REPORT_PRINT_RULER
• CONDENSED_REPORT_CHANGED_DATA_UNDERLINE_CHARACTER
• CONDENSED_REPORT_SYNC/KEY_UNDERLINE_CHARACTER
7-10 File-AID/MVS Batch Reference Manual
CONDENSED
Condensed report style has reduced heading lines and enables you to specify the
following additional report options:
• CONDENSED_REPORT_SUPPRESS_PRINT_WITHOUT_CHANGES
• CONDENSED_REPORT_PRINT_RULER
• CONDENSED_REPORT_CHANGED_DATA_UNDERLINE_CHARACTER
• CONDENSED_REPORT_SYNC/KEY_UNDERLINE_CHARACTER
STANDARD
Standard report style is the full Compare report.
0000 UNFORMATTED_PRINT_SEQUENCE=GROUP
ALTERNATE
GROUP
Groups OLD record print lines together and NEW record print lines together
(default).
ALTERNATE
Alternates OLD and NEW record print lines for each 100 record positions.
0000 CHANGED_RECORD_PRINT_CONTENT=SYNC/KEY
RECORD
BOTH
SYNC/KEY
Print sync/key data for changed record.
RECORD
Print entire changed record.
BOTH
Print both sync/key data and entire changed record.
0000 INSERTED_RECORD_PRINT_CONTENT=SYNC/KEY
RECORD
BOTH
SYNC/KEY
Print sync/key data for inserted record.
RECORD
Print entire inserted record.
Compare Criteria Control Cards 7-11
BOTH
Print both sync/key data and entire inserted record.
0000 DELETED_RECORD_PRINT_CONTENT=SYNC/KEY
RECORD
BOTH
SYNC/KEY
Print sync/key data for deleted record.
RECORD
Print entire deleted record.
BOTH
Print both sync/key data and entire deleted record.
0000 MATCHED_RECORD_PRINT_CONTENT=SYNC/KEY
RECORD
BOTH
SYNC/KEY
Print sync/key data for matched record.
RECORD
Print entire matched record.
BOTH
Print both sync/key data and entire matched record.
0000 CONDENSED_REPORT_PRINT_ONLY_CHANGED_DATA=YES
NO
YES
Prints only the changed data for the new record. Unchanged data is displayed as
spaces.
NO
Prints the entire record content.
0000 CONDENSED_REPORT_UNDERLINE_CHANGES=OLD
NEW
BOTH
NEITHER
OLD
Underline changes in the OLD record.
NEW
Underline changes in the NEW record.
BOTH
Underline changes in the OLD and NEW record.
NEITHER
Do not underline changes in either the OLD or NEW file.
0000 CONDENSED_REPORT_UNDERLINE_SYNC/KEY=OLD
NEW
BOTH
NEITHER
OLD
Underline sync/key field in the OLD record.
NEW
Underline sync/key field in the NEW record.
BOTH
Underline sync/key field in the OLD and NEW record.
NEITHER
Do not underline sync/key field in either the OLD or NEW file.
0000 CONDENSED_REPORT_SUPPRESS_PRINT_WITHOUT_CHANGES=YES
NO
Specifying YES (default) prints only the lines that contain changes and/or key or sync
fields. Specify No to print all records.
0000 CONDENSED_REPORT_PRINT_RULER=TOP
ALWAYS
NEVER
Compare Criteria Control Cards 7-13
TOP
Only prints at the top of the page (default).
ALWAYS
Always prints the ruler for every inserted, deleted, and matched record, and every
pair of changed records.
NEVER
Does not print a ruler.
0000 CONDENSED_REPORT_CHANGED_DATA_UNDERLINE_CHARACTER=_
0000 CONDENSED_REPORT_SYNC/KEY_UNDERLINE_CHARACTER=#
WRITE TO FILE
The WRITE_TO_FILE keyword specifies the output file number, which file to take the
record or member to write, and the type of record to write. In batch, a DD01COn DD card
must be present for each unique file number specified.
0000 WRITE_TO_FILE_n=file/type
n
N is the output file number. Valid entries are 1-6. In batch, this corresponds to the
DD01COn JCL DD card. Multiple record/member types may be written to the same
output file. If records/members from both the OLD file and the NEW file are written
to the same output file, then the OLD file format is used as the output format.
Padding or truncation may occur.
file
File is the input file from which to take the record or member to write. Valid entries
are OLD or NEW.
type
Type is the record type to write. Valid entries are CHANGED, MATCHED, DELETED
or INSERTED. DELETED is only valid for the OLD file. INSERTED is only valid for the
NEW file.
Examples:
0000 WRITE_TO_FILE_3=NEW/INSERTED
0000 WRITE_TO_FILE_6=OLD/CHANGED,OLD/MATCHED
7-14 File-AID/MVS Batch Reference Manual
0000 OLD_SYNC/KEY_MEMBER=EMPLOYEE,LAYOUT_NAME=EMPLOYEE-MASTER-FILE
0000 NEW_SYNC/KEY_MEMBER=ALTEMPLY,LAYOUT_NAME=ALTERNATE-MASTER-FILE
• SYNC/KEY MEMBER and LAYOUT cards are optional for single layouts.
• LAYOUT_NAME may be left blank if there is only one layout in the specified
SYNC/KEY_MEMBER=.
• The SYNC/KEY MEMBER and LAYOUT cards are valid only for a formatted compare.
SYNC/KEYnnn
The SYNC/KEY keyword associates OLD and NEW data as SYNC/KEY pairs.
Each SYNC/KEY is ordered based on the three-digit (1-256) sequence number which is
part of the keyword (e.g., SYNC/KEY003 defines the third SYNC/KEY field).
0000 SYNC/KEY001:OLD_NAME=old-field-name,NEW_NAME=new-field-name,
SORTED=YES,SEQUENCE=ASCENDING
NO DESCENDING
or
0000 SYNC/KEY004:OLD_POSITION=12345,OLD_LENGTH=12345,
OLD_DATA_TYPE=data-type
0000 SYNC/KEY004:NEW_POSITION=12345, NEW_LENGTH=12345,
NEW_DATA_TYPE=data-type
OLD_NAME/NEW_NAME
Name of field selected for SYNC/KEY specification.
OLD_POSITION/NEW_POSITION
Starting position of the field within the record (relative to 1).
OLD_LENGTH/NEW_LENGTH
Number of bytes in the corresponding field.
Compare Criteria Control Cards 7-15
OLD_DATA_TYPE/NEW_DATA_TYPE
B Binary unsigned.
BS Binary signed.
BT Bit.
C Character alphanumeric.
F Floating point.
Z Zoned decimal.
SEQUENCE
Specify the field sequence direction for this key field (ASCENDING or DESCENDING).
SORTED
Specify whether this SYNC/KEY field is in a sort sequence (YES or NO).
Guidelines
Use the following guidelines when coding SYNC/KEY associations:
Multiple SET ID numbers are used ONLY for XREF processing. Each layout member name
and layout name combination has a unique SET ID number used to group all control
cards for the XREF. SET control cards must always be together and arranged in order by
SET ID. However, users may assign any unique SET ID number to any layout member
name/layout name combination they wish.
The XREF member names must be present on the DDxxXR/DDxxXRN JCL statement.
If not provided for a single-layout compare, member name(s) are determined via the JCL.
If unspecified for a single-layout compare, the first layout in the member is used.
0005 OLD_LAYOUT_MEMBER=EMPLOYEE,OLD_LAYOUT_NAME=EMPLOYEE-MASTER-FILE
0005 NEW_LAYOUT_MEMBER=EMPLOYEE,NEW_LAYOUT_NAME=ALTERNATE-MASTER-FILE
FIELDnnn
When specifying FIELD associations, specify the FIELD number (POS. 11-14) groups
associated sub-keywords together. FIELD association keywords must be in sequence by
FIELD number. Sub-keywords may be continued on subsequent cards. A sub-keyword and
its value must end on the card on which it begins.
For field values (name, positions, length, and data type), please see the field value
information in “SYNC/KEYnnn” on page 7-14.
0005 FIELD0001:OLD_NAME=OLD-FIELD-NAME,NEW_NAME=NEW-FIELD-NAME
or
0005 FIELD0006:OLD_POSITION=12345,OLD_LENGTH=12345,
OLD_DATA_TYPE=data-type
0005 FIELD0006:NEW_POSITION=12345,
NEW_LENGTH=12345,
NEW_DATA_TYPE=data-type,
TOLERANCE=123456789.123456789,PRINT_ONLY
Guidelines
• Minimum information for specifying FIELD associations is OLD_NAME or
OLD_POSITION. If NEW information is omitted, OLD information is assumed for
both.
• OLD_NAME or NEW_NAME cannot be used for an UNFORMATTED compare.
OLD_NAME is mutually exclusive of OLD_LENGTH and OLD_DATA_TYPE.
• NEW_NAME is mutually exclusive of NEW_LENGTH and NEW_DATA_TYPE.
• POSITION, LENGTH, and DATA_TYPE format may be used in place of NAME for a
FORMATTED COMPARE.
Compare Criteria Control Cards 7-17
Chapter 8.
Output Reports C ha p 8
This chapter provides sample output for the three report datasets for File-AID/Batch:
• SYSPRINT
• SYSLIST
• SYSTOTAL.
SYSPRINT Output
This section describes the following output reports and logs generated by File-AID:
• SYSPRINT heading
• Opening messages
• Comments
• Actions-taken map
• Function statistics
• Accumulations
• Dataset processing messages
• Closing message/Record count
• Alternate date
• Data check
• Block count error log
• Output PDS error log
• Input PDS error log
• DCB abend log
• Open error logs
• VSAM warning
• Invalid packed field error log
• Control card error log.
Heading
Figure 8-1 shows the heading information that SYSPRINT generates each time File-AID is
executed. The first line shows the File-AID release number, and the date and time of
execution. The second line shows the installation (company name), and the release date
of the File-AID release in use.
Opening Messages
Figure 8-2 on page 8-2 shows the SYSPRINT report generated when File-AID opens a
dataset. This dataset information defines:
8-2 File-AID/MVS Batch Reference Manual
• Dataset name
• Access method
• Processing direction
• Record format
• Record size
• Block size
• VOLSER
• Tape density
• Key length
• Relative key position (RKP)
• Number of records in prime data area (NRECRDS) for ISAM and VSAM KSDS datasets.
• control interval for VSAM datasets
• maximum byte address for VSAM datasets.
SYSPRINT codes for the access method used by the dataset are Table 8-1.
SYSPRINT codes for the record format used by the dataset are Table 8-2.
Figure 8-3 on page 8-3 shows a SYSPRINT opening message for a sequential dataset
opened backwards.
Output Reports 8-3
Comments
Figure 8-4 shows the format of comment cards generated when no SYSTOTAL DD
statement is entered in the JCL. Comment cards can be entered at any time and are
printed in the order in which they are entered.
Function Statistics
Figure 8-6 on page 8-4 shows the function statistic line that SYSPRINT prints after each
function is executed. The function statistics available on this line are described in Table
8-3 on page 8-4.
8-4 File-AID/MVS Batch Reference Manual
RECORDS-READ=41,COPIED=41,PRINTED=41,ENDING ON PAGE 18
SELECTED
UPDATED
MEMBERS-READ
Number of members actually updated as a result of an UPDATE function.
Value can be equal to or less than that in SELECTED.
COPIED
SKIPPED
TRUNCATED
ADDED
UPDATED
RECORDS-READ
Number of actual records changed by the EDIT, REPL, or MOVE action
parameters during an UPDATE function.
COPIED
DROPPED
PRINTED
Accumulations
Figure 8-7 is a SYSPRINT report generated when an accumulation is taken using ACCUM
parameters and a REPL parameter in the replace-by-location format. The report also
shows a second format for comments generated by SYSPRINT--a print of a comment at
the end of the control card. Comments of this format must be separated from the last
entry of the card by at least one blank space. Totals generated from ACCUM parameters
are shown on the SYSPRINT report when no SYSTOTAL DD is provided in the JCL. See
“SYSTOTAL Output” on page 8-17 for more information.
Figure 8-9 shows a sample SYSPRINT output generated when multivolume datasets are
processed. It reports the number of processed records and volume serial numbers. In
addition, when concatenations are processed, the dataset name is reported.
Figure 8-10 on page 8-6 shows a sample SYSPRINT output generated when the USER
function is used with three WRITE parameters to create three output datasets. The
opening message for each dataset appears below the control card listing.
8-6 File-AID/MVS Batch Reference Manual
Alternate Date
Figure 8-12 shows the alternate date format (APR - 09 - 1999) that SYSPRINT generates for
April 9, 1999.
Data Check
Figure 8-13 on page 8-7 shows a SYSPRINT log generated when File-AID recognizes a data
check. If the error block is printed, the right-hand column displays PRINTED, as shown
in the figure. If it is not printed, the data check is logged but the right-hand column
displays SKIPPED.
Output Reports 8-7
MEMBERS-READ=1,SELECTED=1,RECORDS-READ=28,COPIED=28
28 RECORDS WRITTEN TO DD01O-USERID0.TEST.JCL ***RECORD COUNT***
VOL=PRD927
Figure 8-18 shows a SYSPRINT report generated for a DCB abend that logs an open error
(013-20). A File-AID error message (DE08) is listed in the right-hand column.
$$DD01 COPY
ER048-OPEN ERROR 13-20 WAS ENCOUNTERED ON DD01 RC=8
......SKIPPING TO NEXT $$DD CARD
$$DD02 S
UNABLE TO OPEN DD02 DCB/ABEND 013-20 RC=8 **ERROR** DE02,FDBK=08
......SKIPPING TO NEXT $$DD CARD
SYSLIST Output
This section describes the following output reports and messages by SYSLIST:
• SYSLIST heading
• Disk dataset access message
• DUMP request
• PRINT request
• Output record print
• LIST request
• FPRINT request
• VPRINT request
• Changed/truncated record tag
• VSAM retrieval output
• Tape dataset blocks
• Sequential dataset records.
Heading
Figure 8-23 on page 8-10 shows the SYSLIST heading information generated for each
accessed dataset. The heading lines include:
The third line shows the placement of the column scale when a short form is requested
with a FORM=SHORT parameter value. The column scale length is determined by the
length of the output records. For records under 100 bytes, the line is as long as the
8-10 File-AID/MVS Batch Reference Manual
maximum LRECL of the dataset. If records are 100 bytes or longer, the column scale line
printed is exactly 100.
REC RD 1 DATA 517 CHAR C OAX-12222 COAXIA L CABLE FT NYCB/O 121593CA LAVAIL 10049
003 1-07-000 DATA 5170 1...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR 3 02505A90 EAST COAST ELECTRICA L SUPPLY CARL KR AGEN 71 8458392871 84583900A8 7BROO
101...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR GEORG E MUSIAL 2123721827 2123721800 A92DUNCAN INDUSTRIAL ELECTRIC *DUAN E MCG
301...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR OVERN 917372812 3917372810 0A45PITTSF IELD SUPPL Y CO *GEO RGE NEWTON 215
401...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
REC RD 2 DATA 517 CHAR C OAX-12223 COAXIA L CABLE FT NYCB/O 121593CA LAVAIL - 09179
1...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR 3 02505A90 EAST COAST ELECTRICA L SUPPLY CARL KR AGEN 71 8458392871 84583900A8 7BROO
101...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR GEORG E MUSIAL 2123721827 2123721800 A92DUNCAN INDUSTRIAL ELECTRIC *DUAN E MCG
301...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
CHAR OVERN 917372812 3917372810 0A45PITTSF IELD SUPPL Y CO *GEO RGE NEWTON 215
401...5 ...10...15 ...20...25 ...30...35 ...40...45 ...50...55 ...60...65 ...70...75 ...80...85 ...90...95 .....
DUMP Request
Figure 8-25 on page 8-11 shows the SYSLIST output generated when a DUMP function or
parameter is requested. Each record is numbered from the beginning of the dataset. The
length of each record is also shown.
Output Reports 8-11
RECR D 1 D ATA 517 CH AR COA X-12222 COAXIAL CABLE FT NY CB/O 121593CALA VAIL 10 049
0031 -07-000 D ATA 5170 ZO NE 0000CDC E6FFFFF444 44CDCECCD4 CCCDC44444 4444444444 4444444444 44CE0020DE CC6D444000 FFFFFFCCDC ECCD4100FF FFF
NU MR 2500361 7012222000 0036179130 3123500000 0000000000 0000000000 0063005C58 321600030C 1215933131 5193000C10 049
1...5.. .10...15.. .20...25.. .30...35.. .40...45.. .50...55.. .60...65.. .70...75.. .80...85.. .90...95.. ...
CH AR 3 02505A90EA ST COAST E LECTRICAL SUPPLY CARL KRAG EN 7184 5839287184 583900A87B ROO
ZO NE F030000 FFFFFCFFCC EE4CDCEE4C DCCEDCCCD4 EEDDDE4402 0CCDD4DDCC CD44444444 444444FFFF FFFFFFFFFF FFFFFFCFFC DDD
NU MR 300C10C 0250519051 2303612305 3533993130 2477380000 C319302917 5500000000 0000007184 5839287184 5839001872 966
101...5.. .10...15.. .20...25.. .30...35.. .40...45.. .50...55.. .60...65.. .70...75.. .80...85.. .90...95.. ...
CH AR 3482912 2153482900
ZO NE FFFFFFF FFFFFFFFFF
NU MR 3482912 2153482900
501...5.. .10...15..
PRINT Request
Figure 8-26 shows the SYSLIST output generated when a PRINT function or parameter is
requested. Since the printed records in the figure are also unblocked, SYSLIST numbers
each block and shows the length (BLOCK-2, DATA-80).
BLOCK 1 DATA 517 CHAR COAX-1222 2 COAX IAL CABLE FT NYCB/O 121593 CALAVAIL 100493
0016-00 -000 DATA 517 1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR 02505A 90EAST COA ST ELECTRI CAL SUPPLY CARL KRAGEN 7184583928 7184583900 A87BROOKLY N
1 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR GEO RGE MUSIAL 21237218 2721237218 00A92DUNCA N INDUSTRI AL ELECTRI C *DU ANE MCGOVE R
3 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR N 9173728 1239173728 100A45PITT SFIELD SUP PLY CO *G EORGE NEWT ON 215348 2
4 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
BLOCK 2 DATA 517 CHAR COAX-1222 3 COAX IAL CABLE FT NYCB/O 121593 CALAVAIL - 091793
0016-00 -001 DATA 517 1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR 02505A 90EAST COA ST ELECTRI CAL SUPPLY CARL KRAGEN 7184583928 7184583900 A87BROOKLY N
1 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR GEO RGE MUSIAL 21237218 2721237218 00A92DUNCA N INDUSTRI AL ELECTRI C *DU ANE MCGOVE R
3 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR N 9173728 1239173728 100A45PITT SFIELD SUP PLY CO *G EORGE NEWT ON 215348 2
4 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
RECRD 1 DATA 517 CHAR COAX- 12222 COAXIAL CA BLE FT NYCB /O 12 1593CALAVA IL 1004 9
0031-07 -000 DATA 5170 1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR 3 02 505A90EAST COAST ELE CTRICAL SU PPLY C ARL KRAGEN 718458 3928718458 3900A87BRO O
1 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR KLYN ELEC TRIC SALLY KING 71883 2938471883 29300A76FR ASER ELECT RIC
2 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR GEORGE MU SIAL 2123 7218272123 721800A92D UNCAN INDU STRIAL ELE CTRIC *DUANE MC G
3 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
OUTPUT 1 DATA 517 CHAR C OAX-12222 COAXIA L CABLE ****** NYCB/O 121593CA LAVAIL 1
1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR 00493 02505A90 EAST COAST ELECTRICA L SUPPLY CARL KR AGEN 71 8458392871 84583900A8 7
1 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR MCGOVERN 917372812 3917372810 0A45PITTSF IELD SUPPL Y CO *GEO RGE NEWTON
4 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
LIST Request
Figure 8-28 shows the SYSLIST output generated when a LIST function is requested. Note
that no record information (length) is printed. Because of this, listed records of more
than 100 bytes can produce confusing output.
File-AID adds “tags” to the left-hand columns of output for changed or truncated records.
The TRUNCATED and CHANGED tags are output when a LISTALL function with EDIT
parameters is executed. When using logical JCL processing, an ADDED tag is printed if
records are added during editing. Other examples of tags are shown in Figure 8-35 on
page 8-16.
***C H A N G E D*** COAX -12222 COFFEE TA BLE FT NYC B/O 12 1593CALAVA IL 1004 9
3 0 2505A90EAS T COAST EL ECTRICAL S UPPLY CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800A92 DUNCAN IND USTRIAL ELE CTRIC *DUANE MC G
OVERN 91 7372812391 73728100A4 5PITTSFIEL D SUPPLY C O *GEORGE NEWTON 21 5
34829122 153482900
***C H A N G E D*** COAX -12223 COFFEE TA BLE FT NYC B/O 12 1593CALAVA IL - 0917 9
3 0 2505A90EAS T COAST EL ECTRICAL S UPPLY CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800A92 DUNCAN IND USTRIAL ELE CTRIC *DUANE MC G
OVERN 91 7372812391 73728100A4 5PITTSFIEL D SUPPLY C O *GEORGE NEWTON 21 5
34829122 153482900
***C H A N G E D*** COAX -12223A COFFEE TA BLE FT NYC B/O 12 0593CALB/O 1231 9
3 0 2505A90EAS T COAST EL ECTRICAL S UPPLY & CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800A92 DUNCAN IND USTRIAL ELE CTRIC *DUANE MC G
OVERN 91 7372812391 73728100A4 5PITTSFIEL D SUPPLY C O *GEORGE NEWTON 21 5
34829122 153482900
***C H A N G E D*** COAX -747 COFFEE TA BLE FT NYC B/O 12 1593CALNOS TCK
0 2503A90EAS T COAST EL ECTRICAL S UPPLY & CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800
***C H A N G E D*** COAX -747-A COFFEE TA BLE FT NYC AVAIL & 12 1593CALAVA IL 1129 9
3 0 2505A90EAS T COAST EL ECTRICAL S UPPLY & CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800A72 MIDWEST SU PPLY CO *MICHELLE
MATTHEWS 40 2728338140 27283300A1 5WESTERN E LECTRIC SU PPLY @JOHN NE WTON 90 6
73636729 067363600
***C H A N G E D*** COAX -777-LONG COFFEE TA BLE FT NYC B/O 12 2093CALAVA IL 1013 9
3 0 2503A90EAS T COAST EL ECTRICAL S UPPLY CARL KRAGE N 718458 3928718458 3900A87BRO O
KLYN ELE CTRIC SALLY KIN G 7188 3293847188 329300A76FR ASER ELECT RIC
GEORGE M USIAL 212 3721827212 3721800
EF90 00 AIR CONDI TIONING UN ITS EA g/ NYC B/O *12 2793CALAVA IL *0815 9
3 * *0 9004H21IND USRTIAL AI R JEFFREY RO KOP 312928 3721312928 3700H32MID W
EST COOL ING SUPPLI ES & KAREN LID SKY 4062 8273784062 827300H40AI R CONDITIO NING SUPPL I
ES *ALLEN MC LAIN 313 7373821313 7373800V01 COOLING MA X INC *PAUL VER M
ANN 2147736271 2147736200
Output Reports 8-13
FPRINT Request
Figure 8-29 shows the output that FPRINT (formatted print) generates with the default
SHOW=FORMAT parameter. SHOW=FORMAT presents a field length and field format for
each layout field. See Appendix B, “Data Format Abbreviations” for more information.
26 - JUL - 1999 FILE- AID 8.8 PR INT FACILI TY 10:1 7:51 PAGE 1
Figure 8-30 on page 8-14 shows the output that FPRINT (formatted print) generates when
the SHOW=OFFSET parameter is coded. SHOW=OFFSET reports the offset of each layout
field from the beginning of the record, in bytes relative to 0.
8-14 File-AID/MVS Batch Reference Manual
26 - JU L - 1999 FILE -AID 8.8 P RINT FACIL ITY 11: 17:51 PAG E 1
Figure 8-31 shows the output that FPRINT (formatted print) generates when the
SHOW=PICTURE parameter is coded. SHOW=PICTURE presents the picture clause
associated with each layout field.
FI LE CONTENT S REPORT
F ile Printe d US ERID0.FASA MP.EMPLOYE E
T ype VS AM KSDS
5 EMP-NUMBE R X( 5) 000 90
5 EMP-LAST- NAME X( 15) MAR TIN
5 EMP-FIRST -NAME X( 10) EDW ARD
5 EMP-MID-I NIT X M
5 FILLER XX
5 EMP-TITLE X( 30) AIR PLANE MANU FACTURER
5 EMP-PERSO NAL-INFO SY NC G ROUP
10 EMP-NA TL-ID-NUMBE R 9( 9) 427 890125
10 FILLER X
10 EMP-DA TE-OF-BIRTH X( 6) 101 954
10 EMP-HI RE-DATE X( 6) 920 101
10 EMP-MA RITAL-STATU S X M
5 EMP-WITHO LD-INFO SYN C G ROUP
10 EMP-LI FE-INS-WITH OLD-AMT D ISPLAY 300 00}
S9 (4)V99 -30 00.00
10 EMP-NA TL-TAX-WITH OLD-PCT S9 99V99 -74 .00
10 EMP-RE GION-TAX-WI THOLD-PCT
S9 99V99 25. 00
10 EMP-LO CAL-TAX-WIT HOLD-PCT
S9 99V99 5.0 0
5 EMP-HOME- ADDRESS SYN C G ROUP
10 EMP-ST REET-ADDRES S X( 25) 859 O’FARREL ST.
10 FILLER X
10 EMP-CI TY X( 15) SAN FRANCISCO
10 EMP-ST ATE-PROV-CN TY SYNC G ROUP
15 EMP- STATE XX CA
15 FILL ER XX
10 EMP-PO STAL-CODE 9( 5) 121 21
5 EMP-EMERG ENCY-CONTAC T SYNC G ROUP
10 EMP-CO NTACT-NAME X( 25) BIL L JONES
10 FILLER XX
10 EMP-CO N-WORK-PHON E X( 10) 408 5555897
10 EMP-CO N-HOME-PHON E X(10) 4 155556981
Output Reports 8-15
Figure 8-32 shows the output that FPRINT (formatted print) generates when the
SHOW=NUMBER parameter is coded. SHOW=NUMBER presents a number, assigned by
File-AID, for each layout field.
FI LE CONTENT S REPORT
F ile Printe d US ERID0.FASA MP.EMPLOYE E
T ype VS AM KSDS
5 EMP-NUMBE R 1 000 90
5 EMP-LAST- NAME 2 MAR TIN
5 EMP-FIRST -NAME 3 EDW ARD
5 EMP-MID-I NIT 4 M
5 FILLER 5
5 EMP-TITLE 6 AIR PLANE MANU FACTURER
5 EMP-PERSO NAL-INFO SY NC 7
10 EMP-NA TL-ID-NUMBE R 8 427 890125
10 FILLER 9
10 EMP-DA TE-OF-BIRTH 10 101 954
10 EMP-HI RE-DATE 15 920 101
10 EMP-MA RITAL-STATU S 16 M
5 EMP-WITHO LD-INFO SYN C 17
10 EMP-LI FE-INS-WITH OLD-AMT 18 300 00}
18 -30 00.00
10 EMP-NA TL-TAX-WITH OLD-PCT 19 -74 .00
10 EMP-RE GION-TAX-WI THOLD-PCT
20 25. 00
10 EMP-LO CAL-TAX-WIT HOLD-PCT
21 5.0 0
5 EMP-HOME- ADDRESS SYN C 22
10 EMP-ST REET-ADDRES S 23 859 O’FARREL ST.
10 FILLER 24
10 EMP-CI TY 25 SAN FRANCISCO
10 EMP-ST ATE-PROV-CN TY SYNC 26
15 EMP- STATE 27 CA
15 FILL ER 28
10 EMP-PO STAL-CODE 29 121 21
5 EMP-EMERG ENCY-CONTAC T SYNC 30
10 EMP-CO NTACT-NAME 31 BIL L JONES
10 FILLER 32
10 EMP-CO N-WORK-PHON E 33 408 5555897
10 EMP-CO N-HOME-PHON E 34 415 5556981
VPRINT Request
Figure 8-33 shows the output that VPRINT (vertical formatted print) generates for the
FASAMP.EMPLOYEE sample file. Data is truncated once the 132-character limit is
reached. Fields one through seven are shown.
EMP-NUMBE R EMP-LAST -NAME EM P-FIRST-NA ME EMP-MID -INIT FILL ER EMP-T ITLE EMP-P ERSONAL-IN FO
5/AN 15/AN 10 /AN 1/AN 2/AN 30/AN 23/GR P
(1-5) (6-20) (2 1-30) (31-31) (32- 33) (34-6 3) (64-8 6)
1-------- - 2------- ------- 3- ---------- -- 4------ ----- 5--- ---- 6---- ---------- ----------- ---- 7---- ---------- --------
00090 MARTIN ED WARD M AIRPL ANE MANUFA CTURER 42789 0125 10195 4920101M
00100 MULSTROM RO BERTA A HOLLY WOOD SEAMS TRESS 34657 3656 09085 9920111S
00200 JACKSON JO SEPH C ORATO R 27558 7177 02046 2920121S
10000 ANDREWS GE ORGE ACTOR 57631 2032 04224 8920131S
15000 MURPHY RO NALD L PAINT ER 98765 4321 12025 5920201S
18034 SCHNEIDE R EL LEN C NURSE 34155 9549 03296 0920211S
21035 JONES GE ORGE B COUNT RY SINGER 46381 3456 09094 4920221S
25100 ROBERTS WI LLIAM R POLIT ICIAN 87956 3325 05086 5920301S
Figure 8-34 on page 8-16 shows the output that VPRINT (vertical formatted print)
generates when the FIELDS parameter is coded for the FASAMP.EMPLOYEE file with the
FIELDS 1-3, 6, and 10 specification.
8-16 File-AID/MVS Batch Reference Manual
RECRD 1 DATA 517 CHAR COAX- 12222 COFFEE TAB LE FT NYCB /O 12 1593CALAVA IL 1004 9
***C H A N G E D*** ZONE 0000CDCE6 FFFFF44444 CDCCCC4ECC DC44444444 4444444444 4444444444 CE0020DECC 6D444000FF FFFFCCDCEC CD4100FFFF F
NUMR 250036170 1222200000 3666550312 3500000000 0000000000 0000000000 63005C5832 1600030C12 1593313151 93000C1004 9
1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR 3 02 505A90EAST COAST ELE CTRICAL SU PPLY C ARL KRAGEN 718458 3928718458 3900A87BRO O
ZONE F030000FF FFFCFFCCEE 4CDCEE4CDC CEDCCCD4EE DDDE44020C CDD4DDCCCD 4444444444 4444FFFFFF FFFFFFFFFF FFFFCFFCDD D
NUMR 300C10C02 5051905123 0361230535 3399313024 77380000C3 1930291755 0000000000 0000718458 3928718458 3900187296 6
1 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR KLYN ELEC TRIC SALLY KING 71883 2938471883 29300A76FR ASER ELECT RIC
ZONE DDED4CDCC EDCC444444 4444444030 ECDDE4DCDC 4444444444 44444FFFFF FFFFFFFFFF FFFFFCFFCD CECD4CDCCE DCC4444444 4
NUMR 238505353 3993000000 000000000C 2133802957 0000000000 0000071883 2938471883 2930017669 1259053533 9930000000 0
2 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
CHAR GEORGE MU SIAL 2123 7218272123 721800A92D UNCAN INDU STRIAL ELE CTRIC *DUANE MC G
ZONE 444444404 0CCDDCC4DE ECCD444444 444444FFFF FFFFFFFFFF FFFFFFCFFC EDCCD4CDCE EEDCCD4CDC CEDCC44440 45CECDC4DC C
NUMR 000000005 C756975044 2913000000 0000002123 7218272123 7218001924 4531509544 2399130535 3399300000 7C44155043 7
3 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95.... .
BLOCK 2 DATA 328 CHAR q & & J K & && K+ < K +& N & n & j & %K
ZONE 9ED01B004 1B10009501 00051D05D1 01D5101511 05110D0D41 055D445511 6D4D4BDD0D 450D051B34 7B5905047B 5985048B6D
NUMR 0C0C8F705 0000008800 0AA0008000 4818000800 0800423080 C800810087 62E0C0C270 E045201187 00A5003700 A1003700C2
1...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95....
CHAR D Nq
ZONE 50BC41D00 01D9ED01F0 F444444444 4444444444 4444444444 4444444444 4444444444 4444444444 4444444444 4444444444
NUMR 80041000A A858C0C7F7 E000000000 0000000000 0000000000 0000000000 0000000000 0000000000 0000000000 0000000000
2 01...5...1 0...15...2 0...25...3 0...35...4 0...45...5 0...55...6 0...65...7 0...75...8 0...85...9 0...95....
RECR D -1 D ATA 355 C HAR 38 00-3XL2006 IBM LAS ER PRNTR W / ALL PNTS ADDRESSAB LE EA N YCAVAIL 121593CAL NOSTCK
0031 -07-003 D ATA 5105 1...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR 50003I02F ERGUSON CO MPUTERS *MARTHA S MITH 212 8373647212 8373600I04 THE
101...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR PRINTE RS SUPPLY STORE KEN JAC KSON 71 3883728371 38837200I1 0PRINTERS AND MORE
201...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
RECR D -2 D ATA 355 C HAR 38 00-3XL2005 IBM LAS ER PRNTR W / ALL PNTS ADDRESSAB LE EA N YCAVAIL 121593CAL AVAIL 0 1099
1...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR 4 50003I02F ERGUSON CO MPUTERS *MARTHA S MITH 212 8373647212 8373600I04 THE
101...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR PRINTE RS SUPPLY STORE KEN JAC KSON 71 3883728371 38837200I1 0PRINTERS AND MORE
201...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
RECR D -3 D ATA 355 C HAR 38 00-3XL2004 IBM LAS ER PRNTR W / ALL PNTS ADDRESSAB LE EA N YCB/O 121593CAL AVAIL @0 1159
1...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR 4 50003I02F ERGUSON CO MPUTERS *MARTHA S MITH 212 8373647212 8373600I04 THE
101...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
C HAR PRINTE RS SUPPLY STORE KEN JAC KSON 71 3883728371 38837200I1 0PRINTERS AND MORE
201...5. ..10...15. ..20...25. ..30...35. ..40...45. ..50...55. ..60...65. ..70...75. ..80...85. ..90...95. ....
SYSTOTAL Output
This section describes the following reports and messages generated to the SYSTOTAL
DD:
• SYSTOTAL heading
• Comments
8-18 File-AID/MVS Batch Reference Manual
• Accumulations
• Data Type Accumulations Example
• Negative Accumulations Example.
Heading
Figure 8-39 shows the SYSTOTAL heading line that identifies the output as the audit
totals page. The heading contains the File-AID release level, the date, and the time of
execution. Time is listed in hours, minutes, and seconds.
Comments
Figure 8-40 shows SYSTOTAL comment card output. Any control cards containing an
asterisk (*) in column 1 are written to the SYSTOTAL report. This allows you to format
your own report headings. Comments are printed as entered on SYSTOTAL. If centering
of comment text is desired, just center your comments in the comment card. If a
SYSTOTAL DD is not provided, comments are printed as entered on SYSPRINT, and
reported as shown in Figure 8-7 on page 8-5.
Accumulations
Figure 8-41 shows the output generated on SYSTOTAL each time accumulations are taken
on a different dataset. The output consists of the line: FOLLOWING TOTALS DEVELOPED
FROM, followed by a line identifying the dataset name, and the first volume serial
number.
Figure 8-42 shows the SYSTOTAL accumulations output. The first two lines show the
default description that SYSTOTAL uses when no description is entered. The default
description includes the location entered in the ACCUM parameter. The third and fourth
lines are descriptions coded in the ACCUM parameter.
Output Reports 8-19
LOCATION 00087-------------------16323600
LOCATION 00099---------------------174489
LIFE INS SINGLE TOT---------------8060000
LOCAL TAX SINGLE TOT-----------------9950
Figure 8-43 shows the control cards used for these accumulations.
*
* ACCUMULATE FIELDS COMMENT CARD 1
* COMMENT CARD2
*
FOLLOWING TOTALS DEVELOPED FROM
USERID0.ACCUM.DATA VOL=VOL002
ACCUMULATE CHARACTER-----------------5555
BINARY ACCUMULATION--------------------10
ACCUMULATE PACKED DATA-----------------25
*
* ACCUMULATE FIELDS COMMENT CARD 1
* COMMENT CARD2
*
$$DD01 DUMP REPL=(2,C’111’),
ACCUM=(2,4,C,’ACCUMULATE CHARACTER’),
REPL=(9,X’000002’),
ACCUM=(9,3,B,’BINARY ACCUMULATION’),
REPL=(50,X’000000000000005C’),
ACCUM=(50,’ACCUMULATE PACKED DATA’)
LOCATION 00001--------------------------2
LOCATION 00005--------------------------2
LOCATION 00009--------------------------2-
LOCATION 00005-------------------------10
Chapter 9.
Message Codes C ha p 9
When an error message is generated, the word ERROR displays at the right-hand side of
the line. When a problem occurs after datasets are opened for input or output, the word
ERROR may be followed by additional File-AID error codes.
Each error code is described below. Examples of typical error messages in File-AID output
reports are shown in “Output PDS Error Log” on page 8-7.
Code Description
No dataset in the job stream matches the dataset identified in the control statement
DE01
($$DDxx).
An error was encountered while retrieving the dataset control block (DSCB) for the
displayed dataset identifier. This message is followed by a feedback code (FDBK=) that
reflects the codes that return from the OBTAIN macro. The feedback codes are
DE02 • 04 - Volume containing the dataset cannot be mounted.
• 08 - The DSCB is not on the disk specified in the catalog.
• 12 - Found a permanent I/O error while trying to retrieve a DSCB for the
identified dataset.
Cannot calculate access method of the dataset due to incorrect disk space allocation or
DE03 a system error. Ensure that the correct access method is used. If the error persists,
reallocate the dataset.
Received an error from a generate control block macro while an exit list for a VSAM
DE04 dataset was being built. A DE04 occurs only when many concurrent VSAM datasets are
created with a WRITE parameter. Allocate a larger region size.
Allocated insufficient space to build an access method control block for a VSAM dataset.
DE05
Allocate a larger region size.
Region size is insufficient to build a request parameter list for a VSAM dataset. Allocate a
DE06
larger region size.
Cannot determine the VSAM dataset type (KSDS, ESDS, RRDS). This is probably a system
DE07
error. Delete and reallocate the datasets.
9-2 File-AID/MVS Batch Reference Manual
Code Description
Returned an error from an open macro or found a DCB abend. For VSAM datasets, a
feedback code (FDBK=) prints to help determine the exact error. The most common
feedback codes are:
• 136 - Insufficient memory is available to contain all work areas or
buffers.
• 160 - Found inconsistent operands in the control blocks. You can get this
DE08 code by accessing an empty dataset.
• 168 - A dataset is not available for the requested processing type. It may
be protected by password while being opened for update.
• 184 - I/O error cannot be corrected.
Other feedback codes are described in the IBM OS/VS Virtual Storage Access Method
(VSAM) Programmer’s Guide.
DE09
VSAM issued a warning message. A warning return code prints and dataset processing is
attempted
DE51
Found an invalid member pointer in a PDS directory. The member in error is logged as
skipped and processing continues.
DE52
The output PDS directory is full. Processing stops.
Detected an I/O error on a dataset. For non-VSAM datasets, the error message is like
those received from a SYNADAF macro instruction. For VSAM datasets, a feedback code
(FDBK=) prints. The most common feedback codes are:
• 08 - Attempted to store a record with a duplicate key.
DE53 • 12 - Attempted to load or store a keyed record out of sequence.
• 28 - Cannot extend a dataset due to lack of space.
• 32 - Specified a relative location that extends beyond the end of the
dataset.
Other feedback codes are described in the IBM OS/VS Virtual Storage Access Method
(VSAM) Programmer’s Guide.
Return Codes
When an error is detected, all processing on the accessed dataset stops unless the error is
ignored. All subsequent control cards for the erroneous dataset are checked for validity
and then bypassed. The decimal return codes issued by File-AID always reflect the highest
error detected during execution. File-AID return codes are described below.
Code Description
(1) Found an error while decoding a control card. After printing an error message on
SYSPRINT, File-AID skips to the next valid control card.
(2) Issued a warning message for a VSAM dataset. After logging the warning on
SYSPRINT, File-AID attempts to process the dataset.
04 (3) One or more records were truncated in a COPY operation.
(4) FORM=JCL is specified for processing a PDS and the continued portion of a continued
JCL statement is missing. The member(s) is identified on SYSLIST. File-AID processing
halts for the member(s) at the location of the missing continuation. As a result, the
member(s) does not complete processing.
Message Codes 9-3
Code Description
(1) No valid input or output DD statements match a control card. The invalid DD name
prints on SYSPRINT and File-AID skips to the next valid control card.
(2) No records copied to the output dataset during a COPY, DROP or USER function.
(3) No VTOC information produced during any VTOC function (VTOCDSN, VTOCINFO,
or VTOCMAP).
(4) No File-AID load module loaded when executing either COMPARE or any VTOC
function.
08
(5) Your system does not allow this function. Check SYSPRINT for error information. File-
AID stops processing the current function and continues with the next valid control
statement.
(6) File-AID is unable to compile the specified record layout for FPRINT, RLPRINT, VPRINT,
or XRPRINT. File-AID stops processing the current function and continues with the next
valid control statement, or for XRPRINT, File-AID completes the function without the
record layout.
28 Open for SYSPRINT failed. Processing stops. Refer to “Getting Help” on page xii.
File-AID is unable to dynamically allocate SYSLIST. Processing stops. Add //SYSLIST to job
32
stream.
36 Open for SYSLIST failed. Processing stops. Refer to “Getting Help” on page xii.
Specified an invalid parameter on the JCL EXEC card. Processing stops. Check the values
44
in the EXEC card.
48 Entered a bad access code. Processing stops. Refer to “Getting Help” on page xii.
Attempted to print invalid audit trail file. Processing stops. Specify a valid audit trail file
52
name.
Attempted to print unformatted audit trail report, but was unable to load the print
102
program - FAAUNPR. Possible install error - check installation steps.
128 Internal File-AID error occurred. Processing stops. Refer to “Getting Help” on page xii.
Internal error processing security occurred. Processing stops. Refer to “Getting Help” on
129
page xii.
255 Compuware security failed. Processing stops. Refer to “Getting Help” on page xii.
9-4 File-AID/MVS Batch Reference Manual
A-1
Examples App A
This appendix provides examples of File-AID control cards that solve specific problems.
Each example is organized as follows:
For each example, the JCL described in “JCL Required for Execution” on page 2-13 is
assumed to be present.
A table that references the functions and parameters used in each example of this
appendix is shown in Table A-1. The examples are organized according to the complexity
of their syntax, with the most simple examples presented first and the most complex
examples presented last.
Example 1:
The output is a hexadecimal print of the first 500 records of the dataset.
Example 2:
Dump 250 records from a physical sequential dataset which contain the type-code
character string 10 or 11 beginning in location 1.
A logical OR condition is created by coding multiple data entries. This statement creates
a hexadecimal printout of the first 250 records that contain the character string 10 or 11
beginning in location 1.
Example 3
Create a test file that consists of every third record that has the type code A in location
14. Copy only 100 records to the test file and dump the first 20 selected records.
A file is created and written to the dataset named DD01O. Every third record that meets
the selection criteria is written to DD01O, up to a maximum of 100. Twenty records are
dumped.
Example 4:
From a physical sequential dataset, dump 25 records that contain the character A or B in
location 10 and the department code 101 or 102 in location 43-45.
Logical OR conditions are created by coding multiple entries in the data elements of each
IF parameter, and a logical AND condition is created by coding contiguous IF parameters.
Example 5:
Print 10 records that contain the character string 50 beginning in location 47, and 15
records that contain the character string 15 beginning in location 47.
The parameters on line 2 are ORed with those on line 1 because they are separated by the
OUT parameter on line 1. Twenty-five records are printed. If the record types are
interspersed, they are printed in the order in which they are read.
Example 6:
To create a test file, extract 50 records from department 201 (location 46-48) and 50
records from department 202. Accumulate the total pounds (location 49-54) and total
dollars (location 55-60) in these records to provide a way to verify test results. The
pounds field is packed; the dollars field is numeric. Dump ten records from each
department.
Example 7:
Given the same dataset as described in Example 6, create two test files, one for
department 201 records and another for department 202 records. Accumulate and dump
the same records as those described in Example 6.
The USER function creates two test files concurrently. The WRITE parameter names A and
B must correspond to the names on DD statements in the JCL job stream.
Example 8:
$$DD01 CA REPL=(49,2P’+0’),
IF=(45,4,NEP),
REPL=(45,X’0000000C’)
A-4 File-AID/MVS Batch Reference Manual
The COPYALL function is used because File-AID must apply multiple actions to each
record. The first REPL parameter places packed zeros in the two contiguous packed-
decimal fields beginning in location 49. The IF parameter locates any record that does
not contain packed data in locations 45 through 48. The second REPL parameter places
packed zeros in location 45 through 48 of any record selected by the IF parameter. The
full hexadecimal representation of the entire packed field is entered so that File-AID
calculates the correct field length. It is used because the REPL parameter requires a valid
packed field to be present before replacing a packed value. The output DD labeled DD01O
is required in the JCL job stream.
Example 9:
The date record at the beginning of a production file has the wrong year. The year is in
locations 32 through 33 and should be the character string 91. The date record has all
low values in locations 1 through 10. Correct the record and verify the results.
The entire dataset is copied. The REPL parameter locates a record containing low values
in locations 1 through 10 and replaces the date in locations 32 through 33 with the
string 91. One selected date record is dumped on the SYSLIST dataset.
Example 10:
Create a backup of a variable-length VSAM dataset that can be used as sequential input
for other tasks.
$$DD01 COPY
Because variable-length VSAM records do not contain an RDW, one is created for each
record.
Example 11:
Two output DD statements must be entered in the JCL job stream for datasets A and B, as
discussed in “JCL Required for Execution” on page 2-13.
Example 12:
Add multiple members to a PDS from three different sequential input datasets.
The NEWMEM parameter is used to assign the new member name in the PDS referenced
by DD name A (WRITE=A). Data records for MEMA are copied from the DD01 input
dataset. MEMB records are copied from DD02, and MEMC records are copied from DD03.
Example 13:
A large report has been spooled to tape. Before printing it, check the totals to make
certain the report balances. The report page is identified by the heading FINAL TOTAL
beginning in location 60. It is the last page of the report that uses ASA print control
characters.
The first STOP parameter locates each header line. The second STOP locates the page
heading FINAL TOTAL After finding this string, the LIST parameter sends the final total
page to the printer.
Example 14:
Two datasets were created with the same name, but only one contains the correct totals.
The datasets are history files that contain two years of data organized by month.
Determine the correct dataset by adding the data fields for January, 1989 and January,
1990. The year is in locations 10 through 11, month is in 14 through 15, and the packed
field to be added is in locations 16 through 21.
The TALLY function is used because the logic requires multiple parameter groups. The
first group, which consists of the first three parameters, accumulates the 1989 data. The
second group, consisting of the last three parameters, accumulates the 1990 data.
Although the SYSTOTAL dataset is optional, it produces a separate report that shows the
DSN of each dataset and the totals developed from each ACCUM parameter.
Example 15:
The sales department needs a report that lists the totals of all sales for the last two years.
The department also wants to know the January totals for each year. The input dataset is
the same as that described in Example 14.
Because the first ACCUM parameter is not preceded by an IF parameter, it accumulates all
records in the input dataset. Two parameter groups follow the first ACCUM. Group 1
accumulates the JANUARY, 1989 total; Group 2 accumulates the JANUARY, 1990 total.
Use of the optional SYSTOTAL dataset causes these totals to appear on the SYSTOTAL
dataset.
Example 16:
Due to a program failure, a packed field in locations 42 through 46 that should be zeros
in certain records was added to the totals. This addition puts the dataset out of balance.
The erroneous record types are identified as:
The first ACCUM parameter (TOTAL) accumulates the dataset’s grand total before any
fields are replaced. Two parameter groups follow the first ACCUM. Group 1 accumulates
the type 2, subtype 1, 2, and 3 records, then places zeros in them. Group 2 accumulates
the type 3, subtype 5, 6 and 7 records, then places zeros in them. To verify the
corrections, obtain the net amount by subtracting the type 2 and type 3 totals from the
grand total. The replace map produced in the SYSPRINT dataset shows the number of
corrections to each record type.
Example 17:
Create a VSAM test dataset from the current VSAM master dataset that has 1,000 random
even-numbered accounts beginning with account number 10000. The account numbers
are in locations 3 through 8 of the input dataset records. The account number field is the
key field and is character numeric data.
The binary data element of the IF parameter drops all odd-numbered account numbers,
leaving only even-numbered accounts in the output dataset. The SELECT parameter
selects every third even-numbered account number. The output VSAM dataset requires a
DD of DD01O in the JCL job stream.
Substituting the COPY function for the DROP function copies only odd-numbered
accounts:
In both versions of Example 17, the KEY parameter causes File-AID to begin processing at
account number 10000.
Example 18:
Erroneous records were generated in a dataset. Drop them and calculate the effect of the
drop to the dataset. The erroneous records are identified by a hexadecimal value FF in
location 28. The character field to be accumulated for totals is in locations 12 through
19.
The first ACCUM parameter (TOTAL) sums all records in the dataset. The second ACCUM
parameter (DROPPED) sums only the dropped records. Determine the net amount by
subtracting the dropped sum from the total sum.
Example 19:
Create a VSAM test dataset from a VSAM master dataset consisting of every fifth record
that contains account numbers 10000 through 10999 and 15000 through 15999, and has
a subtype character 5 in location 9. The account number is the key and is in location 3-8
in a character numeric format.
Examples A-7
The KEY parameters begin processing at account number 10000, then again at 15000. The
STOP parameters stop at account numbers greater than 10999 and 15999, respectively.
The IF parameters narrow the COPY function to subtype 5, and the SELECT copies every
fifth record. An output DD named DD01O that describes a VSAM cluster is required in
the JCL.
Example 20:
Determine the production accounts-receivable JCL procedures that use the dataset
AR.MASTER. The member names of the accounts-receivable procedures begin with the
characters AR, and are considered production procedures when a P is in location 8 of the
member name.
If the parameter PARM=TSO is coded on the JCL EXEC statement, File-AID does not skip
to a new page for each new member name. In this example, the MEMBERS parameter
limits the search to members that begin with the characters AR and end with the
character P. The IF parameter is a scanning parameter that further limits the search to
records that contain the characters DSN=AR.MASTER. When a match is found, the
record is listed; processing continues until all members that meet the selection criteria
are searched.
Example 21:
Due to an oversight, a packed field in certain records of a variable length dataset will
overflow because the field is too small to contain the data. The affected records contain
the character A in data byte 1. Change the current dataset to increase the field length by
one byte. The field to be lengthened begins at location 102. In addition, add a four-byte
packed field to the end of all records of the dataset that contain a character B in data byte
1. The input and output records are both variable length.
The COPYALL function copies the entire dataset. Because the records are variable length,
the first addressable data location is 5 (since the RDW is in 1-4). If a record is type A (line
1), the first 101 bytes of the input record are moved to the output record (line 2). Next, a
hexadecimal zero (X’00’) is inserted into the next available output location (+0 in line 3).
This byte lengthens the packed field. The remainder of the record is then moved to the
next output location (+0 in line 4).
The zero length element of the MOVE parameter in line 4 causes File-AID to calculate the
remaining length in the input record based on the entered location (record length - 106 =
remaining length). If the input record’s remaining length is less than the length
remaining in the output record, the input record remaining length is used as the length
element in the MOVE parameter. If the input record’s remaining length is greater than
that of the output record, the output record’s maximum remaining length is used.
If a record is type B (line 6) the data portion of the record (excluding the RDW) is moved
to the output record (line 7). The zero length of MOVE in line 7 causes File-AID to again
A-8 File-AID/MVS Batch Reference Manual
calculate the correct remaining length. A hexadecimal field (actually a packed field) is
then moved to the end of the record (line 8). File-AID calculates a new record length for
both record types A and B, creates the RDW, puts the length into the RDW, and writes
the new record. Records that are not either type A or B are copied without changes.
The DUMP parameter in line 5 prints the first five sets of records processed by the MOVE
parameters in lines 2, 3, and 4. A set consists of both the input and output record. The
DUMP parameter in line 9 dumps five sets of records processed by the MOVE parameters
in lines 7 and 8.
Example 22:
A dataset was created with the sign reversed (positives are negative, negatives are
positive) in a packed field in location 26-30. Reverse the sign.
File-AID copies the entire dataset because no selection (IF) criteria are specified. The
REPLACE parameter references the sign in the right most location of the field in error.
Using an exclusive OR to the last bit of the signed field (BX’01’) changes C (positive)
signs to D (negative), and D to C.
Example 23:
Create a test VSAM dataset of 1,000 random records, beginning with the record of the
input ISAM master file that contains account number 12345. Select only those records
that have departments 1 or 12 within plant 6 or department 15 within plant 5. The
account number is a five-byte character field and is the key. The plant number is a
character field in location 22. The department number is a three-byte packed field
beginning in location 46.
The output DD statement named DD01O that references a VSAM dataset is required in
the JCL. The OUT and SELECT parameters are location-dependent, but because only one
set of IF parameters is used, their location is irrelevant. Every fifth record (SELECT=5) is
selected; a maximum of 1,000 records (OUT=1000) is written. Processing begins at record
key 12345, or the next higher key if 12345 is not found.
Example 24:
Create two test VSAM KSDS datasets of 1,000 random records from the ISAM master file
described in Example 23. Each test dataset begins with the record that contains account
number 12345. For the first dataset, select every third record and dump the first 25
selected records. For the second dataset, select every seventh record and dump the first
30 selected records.
The two created VSAM datasets are assumed to be empty; otherwise, File-AID considers
them to be extensions. The first SELECT parameter (line 4) writes every third record that
matches the selection criteria in lines 2 and 3 to dataset A. The first DUMP parameter
(line 4) dumps the first 25 records written to dataset A. The second SELECT parameter
(line 7) writes every seventh record that matches the selection criteria in lines 5 and 6 to
dataset B. The second DUMP parameter (line 7) dumps the first 30 records selected for
dataset B.
Examples A-9
Example 25:
Create a new test PDS with test versions of several JCL procedures that currently reside in
a production PDS. To create the test versions, copy any member that accesses the datasets
A.PROD.DATA1 or A.PROD.DATA2, and change the word PROD in the dataset names to
the word TEST. Also, rename all the copied procedures to test versions by placing a
character T in location 8 of the member name.
Because this is a copy of a PDS, using the MEM modifier with an IF condition causes only
the members that contain the data specified in the IF parameter to be copied to the
output dataset. A character T is placed in the eighth position of each copied member’s
name. For members that have eight-character positions in their name, theT overlays the
eighth position. For members that have a name of less than eight characters, the T is
shifted to the left until it is contiguous to the name.
Example 26:
The XYZ Corporation has changed its name. Determine the number of programs that
must be changed to reflect the new company name.
The production load library is scanned for XYZ CORP. Because a MOVE parameter is used
with a PRINT function, File-AID interprets PRINT as a request to print only the data that
is moved, regardless of the length of the input record. Thus, only the member name and
XYZ CORP are printed. Coding PARM=TSO on the EXEC statement eliminates needless
page skipping for each member.
Example 27:
Scan a keyed BDAM dataset with a key length of 110 bytes for the character string FLD,
which is located somewhere in the key field. Copy the selected records to a sequential
dataset.
Because the dataset is in keyed BDAM format, the key portion of the record is located
before the data portion. Since the key is 110 bytes long, the location element of the IF
parameter has a negative relative location of -110. To copy the key with the data, a
MOVE parameter is used that references the first key location. The zero length in the
MOVE parameter forces File-AID to calculate the length of the key and data portions, and
write a record containing both. Further explanation of special requirements is provided
in “Access Method Rules” on page 2-9.
Example 28:
Determine the number of records of each type that are on a file. The valid record types
are 37, 39, 47, 52, 73, and 87. The record type begins in location 129.
The SPACE function and REPL parameter are used to produce automatic counts of the
occurrences of the various record types in the dataset without actually changing data.
The counts are displayed in the ACTIONS TAKEN MAP report of the SYSPRINT output
(see “SYSPRINT Output” on page 8-1). The function statistics line of the SYSPRINT output
A-10 File-AID/MVS Batch Reference Manual
reports the total number of records in the dataset because no limiting parameters are
used. Therefore, processing continues until the end of data is reached.
Example 29:
Create a test file that contains five of each type of record found on the master file
described in Example 28.
The file is created using the location dependence of the OUT parameter, and automatic
OR conditions created by separating IF parameters with OUT, IN, SELECT, REPL, MOVE,
EDIT or DROP parameters. A total of 30 records, consisting of five of each type specified
in the IF statements, are copied to the output dataset, The REPL parameters produce an
ACTIONS TAKEN MAP report on the SYSPRINT output, which counts the number of each
record type that is being written.
Example 30:
Due to a program malfunction, the word TEST, which should have appeared once in
records in a dataset, was repeated several times. Delete the multiple occurrences.
While COPYALL copies the entire dataset, the IF parameter finds the first occurrence of
the character string TEST, and EDITALL deletes all subsequent TEST words.
Example 31:
Scan and edit all procedures to accommodate equipment changes. The changes include
converting all 1600-BPI tape drives to 6250 BPI, and changing disk drive units from
model 3480 to 3490. Three tasks must be performed. First, produce a listing that shows
the procedures and the lines within them that must be changed. Second, produce a
listing that shows the content of the procedures after these changes are made. Third,
update the changed procedures.
Three executions of File-AID are required. Execution 1 produces a listing of the lines in
each member that contain the character string TAPE1600 or 3450. This listing can be
used to verify that all members and changes in those members are identified.
Execution 2 lists the entire members after the EDIT and REPL parameters are processed.
Each line in the member that has been changed by the EDIT or REPL parameters is
flagged as changed or truncated. Note that even though the edits and replacements are
performed the LISTALL function makes no actual changes to the dataset.
Execution 3 is the same as execution 2 except that the UPDATE function is used to
permanently update the dataset.
Example 32:
Drop the DEST entry from all JCL JOB statements that contain it. The DEST entry is
assumed to be on the same card as the JOB statement and is always followed by a two-
digit number.
Examples A-11
Line 1 limits the search to JOB cards. Line 2 further limits the search to JOB cards that
contain destination entries. Line 3 replaces the two-digit unknown destination with a
common denominator. Line 4 uses double quotes for the search entry because a comma
must be deleted from this card. The LIST parameter in line 5 produces a listing of all
edited JOB cards.
Example 33:
Add the members in a sequential dataset with 80-byte records to a PDS. Each member of
the input dataset is separated by a TITLE card. The eight-character name of the member
that follows this card is located after TITLE string. Each name begins with the characters
HTH. The title card is used to build an input control card for the IEBUPDTE program
that adds the members to the PDS. The member name must also appear in locations 73
through 80 of all the output records.
The TITLE card is overlaid with an IEBUPDTE control card. The first line moves the
input record to the record work area. Line 2 finds any record with TITLE in it. Assuming
that the TITLE card is the first record of the program, line 3 finds the program name on
that record. Line 4 loads blanks into the first 72 locations of the output record. Line 5
moves the front portion of the IEBUPDTE control card. As a result of this move, the
output relative location is positioned after the constant moved in line 5. Line 6 moves
the name found in line 3 to this location. Line 7 formats locations 73 through 80 with
the same name so that when the move on line 1 is done for the following records, it
contains the name of this member. The PRINT parameter on line 8 provides a listing of
all read input title cards and all output IEBUPDTE control cards.
Example 34:
Print 10 formatted records that contain the character string 50 beginning in location 47,
and 15 records that contain the character string 15 beginning in location 47. Format the
records according to the record layout member CLIENT in the DD01M map dataset.
The parameters on line 2 are ORed with those on line 1 because they are separated by the
OUT parameter on line 1. Twenty-five formatted records are printed. If the record types
are interspersed, they are printed in the order in which they are read.
Example 35:
Split a single input file to multiple output files on different tapes. Put the first input
records, that start with C’001’, on OUTPUT1. Put the next input records, that start with
C’002’, on OUTPUT2, but use the same tape drive as for OUTPUT1. Print, in hexadecimal,
the first record of each group.
A-12 File-AID/MVS Batch Reference Manual
//DD01 DD DISP=SHR,DSN=input.file
//OUTPUT1 DD DISP=(NEW,CATLG,CATLG),DSN=output.file1,
// UNIT=tape,VOL=(,,,5),DCB=(. . .)
//OUTPUT2 DD DISP=(NEW,CATLG,CATLG),DSN=output.file2,
// UNIT=AFF=OUTPUT1,VOL=(,,,5),DCB=(. . .)
$$DD01 USER STOP=(1,NE,C’001’),WRITE=OUTPUT1,DUMP=1
$$DD01 USER STOP=(1,NE,C’002’),WRITE=OUTPUT2,DUMP=1
Note: See the discussion of the CLOSE OUTPUT DATASETS AFTER USER FUNCTION
batch install option in the File-AID Installation Guide. The setting of the CLOSE
OUTPUT DATASETS AFTER USER FUNCTION install option affects the USER
function in this example as follows:
Causes S413-04 abend on open of OUTPUT2, because the UNIT=AFF= causes it to use the
Y
same tape drive as OUTPUT1, but OUTPUT1 is still open, and hanging on the drive. These
or
values are okay if outputs are to disk, or to different tape drives. Y is the default value for this
N
install option.
Required setting if you want to put both outputs on the same tape drive, because the first
A
output must be closed and demounted before the second output can be opened or mounted.
Example 36:
Split multiple input files to multiple output files on tape. From the first input $$DD01,
put the first input records, that start with C’001’, on OUTPUT1. Put the next input
records, that start with C’002’, on OUTPUT2. Then do the same for the second input
$$DD02.
//DD01 DD DISP=SHR,DSN=input.file1
//DD02 DD DISP=SHR,DSN=input.file2
//OUTPUT1 DD DISP=(NEW,CATLG,CATLG),DSN=output.file1,
// UNIT=tape,VOL=(,,,5),DCB=(. . .)
//OUTPUT2 DD DISP=(NEW,CATLG,CATLG),DSN=output.file2,
// UNIT=tape,VOL=(,,,5),DCB=(. . .)
$$DD01 USER STOP=(1,NE,C’001’),WRITE=OUTPUT1
$$DD01 USER STOP=(1,NE,C’002’),WRITE=OUTPUT2
$$DD02 USER STOP=(1,NE,C’001’),WRITE=OUTPUT1
$$DD02 USER STOP=(1,NE,C’002’),WRITE=OUTPUT2
Note: See the discussion of the CLOSE OUTPUT DATASETS AFTER USER FUNCTION
batch install option in the File-AID Installation Guide. The setting of the CLOSE
OUTPUT DATASETS AFTER USER FUNCTION install option affects the USER
function in this example as follows:
Causes data loss, because the outputs are closed after USER statement 2, and rewritten from
Y
the beginning by USER statements 3 and 4. Y is the default value for this install option.
Required setting for splitting multiple input files to multiple output files. If output files are on
N tape, you must give each output file it own tape drive. Do not use UNIT=AFF= because it will
cause a S413-04 abend. See Example 35.
Causes data loss, because the outputs are closed after each USER statement, and rewritten
A
from the beginning by USER statements 3 and 4.
B-1
This appendix describes the data format abbreviations used by File-AID when the FPRINT
function or parameter is used to print records with the SHOW=FORMAT parameter.
Abbreviations are used for the data format descriptions of each layout field, to allow the
field usage information to fit within the confines of the Field Description area. Contents
of this appendix includes:
See Table B-1 for a list of COBOL abbreviations, and Table B-2 for a list of PL/I
abbreviations.
abend. ABnormal END of task. The termination blank. Part of a data medium in which no charac-
of a job, prior to normal completion, due to an ters are recorded; its hexadecimal character repre-
unresolved error condition. sentation is X’40’.
ABEND. Parameter that alters default abend han- block. String of records, string of words, or a
dling procedures. character string formed for technical or logic rea-
sons to be treated as an entity.
access method. Technique for moving data
between main storage and input/output devices. Boolean operator. Operator that results in one of
two values: TRUE or FALSE.
access mode. Technique that is used to obtain a
specific logical record from, or to place a specific BPAM. Basic Partitioned Access Method.
logical record into, a file assigned to a mass stor-
age device. catalog. Directory of locations of files and librar-
ies.
ACCUM. Parameter that accumulates totals while
performing a function. CEM. Parameter that copies empty members of a
partitioned dataset.
ALL. Function modifier that allows a function to
process an entire dataset. character. Data notation system that uses one
byte to represent a letter, digit or symbol.
alphanumeric. Data notation system consisting
of letters A through Z, any one byte unsigned dig- character string. String of data consisting solely
its, or special and control characters. of characters.
AND. Parameter that is a synonym for the IF CHARSET. Parameter that defines the character
parameter. set from the code page table to determine which
language set to use.
APRINT. Function that prints the audit trail file.
CLIST. Command LIST. File containing a list of
BACK. Function modifier that allows the back- commands to a computer system, normally
ward processing of all record formats within any entered through operations console.
sequential or VSAM dataset.
comment. Statement in source code that is usu-
background. Environment in which jobs are exe- ally preceded and succeeded by a special character
cuted in main storage one at a time. One job step to indicate that it is non-executable, and printed
at a time is assigned to a region of main storage on the listing for documentation purposes.
and remains there until completion.
COMPARE. Function that compares the contents
Basic Direct Access Method (BDAM). File access of two files.
method that directly retrieves or updates specified
blocks of data on a direct access storage device. control card. Eighty-byte input record contain-
ing instructions in the form of functions, and
Basic Partitioned Access Method (BPAM). File optionally, parameters, that tell File-AID the oper-
access method that can be applied to create pro- ation(s) to perform on an input file. Control cards
gram libraries, in direct access storage, for conve- may also include comments.
nient storage and retrieval of programs.
CONVERT. Function that converts existing File-
batch. Processing in which jobs are grouped AID Release 6.5 and below selection tables and
together (batched). The jobs are executed sequen- Release 7.0 XREFs to Release 8.0 XREF format.
tially, and each job must be processed to comple- Converts 7.0 saved selection criteria to Release 8.0
tion before the following job can begin execution. selection criteria format.
COPY. Function that copies data and reports the where data must be stored and retrieved sequen-
number of records and/or PDS members copied. tially.
CSECT. Control SECTion. Smallest relocatable directory. Index used by a control program to
unit in the load library. It can be a subroutine or a locate one or more blocks of data that are stored in
program. separate areas of a dataset in direct access storage.
DASD. Direct Access Storage Device. disposition (DISP). JCL parameter that describes
the current status of a dataset, and directs the sys-
Data Control Block (DCB). Control block used tem on the disposition of the dataset when a step
by access method routines in storing and retriev- ends or abnormally terminates. The DISP parame-
ing data. ter is always required unless the dataset is created
and deleted in the same step.
data definition (DD) statement. Job control
statement that describes a dataset associated with DROP. Function or parameter that controls maxi-
a particular job step. mum number of records dropped.
data element. Parameter component that defines DSCB. Dataset control block.
a single item of data.
DSN. Dataset name.
dataset. Collection of data treated as a unit that
is the primary unit of access and storage. It can be DSNAME. Parameter that limits VTOC processing
organized in various ways. to a specified dataset name(s).
dataset control block (DSCB). Dataset label for a DSORG ID. Dataset organization identifier.
dataset in direct access storage.
DUMP. Function or parameter that prints entire
dataset identifier. First element on a File- or portions of datasets in vertical hexadecimal for-
AID/Batch control card. It logically connects the mat.
input dataset with the function to be performed.
duplication factor. Numeric value that specifies
dataset name (DSN). Set of qualifying strings the number of times an operation is to be per-
used to identify a dataset. formed.
dataset organization identifier (DSORG ID). EDIT. Parameter that alters single occurrence of
data while performing a function.
Two-character code used to force File-AID to pro-
cess a dataset with a specific organization EDITALL. Parameter that alters multiple occur-
(DSORG), regardless of the organization used to rences of data while performing a function.
create it.
entry-sequenced dataset (ESDS). VSAM dataset
dataset type. Value that specifies dataset organi- whose records are loaded in sequence. ESDS
zation and relative record sequence. records can be accessed randomly by their
addresses.
DCB. Data control block.
ERRS. Parameter that defines the number of
DD statement. Data definition statement. allowable data checks per tape volume per execu-
tion.
default value. Choice among exclusive alterna-
tives made by the system when no explicit choice ESDS. Entry-sequenced dataset.
is specified by the user.
FEOV. Parameter that forces end-of-volume pro-
direct access. Facility to obtain data from a stor- cessing for an output dataset when the input
age device, or to enter data into a storage device in dataset reaches end of volume.
such a way that the process depends only on the
location of that data and not on a reference to file. Set of related records treated as a unit.
data previously accessed.
file definition. File identifier that identifies the
Direct Access Storage Device (DASD). Storage input or output files to be used during execution
device, rotating or solid-state, in which data can of a program.
be stored and retrieved randomly, unlike tape,
G-3
file description. Part of a file in which file and Indexed Sequential Access Method (ISAM). File
field attributes are described. access method in which records are stored and
retrieved in a sequence that is based upon a key
file layout. The arrangement and structure of field located in the record and the index. Unlike
data or words in a file, including the order and basic sequential accessing, ISAM permits direct
size of the components of the file. access to records.
foreground. Environment in which jobs are Innovation Access Method (IAM). Key-indexed
swapped in and out of main storage to permit file access method, by Innovation Data Processing,
shared processing time among multiple users. The Inc., intended primarily for use as a transparent
jobs execute in a swapped-in region of main stor- alternative to ISAM or VSAM.
age and appear to begin executing almost immedi-
ately. IOEXIT. Parameter that specifies the input and
output I/O exit names.
FORM. Parameter that processes data as JCL, con-
trols the print format, makes multiple passes input file. File containing data to be read into a
against one file, controls the audit trail print for- job.
mat, and controls the print, report, and data for-
mat for the COMPARE function. interactive. Pertaining to an application in
which each entry calls forth a response from a sys-
format. The arrangement or layout of data on a tem or program.
data medium.
Interactive System Productivity Facility (ISPF).
FPRINT. Function or parameter that prints
records in formatted mode, presenting the data IBM program product that provides the interface
according to a COBOL or PL/I record layout like between a display terminal and applications such
the formatted display of File-AID. as the PDF.
function. Process that is invoked with a control ISAM. Indexed Sequential Access Method.
statement.
ISPF. Interactive System Productivity Facility.
function identifier. Number that corresponds to
a matching JCL data definition (DD) card. JCL. Job Control Language.
function modifier. Code word appended to a Job Control Language (JCL). IBM language used
function identifier to alter or control the way in to describe a batch job and its requirements to the
which the function operates. operating system.
hexadecimal. Data notation system using a key. Code used to locate a record and establish its
numerical base of 16, where each hexadecimal position in an index. The key can be part of a
digit has a value of 0 to 9 or A through F. field, a full field or multiple fields duplicated from
the record.
IAM. Innovation access method.
KEY. Parameter that controls the printing of keys
identification record (IDR). Record that speci- in keyed datasets, and controls processing at a
fies the CSECT in a module to be updated with a record with a specific key.
program temporary fix (PTF) or an independent
component release (ICR). key sequence. In VSAM, the collating sequence
of data records as determined by the value of the
IDR. Identification record. key field in each of the data records. The key
sequence may be the same as, or different from,
IF (AND). Parameter that selects records for a the entry sequence of the records.
function based on selection criteria.
key-sequenced dataset (KSDS). VSAM file type
IN. Parameter that controls the number of whose records are loaded in key sequence. Records
input records read for processing. are retrieved by key or address using an index.
New records are inserted in key sequence by
index. Ordered collection of record keys and means of distributed free space.
pointers used to sequence and locate the records
of a key-sequenced dataset. It is organized in levels key-sequenced file. File whose records are loaded
of index records. in key sequence and controlled by an index.
Records are retrieved and stored by keyed access or
G-4 File-AID/MVS Batch Reference Manual
by addressed access, and new records are inserted MOVE. Parameter that builds an output record by
in key sequence by means of distributed free moving data to it.
space.
Multiple Virtual Storage (MVS). An operating
keyword. Reserved word of an application that system for IBM mainframe computers.
has special significance.
MVS. Multiple Virtual Storage.
KSDS. Key-sequenced dataset.
NEWMEM. Parameter that names single member
LAYOUT. Parameter that specifies the DDxxRL on an output PDS.
dataset member used to format data for the
FPRINT function or parameter. The LAYOUT NEWMEMS. Parameter that names multiple
parameter is an alias for the MAP parameter. members of output PDS.
length element. Parameter component that numeric. Data notation system that is comprised
describes the size of the field to be examined. of the digits 0 thru 9 and a plus (+) or minus (-)
sign.
library. Collection of related files.
numeric data. File-AID considers a field numeric
LIST. Function or parameter that prints alphanu- if each byte of the field is in zoned decimal format
meric data as entered, while printing packed and (F0 - F9). The last byte can be signed positive (C0 -
binary data as blanks. C9), negative (D0-D9), or unsigned (F0 - F9).
location element. Parameter component that operating system (OS). Software that controls
defines the location of data in a record. the execution of tasks. It may provide resource
allocation and scheduling.
logical JCL record. Complete JCL statement with
a maximum length of 256 bytes and containing operator element. Parameter component that is
one or more physical JCL records. used to perform conditional tests on data.
LPI. Parameter that specifies lines per inch on an ORIF. Parameter that creates logical OR condition
output print. when used with preceding IF parameter.
macro. Set of statements that defines the name OS. Operating system.
of, format of, and conditions for generating a
sequence of Assembler language statements from a output file. File created by a job.
single source statement.
OUT. Parameter that controls maximum records
MAP. Parameter used to specify a COBOL or PL/I written to an output dataset.
record layout for use with an FPRINT function or
parameter. packed data. String of one to eight bytes where
each byte except the last contains two numeric
MAXENT. Parameter that extends the area in digits (0-9). The last byte contains one numeric
which parameter information is stored. digit and a sign indicator of A,C, E or F (positive),
or B or D (negative). COBOL and File-AID require
MAXOUT. Parameter that is used to process more the sign indicator to be C (positive), D (negative),
than eight output datasets per execution. or F (positive or unsigned).
MEM. Function modifier that is used to select packed decimal. See packed data.
members within a PDS based on the content of the
member. PADCHAR. Parameter that specifies a fill value
when a record is lengthened.
member. One partition of a partitioned dataset.
parameter. Code word that controls or limits pro-
MEMBER. Parameter that selects a specified cessing of a function.
member within a PDS.
partitioned dataset (PDS). Dataset which is
member list. Alphabetical list of related files divided into partitions (members). Each member
grouped under one name, as in a PDS. can contain data. Partitioned datasets can exist
only on DASD files.
MEMBERS. Parameter that selects groups of
members from a PDS using a mask.
G-5
password. Unique string of characters that a pro- record size. Length specification of a logical
gram, computer operator, or user must supply to record in bytes for fixed- or variable-length
meet security requirements before gaining access records.
to data.
record zero. Capacity record that describes the
PDS. Partitioned dataset. amount of space used on a track.
PDSSTAT. Parameter that maintains PDS member REFORMAT. Function that is used with a File-AID
statistics when updating partitioned datasets. reformat definition to reformat data as it is copied.
physical JCL record. Single JCL display-line on REFOUT. Parameter that specifies which records
the screen, with a maximum length of 80 bytes to copy when executing a reformat definition.
containing one or less JCL statements.
relative addressing format. Relative addressing
primary key. Portion of the first block of each in the form TTR where: TT is a two-byte binary
record in an indexed dataset that can be used to number that specifies the number of the track rela-
find the record in the dataset. tive to the first track allocated for the dataset; R is
a one-byte binary number that specifies the num-
PRINT. Function or parameter that prints alpha- ber of blocks relative to the first data block on the
numeric data and labels each record with its track.
record number and record length.
relative byte address (RBA). Displacement of a
program function (PF) key. Keyboard keys that record from the beginning of the storage space or
are numbered from PF1 to PF12 (PF24 on some control interval of the file to which the record
keyboards) and can be programmed by the user to belongs. The RBA of a VSAM record can change
perform functions such as scrolling. because of Control Interval or Control Area splits.
QSAM. Queued Sequential Access Method. relative location address (RLA). Signed number
that specifies the location in a record to which
qualified name. Method of grouping datasets processing is to move in relation to the current
that consists of multiple names, eight characters position.
or less, each of which is separated by a period (.).
Relative Record Dataset (RRDS). VSAM dataset
Queued Sequential Access Method (QSAM). File whose record locations are specified by a number
access method in which the input and/or output that represents a record’s location in the dataset
data blocks are placed into a queue. The use of a relative to the beginning of the dataset.
queue decreases input/output time.
REPL. Parameter that replaces a single occurrence
RBA. Parameter that begins processing at a rela- of data in a record with other specified data.
tive byte/block address.
REPLALL. Parameter that replaces multiple
RDW. Parameter that controls the inclusion or occurrences of data in a record with other speci-
exclusion of a Record Descriptor Word. fied data.
record layout. Arrangement and structure of data RRN. Parameter that specifies the relative record
or words in a record, including the order and size number for VSAM RRDS and BDAM.
of the components of the record in the dataset.
G-6 File-AID/MVS Batch Reference Manual
SCPRINT. Function that prints the dataset con- UNIT. Input/output device type specification; for
taining selection criteria created from File-AID example: a 3380 disk, 3420 tape, 3820 printer, etc.
online functions. Parameter that specifies generic unit names for the
VTOCDSN, VTOCINFO, and VTOCMAP functions.
SELECT. Parameter that is used to select a given
occurrence of a record for processing. UPDATE. Function that updates altered records
in place as specified by an action parameter.
sequential (SEQ) dataset. Dataset whose records
are organized in ascending or descending USER. Function that creates new records and
sequence. The sequence is based upon partial or datasets and allows greater control over the writ-
complete field(s) occurring in the same location in ing of output records and datasets.
every record in the file.
variable length record. Record having a length
sequence error. Error detected whenever the key independent of the length of other records with
of one record is lower than the key of the preced- which it is logically or physically associated.
ing record.
virtual storage. Notion of storage space that may
SHOW. Parameter that specifies the type of infor- be regarded as addressable main storage by the
mation given with FPRINT output. user of a computer system in which virtual
addresses are mapped into real addresses.
SPACE. Function that moves current record
pointer forward or backward for a specified Virtual Storage Access Method (VSAM). File
amount. access method with which the records in a DASD
file can be accessed in key sequence (KSDS), entry
special character. Graphic character in a charac- sequence (ESDS), or relative record sequence
ter set that is neither a letter, digit, nor space char- (RRDS).
acter.
VOLSER. Parameter that specifies volume serial
STOP. Parameter that halts processing of a func- numbers for the VTOCDSN, VTOCINFO, and
tion when the entered criteria has been met. VTOCMAP functions.
SYNADF. Macroinstruction in Assembler lan- VOLSTAT. Parameter that specifies the volume
guage used in an error-analysis routine to analyze status for the VTOCDSN, VTOCINFO, and VTOC-
permanent input and/or output errors. MAP functions.
SYSIN. A system input stream; also, the name volume. Certain portion of data, together with its
used as the data definition name of a dataset in data carrier, that can be handled conveniently as a
the input stream. unit.
TALLY. Function that reads a dataset and accumu- volume serial (VOLSER). Number in a volume
lates fields specified by ACCUM parameters. label that is assigned when a volume is prepared
for use in the system.
temporary dataset. Dataset that is created and
deleted in same job. Volume Table of Contents (VTOC). Table (direc-
tory) on a direct access volume that describes each
test under mask. Method of checking selected dataset on the volume.
bits in a byte by comparing the whole byte to
another byte. The selected bits are set to 1 and all VSAM. Virtual Storage Access Method.
the other bits are set to 0. If any of the selected
bits are set to 1, a status flag is set. VTOC. Volume Table of Contents.
Time Sharing Option (TSO). Optional IBM oper- VTOCDSN. Function that displays VTOC sum-
ating system feature that allows conversational mary information and dataset names in alphabeti-
time sharing from remote stations. cal sequence. This function is equivalent to File-
AID’s online VTOC utility (3.7) option BLANK.
TSO. Time Sharing Option.
VTOCINFO. Function that displays volume infor-
TTR. Relative addressing format. mation. This function is equivalent to File-AID’s
online VTOC utility (3.7) option I.
TYPE. Parameter that specifies the type of conver-
sion to invoke. Valid only with the CONVERT VTOCMAP. Function that displays volume infor-
function. mation and datasets in address location sequence.
G-7
C
D
CA-Librarian datasets, 2-12
CA-Panvalet datasets, 2-12 data element, 2-5
calling File-AID/Batch as a subroutine, 6-4 binary data, 2-7
capabilities character data, 2-6
See features, product capabilities duplication factor, 2-7
CEM parameter, 4-8 hexadecimal data, 2-7
CHANGED (CHA) parameter, 4-8 length, 2-6
changing data, capabilities for, 1-6 packed data, 2-7
I-2 File-AID/MVS Batch Reference Manual
T
TALLY (T) function, 3-9
examples of, A-5
tape input datasets, 2-12
technical support, xii
text data, 2-6
TSO continuation ***, 6-2
TSO execution, 6-2
TSO parameter, 6-1
TSO PARM, 2-11, 2-13
TSO screen format, 6-3
TYPE (TYP) parameter, 4-52
TYPRUN parameter, 4-52
U
UMP, 3-5
unblocked input datasets, 2-11
unit affinity statement, 2-12
UNIT parameter, 4-53
UNIX HFS Access Rules, 2-11
UPDATE (UP) function, 3-10
examples of, A-10
USER (US) function, 3-10
examples of, A-4, A-8
USERID (USR) parameter, 4-53
V
valid numeric data, record selection, 4-26
variable-blocked-spanned input datasets, 2-11
variable-length record input datasets, 2-12
VOLSER (VOL) parameter, 4-54
VOLSTAT (VST) parameter, 4-54
VPRINT (VP) function, 3-12
VPRINT (VP) parameter, 4-55
VSAM access rules, 2-10
VTOCDSN (VTD) function, 3-12
VTOCINFO (VTI) function, 3-13
VTOCMAP (VTM) function, 3-13
W
website, File-AID/MVS frequently asked questions, xii