FDREPORT PRINT Statement


PRINT statement

The PRINT statement actually generates the report defined by previous FDREPORT statements and operands on PRINT itself. FDREPORT performs the print using the characteristics specified on the preceding XSELECT, REPORT, DEFAULT, and/or SORT statements. A PRINT statement must be specified; multiple PRINT statements may be given to produce various reports in one execution of FDREPORT. All parameters that define the report to be generated (TITLE, HEADING, REPORT, SORT, SUMMARY, XSELECT, XEXCLUDE, and/or PUNCH) must precede the PRINT statement.

Important

The values entered on XSELECT and/or XEXCLUDE statements remain in effect until canceled (see CANCEL statement). Specifying a new XSELECT and/or XEXCLUDE statement without canceling a prior XSELECT and/or XEXCLUDE statement only serves to augment the existing statements. Specifying new TITLE, HEADING, REPORT, SORT, and SUMMARY statements completely replace the prior version of these statements. The values on the DEFAULT statement remain in effect until specifically modified.

PRINT statement syntax

PRINT


AGE=nnn


,AGEACCUM=nn


,AGEINC=nnn


,ALIASLEVEL=n


,ALTDATADDNAME=ddn


,ARCLIMIT=nnnnn


,BININTERVAL=nn


,BYTEFORMAT=BYTES|KILOBYTES|MEGABYTES|GIGABYTES|TERABYTES|REALBYTES


,CANDSPACE=GUARANTEED|POTENTIAL


,CATALOGSEARCH=RELATED|STANDARD


,CHKONLRESERVE=BYPASS|RETRY|WAIT


,COPY=BOTH|EITHER|1|2


,CSVDDNAME=ddn


,DATADDNAME=ddn


,DATATYPE=ARCHIVE|BCDS|CATALOG|CATARCH|CATVTOC|CA1DSN|CA1VOL|DEFDASD| ENCRYPT|EXTRACT|MCDS|RACFGRPS|RACFUSER|RMMDSN|RMMVOL|SCRATCH| STORGRP|SYSPLEX|TVTOC|UNITNAME|VOLDATA|VTOC


,DATEFORMAT=DDMMYY|DDMMYYYY|MMDDYY|MMDDYYYY|YYDDD|YYDDMM|YYMMDD| YYYYDDD|YYYYDDMM|YYYYMMDD


,DIAGPCHDDNAME=ddn


,DISABLE=(options)


,DSKIP=n


,ENABLE=(options)


,EXTRACTDSNAME=dsn


,EXTRACTMEMBER=mem


,FORMAT=CRT|DEVICE|PRINT|TSO


,ICF=IGNORE|YES


,ICFSOURCE=LOCATE|VVDS


,IFKEYWORDERROR=BYPASS|PROCESS


,IFNOVERSION=cccc


,IFSELECTERROR=BYPASS|PROCESS


,INDEXNUM=nn


,LBPZERO=INVALID|VALID


,LINECNT=nnn


,MAXBKUPARRAY=nn


,MAXCOPY=n


,MAXGDG=nnn


,MAXONLINE=nnnn


,MAXSEPARATE=nn


,MIHINTERVAL=n


,MINSEPARATE=nn


,OLDBACKUP=ALL|CUR|(nn[,nn,…])


,PAGEWIDTH=nnn


,PCHDATEFORMAT=DDMMYY|DDMMYYYY|MMDDYY|MMDDYYYY|YYDDD|YYDDMM|YYMMDD| YYYYDDD|YYYYDDMM|YYYYMMDD


,PCHDDNAME=ddn


,PCHSEPCHAR=c


,POFREESPACE=DIR|IFREAD|LBP


,PRTLENGTH=nnnnn


,RECORDSUMMARY=CLUST|COMPON|NONE


,RESETMASKAFTER=nnnnn


,RESFAILRTNCD=nnnn


,RESWAITIME=nn


,RETRYLOOPS=nn


,RPTDDNAME=ddn


,RPTSPFC=nn


,RPTSPFI=nn


,RPTYPE=ABRVTOC|ARCHIVE|COMPDATA|CSV|DATA|GENERATE|HEX|NONE|OSVTOC| SELPCH|TABLE|XREF


,SKIP=n


,SORT=COMBINE|NO|YES


,SORTALLOC=CYL|NO|SORTLIB|SORTMSG|SORTWORK|TRK|YES


,SORTCORE=nnnnnnn


,SORTLIB=dsn


,SORTMSG=AC|AP|CC|CP|NO|PC


,SORTMSGDDNAME=ddn


,SORTPFX=cccc


,SPFC=nn


,SPFI=nn


,SSPKLINECNT=n


,SUMBYTEFORMAT=BYTES|KILOBYTES|MEGABYTES|GIGABYTES|TERABYTES| REALBYTES


,SUMDDNAME=ddn


,SUMDEVICE=BASE|UNIQUE


,SUMLEVEL=INDEX|NONE|REPORT|YES


,SYSUTSPACE=nnnnn


,SYSUTSTORCLAS=storclas


,SYSUTUNIT=unit


,TITLE=CENTER|LEFT|RIGHT


,UNITPREFIX=n


,VOLPREFIX=n


