File-AID data set types


This section provides information on the following types of data sets used by File-AID:

  • Data file
  • Record layout
  • XREF (record layout cross reference)
  • Selection criteria
  • Reformat definition
  • Compare criteria.

All data sets must be cataloged and reside on a direct access storage device or on a mass storage device, with the following exceptions:

  • Uncataloged disk data file data sets are allowed in all functions.
  • Data files residing on tape are allowed as input and/or output for File-AID batch jobs to perform copy, search/update, print, reformat, and compare functions.

Data file data set

A Data File data set contains the data to browse, edit, copy from/to, search/update, print, reformat from/to, or compare. File-AID can process data sets created through any standard MVS method, including:

  • Sequential
  • Partitioned (PDS, PDSE, Version 2 PDSE1)
  • BDAM
  • VSAM (KSDS, JSON2, BSON2, ESDS, RRDS, LDS3)
  • IAM4.

Note

1 : Browse and Edit functions can access old generations of a Version 2 PDSE. Library Utility’s (3.1) Rename and Delete functions support renaming/deleting all member generations of a Version 2 PDSE for non-load libraries only. Copy Utility (3.3) and Search/Update Utility (3.6) Option B (Browse) also recognize all member generations. All other File-AID functions access only the current member (0 generation) by default.

: JSON/BSON databases are supported only in Option 3.5 (VSAM Utility) functions.

3 : LDS (LINEAR data set): Selection Criteria is not supported in Edit; Option U, UPDATE not available in Search/Update.

: For File-AID to continue support of IAM (Innovation Access Method) file types, apply the appropriate IAM version fix(es): IAM Version 9.1 fixes P910005 and P910167, IAM Version 9.2 fix P920095, and IAM Version 9.3 fix P930003.

The following table shows the combinations of data set organizations and record formats allowed for supported data files.

Data set organizations and record formats

DSORG

RECFM

F

FB

V

VB

U

SPANNED

PS (Sequential)

X

X

X

X

X

X

PO (Partitioned)

X

X

X

X

X

 

POE (PDSE)

X

X

X

X

X

 

DA (BDAM)

X

X

 

 

 

 

AM (VSAM-KSDS,JSON,BSON,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-KSDS,ESDS)

N/A

N/A

X

N/A

N/A

X

AM (VSAM-LDS)

(allocate, delete, info only)

Data file data set notes

  1. VSAM-KSDS and ESDS files are treated as variable length files. Also, the concept of blocking, as applied to non-VSAM files like PS and PO, does not apply to VSAM.
  2. File-AID does not support ISAM files as IBM no longer supports ISAM.
  3. 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. Likewise alternate indexing is also supported in IAM files.
  4. 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.
  5. 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 the same as their respective VSAM types (KSDS, ESDS, PATH, etc.) in all functions.
  6. File-AID supports Sequential (PS) data sets greater than 65,535 tracks (DSNTYPE=LARGE) in 64-bit memory mode when the MVS Operating System also supports them.
  7. File-AID supports extended-format datasets with compression, extended-addressing and/or encryption using Key Label for z/OS dataset encryption (IBM Pervasive Encryption).

File-AID allows record lengths up to a maximum of 32,760 bytes (32KB). It processes any record format including fixed, variable length, spanned, and undefined length records.

Browse (F.1), Edit (F.2), and copy (F.3.3) support VBS and VS Sequential files with LRECL=X in Standard mode and allow support for records up to 4,194,304 (4MB) which includes the 4 byte RDW. Selection criteria and XREF criteria are allowed and copy/paste, workfile, and audit LRECL restrictions remain intact.

Important

If a VSAM dataset has more extents than fit in buffer (ER017), copy it to a new data set with better primary/secondary extents.

CA Panvalet and CA Librarian data set support

