Catalog Utility (3.4)
The File-AID Catalog utility displays lists of cataloged data sets. These lists can either be from a generic catalog search or a volume search of VSAM data sets in VSAM data space. A set of line commands can be used on any displayed list.
To select the Catalog utility, type the number 4 in the OPTION field of the Extended Utilities Menu, or as described in Selecting-screens. When you press Enter, the Catalog Utility screen is displayed as shown in Catalog Utility screen.
In addition, File-AID provides an F34 primary command that lets you recursively invoke the Catalog utility function. Enter the F34 command from any File-AID screen with an OPTION or COMMAND field. When you invoke the Catalog Utility in this way, use the END command (PF3) on the Catalog Utility screen, or the RETURN command (PF4) anywhere in the function, to return to the screen from which you entered the F34 command. After the second session is completed, the original session is continued.
Catalog Utility screen
The Catalog Utility screen has two options. The Generic catalog search function (option BLANK) allows you to specify a search name that File-AID uses to generate a list of datasets that match your criteria. When Generic catalog search function fields are left blank, all datasets associated with your userid are listed. When using option V, values must be entered in the Volume dataset list function fields to produce a VSAM dataset list.
Use the Catalog to search if other than default system catalog fields to specify alternate catalogs. The Display confirm delete field is used to specify the display of a confirmation screen when data sets are deleted.
Catalog Utility screen
Field Descriptions
OPTION
To select a Catalog option, enter one of the following option codes:
V
Produce Volume List of VSAM Datasets (Non-ICF Catalogs only). This option generates a list of VSAM components based on the specified volume serial number.
When option V is selected, specify the fields at the Volume dataset list function prompt. The Volume serial field is required and causes File-AID to list the VSAM clusters suballocated on the specified volume. The Translate DSN field is also required. It controls the type of VSAM names displayed on the volume list.
BLANK
Generic Catalog Search. When option BLANK is selected, specify the Generic catalog search function fields.
The value in the Search name field specifies the criteria used to select datasets from the catalog. File-AID displays only datasets that match the Search name value.
Generic catalog search function (all catalogs):
Search dataset name
Specify the Search name with explicit characters or a pattern data set mask (fully qualified, no quotes) to define the dataset names to include in the list. A pattern data set mask or name consists of explicit characters or a combination of explicit and pattern characters. The rules used for specifying a Search Name are similar to those used in ISPF/PDF’s Dataset List Utility. See Pattern data set names.
Format option
Specifies the amount of information to display about each data set. The default value for this parameter is set by the Format option field on the Parameters screen (option 0.4). There are three possible values:
Q (Quick)
Displays only the data set type and status.
S (Short)
Displays data set type, volume, and status.
L (Long)
Displays the data set organization, volume, record format, tracks allocated, percentage used of tracks allocated, and the number of extents allocated.
Multi-volume data sets are identified by the + (plus sign) following the Volume field with the Short and Long formats.
Clusters only
Specifies whether or not VSAM data and index components are included in the data set lists. Specify Y (Yes) to show only VSAM cluster names (along with non-VSAM data set names) in the data set list. Specify N (No) to show data and index components as well as VSAM cluster names (along with non-VSAM data set names) in the data set list.
Volume dataset list function (VSAM catalogs only):
Volume serial
Specify the volume serial of the direct access device to define the VSAM clusters to include in the list.
Translate DSN
Translate dataset name has two possible values: Y (Yes) and N (No). Y specifies that listed dataset names are to be translated from the catalog names into the cluster name. N specifies that the listed names are the catalog names.
Catalog to search if other than default system catalog:
The CATALOG NAME and CATALOG PASSWORD fields are only used when generating a list for a private catalog.
Catalog name
Optionally, specify a catalog for File-AID to search. When a catalog name is not specified in this field for a generic catalog search (option BLANK), File-AID searches the default system catalog.
When a catalog name is not specified for an option V search, File-AID checks all currently open catalogs for ownership of the value in the Volume serial field. The owning catalog contains the entries associated with the value in the Volume serial field.
Catalog password
Specify the password if the catalog is password protected.
Display confirm screen
Specify whether File-AID displays a Confirm Delete screen, as shown in Confirm Dataset Delete Screen when the D (Delete) line command is used on Catalog utility list screens. Valid entries are Y (Yes) and N (No).
Commands
File-AID permits the use of line commands on a list of dataset names displayed by the Catalog utility. The following table lists the available line commands.
Catalog Utility Line Commands
Command | Description | Limitations |
---|---|---|
B | ISPF/PDF Browse | Sequential, PDS |
E | ISPF/PDF Edit | Sequential, PDS |
V | ISPF/PDF View | Sequential, PDS |
R | Rename | All access methods |
U | Uncatalog | All non-VSAM access methods |
D | Delete | All access methods |
M | Modify | VSAM |
I | Display information | All access methods |
S | Display information--short | All access methods |
F | Free unused space | Sequential, PDS, BDAM |
1 | File-AID Browse | All access methods |
2 | File-AID Edit | All access methods |
6 | File-AID Search/Update utility | All access methods |
The FIND, LOCATE, and P (Print) primary commands can be used on Catalog utility lists.
Printing Catalog Lists
Catalog lists are printed by using the P command. The P (Print) command calls the File-AID print facility to write the list to SYSOUT. SYSOUT is then released for printing. The print facility uses the values set in the print parameter default options discussed in Print Parameters and displays a print values prompt screen that can be modified (Print Parameters Screen).
VSAM Dataset List Screen (V)
File-AID displays the VSAM Dataset List screen, as shown in the following figure, when option V is selected on the Catalog Utility screen. Line 1 of the VSAM Dataset List screen shows the volume from which the list was taken and the number of selected datasets. Line three lists the catalog in which the dataset names are located.
VSAM Dataset List Screen
Field Descriptions
Dataset Name
If the TRANSLATE DSN field is set to Y (Yes), the displayed names use the cluster name. If the TRANSLATE DSN field is set to N (No), the system-generated name is shown.
Dataset Type Comp
Identifies the dataset type and components of the displayed names:
Type - Either CLST (cluster) or AIX (alternate index).
Comp - Either DATA or INDX (index).
Allocatn Type
The allocation type is either UNIQUE or SUB-AL (suballocated).
Status
Indicates if line commands were processed on the dataset name (e.g., this column can indicate: DELETED, OLDNAME, NEWNAME). However, browse, edit, and information display are not indicated.
Use the END command (PF3) to terminate the dataset list display.
Dataset list screens (BLANK)
The generic catalog search (option BLANK) displays a list of catalog dataset names based on the search name. File-AID displays the appropriate Catalog Utility Dataset List screen for the specified Format option. Examples of this screen for the QUICK, SHORT, and LONG Format options are shown in the following figures.
The names on the Catalog Utility Dataset List screen match the value in the Search Name field. If Search Name is left blank, File-AID displays all dataset names that match the user’s TSO profile prefix. The top line on the screen states the number of dataset names that were found.
If a value is not specified in the Catalog Utility screen Search name field, File-AID performs two searches. One search is based on the TSO prefix; the other is based on the value in the VSAM Intermediate name field on the System Parameters screen (see System-Parameters).
The VSAM Intermediate name sets the second-level qualifier when the VSAM high-level name is used as the high-level qualifier. When File-AID is used to generate the catalog list, any VSAM data sets with the VSAM intermediate name as the second-level qualifier are selected.
Catalog Utility Dataset List Screen in QUICK Format
Catalog Utility Dataset List Screen in SHORT Format
Catalog Utility Dataset List Screen in LONG Format
Field Descriptions
Dataset Name
Dataset names that match the Search name.
Type
(Quick and Short formats) Catalog entry type. Types that may be displayed include: CLUSTER, DATA, INDEX, ALT INDEX, PATH, NON-VSAM, GDG BASE, USER CTLG, ALIAS, and PAGESPACE.
Org
Organization of the data set using the following codes:
DA - BDAM
PO - Partitioned
POE - Partitioned Extended (PDSE)
PS - Physical sequential
PSC - Physical sequential Extended Compressed
PSE - Physical sequential Extended
VS - VSAM
VSC - VSAM Extended Compressed
VSE - VSAM Extended
Volume
(Short and Long formats) Volume on which the data set is stored.
Multi-volume data sets are identified by the + (plus sign) following the Volume field with the Short and Long formats.
STATUS
Indicates if line commands were processed on the dataset name. For example, this column can indicate: DELETED, OLDNAME, NEWNAME, and UPDATED.
% US
(Long format) Percent of allocated tracks currently in use.
XT
(Long format) Number of extents contained in the data set.
FMT
(Long format) Record format (RECFM) of the data set.
TRKS
(Long format) Number of tracks allocated for the data set.
Use the END command (PF3) to terminate the data set list display.