,VOLSUMMARY=CTLSERNO|DEVTYPE|MFRCODE|NOBREAK|NONE|SSID|STORGRP| UNITPREFIX|VOLPREFIX


,VTOCPAD=nn


,VTOCREAD=CYL|TRK


,WORKDDNAMES=n


,WORKSPACE=nnnnn


,WORKSTORCLAS=storclas


,WORKUNIT=unit

AGE=

nnn

Specifies the number of days since a data set has been referenced as used by the aging summary in the VTOC lists. The number may be from 1 to 999.

Default: 30.

AGEACCUM=

nn

Specifies the number of age accumulators that are maintained and printed if SUMLEVEL=REPORT is specified. The number may be a value from 0 to 10.

Default: Each report summary block does not contain age accumulators.

AGEINC=

nnn

Specifies the number to be added to the age value to derive the next date control break in the aging summary in the VTOC lists. The number may be from 1 to 999.

Default: 30.

ALIASLEVEL=

n

Specifies an alias level, from 0 to 4, to be used when selecting data sets from the system catalogs. If 0, it uses the Multi-Level Alias (MLA) level currently in effect in the Catalog Address Space (CAS) on your system. If 1 through 4 is specified, it acts as though that is the current MLA level active on your system; this provides a way to test an Multi-Level Alias (MLA) catalog structure before you activate it.

Default: 0.

ALTDATADDNAME=

ddn

Specifies the ddname of the file to be used for the input of FDREPORT internal records when RPTYPE=DATA (or COMPDATA) and DATATYPE=EXTRACT are both specified.

Default: SYSUT1.

ARCLIMIT=

nnnn

When DATATYPE=ARCHIVE or CATARCH is specified, only data sets that were archived within the last “nnnn” days are selected.

Default: 0, which disables ARCLIMIT checking.

BININTERVAL=

nn

Specifies the wait time interval in hundredths of seconds to wait for an I/O to an offline device to complete before considering it eligible for purge. The value can be from 4 to 49.

Default: 7 hundredths.

BYTEFORMAT=

Specifies the units to be used in fields that represent a number of bytes are to be processed:

BYTES

Actual bytes.

KILOBYTES

Units of kilobytes (1000 bytes).

MEGABYTES

Units of megabytes (1,000,000 bytes).

GIGABYTES

Units of gigabytes (1,000,000,000 bytes).

TERABYTES

Units of terabytes (1,000,000,000,000 bytes).

REALBYTES

Actual bytes displayed as a 16 digit numeric value.

The fields affected include: BYTES, PRIBYTES, SECBYTES, BYTESUSE, BYTESFRE (see FDREPORT-Field-Names for details). Kilo and megabytes are in units of 1024 and 1048576 if ENABLE=HEXBYTES is in effect.

For printing (REPORT statement), this operand affects both the units in which the field is printed and the width of the field in the report (10 columns for BYTES, 7 for KILOBYTES, 4 for MEGABYTES).

Default: KILOBYTES.

CANDSPACE=

Specifies how candidate space is to be calculated when requested via an ENABLE=CANDSPACE request. The possible values are:

GUARANTEED

Only the already allocated guaranteed space on a volume is included.

POTENTIAL

The maximum possible space, assuming all extents are allocated, is included.

Default: GUARANTEED.

CATALOGSEARCH=

Specifies the search order when issuing locates for data sets or clusters with related catalogs. Related catalogs are usually extracted from a VVR or NVR. They also may be extracted from the master catalog when the data is derived from either DATATYPE=CATARCH or CATVTOC. The possible values are:

RELATED

Use the related catalog when issuing the locate.

STANDARD

Use the standard search order when issuing the locate.

Default: RELATED.

CHKONLRESERVE=

Specifies whether FDREPORT is to check for long term reserves from other systems against online DASD UCBs prior to attempting to process them. A long term reserve is one that lasts over “nn” seconds. The “nn” value for the wait time can be set using the keyword RESWAITIME=RESWAITIME= defaults to 2 seconds. The valid responses are:

BYPASS

Check for the reserve and if it is over “nn” seconds, bypass the UCB while issuing a message, and give the return code specified by RESFAILRTNCD= (default for RESFAILRTNCD= is 7)..

RETRY

Check for the reserve and if it is over “nn” seconds, add the UCB to a retry queue. Up to 500 UCBs can be added to the retry queue. Any more are automatically bypassed. After all other UCBs have been processed, UCBs on the retry queue are retried up to the number of times specified by RETRYLOOPS= (default is 1 retry). If any UCBs fail after all of the retries, they are bypassed, and the return code is set to the value specified by RESFAILRTNCD= (default for RESFAILRTNCD= is 7).

WAIT

Reserves are not checked. If they are encountered, the program waits until the reserve is freed.

Default: RETRY.

COPY=

When fields relating to ABR backup or archive information are included in the report, specifies which ABR copy (1 or 2) appears in the report. Values are:

1

Information about COPY1 is used.

2

Information about COPY2 is used.

n

Information for COPYn is used. “n” can be a value from “1” to “9” inclusive.

ALL

Report information from and apply the selection criteria to all backup copies. The upper limit for copy number is taken from the keyword MAXCOPY= that defaults to 2.