File-AID reads CA Panvalet and CA Librarian data file data sets for the Browse, Copy, Search/Update, and Compare functions. Use Search/Update’s global preview and update option (U) to update Panvalet or Librarian data sets. Panvalet and Librarian member editing is not supported. However, you can select a member for the Edit function and save it to a PDS or sequential file with the CREATE and REPLACE primary commands. Instructions for installing CA Panvalet or CA Librarian support are included in the Installing and Configuring.

Important

File-AID only supports 80-character Panvalet members.

zFS File Support

File-AID’s Hierarchical File System support enables you to Browse, Edit, Copy, Delete, Rename, and Compare zFS files on the UNIX environment of z/OS.

Record layout dataset

A Record Layout dataset contains the Assembler, COBOL or PL/I record layouts, which are used in the following File-AID functions:

  • Formatted and vertical formatted mode of browse and edit
  • Formatted print
  • Formatted selection criteria definitions
  • XREF definitions
  • Formatted compare criteria.

If you specify a record layout dataset on a dataset specification screen without specifying a member, File-AID displays a PDS Processing Options (PPO) screen (see PDS Processing Options), and then a list of members as shown in Record Layout Member Select List Screen. You can select a record layout member with the S line command or SELECT primary command.

Important

Specify a member name of * (asterisk) in the Record layout dataset member name field to bypass the PPO screen and directly display the member list.

For COBOL or PL/I, when more than one record layout exists within the selected member, File-AID displays the List of Available Record Layouts screen, as described in List of Available Record Layouts.

For COBOL or PL/I, when File-AID cannot compile your record layout with the default source options, File-AID displays the Source Statement Selection screen, as described in Source Statement Selection.

For Assembler, File-AID only processes the first DSECT in the Layout.

Record layout member select list screen

File-AID Layout Select - USERID9.FASAMP.LAYOUTS -----------  ROW 1 TO 16 OF 16
COMMAND ===>                                                  SCROLL ===> PAGE
 S  NAME             VV.MM  CREATED     CHANGED      SIZE  INIT   MOD   ID
   COBOLPGM          01.00 95/02/03 95/02/03 15:45     87    87     0 USERID9
   EMPLOYEE          01.00 95/02/03 95/02/03 15:45     35    35     0 USERID9
   EMPLOYE2          01.00 95/02/03 95/02/03 15:45     36    36     0 USERID9
   INVFILE
   ORDERPO           01.00 95/02/03 95/02/03 15:45     29    29     0 USERID9
   ORDERSC           01.00 95/02/03 95/02/03 15:45     26    26     0 USERID9
   ORDERWO           01.00 95/02/03 95/02/03 15:45     54    54     0 USERID9
   PLIEMP            01.00 95/02/03 95/02/03 15:45     31    31     0 USERID9
   PLIEMP2           01.00 95/02/03 95/02/03 15:45     36    36     0 USERID9
   PLIINV            01.00 95/02/03 95/02/03 15:45     24    24     0 USERID9
   PLIORDPO          01.00 95/02/03 95/02/03 15:45     29    29     0 USERID9
   PLIORDSC          01.00 95/02/03 95/02/03 15:45     26    26     0 USERID9
   PLIORDWO          01.00 95/02/03 95/02/03 15:45     54    54     0 USERID9
   PLIPGM            01.00 95/02/03 95/02/03 15:45     97    97     0 USERID9
   PLISEGS           01.00 95/02/03 95/02/03 15:45     62    62     0 USERID9
   SEGRECS           01.00 95/02/03 95/02/03 15:45     62    62     0 USERID9
******************************* BOTTOM OF DATA ********************************

The source data set can be sequential, partitioned, CA Panvalet, or CA Librarian for COBOL or PL/I. The record length can be fixed, fixed-block, variable, and variable-blocked (RECFM=F, FB, V, or VB), if the record layouts are PL/I. The record length can fixed or fixed block and the record length must be 80 if the record layouts are COBOL. For Assembler the source dataset can be sequential or partitioned, Fixed or Fixed blocked.

