FILEAID Manual PDF
FILEAID Manual PDF
GENERAL INFORMATION
.c
om
File-AID's functions enable you to significantly reduce the time required to perform day-to-day
data file manipulation tasks such as creating and modifying test data, resolving production data
problems, and performing ad-hoc file conversions and comparisons.
ES
KEY FEATURES:
o Eliminates ISPF editing restrictions
provides on-line editing of sequential, BDAM, PDS, ISAM, IAM, and VSAM files using
formatted, full-screen displays
eliminates record length restriction
eliminates file size restriction by using selection criteria to limit the number of records to
be edited
supports files in compressed/encrypted format (with I/O exits)
provides optional audit trail of all records updated, inserted, and deleted while editing a
data file
FR
IN
IB
File-AID executes as a dialog under IBM's ISPF dialog manager facility. You can invoke it by
selecting the File-AID option from a customized version of the ISPF primary option menu, or from
a sub-menu panel your installation has set up.
IBMMAINFRAMES.com
If the File-AID execution CLISTS have been installed, you may invoke File-AID from any ISPF
screen. For example, the command TSO FASTART suspends your current screen and displays
the File-AID primary option menu. Upon exit from File-AID your suspended screen is restored.
The following will be presented only if selected by number:
1 - File-AID execution CLISTS
.c
om
ES
FR
OPTION 3 - UTILITIES/E
This option accesses a menu of dataset management utilities. Included are:
3.1 Library (PDS directory management and CSECT info),
3.2 Dataset (Non-VSAM dataset allocation, information),
3.3 Copy (Selective record copying for all file types including PDS members),
3.4 Catalog (search catalog using pattern characters)
3.5 VSAM (Define VSAM clusters, indexes, and paths online or in batch),
3.6 Search/Update (Scan or perform global changes for any dataset),
3.7 VTOC (Search volumes for datasets using pattern characters, analyze space),
3.8 Interactive (run File-AID/Batch online),
3.9 Submit (create batch JCL).
IN
IB
IBMMAINFRAMES.com
.c
om
File-AID uses the full screen for display and entry of data.
The first three lines of each display, called the heading lines, have a common format for all FileAID displays. The remainder of the screen may contain a list of options, input fields and prompts,
or scrollable data.
The first three lines of each display are formatted as follows:
ES
|----------------------------------------|------------------------ --|
line 1: | TITLE
| SHORT MESSAGE |
|--------------------------------------- |------|----------|
line 2: | COMMAND/OPTION
| SCROLL |
|---------------------------------------------- --|----------|
line 3: | LONG MESSAGE
|
|----------------------------------------------------------|
The TITLE area (line 1) identifies the function being performed and, where appropriate, library or
dataset information.
FR
IN
The SCROLL area (line 2) contains the current scroll amount whenever scrolling is applicable.
You may change it by overtyping.
The LONG MESSAGE area (line 3) is used to display an explanation of error conditions upon
request (see HELP command). This line will normally be blank or will contain heading (non data
entry) information. Dataset specification screens allow you to enter information such as dataset
names, member names, and other parameters. The fields in which you may enter information
are labeled and preceded with an arrow. If you fail to enter a required value or if you enter
inconsistent values, you are prompted with a message.
IB
|************************************************
| File-AID ------------- Edit - Dataset Specifi
| COMMAND ===>
|
| Edit Mode
===> C (F=Format
|
| Specify Edit Information:
| Edit Dataset name
===> FASAMP.*
| Member name
===> (Blank or
| Volume serial
===> (If datas
| Disposition
===> OLD (SHR or O
| Create audit trail
===> N (Y = Yes;
IBMMAINFRAMES.com
Several fields on dataset specification screens are pre-entered with values that you entered the
last time on that screen or on a similar screen. If the values are correct, simply press ENTER. If
the values are not correct, overtype the fields that need to be changed before pressing ENTER.
.c
om
The pre-entered information comes from your user profile, which File-AID automatically builds
and maintains across sessions. Information that is maintained in your user profile includes:
ES
|************************************************
| File-AID ---- EDIT - PROJECT.TEST.DATA -------| COMMAND ===>
| NAME
VER.MOD CREATED LAST M
| TEST1
01.04 08/17/93 09/23/
| TEST2
01.02 06/12/93 09/13/
| S TESTFIL3
01.13 07/29/93 09/20/
| TESTFIL4
01.07 08/01/93 08/29/
| TESTFIL5
01.11 07/01/93 09/01/
FR
Scrollable data display screens show file contents or record layouts and allow up/down
scrolling, and in some cases left/right scrolling. On many scrollable data display screens, you can
also update file contents by typing over fields on the screen.
IN
The example below shows the edit formatted screen. You can scroll using the UP and DOWN
commands, and can update file contents by typing over the FIELD VALUE column.
IB
Unscrollable data display screens show "nonrepeating" information which fits on a single screen.
The Selection Criteria Options screen shown below is an example of this type of screen.
IBMMAINFRAMES.com
===> 0
.c
om
********************************************************************************
File-AID ---- Selection Criteria - Options -----------------------------------COMMAND ===>
File-AID provides commands for commonly used functions. You may enter commands in one of
two ways:
ES
1) By typing the command in the command/option field (line 2 of the screen) and then pressing
the ENTER key, or
2) By pressing a program function (PF) key to which you have assigned the desired command.
You can assign commands to PF keys using option 0.0.3 or the KEYS command. When you
press the PF key, the processing is the same as if you typed the command in the command field
and pressed ENTER.
FR
Before you press a PF key, you can enter information in the command field. The PF key definition
is concatenated ahead of the contents of the command field. For example, suppose you assign
the DOWN command to the PF8 key. If you type "6" in the command field and press PF8, the
results are the same as if you had typed "DOWN 6" in the command field and pressed ENTER.
IN
You can stack multiple commands for execution in one interaction by entering a special delimiter
between the commands. The default delimiter is a semicolon (;). You can change the delimiter
using option 0.0.1. For example:
COMMAND ===> DOWN 10;LEFT
In this example the DOWN and LEFT commands have been stacked.
IB
File-AID primary commands are divided into four categories listed below. Commands designated
with an asterisk (*) have the same syntax and function as in ISPF.
In many File-AID functions, the information to be displayed exceeds the screen size. Scroll
commands allow you to move the screen "window" in as many as three dimensions across the
information: up/down, left/right, and forward/back. For a more detailed description of scrolling,
see the SCROLLING section within GENERAL INFORMATION.
The scroll commands are:
UP * Causes scrolling toward the top of a record, file, record layout, or member list.
DOWN * Causes scrolling toward the end of a record, file, record layout, or member list.
IBMMAINFRAMES.com
LEFT * Causes scrolling toward the left margin of the data or causes backward scrolling
towards the beginning of a file.
RIGHT * Causes scrolling toward the right margin of the data or causes forward scrolling
towards the end of a file.
FORWARD
Causes record scrolling toward the bottom of the file.
BACK
Causes scrolling toward the top of the file.
Causes up or down scrolling to the specified line number, label, or member name.
.c
om
LOCATE
LOCATE
Causes up or down scrolling to the record with a label (dataname) or exclude
classification. Also causes scrolling to a data-name that contains, in part or full, the data
name(occ) string.
LR
Causes forward or backward scrolling to a specified record number, label, or any record
with a label classification.
ES
Record manipulation commands allow you to update file contents and to find and change
occurrences of a string in a file.
Causes "n" records to be inserted after the current record (not supported for BDAM
DELETE
Causes "n" records to be deleted beginning with current record (not supported for
BDAM files)
FIND
Causes a record to be repeated "n" times (not supported for BDAM files)
FR
REPEAT
CHANGE
IN
UNDO
SAVE
When using an XREF to work with "segmented" records the following are valid:
IB
ADD
Insert a segment at a point in the record.
NEXT
Display NEXT segment of record using correct layout
REMOVE Remove a segment at a point in the record.
TOP
Return to start of record and display base
USE
Display layouts and allow manual selection and relocation
IBMMAINFRAMES.com
.c
om
Recursive commands: File-AID has special commands like F1 (Browse), F2 (Edit), F33 (Copy)
that let you suspend your current display and start another function. Upon end from the new
function, the suspended display is resumed.
ES
Miscellaneous commands cover a variety of functions. They are listed and briefly described
below.
FR
HEX
KEY
Causes a specified key to be retrieved or the key specification screen to be displayed
(applies to BDAM, ISAM, VSAM-KSDS, VSAM-RRDS, and IAM files only)
CAPS * Causes alphabetic data entered from the terminal to be either translated to upper case
or left as-is
CHAR
IN
RESET * Causes a general resetting of intensified messages and incomplete line commands
Causes a switch from Formatted or Vertical editing modes to Character editing mode
FORMAT Causes a switch from Vertical or Character editing modes to Formatted editing mode
(Aliases: FMT, MAP)
Causes a switch from Formatted or Character editing modes to Vertical editing mode
VFMT
SPLIT * Causes split screen mode to be entered or changes the location of the split line
IB
SWAP * Moves the cursor to wherever it was previously positioned on the other logical screen
of a split screen pair
TSO
KEYS
* Causes an immediate display of a screen on which current PF key definitions are
displayed and modifiable
PANELID * Causes all subsequent screens to be displayed/not displayed with the panel identifier
shown in the upper left corner of the screen
IBMMAINFRAMES.com
HELP
JCL
.c
om
PRINT-HI* Same as PRINT except that high-intensity characters on the screen are printed with
overstrikes to simulate the high-intensity display
Causes the generated JCL to be displayed
The two program access (PA) keys have special meaning in ISPF and File-AID. They are not
equated to ISPF or File-AID commands, and they may not be reassigned.
ES
Normally, you should not use PA1 while operating in File-AID full screen mode. However, there
are two exceptions.
If you press PA1 after the keyboard has been unlocked by File-AID, it is treated like PA2
(RESHOW). It does not cause exit from File-AID. However, if you press PA1 a second time
without any intervening interaction, it causes the current processing to be terminated and the
ISPF PRIMARY OPTION MENU is redisplayed.
If you press PA1 after the keyboard has been manually unlocked (by pressing the RESET key), it
usually causes the current processing to be terminated. The ISPF PRIMARY OPTION MENU is
redisplayed.
FR
You can use PA2 to reshow the last full screen image displayed by File-AID.
IN
You may need to reshow the screen if you accidentally press the ERASE INPUT or CLEAR key,
or if you have typed data on the screen that you want ignored and have not yet pressed ENTER
or a PF key.
DEFAULT ASSIGNMENT
IB
IBMMAINFRAMES.com
.c
om
PAGE SCROLLING
ES
These commands function exactly as they do in ISPF/PDF. On all screens involving scrolling, a
scroll amount is displayed on line 2 of the screen. This value indicates the number of lines or
columns to scroll when you enter one of the four page scrolling commands. You can change the
scroll amount by simply typing over the scroll amount field.
FR
- MAX - specifies scrolling to the top, bottom, left margin, or right margin, depending on which
scrolling command is used.
IN
- CSR - specifies scrolling based on the current position of the cursor. The line or column where
the cursor is positioned is moved to the top, bottom, left, or right of the screen depending on
which scrolling command is used. If the cursor is not in the body of the data, or if it is already
positioned at the top, bottom, left, or right, a full page scroll occurs.
For scrolling purposes a "page" is defined as the amount of information currently visible on the
logical screen. In split screen mode, for example, the edit character display might have 12 lines
by 80 columns of scrollable data. In this case, a scroll amount of HALF would move the window
up or down by 6 lines, or right or left by 40 columns.
IB
The current scroll amount is saved in the user profile. When you type over the scroll amount, the
new value remains in effect until you change it again.
You can override the current scroll amount on a given interaction by entering a scroll amount in
the command field and using a scroll command or PF key.
For example, you can enter:
COMMAND ===> DOWN 5
COMMAND ===> 5
IBMMAINFRAMES.com
RECORD SCROLLING
.c
om
- To change the scroll amount to a number of lines or columns, type over the first character(s)
with the desired number.
ES
The LEFT (PF10/PF22) and RIGHT (PF11/PF23) commands can be used in place of BACK and
FORWARD, respectively.
These commands apply to the screens where one "record" per screen is displayed formatted with
a record layout (edit/browse Formatted, edit formatted field selection criteria, define formatted
XREF) and are used to move forward or backward "n" records (or criteria sets) in a file.
FR
You enter the scroll amount for record scrolling in the COMMAND input area (unless you have
assigned both the command and the scroll amount to a PF key). Valid scroll amounts are:
- a number from 1 to 2,147,483,647 - specifies the number of records to scroll FORWARD or
BACK
- MAX or M - specifies scrolling to the last record (FORWARD) or the first record (BACK) in the
file
IN
There may be times when you want to perform another File-AID function or ISPF/PDF function
without ending the current function. File-AID provides the ability to 'split' the physical screen
image into two logical screens that operate independently of one another, as though you had two
terminals.
IB
In split screen mode, only one of the logical screens is considered active at a time. Any
interactions, such as pressing ENTER or a PF key, are interpreted as having meaning for the
active screen. The current location of the cursor identifies which of the two screens is active. To
switch from one screen to the other, simply move the cursor to the desired screen or enter the
SWAP command.
GENERAL INFORMATION TERMINATING File-AID
You can terminate File-AID in any of three ways:
1) by entering the END command on the primary option menu
2) by entering option X on the primary option menu
IBMMAINFRAMES.com
ES
.c
om
General information about the use of datasets by File-AID follows. Each topic is presented in
sequence, or may be selected by number:
All datasets processed on-line must reside on a direct access storage device or on a mass
storage device. Uncataloged disk data file datasets are allowed in all functions and can be
accessed by specifying a VOLSER.
Temporary data files and tape datasets are allowed as input to independent File-AID/Batch jobs
for which you develop the JCL. File-AID/Batch JCL can be optionally generated with Copy (3.3),
Search/Update (3.6), Print (5.x), Reformat (9), and Compare (10)
FR
When a Dataset Name is required in File-AID, you may enter a fully qualified (quoted), unqualified
(no quotes, userid prefix implied), or pattern (catalog search request).
IN
File-AID saves the name of the most recently referenced dataset of each type (Data file, Record
Layout, XREF, Selection Criteria) in your session profile and redisplays these names on all
appropriate screens.
FULLY QUALIFIED NAMES
You may enter any fully qualified data set name by enclosing the name in apostrophes (').
Trailing quotes are never required.
IB
If you omit the apostrophe(s), your TSO prefix is left-appended to the entered data set name
(unless the TSO profile option "NOPREFIX" has been specified).
If you specify a default VSAM INTERMEDIATE NAME with the 0.1 System Parameters function,
and/or your installation uses the optional File-AID VSAM high level index, and no dataset can be
found with the combination of "TSO-PREFIX.DATASET", a new "VSAM prefix" is constructed as
follows:
VSAM high level index.VSAM INTERMEDIATE NAME.
The constructed "VSAM prefix" is then left-appended to the entered dataset name (VSAM
prefix.dataset) and the catalog is again searched for the dataset. If allocating a VSAM cluster,
IBMMAINFRAMES.com
with the 3.5 VSAM utility, the VSAM prefix is always constructed when an unqualified name is
specified.
UNCATALOGED DATASETS
If the dataset is not cataloged, you must specify a Volume serial number.
USING PATTERN CHARACTERS - CATALOG SEARCH
ES
.c
om
You can use pattern characters in the dataset field to dynamically invoke File-AID's catalog
search (3.4) to look for matching dataset names. Valid pattern characters are: ? and % (single
character) * (multiple characters in one node), + (0 or more nodes). Pattern characters are used
to represent any or all characters which are not part of the high-level node of a dataset name.
The high-level node must be fully specified. Following are some examples of using the
asterisk (*) to retrieve a list of datasets:
After specifying the pattern, press ENTER. The File-AID 3.4 Catalog Utility is invoked, and a
list of datasets corresponding to the pattern that you specified is displayed. Type S in the
COMMAND column to the left of the name of the dataset you want to select and press ENTER.
The selected dataset will be used and will replace the pattern you specified on the panel for the
function you are performing.
FR
If you are not licensed for File-AID/SPF, you will receive an error if you use a pattern
character in the dataset field.
IN
For further information on pattern characters, explore the tutorial for the 3.4 Catalog utility or
see the File-AID Online Reference Manual, CATALOG UTILITY.
PDS DATASET(MEMBER)
A member name enclosed in parentheses may follow the data set name (within the apostrophes,
if they are present) for partitioned data sets. For selection purposes, specifying a member name
for a partitioned dataset will cause the member to be processed as a
sequential dataset.
IB
In most instances a Member Name prompt is provided under the Dataset Name prompt. If a
member name is specified in parentheses along with the dataset name, the member information
is considered as if it had been entered in the Member Name field.
PDS MEMBER NAME MASKS
When referencing a PDS dataset, you may specify a Member Name of blank, or use a pattern to
generate a list of members for selection.
PDS MEMBER NAME MASKS (cont.)
You can use a question mark (?) or percent (%) to represent a single character of the member
name or an asterisk (*) to represent multiple
IBMMAINFRAMES.com
characters in a member name. However, you must enter at least the first character of the
member name before you can use the asterisk. (Exception: in 3.3 Copy or 3.6 Search Update, a
member name of asterisk (*) means to process all members and to bypass all PDS
Processing Options screens and member lists.)
.c
om
Using blank or a member name pattern will either cause a File-AID member list to be displayed or
a PDS Processing Option screen to appear to provide additional member selection options.
Once a list of members is presented, you can select a member from this
list by using the S line command.
You can also enter the full member name, in parentheses, on the same line as the dataset name.
If you do so, you can ignore the Member Name field.
GENERATION DATASETS
ES
CATALOG DATASET
FR
On some panels a catalog dataset name may be entered. In this case whether the catalog
dataset name is enclosed in quotes or not, the name is always considered to be a fully qualified
name and no prefix is appended to it.
Catalog dataset name ===> 'CATALOG.DATASET'
Catalog dataset name ===> CATALOG.DATASET
In the above example, both entries are correct and treated equally.
IN
The data file dataset contains the data to be browsed, edited, reformatted from/into, copied
from/into, searched, updated, printed or compared. It can also be a dataset you are defining or
managing with the extended utilities.
File-AID supports user written I/O exit programs for data file datasets. I/O exits can handle
compression/decompression, encryption/decryption, or can perform all physical I/O to your data
file. See the File-AID Installation Guide for details and samples.
IB
The next two tutorial pages display tables showing the combinations of dataset organizations and
record formats allowed for data files. For sequential (PS), partitioned (PO), BDAM (DA), and
ISAM (IS) files, the LRECL and BLKSIZE can range from 1 to 32,760 for each RECFM. For
VSAM files, the LRECL can range from 1 to 32,767.
The table below shows the combinations of dataset organizations and
record formats allowed for data files.
IBMMAINFRAMES.com
.c
om
RECFM
+----------------------------------------------------------------------------------+
| DSORG
| F | FB | V | VB | U | SPANNED |
+-------------------------+-----+-----+-----+-----+-----+----------------------|
| PS (Sequential)
| X | X | X | X | X | X
|
+-------------------------+-----+-----+-----+-----+-----+----------------------|
| PO (Partitioned)
| X | X | X | X | X |
|
+-------------------------+-----+-----+-----+-----+-----+---------------------|
| IS (Indexed Sequential) | X | X | X | X | n/a | n/a
|
+-------------------------+-----+-----+-----+-----+-----+---------------------|
| DA (BDAM)
| X | X |
|
|
|
|
+---------------------------------------------------------------------------------+
FR
ES
RECFM
+-----------------------------------------------------------------------------------------+
| DSORG
| F | FB | V | VB | U | SPANNED |
+-------------------------+-----+-----+-----+-----+-----+-----------------------------|
| AM (VSAM-KSDS,ESDS) | n/a | n/a | X | n/a | n/a | X
|
+-----------------------------------------------------------------------------------------+
| AM (VSAM-RRDS)
| X | n/a | n/a | n/a | n/a | n/a
|
+------------------------------------------------------------------+
| AM (IAM)
| X | n/a | X | n/a | n/a | X
|
+-----------------------------------------------------------------------------------------+
| AM (VSAM-LDS)
| (allocate, delete, info only)
|
+-----------------------------------------------------------------------------------------+
1) VSAM-KSDS and ESDS files are treated as variable length files. Also, the concept of blocking,
as applied to PS, PO, and IS files, does not apply to VSAM.
IN
2) File-AID does not support ISAM files with OPTCD=L in the DCB information when the key
starts in the first position (RKP=0 for fixed length files, RKP=4 for variable length files)
3) File-AID does not support fixed length unblocked ISAM files with a relative key position of 0
(RKP=0), or variable length unblocked ISAM files with a relative key position of 4 (RKP=4).
4) File-AID supports reading a VSAM-KSDS in an alternate key sequence via a VSAM PATH. A
PATH name may be specified for the input data file name in the browse, edit, copy, print, and
compare options.
IB
5) File-AID treats RECFM=FB BDAM files as RECFM=F (i.e., records are not de-blocked.)
Keyed BDAM files are processed by File-AID as if the key were concatenated in front of
each data block.
6) IAM files exist as fixed or variable length files. Due to a constraint in the information available
to File-AID from the IAM access method, all files are currently handled as variable length files. If
the length is changed on an IAM file which is truly fixed, File-AID will display an error message.
IAM files are processed as VSAM-KSDS files in all functions.
IBMMAINFRAMES.com
.c
om
If you attempt to access a dataset protected by an OS password, File-AID will present the OSPassword-Protected screen containing a field where you can specify a dataset password as
follows:
Dataset password ===>
A nondisplay input field is used so that the password does not appear on the screen while you
are typing it.
ES
Note that the File-AID 3.5 VSAM utility supports specification and modification of passwords for
VSAM clusters.
RECORD LAYOUT DATASET
This dataset contains the record layouts which are used in many File-AID functions. The record
layout dataset can be one of four types:
IN
FR
|---------------------------------------|---------------|-------------------|----------------|
| TYPE
| DSORG | RECFM
| LRECL |
|---------------------------------------|------------ --|--------------------|----------------|
| Partitioned Dataset
| PO
| F, FB, V, VB | 80
|
|----------------------------------------|--------------|--------------------|----------------|
| PANVALET file
| *
|
*
| *
|
|----------------------------------------|-------------|--- -----------------|---------------|
| LIBRARIAN file
| *
|
*
| *
|
|----------------------------------------|-------------|--------------------|----------------|
| Standard sequential dataset | PS
| F, FB, V, VB | 80
|
|----------------------------------------|-------------|--------------------|----------------|
Must conform to the requirements for a valid CA-PANVALET/LIBRARIAN file. CAPANVALET and CA-LIBRARIAN are products of Computer Associates International, Inc.
A record layout may be a separate COPYLIB member or may be hard-coded within the source
statements of a program. If the layout is in a program or if a COPYLIB member contains multiple
record layouts, you can isolate the specific layout, or portion of a layout, that File-AID should use
by specifying a starting data-name.
IB
If you do not specify a starting data-name, File-AID uses every layout found in the program, or
COPYLIB member, to format the data, treating the second through last layouts as additional
layouts that may be manually selected and overlaid at any offset via the USE command.
Note: File-AID Release 6 "MAP" libraries containing compiled record layouts are acceptable as a
record layout library.
IBMMAINFRAMES.com
LANGUAGE SUPPORT
File-AID supports source record layouts coded in COBOL or PL/I.
Layouts may be used when browsing, editing, printing, reformatting and comparing data files.
Layouts can also be used to define selection criteria and to specify tests for multiple record type
layout usage.
.c
om
File-AID supports Format 1 of the COBOL data definition statement and ignores Formats 2 and 3.
When a 66 or 88 level item is encountered File-AID skips to the end of the sentence and performs
no syntax checking.
FORMAT 1
FORMAT 2
FORMAT 3
REDEFINES clause
BLANK WHEN ZERO
JUSTIFIED clause
OCCURS clause
PICTURE clause
SIGN clause
SYNCHRONIZED clause
USAGE clause
VALUE clause.
ES
FR
1) The first data description entry in the COBOL layout need not have level number 01.
IN
2) If multiple data description entries have level number 01, the second through "n" 01 level
entries are treated as though they redefine the first 01 level entry. Each 01 level entry need not
be successively longer than the previous 01 level entry.
3) The clauses may be written in any order.
4) The PICTURE clause must be specified for every elementary item with the exception of
INDEX, COMP-1, and COMP-2 data items.
IB
7) The EJECT, SKIP1, SKIP2, and SKIP3 reserved words may be imbedded between data
definition statements within a COBOL layout. File-AID skips over these words.
8) File-AID also skips over the TITLE statement, which is valid in VS COBOL II.
9) Sort file description entry statements (SD) and file description entry statements (FD) may be
imbedded within the COBOL layout. File-AID skips these statements and performs no syntax
checking.
IBMMAINFRAMES.com
10) File-AID also skips debugging lines ("D" in column 7) and sentences which do not begin with
a valid level number.
11) File-AID ignores the REDEFINES clause if it is on the first data description entry in the
COBOL layout.
.c
om
The level number and data-name are required in the COBOL data description entry. The format
is:
level number data-name
The level number may be any number from 1 through 49. You may not use level number 77.
ES
Data-names must be 30 characters or less but are not otherwise validated. For example, you are
not restricted to using characters A through Z, 0 through 9, and hyphen to form data-names, and
you need not make data-names unique. The keyword FILLER is treated the same as other
data-names.
The format of the REDEFINES clause is:
The level numbers of data-name-1 and data-name-2 must be identical and can be any level
number from 1 to 49. Between the data descriptions of data-name-2 and data-name-1, there may
be no entries having numerically lower level numbers than the level number of data-name-2 and
data-name-1.
FR
The data description entry for data-name-2 may not contain an OCCURS clause. However, dataname-2 may be subordinate to an item containing an OCCURS clause with or without the
DEPENDING ON option. Items subordinate to data-name-2 may contain an OCCURS clause
without the DEPENDING ON option.
IN
Data-name-1 and any items subordinate to data-name-1 may contain an OCCURS clause with or
without the DEPENDING ON option. If data-name-1 contains an OCCURS clause, its length is
computed to be the length of one occurrence multiplied by the number of occurrences.
The size of the redefining area must be less than or equal to the size of the redefined area.
Multiple redefinitions of the same redefined area may reference the data-name of the redefined
area or the data-name of any of the preceding redefining areas.
REDEFINES clauses may also be specified for items subordinate to items containing
REDEFINES clauses.
IB
File-AID ignores the REDEFINES clause if it is on the first data description entry in the COBOL
layout.
The format of the BLANK WHEN ZERO clause is:
BLANK (WHEN) ZERO
The word "WHEN" is optional. This clause is checked for valid syntax but it does not affect
processing in any way.
IBMMAINFRAMES.com
.c
om
The JUSTIFIED clause is used to override normal positioning of data within a receiving
alphanumeric data item. This clause affects processing in the reformatting function (option 9)
only.
Normally data is left justified in the receiving field and either truncation or blank padding occurs
on the right. When the JUSTIFIED clause is specified, data is right justified in the receiving field
and either truncation or blank padding occurs on the left.
The OCCURS clause has two basic formats:
ES
FORMAT 1
OCCURS integer-2 TIMES (DEPENDING ON data-name-1)
(ASCENDING KEY IS data-name-2 (data-name-3)...)...
DESCENDING
FORMAT 2
OCCURS integer-1 TO integer-2 TIMES (DEPENDING ON data-name-1)
FR
The words "TIMES", "KEY IS", and "BY" are optional in both formats.
IN
IB
The ASCENDING KEY, DESCENDING KEY, and INDEXED BY options are checked for valid
syntax, but do not affect processing in any way.
Data-name-1, the object of the DEPENDING ON option:
- must be defined as an integer
- must not contain or be subordinate to an OCCURS clause
There can be multiple OCCURS DEPENDING ON clauses per COBOL layout.
IBMMAINFRAMES.com
A X B 0 Z , . *
.c
om
File-AID interprets all options of the PICTURE clause. The alphabetic, alphanumeric,
alphanumeric edited, and numeric edited categories of data are all treated as alphanumeric data
(i.e. treated as if the character string contained all X's). Picture characters
- CR DB $ E
are all treated as the picture character X (XX for CR and DB). For alphanumeric edited and
numeric edited data items, File-AID does not validate the character string according to the
"precedence of symbols" as COBOL does.
ES
External floating point items are fully syntax checked and treated as picture X items. Also, the
scaling position character, P, is supported
The format of the SIGN clause is:
The word "CHARACTER" is optional in the SEPARATE option. File-AID treats the SIGN clause
exactly as COBOL treats it.
The format of the SYNCHRONIZED clause is:
FR
SYNCHRONIZED (LEFT)
SYNC
(RIGHT)
When
IN
File-AID treats all other aspects of the SYNCHRONIZED clause exactly as COBOL treats them,
including computation of slack bytes for groups, defined with the OCCURS clause, containing
synchronized items.
IB
DISPLAY
DISPLAY-1
COMPUTATIONAL
COMP
COMPUTATIONAL-1
USAGE (IS) COMP-1
COMPUTATIONAL-2
COMP-2
COMPUTATIONAL-3
COMP-3
COMPUTATIONAL-4
COMP-4
INDEX
IBMMAINFRAMES.com
.c
om
If the USAGE clause is not specified for an elementary item, or for any group to which the item
belongs, usage DISPLAY is assumed.
COMPUTATIONAL-4 and COMP-4 items are treated as COMPUTATIONAL items.
The format of the VALUE clause is:
VALUE (IS) literal
ES
The VALUE clause is checked for valid syntax but does not affect processing in any way.
COBOL LAYOUT ERRORS
When File-AID encounters an error during its on-line processing of a COBOL layout, an error
messages is written to your ISPF log file. These messages contain an image of the last line FileAID read from the COBOL layout, plus the internal layout representation File-AID built before
the error occurred. By using these messages in conjunction with the error message File-AID
displays at your terminal, you will be able to resolve most COBOL layout errors.
FR
Whenever you leave the layout member name blank or use a pattern, File-AID presents a
member list. A partitioned processing options (PPO) screen usually appears first to let you filter
the member list to improve performance. A pattern consisting only of an asterisk (*) tells File-AID
to list all members and to bypass the PPO screen.
IN
NOTE: Using a single asterisk (*) pattern to list all members of a large layout library (such as a
Panvalet or Librarian library) may be time consuming.
Member list presentation occurs automatically in the XREF function when you use line
commands, or enter a pattern in the member name field (with or without using the S or SU line
command).
SOURCE OPTIONS
IB
When File-AID cannot compile your record layout with the default source options, the Source
Statement Selection panel is displayed. This panel contains a Source Statement selection area
and a compiler option section. Record layout extraction can be done by "Character string" or
"Statement number".
-Character string selection is
performed by entering the full or
partial dataname of the first group
item wanted. The ending string is
only needed for PL/I or when a
IBMMAINFRAMES.com
| Ending string
===>
|
| Record layout selection by Source State
| Beginning number ===>
| Ending number
===>
| Number type
===>
.c
om
The Source Options panel is also used to enter compiler options. The compiler options are
Language, Starting level number, Literal delineator (COBOL only) and Use 48 character set (PL/I
only).
ES
FR
XREF DATASET
If File-AID cannot determine the language, or if compilation fails, it will display this panel to allow
you to change source or compile options.
IN
|-----------------------------|---------------|--------------|-------------|
| TYPE
| DSORG | RECFM | LRECL |
|-----------------------------|--------------|--------------|-------------|
| Partitioned Dataset | PO
| VB
| 300
|
|-----------------------------|--------------|--------|-------------|
LAYOUT XREF DATASET
IB
You create XREF members to communicate information about the record layout dataset to FileAID in the following situations:
1) the data file you want to work with contains records with differing formats, requiring different
record layouts to define the various formats
2) the record layout that defines the data file is hard-coded in a program
3) the record layout that defines the data file is stored in a COPYLIB member that contains
multiple record layouts
IBMMAINFRAMES.com
4) each record in the data file requires two or more record layouts, presented in sequence, to
define it
For the first situation, the XREF contains two pieces of information:
.c
om
1) the name or the length and starting position of the field(s) within each data record that FileAID should use to identify the data record's type (referred to as the "record type field(s)")
2) a list of all the possible record type values and the corresponding layout library member
which defines the data records with those values
For the second and third situations, the XREF contains the data-name that starts the data
structure you want (referred to as the "starting data-name"). File-AID reads the layout from the
source library member (containing either multiple layouts or a program) starting with the dataname you specify. File-AID stops reading when it finds a new data structure (equal or lower level
number) or when the end of the record layout, library member, or program is reached.
ES
For the fourth situation, the XREF contains the names of the layout library members for each
segment of a data record. It also contains the rules for identifying each segment of the record by
locating the "segment type field" and field values to use for selecting a segment layout (via NEXT
command of Formatted Browse/Edit).
In any of the File-AID primary options which use layouts to define the data, the record layout
dataset and XREF dataset information are specified as shown in the example below.
FR
IN
RECORD LAYOUT USAGE indicates whether you will use a single record layout (usage "S"), a
layout XREF (usage "X"), or no source layouts (usage "N") to define the file.
The table below shows the valid dataset and member entries for the record layout and layout
XREF datasets, for each layout usage.
IB
|---------------|-----------------------------------------------|-----------------------------------|
| LAYOUT |
RECORD LAYOUT
|
XREF
|
| USAGE |
DATASET
|
DATASET
|
|--------------|------------------------------------------------|----------------------------------|
| S
| sequential file, or
| ignored
|
|
| member of partitioned/PAN/LIB file |
|
|--------------|------------------------------------------------|----------------------------------|
|
| sequential file, or
| member of partitioned file|
| X
| partitioned/PAN/LIB file;
| (required)
|
|
| member must be blank
|
|
|-------------|------------------------------------------------|-----------------------------------|
| N
| ignored
| ignored
|
IBMMAINFRAMES.com
|-----------------------------|---------------|--------------|-------------|
| TYPE
| DSORG | RECFM | LRECL |
|-----------------------------|--------------|---------------|-------------|
| Partitioned Dataset | PO
| V, VB
| 300
|
|-----------------------------|--------------|---------------|-------------|
REFORMAT DEFINITION DATASET
.c
om
ES
|-----------------------------|--------------|---------------|-------------|
| TYPE
| DSORG | RECFM | LRECL |
|-----------------------------|--------------|--------------|--------------|
| Partitioned Dataset | PO
| V, VB
| 1570
|
|-----------------------------|--------------|--------------|--------------|
FR
When partitioned datasets are specified on the dataset specification screens, you may display a
member list by:
- Leaving the member name field blank
IN
IB
A pattern is a partial member name containing one or more of the single character "wild cards" *
(asterisk) ? (question) or % (pct). If any pattern character is present, the name becomes a mask
matching any member name starting with the pattern entered (as if the pattern contained all "wild
cards" at the end). Therefore, one trailing pattern character is used only if it is the only "wild
card" in the mask, otherwise it is assumed. (Ex. PR?G is the same as PR?G???? and PR?G*.
However PRO and PRO* are different because PRO is a member name not a pattern like PRO*
is.)
For example, the patterns: ?RO*, ?RO, P*, PR?G%, P?O?G, PROGRAM* all match and produce
the following list:
PROGRAM1
PROGRAM2
PROGRAM3
IBMMAINFRAMES.com
Use the S (Select) line command to select the member you want. You may also scroll through the
member list using the UP and DOWN commands. In addition, you can enter a LOCATE primary
command and scroll directly to (or near) a specified member name.
.c
om
If the main dataset in Browse (1), Edit (2), Copy (3.3), Search/Update (3.6), and Print data (5.1),
is a PDS and an explicit member is not specified, File-AID provides a PDS Processing Options
(PPO) screen. The PPO screen lets you specify additional member qualification filters such as:
member name range, last modified userid range, create date range, and modified date range.
ES
If you wish to bypass the PPO screen and process all members, use a member name of * on the
main entry screen (Ex. Edit DSN=MY.PDS(*) ).
ABNORMAL TERMINATION
Note that when multiple PDSs are specified on the entry screen the list of members matching
your PPO options may not appear until AFTER all other PDS member lists have been presented
and a member selected.
FR
IN
In both situations, File-AID intercepts the abend and displays an error screen. In the first case, a
message is displayed describing the unrecoverable error encountered. In the second case, the
system and user abend codes are displayed.
The first keyboard interaction on the error display screen causes the ISPF abnormal termination
screen to be displayed.
File-AID attempts to close all open files prior to returning control to ISPF.
DATASET SECURITY
IB
File-AID is completely compatible with any data security software your installation may have (Ex.
RACF, CA-ACF2/TOP Secret, etc). File-AID processing does not circumvent your security
software in any way.
File-AID provides your installation with the capability of creating its own security exit routine that
File-AID will call during its processing. This enables your installation to limit access to certain
datasets. Following are some examples of the optional security exit routine uses:
To allow only authorized users to browse and/or edit selected data files
IBMMAINFRAMES.com
If you require information on your installation's security exit routine, contact the person
responsible for File-AID at your installation.
In addition to the security exit, an audit exit is provided that can be customized for various uses
including:
.c
om
- To force the creation of an audit trail when option 2 of File-AID is used to edit selected data
files, and/or to force the printing of an audit trail report upon completion of the data file updates
ES
When you use option 2 of File-AID to edit a data file, you may specify that File-AID capture all of
your update activity in an audit trail dataset. Every insert, repeat, delete, copy, typeover, and
CHANGE command you perform causes a before and/or after image of the record(s) affected to
be written to the audit trail dataset. When you complete your edit session, a screen is displayed
giving you the option to print, delete, or keep the audit trail. If you specify that the audit trail be
printed, a batch job is submitted which produces a formatted audit trail report.
File-AID also provides your installation with the ability to force the creation of an audit trail during
any user's edit session through an audit exit routine. This is especially useful, for example, if your
installation wants to ensure that an audit trail is created whenever File-AID is used to edit certain
sensitive data files. When the edit session is complete, the audit exit routine can also be used to
force the automatic submittal of a batch job to produce the audit trail report, thereby ensuring that
a record of the edit session is printed.
FR
In addition to the audit trail facility, File-AID provides the option to log all dataset updates to the
system SMF datasets.
If you require information on how your installation may be using any of these audit trail facilities,
contact the person responsible for File-AID at your installation.
IN
COMPRESSION/ENCRYPTION EXIT
File-AID provides your installation with the capability of creating its own compression/encryption
exit routine that will act as an interface between File-AID and any compression/encryption
software you may have (e.g., SHRINK or DATA PACKER). This allows you to work with data files
that are stored on disk or tape in a compressed or encrypted format in all File-AID options. FileAID invokes the compression/encryption exit for data files only, not for record layout datasets,
record/layout cross references, or selection criteria.
IB
If you require information on your installation's compression/ encryption exit, contact the person
responsible for File-AID at your installation.
File-AID will automatically detect and present DBCS data characters if your terminal type is set to
3277KN or 3278KN from option 0.0.1 of File-AID, or option 0.1 of ISPF (ISPF terminal
characteristics).
There are two ways File-AID presents data.
The two ways are presented in sequence, or may be selected by number:
IBMMAINFRAMES.com
.c
om
For PIC G(nn) fields in COBOL or GRAPHIC(nn) fields in PL/I File-AID assumes that the field
contains only Double-Byte Character Set (DBCS) data. DBCS data does not include shift-out
(X'0E') and shift-in (X'0F') characters and should be an even number of bytes in length.
Note: X'0E' and X'0F' are for IBM sites. Other platforms such as FSP and Hitachi may use other
representations for shift-in and shift-out.
FULL-SCREEN DATA PRESENTATION
ES
When data is presented without COBOL or PL/I record layouts (three-line hexadecimal or
character format), each character line displayed is considered a character field.
File-AID assumes that all character fields contain a mixture of EBCDIC data and Double-Byte
Character Set (DBCS) data. The DBCS characters are enclosed with shift-out (X'0E') and shift-in
(X'0F') characters.
Use caution when entering DBCS characters to ensure that the shift-out and shift-in characters
are accounted for and will not overlay other data values unexpectectly.
FR
The command HEX ON is useful to view the location of the shift bytes.
File-AID will automatically detect and present DBCS data characters if your terminal type is set to
3277KN or 3278KN from option 0.0.1 of File-AID, or option 0.1 of ISPF (ISPF terminal
characteristics).
IN
IB
File-AID assumes that all character fields contain a mixture of EBCDIC data and Double-Byte
Character Set (DBCS) data. The DBCS characters are enclosed with shift-out (X'0E') and shift-in
(X'0F') characters.
For PIC G(nn) fields in COBOL or GRAPHIC(nn) fields in PL/I File-AID assumes that the field
contains only Double-Byte Character Set (DBCS) data. DBCS data does not include shift-out
(X'0E') and shift-in (X'0F') characters and should be an even number of bytes in length.
Note: X'0E' and X'0F' are for IBM sites. Other platforms such as FSP and Hitachi may use other
representations for shift-in and shift-out.
IBMMAINFRAMES.com
.c
om
File-AID assumes that all character fields contain a mixture of EBCDIC data and Double-Byte
Character Set (DBCS) data. The DBCS characters are enclosed with shift-out (X'0E') and shift-in
(X'0F') characters.
Use caution when entering DBCS characters to ensure that the shift-out and shift-in characters
are accounted for and will not overlay other data values unexpectectly.
IB
IN
FR
ES
The command HEX ON is useful to view the location of the shift bytes.
IBMMAINFRAMES.com