ANY

Report information from and apply the selection criteria to the first backup copy located. The upper limit for copy number is taken from the keyword MAXCOPY= that defaults to 2.

BOTH

Both COPY1 and COPY2 are used (if both are cataloged). Prints two lines in the report.

EITHER

COPY1 information is used, if a COPY1 backup is recorded, otherwise, COPY2 is used.

Default: EITHER.

CSVDDNAME=

ddn

Specifies the ddname to be used when creating RPTYPE=CSV output reports.

Default: ABRCSV, unless the operand CSVDDNAME= was specified on the DEFAULT statement.

DATADDNAME=

ddn

Specifies the DD statement name of the file to be used for the output of FDREPORT internal records when RPTYPE=DATA is specified, or for the input of those records when DATATYPE=EXTRACT is specified.

Default: SYSUT2.

DATATYPE=

Specifies the source of FDREPORT’s input data. Values are:

ARCHIVE

Read records from an Archive Control File. If an ARCHIVE DD Statement is present, that Archive Control File is read; otherwise the control file name specified in the ABR option table or by ARCDSNAME= is dynamically allocated.

BCDS

Report on data extracted from a DFSMShsm (Backup Control Data Set (BCDS). See FDREPORT-DFSMShsm-Reporting for details.

CATALOG

Data set records are extracted from system catalogs.

CATARCH

Data set records are extracted from system catalogs; only those data sets cataloged for auto-recall are selected. The extracted names are used to select data sets from the Archive Control File (see ARCHIVE” in Section 54.21).

CATVTOC

Data set records are extracted from system catalogs. The extracted names are used to select data sets from the VTOCs of the volumes extracted from the catalog (see VTOC” in Section 54.21).

CA1DSN

Report on tape data set information extracted from the CA 1 tape management system. See Section 54.32 “FDREPORT Tape Management Reporting for details.

CA1VOL

Report on tape volume information extracted from the CA 1 tape management system. See Section 54.32 “FDREPORT Tape Management Reporting for details.

DEFDASD

Information is collected from all defined DASD.

ENCRYPT

Input data is extracted from the Encrypt Key File created and maintained by the BMC product FDRCRYPT.

EXTRACT

FDREPORT internal records are read from the SYSUT2 DD Statement. This data set must have been created by FDREPORT using RPTYPE=DATA or RPTYPE=COMPDATA in this step or a previous step or job. This may be used to produce several reports from the same set of data without the overhead of reconstructing that data. For extract files created with RPTYPE=DATA only, SYSUT2 may be a concatenated DD statement, allowing you to read several extract files as one.

MCDS

Report on data extracted from a DFSMShsm MCDS (Migration Control Data Set). See Section 54.31 “FDREPORT DFSMShsm Reporting for details.

RACFGRPS

Report on all defined IBM RACF groups using a predefined output format. No selection or output formatting is offered.

RACFUSER

Report on all defined IBM RACF users using a predefined output format. No selection or output formatting is offered.

RMMDSN

Report on tape data set information extracted from the DFSMSrmm tape management subsystem. See Section 54.32 “FDREPORT Tape Management Reporting for details.

RMMVOL

Report on tape volume information extracted from the DFSMSrmm tape management subsystem. See Section 54.32 “FDREPORT Tape Management Reporting for details.

SCRATCH

Information is collected from the ABR scratch catalog.

STORGRP

Report on all defined System Managed Storage (SMS) storage groups using a predefined output format. No selection or output formatting offered.

SYSPLEX

Report on the current sysplex definition using a predefined output format. No selection or output formatting offered.

TVTOC

Information is extracted from a backup file created by FDR, FDRDSF, FDRABR, or SAR.

UNITNAME

Report on all defined unit names using a predefined output format. No selection or output formatting offered.

VOLDATA

Volume summary data is gathered for selected volumes using LSPACE, VTOC, VTOCIX, and VVDS, creating a volume record.

VTOC

Data set information is read from the VTOCs and VVDSs of volumes selected.

Default: VTOC.

DATEFORMAT=

Specifies the format that dates are printed in generated reports. Valid values are:

DDMMYY

Gregorian format, day first “dd/mm/yy”.

DDMMYYYY

Gregorian format, day first with 4-digit year “dd/mm/yyyy”.

MMDDYY

Gregorian format, month first “mm/dd/yy”.

MMDDYYYY

Gregorian format, month first with 4-digit year “mm/dd/yyyy”.

YYDDD

Julian format “yy.ddd”.

YYDDMM

Gregorian format, 2-digit year first “yy/dd/mm”.

YYMMDD

Gregorian format, 2-digit year first “yy/mm/dd”.

YYYYDDD

Julian format with 4-digit year “yyyy.ddd”.

YYYYDDMM

Gregorian format, 4-digit year first “yyyy/dd/mm”.

YYYYMMDD

Gregorian format, 4-digit year first “yyyy/mm/dd”.

If one of the Gregorian formats is chosen, then date fields are 8 columns long in reports, instead of the 6 columns shown in the tables that follow. If a 4-digit year format is chosen, the date fields are an additional two bytes. This affects only printing; sorting is always in Julian “yyyyddd” format and selection operands can use Julian in either 2- or 4-digit year format.

Default: YYYYDDD (Julian format).

DIAGPCHDDNAME=

ddn

Specifies the ddname to be used when ENABLE=PUNCHDIAGNOS is specified causing IDCAMS DELETE statements that are created from VVDS errors encountered in normal processing or the result of running with DIAGNOSEVVDS enabled to be punched.

Default: DIAGPCH; unless the operand DIAGPCHDDNAME= was specified on the DEFAULT statement.

DISABLE=

The FDREPORT options specified are to be disabled for this run. Multiple options can be specified by enclosing the list in parentheses, separated by commas. Available options are described in FDREPORT-Execution-Options.

DSKIP=

n

Specifies the number of blank lines to be inserted between lines representing separate data sets (differs from SKIP= when multiple lines are required for one data set.

Default: 0.

ENABLE=

The FDREPORT options specified are to be enabled for this run. Multiple options can be specified by enclosing the list in parentheses, separated by commas. Available options are described in FDREPORT-Execution-Options.

EXTRACTDSNAME=

dsn

Specifies the data set name of an existing data set to be used for FDREPORT extract data input (if DATATYPE=EXTRACT) or output (RPTYPE=DATA or COMPDATA). This data set is dynamically allocated as SYSUT2 DD Statement (or whatever is specified by DATADDNAME=).

EXTRACTMEMBER=

mem

Used in conjunction with EXTRACTDSNAME=. If the data set pointed to by EXTRACTDSNAME= is a PDS, this specifies a member name in that PDS to be used for input or output.

FORMAT=

Specifies that the report is to be prepared using other than the default format selected by the program.

CRT

Defaults to PAGEWIDTH=78 to generate a report formatted for viewing on a terminal. Can also be specified as TSO or T.

DEVICE

Defaults to CRT if the output device type is a terminal and PRT is the output device type is a print device.

PRINT

Defaults to PAGEWIDTH=120 to generate a report formatted for printing. Can also be specified as PRT.

The line length can be overridden by the PAGEWIDTH= operand.

Default: CRT if executed under TSO; PRT otherwise.

ICF=

Specifies how ICF VSAM data sets are to be processed. The available options are:

IGNORE

Bypass relating the ICF components to the base cluster. Permit selection and processing by component name.

YES

Process ICF data sets based on the base cluster only. Do not select or process any component as a separate entity.

Default: YES.

ICFSOURCE=

Specifies how (where) information is to be obtained for reporting on ICF VSAM data and index components.

LOCATE

Issue super-locate to obtain the necessary information.

VVDS

Read the SYS1.VVDS.Vvolser cluster directly and extract the necessary information directly from the VVR records.

Default: LOCATE if FDREPORT is not APF authorized; VVDS if FDREPORT is APF authorized.

Important

Specifying VVDS requires that the programs reading the VVDS be fully APF authorized or the end of extent appendage IGG019YZ be placed in the Authorized Appendage List.

IFKEYWORDERROR=

Specifies how FDREPORT is to respond to the PRINT command (or other action commands) if an error is encountered during the parsing of user specified keywords.

BYPASS

Bypass all action commands but continue to parse keywords.

PROCESS

Process all action commands.

Default: PROCESS.

IFSELECTERROR=

Specifies how FDREPORT is to respond to the PRINT command (or other action commands) if an error is encountered during the parsing of user specified keywords and values on any of the XSELECT or XEXCLUDE commands.

BYPASS

Bypass all action commands but continue to parse keywords.

PROCESS

Process all action commands.

Default: PROCESS.

INDEXNUM=

nn

Field name INDEX allows sorting, summary, and so on, on an index level extracted from each data set name. INDEXNUM= specifies which index level is to be extracted (1 is first, 2 is second, and so on up to 22).

Default: 1, the high-level index.

LBPZERO=

Specifies how a PS (sequential) data set whose last block pointer is all zeros is to be treated for used and free track calculations.

VALID

Means that such data sets are considered to have no tracks used and all tracks free.

INVALID

Means they are considered to be entirely used and no tracks free.

Since most access methods maintain a valid last block pointer in the Format 1 DSCB, LBPZERO=VALID (the default) produces correct reports for almost all data sets so it is recommended.

Default: VALID.

Important

The LBPZERO= operand in FDREPORT is not affected by the default value of LBPZERO in the FDR Global Options (that value is used for backups, restores, and similar functions). The default of LBPZERO in FDREPORT can be changed with the procedure described under the DEFAULT statement (FDREPORT-DEFAULT-Statement).

LINECNT=

nnn

Specifies the maximum number of lines each report page can contain, including heading lines, from 10 to 999 inclusive.

Default: 58.

MAXBKUPARRAY=

nn

Specifies the maximum number of backup segments that can be associated with any report data record. The value specified may be any number from 2 through 30.

Default: 28.

MAXCOPY=

n

Specifies the maximum value for COPY= when executing with COPY=ALL or COPY=ANY. The value specified may be any number from 1 through 9.

Default: 2.

MAXGDG=

nnn

When reading from the system catalogs (DATATYPE=CATALOG, CATVTOC, or CATARCH), specifies the maximum number of generations of each Generation Data Group (GDG) that are selected. Only the most recent “nnn” generations are processed.

Default: All generations are processed.

MAXONLINE=

nnnnn

Specifies the maximum number of DASD volumes that can be processed by this PRINT statement. The value can be from 5 to 32000. If the number of DASD volumes selected exceeds this number, an error occurs. This is a special concern when using ENABLE=ONLINE in installations with large DASD installations.

Default: 256. If ENABLE=AUTOMAXONLIN is in effect, MAXONLINE= is automatically set to the number of DASD volumes online to this system.

MAXSEPARATE=

nn

Specifies the maximum number of spaces that must be left between printed data fields during custom report generation. The number may be a value from the current value of MINSEPARATE= to 30.

Default: 1.

MIHINTERVAL=

n

Specifies the wait time interval in seconds when using the Missing Interrupt Handler (MIH) to time I/Os against offline devices. The number may be a value between 1 and 7.

Default: 1.

MINSEPARATE=

nn

Specifies the minimum number of spaces that must be left between printed data fields during custom report generation. The number may be a value from 0 to the current value of MAXSEPARATE=.

Default: 1.

OLDBACKUP=

When ABR backup information is requested, and old backups are being recorded, specifies which old backup information is to be printed. Values are:

(nn,…,nn)

Requests specific old backups. “nn” are numbers from 00 to 13 (00 being the most recent backup, 13 being the oldest).

ALL

Requests all old backups existing for a data set are to be printed.

CUR

Requests that only the current backup is to be printed.

If multiple backups exist and are requested for a data set, the report contains multiple lines for the data sets.

Default: CUR.

PAGEWIDTH=

nnnn

Specifies the number of print positions (from 52 to 3072) to be used in creating the report, excluding the printer control character in column 1. Heading lines and formatted data fields should fit within this limit. If the data fields requested exceed the PAGEWIDTH=, FDREPORT prints all of the data that fits and displays a warning message.

Default: 78 if FORMAT=CRT and 120 if FORMAT=PRT.

Important

PAGEWIDTH= is ignored if the report is printed on SYSPRINT. ABRMAP must be present for PAGEWIDTH= to be honored.

PCHDATEFORMAT=

Specifies the format that dates are displayed in “punched” output generated by RPTYPE=SELPCH. Valid values are:

DDMMYY

Gregorian format, day first “dd/mm/yy”.

DDMMYYYY

Gregorian format, day first with 4-digit year “dd/mm/yyyy”.

MMDDYY

Gregorian format, month first “mm/dd/yy”.

MMDDYYYY

Gregorian format, month first with 4-digit year “mm/dd/yyyy”.

YYDDD

Julian format “yy/ddd”.

YYYYDDD

Julian format with 4-digit year “yyyy/ddd”.

PCHDDNAME=

ddn

Specifies the ddname to be used when punching for RPTYPE=SELPCH.

Default: SYSPUNCH; unless the operand PCHDDNAME= was specified on the DEFAULT statement.

PCHSEPCHAR=

c

Specifies the character to be used to delimit the elements of dates formatted for punch display (RPTYPE=SELPCH).

Default: /.

POFREESPACE=

Specifies what is used to determine the amount of free space in a partitioned data set (PDS, DSORG=PO). There are three options:

DIR

Cause the directory blocks to be read and, if there are no members, set the number of bytes/tracks used to zero (0).

IFREAD

If the directory blocks are to be read for some other reason (that is, field name) and, if there are no members, set the number of bytes/tracks used to zero (0).

LBP

Use the LSTAR to determine the free space.

Default: IFREAD.

PRTLENGTH=

Limit the amount of data printed for each record output with RPTYPE=HEX to the number of bytes specified.

Default: 10000.

RECORDSUMMARY=

Specifies the level of data set summarization to be done for VSAM clusters (summarize all components) and multi-volume data sets of all kinds (summarize data from all volumes). It is ignored unless DATATYPE=CATALOG, CATARCH, CATVTOC, or EXTRACT is in effect. Valid values are:

CLUSTER

Summarize at the cluster level for VSAM and data set level for non-VSAM.

COMPONENT

Summarize at the component level for VSAM and data set level for non-VSAM.

NONE

Do not summarize.

Default: NONE.

RESETMASKAFTER=

nnnnn

Specifies that the punch mask is to be reset after “n” number of records have been processed. The number can be any value from 0 to 32000, where 0 (zero) disables the reset checking.

Important

This operand is only significant if executing with RPTYPE=SELPCH.

Default: 0; the punch mask is not reset based on the number of records processed.

RESFAILRTNCD=

nnnn

Specifies the return code to be set if a UCB or volume is bypassed due to reserve or enqueue failure, such as a long term reserve from another system when CHKONLRESERVE=BYPASS or RETRY is in effect. The value may be any value from 0 through 1023, inclusive.

Default: 7.

RESWAITIME=

nn

Specifies the time in seconds to wait for reserve from another system to complete, when CHKONLRESERVE=BYPASS or RETRY is in effect. The value may be any value from 1 to 20, inclusive.

Default: 2.

RETRYLOOPS=

nn

Specifies the number of times a UCB is to be retried, if it was requeued because of CHKONLRESERVE=RETRY. The value may be any value from 1 to 20, inclusive.

Default: 1 retry.

RPTDDNAME=

ddn

Specifies the ddname to be used when creating output reports, other than RPTYPE=SELPCH.

Default: ABRMAP unless the operand RPTDDNAME= was specified on the DEFAULT statement.

RPTSPFC=

nn

Specifies the maximum number of characters to use within the RPTSPFI= index count when creating SUMLEVEL=INDEX control breaks with NEWSUMFORMAT enabled. The number may be from 1 to 44.

Default: 44.

RPTSPFI=

nn

Specifies the maximum number of indexes to consider when creating SUMLEVEL=INDEX control breaks with NEWSUMFORMAT enabled. The number may be from 1 to 21.

Default: 1.

RPTYPE=

Specifies the report type to be generated by FDREPORT, and requests certain predefined report formats or special processing. When predefined reports are requested, the REPORT and HEADING statements and the AUTOSTACK operand are ignored. Values are:

ABRVTOC

A report in standard ABR VTOC format (equivalent to PRINT VTOC) is printed.

ARCHIVE

A standard ABR ARCHIVE report (equivalent to PRINT ARCHIVE) is printed; intended for use with DATATYPE=ARCHIVE.

COMPDATA

Similar to RPTYPE=DATA, except that only the fields named in a REPORT statement are written to the extract file; this makes the extract file much smaller.

Important

An extract file created by DATATYPE=COMPDATA cannot be part of a concatenated DD statement when used as input.

CSV

Generate a variable blocked file designed to be input to programs such as Microsoft Excel. all displayable fields are valid in a Comma Separated Values (CSV) file. Data formatting is controlled in the same manner as when printing.
There are two output options for FDREPORT’s CSV: Print and File. File output is directed to the ddname specified by the DEFAULT or PRINT keyword CSVDDNAME= that defaults to ABRCSV.

DATA

No report is printed, but FDREPORT internal records for every data set or volume selected are written to the extract data file on DD statement name SYSUT2. This data may be read as input to FDREPORT in this or another step (DATATYPE=EXTRACT) allowing multiple reports to be generated without the overhead of reconstructing the data. With RPTYPE=DATA, FDREPORT includes in the extract file all relevant data fields from its primary source specified by DATATYPE=; for example, if you specify DATATYPE=VTOC or CATVTOC, all fields generated from the VTOC and VVDS are available. If you need additional fields from another source, include a REPORT statement requesting at least one such field, for example,

REPORT FIELDS=(CATALOG,DIRBLOCKS)

that gathers ALL catalog and directory fields in addition to the VTOC and VVDS fields.

GENERATE

Generates a customized report based on FDREPORT options (default).

HEX

Prints records from the Archive Control File (if DATATYPE=ARCHIVE) or records generated by FDREPORT (for all other data types) in a dump (hex and character) format.

NONE

Suppresses the detail report, allowing only summaries to be printed (SUM=YES, SUM=INDEX, or the SUMMARY statement should also be specified).

OSVTOC

A report containing information equivalent to an IEHLIST LISTVTOC statement (but not in the same format) is printed.

SELPCH

No report is printed, but for each data set selected a statement is written to SYSPUNCH in the format specified by the MASK operand of the PUNCH statement, or, by default, in the format:

XSELECT VOL=volser,DSN=dsname

The SYSPUNCH data set may be passed to a following step, possibly a ABR step, allowing the enhanced selection facilities of FDREPORT to select data sets to be processed by ABR or other programs, or it may be submitted directly to a JES internal reader if a complete job stream is generated by the punch mask. A SORT is forced to properly handle multi-volume data sets unless SORT=NO is specified.

TABLE

Generates output designed to be read by other programs. No titles are printed and the report is not limited by the PAGEWIDTH= operand. One set of column headings are printed unless DISABLE=HEADINGS is specified. Records up to 32760 bytes long may be created (depending on the characteristics of the ABRMAP data set). The ABRMAP DD Statement is required; this report cannot go to SYSPRINT. Fields requested by the REPORT statement appear in sequence with single columns between them.

XREF

A report in standard ABR VTOC/BACKUP XREF format (equivalent to PRINT BACKUP) is printed.

SKIP=

n

Specifies the number of blank lines to be inserted between report lines. The number can be a value from 0 (single space) to 3.

Default: 0.

SORT=

Specifies if the data is to be sorted. However, sorting is forced by a SORT statement and by some other options that require sorting.

COMBINE

If no SORT statement is present, sorts by data set name, volume sequence number, and volume serial number, all ascending, to produce a report sorted by data set name across all volumes. Ignored if a SORT statement is present.

NO

No sorting is performed. SORT statements and implied sorts are ignored.

YES

Sorts by DASD volume serial. If a SORT statement is present, and the first sort field is not VOL, VOL is temporarily inserted as the first field. If no SORT is present, data is sorted by volume serial and data set name, both ascending.

If sorting is required, any DD statements required by your installation's SORT product must be included in the FDREPORT step unless the SORTALLOC= operand is specified.

Default: NO; unless a SORT statement precedes the PRINT statement or SUM or RPTYPE implies sorting.

SORTALLOC=

If sorting is specified or forced, this specifies if FDREPORT dynamically allocates some or all files required by your system sort product.

CYL

If SORTWKnn files are allocated, the allocation is in cylinders.

NO

Do not dynamically allocate SORT related data sets. If sorting is required, any necessary DD statements must be included in the JCL.

SORTLIB

Dynamically allocate the SORTLIB data set using the value in the operand SORTLIB for the data set name. Users of the SYNCSORT product should see the note under the SORTLIB=operand.

SORTMSG

Dynamically allocate the SORT message output to SYSOUT using the value in the operand SORTMSGDDNAME= for the ddname.

SORTWORK

Dynamically allocate the number of SORTWKnn data sets specified in the operand WORKDDNAMES=, using the value in the operand WORKUNIT= as the unit name.

TRK

If SORTWKnn files are allocated, the allocation is in tracks.

YES

Dynamically allocate all of the above.

More than one option can be specified, in parentheses, separated by commas, for example, SORTALLOC=(YES,CYL).

Default: (NO,TRK).

SORTCORE=

nnnnnnn

Specifies the amount of storage the program SORT is to use if external sorting is required. The number may be from 10000 to 8000000 inclusive.

Default: Taken from the FDR Global Options and is usually 100000.

SORTLIB=

dsn

Specifies the data set name to be allocated to the ddname SORTLIB.

Default: SYS1.SORTLIB.

Important

Your SORT product may not require a SORTLIB, so SYS1.SORTLIB may not exist on your system. If SORTALLOC=YES is specified, FDREPORT attempts to allocate it and may fail. To circumvent this, either create an empty PDS called SYS1.SORTLIB, or override the SORTLIB= operand to specify some other existing PDS. Alternately, specify SORTALLOC=(SORTWORK,SORTMSG) or make this the permanent default (see FDREPORT-DEFAULT-Statement).

SORTMSG=

Specifies the message option to be used by the program SORT if external sorting is required.

AC

All messages to the console.

AP

All messages to the printer.

CC

Critical messages to the console.

CP

Critical messages to the printer.

NO

No messages to be produced.

PC

Critical messages to both console and printer.

Default: CC.

SORTMSGDDNAME=

ddn

Specifies the ddname to be used by the program SORT if messages are to be printed.

Default: SYSOUT.

SORTPFX=

cccc

Specifies the ddname prefix to be used by the program SORT if external sorting is required. If the string specified is less than 4 characters, a dollar sign($) fill character is used.

Default: Taken from the FDR Global Options and is usually “SORT”.

SPFC=

nn

Specifies the maximum number of characters to use within the SPFI= index count when creating SUMLEVEL=INDEX control breaks. The number may be from 1 to 23.

Default: 8.

SPFI=

n

Specifies the maximum number of indexes to consider when creating SUMLEVEL=INDEX control breaks. The number may be from 1 to 4.

Default: 1.

SSPKLINECNT=

n

Specifies the number of blank lines that are to be inserted at each break when BREAK=SSPK is specified on the SORT command. The number may be a value from 1 to 9, inclusive.

Default: 2.

SUMBYTEFORMAT=

Specifies the print value to be used when displaying byte formatted fields if the SUMMARY command is specified.

BYTES

Display the values as a true byte count.

KILOBYTES

Display the values as kilobytes, rounded.

MEGABYTES

Display the values as megabytes, rounded.

GIGABYTES

Display the values as gigabytes when ELEVENBYTES or DECIMALBYTES is enabled.

TERABYTES

Display the values as terabytes when ELEVENBYTES or DECIMALBYTES is enabled.

REALBYTES

Actual bytes displayed as a 16 digit numeric value.

There are two defaults for the SUMBYTEFORMAT= operand. If SUMBYTEFORMAT= is not specified on the DEFAULT command, but BYTEFORMAT= is specified, the format is taken from the BYTEFORMAT= operand. If SUMBYTEFORMAT= is not specified on the PRINT command, it retains the format from the last DEFAULT command or the value in F$REPOPT, the FDREPORT Option Table.

SUMDDNAME=

ddn

Specifies the ddname to be used when creating output summary reports.

Default: ABRSUM.

Important

Memory stacking of summary reports for later printing increases the region size by 100K.

SUMDEVICE=

Specifies how summaries by device type are to be handled if there is more than one density for the device.

BASE

Summary is at the base level, for example, 3390-1, 3390-2, 3390-3, 3390-9 and 3390-27 are summarized as 3390.

UNIQUE

Summary is by individual device type, for example, 3390-1, 3390-2 are summarized separately.

Default: BASE.

Important

The SUMDEVICE= operand controls the selection and report fields DEVTYPE and VLDEVTYP whether or not a summary command or SUMLEVEL= operand is specified.

SUMLEVEL=

Controls the printing of summary reports, in conjunction with the SUMMARY statement. Summaries are printed at indicated points in the detail report (on ABRMAP or SYSPRINT) unless an ABRSUM DD Statement is present, when the summary report is printed on ABRSUM.

INDEX

Summary reports are printed for each high-level data set index encountered. The SUMMARY statement is honored, or if absent defaults as shown above. SUM=INDEX forces a sort on data set name unless SORT=NO is specified.

NONE

No summary reports are printed.

YES

Summary reports are printed as specified by the SUMMARY statement. If no SUMMARY is present, this is assumed,

SUMMARY FIELDS=(DSN,NOEXTENT,SIZE,SIZEFREE,SIZEUSED).

Default: NO; unless a SUMMARY statement precedes the PRINT statement.

SYSUTSPACE=

nnnnn

Specifies the number of space allocation units to use for both primary and secondary allocation for SYSUTn DD statements. The number may be from 10 to 16000.

The unit of space allocation is specified by the SORTALLOC= operand, with a default of SORTALLOC=TRK.

The SYSUTn DD statements used by FDREPORT are:

  • SYSUT1 - used for input when RPTYPE=COMPDATA or RPTYPE=DATA is specified with DATATYPE=EXTRACT.
  • SYSUT2 - dynamically allocated if RPTYPE=COMPDATA or RPTYPE=DATA is specified and there is no SYSUT2 DD statement in the JCL.
  • SYSUT3 and SYSUT4 - internal work files, dynamically allocated for certain types of reports.

Default: 200.

SYSUTSTORCLAS=

cccccccc

Specifies the SMS storage class name (1 to 8 characters) to use when dynamically allocating any of the temporary SYSUTn files. It must be a value valid for STORCLAS= in the JCL.

There is no default for the SYSUTSTORCLAS= keyword. If SYSUTSTORCLAS= is not specified, processing continues using the default value for SYSUTUNIT=.

SYSUTUNIT=

cccccccc

Specifies the unit name to use when allocating SYSUTn DD statements.

Default: SYSALLDA.

TITLE=

Controls the placement of the title line within the current page width. Values are:

CENTER

Center the title line based on the value of PAGEWIDTH=.

LEFT

Align the title line with the left margin.

RIGHT

Align the title line with the right margin.

Default: CENTER.

UNITPREFIX=

n

Used in conjunction with the VOLSUMMARY= keyword value UNITPREFIX= and is used to set the significant length for compares. The value specified may be from 1 to 3.

Default: 2.

VOLPREFIX=

n

Used in conjunction with the VOLSUMMARY= keyword value VOLPREFIX= and is used to set the significant length for compares. The value specified may be from 1 to 5.

Default: 5.

VOLSUMMARY=

Specifies the level of volume summarization to be done. It is ignored unless DATATYPE=VOLDATA or EXTRACT is in effect. Volume summarization produces volume summary records instead of individual volume records. The fields you have selected in the REPORT statement are totaled, average, or recalculated as appropriate; some fields that are unique (such as volume serial number or address) are blanked. Valid values are:

CTLSERNO

Summarizes volume records based on the serial number of the controller.

DEVTYPE

Summarize volume records based on the device type. The contents of the device type field are controlled by the SUMDEVICE= keyword.

MFRCODE

Summarizes volume records based on manufactures code.

NOBREAK

Summarizes all available volume records. No control break is taken.

NONE

No summarization of volume records is performed.

SSID

Summarizes volume records based on subsystem ID.

STORGRP

Summarize by SMS storage group name (non-SMS volumes are summarized under a blank storage group name)

UNITPREFIX

Summarize by the first “n” hex digits of the device address. The operand UNITPREFIX=n must also be specified (n=1 to 3).

VOLPREFIX

Summarize by the first “n” characters of the volume serial. The operand VOLPREFIX=n must also be specified (n=1 to 5).

Default: NONE.

VTOCPAD=

nn

Specifies the number of tracks to be added to the value CVAF returns for the highest DSCB in use when SETVTOCLIMITS is enabled. The value may be any value from 3 to 45.

Default: 15.

VTOCREAD=

Specifies the amount of data FDREPORT reads into storage in one EXCP when processing the VTOC and VVDS.

CYL

Read a minimum of one cylinder into storage with a single EXCP. Chained multi-record read CCWs are used if MULTIRECREAD is enabled, else chained single record CCWs are used to perform the read.

TRK

Read a maximum of one track into storage with one EXCP.

Default: CYL.

WORKDDNAMES=

n

Specifies the number of SORT work ddnames to allocate, from 1 to 5, inclusive.

Default: 3.

WORKSPACE=

nnnn

Specifies the number of tracks or cylinders (controlled by the TRK and CYL operands of SORTALLOC=) to allocate to each of the SORT work files, from 10 to 1000.

Default: 100.

WORKSTORCLAS=

cccccccc

Specifies the SMS storage class name (1 to 8 characters) to use when dynamically allocating any of the temporary SORTWKnn files. It must be a value valid for STORCLAS= in JCL.

Default: There is no default for the WORKSTORCLAS= operand. If WORKSTORCLAS= is not specified, processing continues using the default value for WORKUNIT=.

WORKUNIT=

cccccccc

Specifies the unit name (1 to 8 characters) to use when dynamically allocating sort work files if requested by SORTALLOC=. It must be a value valid for UNIT= in JCL, and the volumes included on those units must include some in STORAGE or PUBLIC status for the allocation to be successful.

Default: SYSALLDA; which is valid on all z/OS systems and includes all DASD.

 

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