The record layout can be a separate COPYLIB member or hard-coded in a COBOL or PL/I program. If the layout is in a program, File-AID displays the Source Statement Selection screen. COBOL and unaligned PL/I record layouts are compiled as interpreted by File-AID. The record layout can be a separate member or hard-coded in an Assembler program. If the layout is in a 
program, File-AID interprets the first DSECT for the Record Layout.

If a COPYLIB member contains multiple record layouts, you can isolate the specific layout by defining a record layout cross reference (XREF) member. See Record Layout XREF Dataset and Record-Layout-Cross-Reference-function.

If a COPYLIB member contains multiple record layouts, you can isolate the specific layout by defining a record layout cross reference (XREF) member. See Record Layout XREF Dataset and Record-Layout-Cross-Reference-function.

Concatenation list data set

Some screens allow you to specify a Concatenation List member in place of a single Record Layout Dataset.

The Concatenation List data set functions as the Master Library of Record Layout Concatenation Lists. Each member of this Master Library may contain a list of up to 16 DSNs. Each such list designates a set of Record Layout Datasets that can be concatenated on the Record Layout Dataset ddname, so you are no longer limited to specifying one Record Layout Dataset, but are able to specify a composite list of record layout datasets for concatenation.

The Concatenation List data set must be a FB 80 PDS or PDSE. In a member of the Library, specify the names of the Record Layout datasets you want to concatenate, one DSN per line. Enclose fully qualified names in single quotes. Unquoted names will be interpreted as if prefixed with the active TSO prefix, generally the TSO userid. GDGs, zFS files, flat files, VSAM files, CA Librarian, and CA Panvalet are not supported. Any text on a line after the DSN is a comment. Blank lines are ignored. An asterisk in column 1 of any line denotes a comment line. Maximum 16 DSNs per member.

To use this feature, you must first specify the Concatenation List DSN on the 0.1 options screen. On the individual panel where you want to use your DSN list (such as Edit or Browse), in the field labeled Record Layout Dataset, specify a plus sign followed by the full member name containing the concatenation list you want to use (e.g., +FRED). If the designated layout libraries contain duplicate layout names, File-AID will always select the first occurrence.

Leave the Member Name field blank or enter a pattern to display the Layout Selection Member list (see the following figure).

Layout selection member list screen

FILE-AID Layout Selection Member List - +FRED ------------- Row 1 to 21 of 109
COMMAND ===>                                                  SCROLL ===> CSR
S NAME     CONCAT VV.MM   CREATED        CHANGED     SIZE  INIT   MOD   ID    
  ALOG1      1    01.04 2007/04/11 2007/04/12 11:57    10    10    10 PMILZM1
  ALOG2      2    01.00 2007/04/11 2007/04/11 19:19    11    11     0 PMILZM1
  ALOG3      3    01.00 2007/04/11 2007/04/11 19:20    18    18     0 PMILZM1
  APSTQUOT   5    01.11 1997/08/14 1997/08/15 08:53    69    26     0 PFHSHK0
  BIGA       5    01.11 1991/11/21 1991/11/25 08:48  1256    12  1245 CWX0120
  BIGALL     5    01.01 1991/11/22 1991/11/25 08:49  3768  3768     3 CWX0120
  BIGB       5    01.02 1991/11/21 1991/11/25 08:48  1256  1256     2 CWX0120
  BIGC       5    01.03 1991/11/21 1992/03/04 09:31  1256  1256     2 CWX0120
  BIGCOBOJ   5    01.01 1993/06/29 1993/06/29 16:34  2465  2465     0 CWX0120
  BIGCOBOL   5    01.05 1991/08/15 2003/01/21 13:33  2465  2465     0 PFHNEC1
  BIGD       5    01.01 1992/02/21 1992/02/21 08:37   102   101   101 CWX0120
  BIGE       5    01.00 1992/02/21 1992/02/21 08:38    11    11     0 CWX0120
  BIGPL1     5    01.20 1991/08/23 1991/08/23 15:19  1749  2465     0 CWX0120
  BIGX       5    01.00 1992/02/21 1992/02/21 08:34     2     2     0 CWX0120
  BLOG3      3    01.00 2007/04/11 2007/04/11 19:19    18    18     0 PMILZM1
  COBLPGM2   5    01.06 2001/11/09 2001/11/09 14:26   110    59     0 PFHBLD0
  COBOLPGM   5                                                                
  COUNTER    5    01.00 2000/04/27 2000/04/27 10:05     6     6     0 PFHNEC1
  CP16185X   5    01.00 2005/08/12 2005/08/12 14:32     5     5     0 FAQCBV1
  CP161855   5    01.00 2005/07/19 2005/07/19 15:03     6     6     0 FAQCBV1
  C417766    5    01.16 2000/11/21 2000/12/14 07:59    38    35     0 PFHMYA0

