Keywords
This details keywords for the EXPLORE command.
- COLUMN-LISTFILE
- specifies that the format of the output is a data set list with
three data set names per print line and is written to the file specified
on the named DD statement. You can specify a SYSOUT DD statement name
so that the output is written as a standard 133-column print file.
Truncated-long data set names will be shown with a “+” symbol. Data sets that are not cataloged are shown with ”(U)” and data sets that are miscataloged are shown with “(M)” in BY-VOLUME mode.
- COLUMN-LIST
- specifies that the format of the output is a data set list with
three data set names per print line and is written to the specified
pre-existing, dynamically allocated data set.
Truncated-long data set names will be shown with a “+” symbol. Data sets that are not cataloged are shown with ”(U)” and data sets that are miscataloged are shown with “(M)” in BY-VOLUME mode.
- DSN-LISTFILE
- specifies that the format of the output is one data set name per
line and is written to the file specified on the named DD statement.
You can specify a SYSOUT DD statement name so that the output is written
as a standard 133-column print file.
Data sets are shown with “Uncataloged” or in BY-VOLUME mode with “Miscataloged” when applicable.
- DSN-LIST
- specifies that the format of the output is one data set name per
line and is written to the specified pre-existing, dynamically allocated
data set.
Data sets are shown with “Uncataloged” or in BY-VOLUME mode with “Miscataloged” when applicable.
- ICF-LISTFILE
- specifies that the format of the output is similar to the IDCAMS
LISTCAT format, but with additional enhancements and is written to
the file specified on the named DD statement. You can specify a SYSOUT
DD statement name so that the output is written as a standard 133-column
print file. The ICF list reports on the data sets selected by your filters and related components that may not have been a part of your selection criteria, such as:
- For VSAM data, ICF list includes the data and index components.
- For catalogs, ICF list includes the associated catalog aliases.
- For non-VSAM data sets, ICF list includes non-SYMBOLICRELATE aliases.
Data sets are shown with “Uncataloged” or in BY-VOLUME mode with “Miscataloged” when applicable.
- ICF-LIST
- specifies that the format of the output is similar to the IDCAMS
LISTCAT format, but with additional enhancements and is written to
the specified pre-existing, dynamically allocated data set. The ICF list reports on the data sets selected by your filters and related components that may not have been a part of your selection criteria, such as:
- For VSAM data, ICF list includes the data and index components.
- For catalogs, ICF list includes the associated catalog aliases.
- For non-VSAM data sets, ICF list includes non-SYMBOLICRELATE aliases.
Data sets are shown with “Uncataloged” or in BY-VOLUME mode with “Miscataloged” when applicable.
- SORTED
- specifies that the output of data sets will be sorted in ascending EBCDIC collating sequence by data set name.
- NO-GDGBASE-NONVSAM
- suppresses the printing of individual GDS in the output of ICFLIST or ICFLISTFILE.
- LIST-ALL-GDS
- List all members of a GDG when any are selected, as IDCAMS LISTCAT does. By default, only GDS that meet all selection criteria are listed.
- EXT-FLAT
- specifies that extract data is written to the specified pre-existing
data set.
Be aware that the fixed-block extract file can have either LRECL of 921 or 1200. With LRECL of 1200, additional fields are available that are not available in the extract of the LRECL 921 record.
EXPLORE writes extract records consisting of a base segment (data set component data) and at most one allocated volume segment. If the data component has more than one allocated volume, EXPLORE writes multiple extract records with the same base segment and one allocated volume segment.
See Usage Note #1 for how specifying ICFLIST or ICFLISTFILE affects the records that are written to the output file.
- EXT-FLATFILE
- specifies that extract data is written to the specified DD statement.
If SYSPRINT is used then the extract will be truncated and will be
unsuitable for use.
Be aware that the fixed-block extract file can have either LRECL of 921 or 1200. With LRECL of 1200, additional fields are available that are not available in the extract of the LRECL 921 record.
EXPLORE writes extract records consisting of a base segment (data set component data) and at most one allocated volume segment. If the data component has more than one allocated volume, EXPLORE writes multiple extract records with the same base segment and one allocated volume segment.
See Usage Note #1 for how specifying ICFLIST or ICFLISTFILE affects the records that are written to the output file.
- STORGRP
- specifies that EXPLORE should determine the storage group for the extracted data.
- GENMAP
- specifies either MAP commands or the output of MAP commands be written based on the GENMAP options. See GENMAP options.
- CRITERIA
- specifies what to include or exclude from the search.
- INCLUDE
- specifies what to include in the search.
- DSN EQ—specifies what data set the search value must equal.
- dsn/dsnmask—specifies a specific or masked data set name.
- filter—see CRITERIA keyword filters
- EXCLUDE
- specifies what to exclude from the search.
- DSN EQ—specifies what data set the search value must equal.
- dsn/dsnmask—specifies a specific or masked data set name.
- filter—see CRITERIA keyword filters
- BY-DSN-DD
- specifies that EXPLORE performs a search on each of the data set names or masks found in the specified DD. You must have the same DD name in the JCL as the DD name used in the EXPLORE statement. BY-DSN-DD and BY-VOLUME are mutually exclusive.
- ONLY-BCS-DATA
- specifies what type of data EXPLORE's catalog reader should access.
By default, when ONLY-BCS-DATA is not specified, EXPLORE determines if it needs to retrieve VTOC and VVDS data to satisfy the request. EXPLORE accesses the VTOC and VVDS for each non-migrated disk data sets when any of the following is true:
- An ICF listing is requested.
- An extract file is requested.
- A filter requires data that is stored in the VTOC or VVDS.
ONLY-BCS-DATA directs EXPLORE to use only data from catalogs and not access the VTOC or VVDS when retrieving catalog data for a data set. ONLY-BCS-DATA can significantly reduce EXPLORE processing time when VTOC and VVDS information is of no value, such as reporting on tape data sets or GDG base information.
Using ONLY-BCS-DATA has the following impacts:- An abbreviated ICF list is written which contains no VTOC or VVDS data.
- The extract file has null values for all of the fields derived from VTOC and VVDS data.
- The DS-TYPE filter accepts only that subset of the values that can be determined without VTOC and VVDS data. Although AIX, AIXC, AIXD, and AIXI are available, all of the detailed VSAM types are eliminated leaving VSAM, VSAMC, VSAMD, and VSAMI.
- Many of the standard filters will not be shown in the ISPF interface's filter dialog and will yield an error in batch processing.
- MASTER-CATALOG
- specifies a fully qualified data set name of a catalog that EXPLORE
will use as the master catalog. This value cannot be a mask.
This keyword is useful when creating a test master catalog or when running EXPLORE with the master catalog of a different image.
When EXPLORE is running on one system with the master catalog of another system, your results will differ due to the following:- EXPLORE resolves symbolic names using the current system's symbolic names.
- EXPLORE will not be able to access data sets including user catalogs that are not online to the current system.
- CACHE-VTOC
- specifies that EXPLORE uses VTOC caching options to improve performance
when indexed VTOCs become disabled on high-activity volumes.
- YES is the default
- NO prevents EXPLORE from using the CVAFDIR caching options
- RESERVE causes EXPLORE to issue a RESERVE on volumes before reading them. EXPLORE will monitor the time volumes are reserved, and periodically release them to avoid system contention.
- BY-VOLUME
- specifies that EXPLORE performs a search on each of the data set
names found in the VTOCs of the specified disk volumes, disk storage
groups, or both. BY-DSN-DD and BY-VOLUME are mutually exclusive.The output of EXPLORE BY-VOLUME differs from the other modes, in the following ways:
- The CATALOGED value may also include “M” when there is a mismatch of volumes between the catalog and the VTOC entries selected.
- The VOLCOUNT-U count of volumes not included in the catalog record may be non-zero.
- For those incorrectly cataloged VTOC entries, EXPLORE gathers
and reports but does not filter on the following data elements:
- VOL
- F1-CREDT
- REFDT
- DEVTYPE
- EXTENTS
- TRACKS-ALLOC
- CYL-ALLOC
- ALLOCTYPE
- JOBNAME (from a format-8 DSCB)
- STEPNAME (from a format-8 DSCB)
- For KSDS data sets with missing catalog truename records, the
output depends on the sort order of the data versus index component
names. Typically, the data component sorts before the index component
because the data component ends with either “.DATA” or “.D” rather
than “.INDEX” or “.I”.
Generally, EXPLORE finds the sorted-first component's truename and uses the cluster entry to resolve the data and index components. Having resolved both of these components, EXPLORE suppresses evaluation of the sorted-second component to eliminate duplicates. However, if EXPLORE cannot find the sorted-first KSDS component true name, this component is reported as not cataloged. Later, when the sorted-second component is evaluated and its truename is found, EXPLORE uses the cluster entry in the catalog to resolve both the data and index components. The result is that the sorted-first component will be available for reporting twice.
- CAT-VOL
- specifies for miscataloged BY-VOLUME items, which volumes will
be written to an extract file.
- C – the volume found from the catalog
- U – the volume found from the VTOC
- INCLUDE-STORAGEGROUP
- specifies one or more disk volume storage group names or storage group masks that contain data set names to be used in the search.
- INCLUDE-VOLUME
- specifies one or more disk volume names or volume masks that contain data set names to be used in the search.
- EXCLUDE-STORAGEGROUP
- specifies one or more disk volume storage group names or storage-group masks that contain data set names to be excluded from the list of data sets used in the search.
- EXCLUDE-VOLUME
- specifies one or more disk volume serials or volume serial masks that contain data set names to be excluded from the list of data sets used in the search.
- PDSE-DATA
-
if YES, specifies that EXPLORE will retrieve internal PDS and PDSE information. This includes:
- Directory block counts and % used
- Member count
- Allocated, used, and high-used space used in pages (4Kb)
- PDSE generation counts
Note: This option will cause significant extra overhead for PDS and PDSE data sets, as they have to be individually allocated, opened, and read to obtain the additional information. This overhead is incurred only for PDS/PDSE data sets; it has no effect on processing of other types of data sets.
GENMAP options
The GENMAP keyword specifies that each KSDS or BCS data set selected by the EXPLORE command will be formatted into a MAP command, executed as a MAP command, or both.
- EXECUTE
- specifies that every KSDS or BCS data set selected by EXPLORE will be executed as MAP commands. The output is written to the normal SYSOUT file.
- OUTFILE
- specifies the Data Definition name (DD name) to use to allocate
the output GENMAP file. You must use this option if one of the following
is true:
- The output is a Generation Data Set (GDS) and you want to specify a relative GDG. For example: GDG.NAME(+1).
- You want to control the STATUS of the output file. For example: DISP=MOD.
- OUTDATASET
- specifies the name of the pre-existing output GENMAP data set.
- REPORTS
- specifies the reports you want to generate. You can specify any
of these available reports:
- ALL—generates all of the reports.
- CATLIST—generates a Catalog Listing report. This report is very similar to an IDCAMS LISTCAT report, but with several beneficial formatting modifications and field additions or changes.
- CA-MAP—generates a Control Area Map report. This report produces, for the Data Component, a CA-by-CA report, that illustrates CA splits, free CIs in each CA, potentially unusable CIs, CI utilization, key compression information. and the high-key for each CA.
- FREE-CI—generates a Free CI Distribution report. This report will actually generate a CA Split Distribution report and a Free CI Distribution report. To obtain this information, the command tallies the number of contiguous CA splits that have occurred throughout the object, as well as the number of free CIs in every CA processed. The reports are a summary of how these two free resources are distributed across the object.
- INDEX—generates an Index Structure report. This report provides a key size distribution summary, an Index Component CI size analysis (to assist in determining if potentially unusable Data Component CIs exist), and an Index Component record distribution summary.
- RECOMMENDATIONS—generates a Recommendations report. This report provides various performance tuning and object attribute change recommendations.
- RECORD-SIZE—generates a Record Size Distribution report. This report uses a sampling technique, when processing the object's Data Component, to reduce execution-time overhead, the sampling value may be changed via the SAMPLE keyword. By default, two CIs in every CA will be sampled, and the records therein used. If the sampled CIs contain segments of a spanned record, additional CIs may be processed. This report may aid in developing an appreciation of the average record size; this will help in developing an appropriate CI free space percentage, the potential for records to span CIs and other data.
- STATISTICAL—generates a Statistical Summary report. This report, while it contains a lot of information similar to the IDCAMS LISTCAT, is considerably more useful, as it combines actual object analysis information with the LISTCAT information, to produce information that tells you how the object is really behaving, and what the various attributes are costing you.
- HEXKEY
- prints the two digit hexadecimal key value along with each line of the character key. This is useful for those application objects that use non-printable characters within the key.
- RECORD-COUNTERS
- controls the number of counter fields to be established to accumulate, by record length, the number of records found. The default value is 2048. You can specify an integer between 1024 and 99999 (inclusive). These accumulators are used when the Record Sizes report is requested.
- SAMPLE
- indicates the number of CIs in each data component CA to sample. Specify an integer value between 0 to 99999999. The default is 2.