Important

Only SELECT, LOCATE, and PRINT primary commands are available with concatenated layout member lists. SORT is not available.

CONCAT

The CONCAT column displays the concatenation number.

Record layout XREF dataset

A record layout cross reference (XREF) dataset contains information created using option 7, XREF. XREF datasets are used in the following File-AID functions:

  • Formatted and vertical formatted mode of browse and edit
  • Formatted selection criteria definitions
  • Formatted print
  • Formatted compare criteria.

If you specify an XREF dataset and an X in Record layout usage on a dataset specification screen without specifying a member, File-AID displays a list of members. You can select an XREF member with the S (Select) line or primary command.

For an XREF dataset, the data set organization must be partitioned (DSORG=PO). The record format must be variable-blocked (RECFM=VB). The logical record length must be 300 (LRECL=300). And the XREF dataset must have a minimum block size of 304 (BLKSIZE=304). XREF and selection criteria members can be stored in the same data set.

You create record layout XREF members to communicate information about the Assembler, COBOL or PL/I record layout dataset to File-AID in the following situations:

  1. The data file you want to process contains more than one type of record, where each type of record requires a different layout to define it. The XREF member contains the location and values in the record type fields and the corresponding record layout members that define the data records with those values.
  2. The Assembler, COBOL or PL/I record layout(s) you want File-AID/Data Solutions to use are stored in a source library member containing multiple record layouts.
  3. The record layout(s) you want File-AID to use are embedded in an Assembler, COBOL or PL/I program.

    In situations 2 and 3, the record layout XREF contains the data-name that starts the record layout 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 data-name you specify.

  4. The data file contains segmented records. A segmented record is a single physical record that is divided into multiple logical records called segments. Each segment can be thought of as a distinct record that is described by a different record layout.
  5. The first n positions of each record in the data file are not defined by your record layout(s), requiring File-AID to generate a data-name item to act as filler before the layout(s).

    In this case, the XREF contains the length of the filler data-name item File-AID should generate before the record layout(s) that define the data records.

File-AID also supports various combinations of the situations described. For more information, see Record-Layout-Cross-Reference-function.

In any of the File-AID primary options that use record layouts to define the data, the record layout dataset or XREF dataset information must be specified. Use the fields shown in the following figure to accomplish this.

Record layout XREF dataset information sample

 Specify Record Layout and XREF Information:
    Record layout usage      ===> X        (S = Single; X = XREF; N = None)
    Record layout dataset    ===>'USERID9.FASAMP.LAYOUTS'
    Member name              ===>          (Blank or pattern for member list)
    XREF dataset name        ===>'USERID9.FASAMP.XREF'
    Member name              ===> XREFMEM  (Blank or pattern for member list)

Record layout usage indicates whether you intend to use a single record layout (usage S), an XREF (usage X), or no record layouts (usage N) to define the file.

If you specify Record layout usage X (use XREF), you must enter the valid record layout dataset name that contains the source layout members referenced in the XREF dataset member. The Record layout member name field is not used and may be left blank when using an XREF.

Important

Starting with File-AID Release 8.5, XREF layouts are compiled as needed.

Warning

XREF datasets should be maintained with File-AID option 7 (see also Editing of XREF or Selection Criteria Members).

Selection criteria data set

The Selection criteria data set contains information created using option 6 of File-AID. You can use selection criteria in the Browse, Edit, Copy, Search/Update, Print, and Compare functions. See Selection-Criteria-function.

For a Selection Criteria data set, the data set organization must be partitioned (DSORG=PO). The record format must be variable-blocked (RECFM=VB). The logical record length must be 300 (LRECL=300). And a selection criteria data set must have a minimum block size of 304 (BLKSIZE=304). Although Selection Criteria and XREF members can be stored in the same data set, it is preferable to keep them in separate data sets.

Warning

Selection Criteria data sets should be maintained with File-AID option 6 (see also Editing of XREF or Selection Criteria Members).

Editing of XREF or Selection criteria members

Every time you edit any XREF or Selection Criteria member, with the File-AID editor or any other editor, immediately issue the PRESERVE ON command (or its equivalent) to ensure that trailing blanks are maintained. File-AID requires trailing blanks in many instances, and if any of the required blanks are lost the XREF or Selection Criteria member becomes unusable by File-AID.

Be sure NOT to add trailing blanks accidentally to the value you supply in the VALUE clause of any criteria. Since File-AID does not require the value string to be enclosed in quotes, any blanks added at the end become part of the value string. You can avoid adding trailing blanks, even with PRESERVE ON, if you use primary commands like CHANGE rather than overtyping the value.

In general, to save disk space on varying length records, most text editors delete all trailing blanks unless you tell them not to do so. Editors other than the File-AID editor usually also delete the File-AID-specific information in the PDS directory, including the file type. Starting with Release 9.1 of File-AID, File-AID reconstructs the missing directory information when needed, but it does not recognize when trailing blanks have been removed.

The case of a change control system is different. Change control systems generally do not tamper with the data within the member; they preserve the data exactly as it is, including the blanks. However, the process of copying the member into the change control system generally loses the directory information when it separates the member from the PDS. When such a member is later retrieved from the change control system, the directory information is not there. Starting with Release 9.1 of File-AID, it is still possible to use such members in File-AID. If you select such a member when looking for an XREF, File-AID will try to use the member as an XREF, reconstructing the missing directory data. Similarly if you select such a member when looking for a Criteria member, File-AID will try to use the member as a Criteria member, reconstructing the missing directory data.

Important

We recommend that you change Criteria and XREF members using the documented File-AID interfaces. However, we also recognize that in some circumstances, particularly when involving a large volume of changes, you might prefer to modify criteria by other methods, using a utility program or a text editor. Realize, however, that if you elect to bypass the documented interfaces you are also bypassing all of the syntax validation that those interfaces perform.
BMC assumes no responsibility or liability for any editing or syntax errors that you may introduce when bypassing the documented interfaces.

Reformat definition dataset

The Reformat definition dataset contains information created using option 9 of File-AID. Option 9 is the reformat function which uses the reformat definition to reformat files online or in batch. For more information, see Reformat-function.

For a reformat definition dataset, the data set organization must be partitioned (DSORG=PO). The record format must be variable-blocked (RECFM=VB). The logical record length must be at least 1570 (LRECL=1570). The reformat definition dataset must have a minimum block size of 1574 (BLKSIZE=1574). Reformat definitions cannot be stored in an XREF or selection criteria data set.

Compare criteria dataset

The Compare criteria dataset contains information created using option 10 of File-AID. Option 10 is the Compare function which uses compare criteria to compare files online or in batch. See Compare-function. For a compare criteria data set, the data set organization must be Sequential (DSORG=PS) or partitioned (DSORG=PO). The record format must be fixed-blocked (RECFM=FB). The logical record length must be 80 (LRECL=80).

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*