OPTION control statement


           .-,-----------------------------.   
           V                               |   
>>-OPTION----+-ARESALL=--+-n--+----------+-+-------------------><
             |           +-nK-+          |     
             |           '-nM-'          |     
             +-ARESINV=--+-n--+----------+     
             |           +-nK-+          |     
             |           '-nM-'          |     
             +-AVGRLEN=n-----------------+     
             +-+-CHALT---+---------------+     
             | '-NOCHALT-'               |     
             +-+-CHECK---+---------------+     
             | '-NOCHECK-'               |     
             +-+-CINV---+----------------+     
             | '-NOCINV-'                |     
             +-CKPT----------------------+     
             +-COBEXIT=--+-COB1-+--------+     
             |           '-COB2-'        |     
             +-COPY----------------------+     
             +-DSA=n---------------------+     
             +-DSPSIZE=--+-MAX-+---------+     
             |           '-n---'         |     
             +-DYNALLOC--+-------------+-+     
             |           '-=-+-d-----+-' |     
             |               +-(,n)--+   |     
             |               +-(d,n)-+   |     
             |               '-OFF---'   |     
             +-DYNAPCT=--+-x---+---------+     
             |           '-OLD-'         |     
             +-DYNSPC=n------------------+     
             +-EFS=--+-name-+------------+     
             |       '-NONE-'            |     
             +-+-EQUALS---+--------------+     
             | '-NOEQUALS-'              |     
             +-EXITCK=--+-STRONG-+-------+     
             |          '-WEAK---'       |     
             +-+-FILSZ=--+-x--+-+--------+     
             | |         +-Ex-+ |        |     
             | |         '-Ux-' |        |     
             | '-SIZE=--+-y--+--'        |     
             |          +-Ey-+           |     
             |          '-Uy-'           |     
             +-HIPRMAX=--+-OPTIMAL-+-----+     
             |           +-n-------+     |     
             |           '-p%------'     |     
             +-+-LIST---+----------------+     
             | '-NOLIST-'                |     
             +-+-LISTX---+---------------+     
             | '-NOLISTX-'               |     
             '-LOCALE=--+-name----+------'     
                        +-CURRENT-+            
                        '-NONE----'


|--+-MAINSIZE=--+-n---+-----------+-----------------------------|
   |            +-nK--+           |   
   |            +-nM--+           |   
   |            '-MAX-'           |   
   +-MERGEIN=--+-ddname---------+-+   
   |           |   .-,------.   | |   
   |           |   V        |   | |   
   |           '-(---ddname-+-)-' |   
   +-MOSIZE=--+-MAX-+-------------+   
   |          +-n---+             |   
   |          '-p%--'             |   
   +-+-MOWRK---+------------------+   
   | '-NOMOWRK-'                  |   
   +-MSGDDN=ddname----------------+   
   +-MSGPRT=--+-ALL------+--------+   
   |          +-NONE-----+        |   
   |          '-CRITICAL-'        |   
   +-NOBLKSET---------------------+   
   +-NOOUTREL---------------------+   
   +-NOOUTSEC---------------------+   
   +-NULLOUT=--+-RC0--+-----------+   
   |           +-RC4--+           |   
   |           '-RC16-'           |   
   +-ODMAXBF=--+-n--+-------------+   
   |           +-nK-+             |   
   |           '-nM-'             |   
   +-OVFLO=--+-RC0--+-------------+   
   |         +-RC4--+             |   
   |         '-RC16-'             |   
   +-PAD=--+-RC0--+---------------+   
   |       +-RC4--+               |   
   |       '-RC16-'               |   
   +-RESALL=--+-n--+--------------+   
   |          +-nK-+              |   
   |          '-nM-'              |   
   +-+-RESET---+------------------+   
   | '-NORESET-'                  |   
   +-RESINV=--+-n--+--------------+   
   |          +-nK-+              |   
   |          '-nM-'              |   
   +-SDB=--+-LARGE-+--------------+   
   |       +-YES---+              |   
   |       +-INPUT-+              |   
   |       '-NO----'              |   
   +-SKIPREC=z--------------------+   
   +-SMF=--+-SHORT-+--------------+   
   |       +-FULL--+              |   
   |       '-NO----'              |   
   +-+-SOLRF---+------------------+   
   | '-NOSOLRF-'                  |   
   +-SORTDD=cccc------------------+   
   +-SORTIN=ddname----------------+   
   '-SORTOUT=ddname---------------'


|--+-SPANINC=--+-RC0--+-+---------------------------------------|
   |           +-RC4--+ |   
   |           '-RC16-' |   
   +-STOPAFT=n----------+   
   +-+-SZERO---+--------+   
   | '-NOSZERO-'        |   
   +-TRUNC=--+-RC0--+---+   
   |         +-RC4--+   |   
   |         '-RC16-'   |   
   +-USEWKDD------------+   
   +-+-VERIFY---+-------+   
   | '-NOVERIFY-'       |   
   +-+-VLLONG---+-------+   
   | '-NOVLLONG-'       |   
   +-+-VLSCMP---+-------+   
   | '-NOVLSCMP-'       |   
   +-+-VLSHRT---+-------+   
   | '-NOVLSHRT-'       |   
   +-+-VSAMEMT--+-------+   
   | '-NVSAMEMT-'       |   
   +-+-VSAMIO---+-------+   
   | '-NOVSAMIO-'       |   
   +-+-WRKREL---+-------+   
   | '-NOWRKREL-'       |   
   +-+-WRKSEC---+-------+   
   | '-NOWRKSEC-'       |   
   +-Y2PAST=--+-s-+-----+   
   |          '-f-'     |   
   '-+-ZDPRINT--+-------'   
     '-NZDPRINT-'

Note for Syntax Diagram: The keywords EFS, LIST, NOLIST, LISTX, NOLISTX, MSGDDN, MSGPRT, SMF, SORTDD, SORTIN, SORTOUT, and USEWKDD are used only when they are specified on the OPTION control statement passed by an extended parameter list or when specified in the DFSPARM data set. If they are specified on an OPTION statement read from the SYSIN or SORTCNTL data set, the keyword is recognized, but the parameters are ignored.

The OPTION control statement allows you to override some of the options available at installation time (such as EQUALS and CHECK) and to supply other optional information (such as DYNALLOC, COPY, and SKIPREC).

Some of the options available on the OPTION statement are also available on the SORT or MERGE statement (such as FILSZ and SIZE). It is preferable to specify these options on the OPTION statement. For override rules, see Specification/override of DFSORT options.

Details of aliases for OPTION statement options are given under the description of individual options. Table 1 summarizes the available aliases.

DFSORT accepts but does not process the following OPTION operands: ALGQ, APP, APPEND, BIAS=value, BLKSET, CASCADE, DIAG, ERASE, EXCPVR=value, MAXPFIX=value, NEW, NEWFILE, NODIAG, NOERASE, NOINC, NOSTIMER, NOSWAP, OPT=value, REP, REPLACE, ROUTE=value, WRKADR=value, WRKDEV=value, and WRKSIZ=value.

ARESALL


>>-ARESALL=--+-n--+--------------------------------------------><
             +-nK-+   
             '-nM-'

Temporarily overrides the ARESALL installation option, which specifies the number of bytes to be reserved above virtual for system use.

ARESALL applies only to the amount of main storage above virtual. This option is normally not needed because of the large amount of storage available above 16MB virtual (the default for ARESALL is 0 bytes). The RESALL option applies to the amount of main storage below 16MB virtual.

n: specifies that n bytes of storage are to be reserved.
Limit: 8 digits.
nK: specifies that n times 1024 bytes of storage are to be reserved.
Limit: 5 digits.
nM: specifies that n times 1048576 bytes of storage are to be reserved.
Limit: 2 digits.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: SeeSpecification/override of DFSORT options .

ARESINV


>>-ARESINV=--+-n--+--------------------------------------------><
             +-nK-+   
             '-nM-'

Temporarily overrides the ARESINV installation option, which specifies the number of bytes to be reserved for an invoking program's user exits that reside in or use space above 16MB virtual. The reserved space is not meant to be used for the invoking program's executable code. ARESINV is used only when DFSORT is dynamically invoked.

ARESINV applies only to the amount of main storage above 16MB virtual. The RESINV option applies to the amount of main storage below 16MB virtual.

n: specifies that n bytes of storage are to be reserved.
Limit: 8 digits.
nK: specifies that n times 1024 bytes of storage are to be reserved.
Limit: 5 digits.
nM: specifies that n times 1048576 bytes of storage are to be reserved.
Limit: 2 digits.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

AVGRLEN


>>-AVGRLEN=n---------------------------------------------------><

Specifies the average input record length in bytes for variable-length record sort applications. This value is used when necessary to determine the input file size. The resulting value is important for sort applications, because it is used for several internal optimizations as well as for dynamic work data set allocation (see OPTION DYNALLOC). See Specify input/output data set characteristics accurately and Allocation of work data sets for more information on file size considerations.

n: specifies the average input record length. n must be between 4 and 32767 and must include the 4-byte record descriptor word (RDW).

Note:

AVGRLEN=n on the OPTION statement overrides the L5 value on the RECORD statement (LENGTH operand) if both are specified. The L5 value on the RECORD statement is ignored for Blockset.
L5=n can be used instead of AVGRLEN=n.

Default: If AVGRLEN=n is not specified, DFSORT uses one-half of the maximum record length as the average record length. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

CHALT or NOCHALT


>>-+-CHALT---+-------------------------------------------------><
   '-NOCHALT-'

Temporarily overrides the CHALT installation option, which specifies whether format CH fields are translated by the alternate collating sequence as well as format AQ or just the latter.

CHALT: specifies that DFSORT translates character control fields and compare fields with formats CH and AQ using the alternate collating sequence.
NOCHALT: specifies that format CH fields are not translated.

Note: If you use locale processing for SORT, MERGE, INCLUDE, or OMIT fields, you must not use CHALT. If you need alternate sequence processing for a particular field, use format AQ.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

CHECK or NOCHECK


>>-+-CHECK---+-------------------------------------------------><
   '-NOCHECK-'

Temporarily overrides the CHECK installation option, which specifies whether the record count should be checked for applications that use the E35 user exit routine without an output data set.

CHECK: specifies that the record count should be checked.
NOCHECK: specifies that the record count should not be checked.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: SeeSpecification/override of DFSORT options.

CINV or NOCINV


>>-+-CINV---+--------------------------------------------------><
   '-NOCINV-'

Temporarily overrides the CINV installation option, which specifies whether DFSORT can use control interval access for VSAM data sets. The Blockset technique uses control interval access for VSAM input data sets, when possible, to improve performance.

CINV: specifies that DFSORT should use control interval access when possible for VSAM data sets.
NOCINV: specifies that DFSORT should not use control interval access.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

CKPT


>>-CKPT--------------------------------------------------------><

Activates the Checkpoint/Restart facility for sorts that use the Peerage or Vale techniques.

Because CKPT is only supported in the Peerage and Vale techniques, the Blockset technique must be bypassed for the Checkpoint/Restart facility to be used. Installation option IGNCKPT=NO causes Blockset to be bypassed when CKPT is specified at run-time. The NOBLKSET option can also be used to bypass Blockset at run-time.

A SORTCKPT DD statement must be coded when you use the Checkpoint/Restart facility (see SORTCKPT DD statement).

Note:

CHKPT can be used instead of CKPT.
Functions such as OUTFIL processing, which are supported only by the Blockset technique, cannot be used if the Checkpoint/Restart facility is used.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

COBEXIT


>>-COBEXIT=--+-COB1-+------------------------------------------><
             '-COB2-'

Temporarily overrides the COBEXIT installation option, which specifies the library for COBOL E15 and E35 routines.

COB1

specifies that COBOL E15 and E35 routines are run with the OS/VS COBOL run-time library or, in some cases, with no COBOL run-time library.

COBEXIT=COB1 is obsolete, but is still available for compatibility reasons.

Note that Language Environment is the only run-time library for COBOL supported by IBM service.

COB2

specifies that COBOL E15 and E35 routines are run with either the VS COBOL II run-time library or the Language Environment run-time library.

Note that Language Environment is the only run-time library for COBOL supported by IBM service.

Note: The DFSORT documents only discuss the Language Environment run-time library, and assume that COBEXIT=COB2 is in effect. Although it is possible to run with older run-time libraries, and with COBEXIT=COB1, these are not recommended or discussed, and are not supported by IBM service.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

COPY


>>-COPY--------------------------------------------------------><

Causes DFSORT to copy a SORTIN data set or inserted records to the output data sets unless all records are disposed of by an E35 exit routine. Records can be edited by E15 and E35 exit routines; INCLUDE/OMIT, INREC, OUTREC, and OUTFIL statements; and SKIPREC and STOPAFT parameters. E35 is entered after each SORTIN or E15 record is copied.

The following must not be used in copy applications:

BDAM data sets
Dynamic binding or link-editing.

See message ICE160A in z/OS DFSORT Messages, Codes and Diagnosis Guide for additional restrictions that apply to copy applications.

Note: User labels will not be copied to the output data sets.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

DSA


>>-DSA=n-------------------------------------------------------><

Temporarily overrides the DSA installation option, which specifies the maximum amount of storage available to DFSORT for dynamic storage adjustment of a Blockset sort application when SIZE/MAINSIZE=MAX is in effect. If you specify a DSA value greater than the TMAXLIM value in effect, you allow DFSORT to use more storage than the TMAXLIM value if doing so should improve performance. The amount of storage DFSORT uses is subject to the DSA value as well as system limits such as region size. However, whereas DFSORT always tries to obtain as much storage as it can up to the TMAXLIM value, DFSORT only tries to obtain as much storage as needed to improve performance up to the DSA value.

The performance improvement from dynamic storage adjustment usually provides a good tradeoff against the increased storage used by DFSORT. On storage constrained systems, however, the DSA value should be set low enough to prevent unacceptable paging.

n: specifies that DFSORT can dynamically adjust storage to improve performance, subject to a limit of n MB. n must be a value between 0 and 2000. If n is less than or equal to the TMAXLIM value in effect, n is set to 0 to indicate that storage will not be dynamically adjusted.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

DSPSIZE


>>-DSPSIZE=--+-MAX-+-------------------------------------------><
             '-n---'

Temporarily overrides the DSPSIZE installation option, which specifies the maximum amount of data space to be used with dataspace sorting. A data space is an area of contiguous virtual storage that is backed by real and auxiliary storage, whichever is necessary as determined by the system. Because DFSORT is able to sort large pieces of data using data space, CPU time and elapsed time are reduced.

Several factors can limit the amount of data space an application uses:

The IEFUSI exit can limit the total amount of Hiperspace, memory objects and data space available to an application.
DSPSIZE can limit the amount of data space available to an application, as detailed later in this section.
Sufficient available storage must be present to back DFSORT's data spaces. "Available" storage is the storage used to back new data space data and consists of the following two types:
1. Free storage. This is storage not being used by any application.
2. Old storage. This is storage used by another application whose data has been unreferenced for a sufficiently long time so that the system considers it eligible to be paged out to auxiliary storage to make room for new data space data.
The amount of available storage constantly changes, depending on current system activity. Consequently, DFSORT checks the amount of available central storage throughout a data space sorting run and switches from using a data space to using disk work data sets if the available central storage is too low.
Other concurrent Hipersorting, memory sorting and dataspace sorting applications further limit the amount of available storage. A dataspace sorting application knows the storage needs of every other Hipersorting, memory object sorting and dataspace sorting application on the system. A dataspace sorting application does not try to back its data space data with storage needed by another Hipersorting, memory object sorting or dataspace sorting application. This prevents overcommitment of storage resources if multiple large concurrent DFSORT applications start at similar times on the same system.
The installation options EXPMAX, EXPOLD, and EXPRES can also be used to further limit the amount of storage available to dataspace sorting applications. EXPMAX limits the total amount of available storage that can be used at any one time to back DFSORT Hiperspaces, memory objects and data spaces. EXPOLD limits the total amount of old storage that can be used at any one time to back DFSORT Hiperspaces, memory objects and data spaces. EXPRES sets aside a specified amount of available storage for use by non-Hipersorting, non-memory object sorting and non-dataspace sorting applications.

Some of these limits depend on system and other DFSORT activity throughout the time a dataspace sorting application runs. Consequently, the amount of data space a dataspace sorting application uses can vary from run to run.

If the amount of data space DFSORT decides to use is sufficient, DFSORT sorts your data in main storage and does not require additional temporary work space. If the amount of data space is not sufficient, DFSORT uses disk as temporary work space. Installation option DYNAUTO=NO is changed to DYNAUTO=YES whenever dataspace sorting is possible. Hiperspace is not used when dataspace sorting is used.

MAX: specifies that DFSORT dynamically determines the maximum amount of data space to be used for dataspace sorting. In this case, DFSORT bases its data space usage on the size of the file being sorted and the paging activity of the system.
n: specifies the maximum amount, in MB, of data space to be used for dataspace sorting. n must be a value between 0 and 9999. The actual amount of data space used does not exceed n, but may be less than n depending on the size of the file being sorted and the paging activity of the system.
If n is zero, dataspace sorting is not used.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

DYNALLOC


>>-DYNALLOC--+-------------+-----------------------------------><
             '-=-+-d-----+-'   
                 +-(,n)--+     
                 '-(d,n)-'

Assigns DFSORT the task of dynamically allocating needed work space. You do not need to calculate and use JCL to specify the amount of work space needed by the program. DFSORT uses the dynamic allocation facility of the operating system to allocate work space for you.

Refer to Using work space for guidelines on the use of DYNALLOC.

d: specifies the device name. You can specify any IBM disk or tape device supported by your operating system in the same way you would specify it in the JCL UNIT parameter. You can also specify a group name, such as DISK or SYSDA.
n: specifies the maximum number of requested work data sets. If you specify more than 255, a maximum of 255 data sets is used. If you specify 1 and the Blockset technique is selected, a maximum of 2 data sets is used. If you specify more than 32 and the Blockset technique is not selected, a maximum of 32 data sets is used.

Tip: For optimum allocation of resources such as virtual storage, avoid specifying a large number of work data sets unnecessarily.

For tape work data sets, the number of volumes specified (explicitly or by default) is allocated to the program. The program requests standard label tapes.

DYNALLOC is not used if SORTWKdd DD statements are provided unless installation option DYNAUTO=IGNWKDD is specified and OPTION USEWKDD is not in effect.

If VIO=NO is in effect:

Work space can be allocated on nontemporary data sets (DSNAME parameter specified).
If the device (d) you specify is a virtual device and reallocation to a real device fails, DFSORT will ignore VIO=NO and use the virtual device.

Note: Message ICE165I gives information about work data set allocation/use.

Default: None; optional. See Specification/override of DFSORT options for full override details.

DYNALLOC can automatically be activated by using the DYNAUTO installation option.
If DYNALLOC is specified without d, the default for d is that specified (or defaulted) by the DYNALOC installation option
If DYNALLOC is specified without n, the default for n is that specified (or defaulted) by the DYNALOC installation option.

You can specify DYNALLOC without n, without d, or without both. If DYNALLOC is specified without n, and the IBM–supplied default for the n value of the DYNALOC installation option is chosen, then:

If one of the Blockset techniques is chosen, four work data sets will be requested.
If a technique other than Blockset is chosen, three work data sets will be requested.

Applicable Functions: See Specification/override of DFSORT options.

DYNALLOC=OFF


>>-DYNALLOC=OFF------------------------------------------------><

Directs DFSORT not to allocate work space dynamically, overriding that function of installation option DYNAUTO=YES, or DYNAUTO=IGNWKDD, or the run-time option DYNALLOC (without OFF). Use this option when you know that an in-core sort can be performed, and you want to suppress dynamic allocation of work space.

OFF: directs DFSORT not to allocate work space dynamically.

Note: When Hipersorting or dataspace sorting is in effect, DFSORT uses dynamic allocation when necessary, even if DYNALLOC=OFF has been specified.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

DYNAPCT


>>-DYNAPCT=--+-x---+-------------------------------------------><
             '-OLD-'

specifies additional work data sets to be dynamically allocated with zero space. DFSORT only extends these data sets when necessary to complete a sort application. The availability of additional work data sets can help avoid out of space ABENDs.

x: specifies the number of additional work data sets (y) as a percentage of the maximum number of dynamically allocated work data sets (DYNALLOC/DYNALOC n value) in effect. y will be set to n * x%. The total number of dynamically allocated work data sets will be n + y. For example, if DYNALLOC=(SYSDA,20) and DYNAPCT=20 are in effect, 4 additional work data sets will be allocated for a total of 24.
The value x must be between 0 and 254. The minimum value for y is 1 and the maximum value for y is 254. The maximum value for n + y is 255; if x results in a value for n + y greater than 255, y will be set to 255-n.
OLD: specifies additional work data sets should only be allocated when DFSORT cannot determine the file size. When DFSORT is able to determine the file size, additional work data sets will not be allocated (y=0), and the total number of work data sets will be n.

Note: When message ICE118I is issued indicating that DFSORT cannot determine the file size, y is set as follows:

For DYNAPCT=OLD, y is set to n * 50%
For DYNAPCT=x with x <= 50, y is set to n * 50%
For DYNAPCT=x with x > 50, y is set to n * x%

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

DYNSPC


>>-DYNSPC=n----------------------------------------------------><

DYNSPC=ntemporarily overrides the DYNSPC installation option, which specifies the total default primary space allocation for all of the dynamically allocated work data sets when the input file size is unknown. That is, when DFSORT cannot determine the input file size for a sort application and the number of records is not supplied by a FILSZ or SIZE value.

Generally, DFSORT can automatically determine the input file size. However, in a few cases, such as when an E15 supplies all of the input records, when information about a tape data set is not available from a tape management system, or when Blockset is not selected, DFSORT cannot determine an accurate file size. In these cases, if the number of records is not supplied by the FILSZ or SIZE run-time option, and dynamic allocation of work data sets is used, DFSORT uses the DYNSPC value in effect as the approximate amount of primary space. DFSORT uses 20% of the primary space as secondary space. Although the primary space is always allocated, secondary space (up to 15 extents) is only allocated as needed.

You may want to use DYNSPC to override the installation default with a larger or smaller value depending on the amount of disk space available for DFSORT work data sets, and the amount of data to be sorted for this application. As a guideline, Table 1 shows the approximate primary space in cylinders that is allocated on a 3390 when Blockset sorts an unknown number of 6000-byte records.

Table 1. Example of DYNSPC Primary Space
Example of DYNSPC Primary SpaceDYNSPC value (megabytes)	Primary space (cylinders)
32	48
64	93
128	183
256	366
512	732

The larger your DYNSPC value, the more data DFSORT can sort when the file size is unknown. For example, in a test using just dynamically allocated work space (no Hiperspace or data space) with the primary space shown in Table 1, and all of the corresponding secondary space, Blockset is able to sort approximately 150 megabytes with DYNSPC=32 and approximately 1200 megabytes with DYNSPC=256. If Hiperspace or data space can be used along with dynamically allocated work space, the amount of data DFSORT can sort will increase according to the amount of Hiperspace or data space available.

n: specifies the total default primary space, in megabytes, to be allocated for all dynamically allocated work data sets (n is not the primary space for each data set). n must be a value between 1 and 65535.
Do not specify a value which exceeds the available disk space, because this causes dynamic allocation to fail for sort applications that use this value.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

EFS


>>-EFS=--+-name-+----------------------------------------------><
         '-NONE-'

Temporarily overrides the EFS installation option, which specifies whether DFSORT is to pass control to an Extended Function Support (EFS) program. See Using extended function support for more information.

name: specifies the name of the EFS program that will be called to interface with DFSORT.
NONE: specifies no call will be made to the EFS program.

Note:

EFS is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.
If you use locale processing for SORT, MERGE, INCLUDE, or OMIT fields, you must not use an EFS program. DFSORT's locale processing may eliminate the need for an EFS program. See the LOCALE option later in this section for information related to locale processing.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

EQUALS or NOEQUALS


>>-+-EQUALS---+------------------------------------------------><
   '-NOEQUALS-'

Temporarily overrides the EQUALS installation option, which specifies whether the original sequence of records that collate identically for a sort or a merge should be preserved from input to output.

EQUALS: specifies that the original sequence must be preserved.
NOEQUALS: specifies that the original sequence need not be preserved.

For sort applications, the sequence of the output records depends upon the order of:

The records from the SORTIN file
The records inserted by an E15 user exit routine
The E15 records inserted within input from SORTIN.

For merge applications, the sequence of the output records depends upon the order of:

The records from a SORTINnn file. Records that collate identically are output in the order of their file increments. For example, records from SORTIN01 are output before any records that collate identically from SORTIN02.
The records from an E32 user exit routine for the same file increment number. Records that collate identically from E32 are output in the order of their file increments. For example, records from the file with increment 0 are output before any records that collate identically from the file with increment 4.

Note:

When EQUALS is in effect, the total number of bytes occupied by all control fields must not exceed 4088.
Using EQUALS can degrade performance.
When EQUALS is in effect with SUM, the first record of summed records is kept. When NOEQUALS is in effect with SUM, the record to be kept is unpredictable.
If a technique other than Blockset is selected, NOEQUALS is forced if SUM is specified.
Do not specify EQUALS if variable-length records are sorted using tape work files and the RDW is part of the control field.
The number of records to be sorted cannot exceed 4294967295 (4 gigarecords minus 1); if the number of records exceeds this number, message ICE121A is issued and DFSORT terminates.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

EXITCK


>>-EXITCK--+-STRONG-+------------------------------------------><
           '-WEAK---'

Temporarily overrides the EXITCK installation option, which specifies whether DFSORT terminates or continues when it receives certain invalid return codes from E15 or E35 user exit routines. For full details of the return codes affected by this parameter, see E15/E35 return codes and EXITCK.

STRONG: specifies that DFSORT issues an error message and terminates when it receives an invalid return code from an E15 or E35 user exit routine.
WEAK: specifies that DFSORT interprets certain invalid return codes from E15 and E35 user exit routines as valid and continues processing. Use of EXITCK=WEAK can make it difficult to detect errors in the logic of E15 and E35 user exit routines.

Note: EXITCK=WEAK is treated like EXITCK=STRONG when:

Tape work data sets are specified for a sort application.
The Blockset technique is not selected for a merge application.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

FILSZ or SIZE


>>-+-FILSZ=--+-x--+-+------------------------------------------><
   |         +-Ex-+ |   
   |         '-Ux-' |   
   '-SIZE=--+-y--+--'   
            +-Ey-+      
            '-Uy-'

The FILSZ parameter specifies either the exact number of records to be sorted or merged, or an estimate of the number of records to be sorted. The SIZE parameter specifies either the exact number of records in the input data sets, or an estimate of the number of records in the input data sets. The supplied record count is used by DFSORT for two purposes:

To check that the actual number of records sorted or merged or the number of records in the input data sets is equal to the exact number of records expected. FILSZ=x or SIZE=y causes this check to be performed and results in termination with message ICE047A if the check fails.
To determine the input file size for a sort application. DFSORT performs calculations based on the user supplied record count and other parameters (such as AVGRLEN) to estimate the total number of bytes to be sorted. This value is important for sort runs, because it is used for several internal optimizations as well as for dynamic work data set allocation (see OPTION DYNALLOC). If no input record count (or only an estimate) is supplied for the sort run, DFSORT attempts to automatically compute the file size to be used for the optimizations and allocations.

The type of FILSZ or SIZE value specified (x/y, Ux/Uy, Ex/Ey, or none) controls the way DFSORT performs the previous two functions, and can have a significant effect on performance and work data set allocation. See Improving efficiency and File size and dynamic allocation for more information on file size considerations.

x or y

specifies the exact number of records to be sorted or merged (x) or the exact number of records in the input data sets (y). This value is always used for both the record check and the file size calculations. FILSZ=x or SIZE=y can be used to force DFSORT to perform file size calculations based on x or y, and to cause DFSORT to terminate the sort or merge application if x or y is not exact.

If installation option FSZEST=NO is in effect and either FILSZ=x or SIZE=y is specified, DFSORT terminates if the actual number of records is different from the specified exact value (x or y). In this case, the actual number of records is placed in the IN field of message ICE047A (or message ICE054I in some cases) before termination. However, if installation option FSZEST=YES is in effect, DFSORT treats FILSZ=x or SIZE=y like FILSZ=Ex or SIZE=Ey, respectively; it does not terminate when the actual number of records does not equal x or y.

FILSZ=0 causes Hipersorting, dataspace sorting, and dynamic allocation of work space not to be used, and results in termination with message ICE047A unless the number of records sorted or merged is 0. If no E15 user exit is present, SIZE=0 has the same effect in terms of Hipersorting and dynamic allocation of work space, and results in termination with message ICE047A unless the number of records in the input data sets is 0.

x: specifies the exact number of records to be sorted or merged; it must take into account the number of records in the input data sets, records to be inserted or deleted by E15 or E32, and records to be deleted by the INCLUDE/OMIT statement, SKIPREC, and STOPAFT. x must be changed whenever the number of records to be sorted or merged changes in any way.
y: specifies the exact number of records in the input data sets; it must take into account the number of records to be deleted by STOPAFT. y must be changed whenever the number of records in the input data sets changes in any way.
Limit: 28 digits (15 significant digits)

Ex or Ey

specifies an estimate of the number of records to be sorted (x) or an estimate of the number of records in the input data sets (y). This value is not used for the record check. It is used for the file size calculations, but only if DFSORT could not reasonably estimate the input file size itself. In all other cases, this value is ignored by DFSORT. See Dynamic allocation of work data sets for details on exactly when an estimated record count is used and when it is ignored by DFSORT.

FILSZ=E0 or SIZE=E0 is always ignored.

x: specifies an estimate of the number of records to be sorted; it should take into account the number of records in the input data sets, records to be inserted or deleted by E15, and records to be deleted by the INCLUDE/OMIT statement, SKIPREC, and STOPAFT. x should be changed whenever the number of records to be sorted changes significantly.
y: specifies an estimate of the number of records in the input data sets; it should take into account the number of records to be deleted by STOPAFT. y should be changed whenever the number of records in the input data sets changes significantly.
Limit: 28 digits (15 significant digits)

Ux or Uy

specifies the number of records to be sorted (x) or the number of records in the input data sets (y). This value is not used for the record check, but is always used for the file size calculations. FILSZ=Ux or SIZE=Uy can be used to force DFSORT to perform file size calculations based on x or y, while avoiding termination if x or y is not exact.

The FSZEST installation option has no effect on FILSZ=Ux or SIZE=Uy processing.

FILSZ=U0 causes Hipersorting, dataspace sorting, and dynamic allocation of work space not to be used, and may cause degraded performance or termination with message ICE046A, if the actual number of records to be sorted is significantly larger than 0. If no E15 user exit is present, SIZE=U0 has the same effect in terms of Hipersorting, dataspace sorting,and dynamic allocation of work space, and may cause degraded performance or termination with message ICE046A, if the actual number of records in the input data sets is significantly larger than 0.

x: specifies the number of records to be sorted; it should take into account the number of records in the input data sets, records to be inserted or deleted by E15, and records to be deleted by the INCLUDE/OMIT statement, SKIPREC, and STOPAFT. x should be changed whenever the number of records to be sorted changes significantly.
y: specifies the number of records in the input data sets; it should take into account the number of records to be deleted by STOPAFT. y should be changed whenever the number of records in the input data sets changes significantly.
Limit: 28 digits (15 significant digits)

Table 2 summarizes the differences for the three FILSZ variations:

Table 2. FILSZ Variations Summary
FILSZ=n is equivalent to FILSZ=En if installation option FSZEST=YES is specified.Conditions	FILSZ=n	FILSZ=Un	FILSZ=En
Number of records	Exact	Estimate	Estimate
Applications	Sort, merge	Sort	Sort
Terminate if n wrong?	Yes	No	No
Use for file size calculation?	Yes	Yes	When DFSORT cannot compute file size
n includes records:
In input data sets	Yes	Yes	Yes
Inserted/deleted by E15	Yes	Yes	Yes
Inserted by E32	Yes	No	No
Deleted by INCLUDE/OMIT	Yes	Yes	Yes
Deleted by SKIPREC	Yes	Yes	Yes
Deleted by STOPAFT	Yes	Yes	Yes
Update n when number of records changes:	In any way	Significantly	Significantly
Effects of n=0	Hipersorting and DYNALLOC not used	Hipersorting and DYNALLOC not used	None

Table 3 summarizes the differences for the three SIZE variations:

Table 3. SIZE Variations Summary
SIZE=n is equivalent to SIZE=En if installation option FSZEST=YES is specified.Conditions	SIZE=n	SIZE=Un	SIZE=En
Number of records	Exact	Estimate	Estimate
Applications	Sort, merge	Sort	Sort
Terminate if n wrong?	Yes	No	No
Use for file size calculation?	Yes	Yes	When DFSORT cannot compute file size
n includes records:
In input data sets	Yes	Yes	Yes
Inserted/deleted by E15	No	No	No
Inserted by E32	No	No	No
Deleted by INCLUDE/OMIT	No	No	No
Deleted by SKIPREC	No	No	No
Deleted by STOPAFT	Yes	Yes	Yes
Update n when number of records changes:	In any way	Significantly	Significantly
Effects of n=0	Hipersorting and DYNALLOC not used	Hipersorting and DYNALLOC not used	None

Attention: Using the SIZE or FILSZ parameter to supply inaccurate information to DFSORT can negatively affect DFSORT performance, and, when work space is dynamically allocated, can result in wasted disk space or termination with message ICE083A or ICE046A. Therefore, it is important to update the record count value whenever the number of records to be sorted changes significantly.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

HIPRMAX


>>-HIPRMAX=--+-OPTIMAL-+---------------------------------------><
             +-n-------+   
             '-p%------'

Temporarily overrides the HIPRMAX installation option, which specifies the maximum amount of Hiperspace to be used for Hipersorting. Hiperspace is a high-performance data space that resides in central storage and is backed by auxiliary storage (if necessary). Because I/O processing is reduced for Hipersorting, elapsed time, EXCP counts, and channel usage are also reduced.

Several factors can limit the amount of Hiperspace an application uses:

The IEFUSI exit can limit the total amount of Hiperspace, memory objects and data space available to an application.
HIPRMAX can limit the amount of Hiperspace available to an application, as detailed later in this section.
Sufficient available storage must be present to back DFSORT's Hiperspaces. "Available" storage is the storage used to back new Hiperspace data and consists of the following two types:
1. Free storage. This is storage not being used by any application.
2. Old storage. This is storage used by another application whose data has been unreferenced for a sufficiently long time so that the system considers it eligible to be paged out to auxiliary storage to make room for new Hiperspace data.

The amount of available storage constantly changes, depending upon current system activity. Consequently, DFSORT checks the available storage level throughout a Hipersorting application and switches from Hiperspace to work data sets if the available storage level gets too low.

Other concurrent Hipersorting, memory sorting and dataspace sorting applications further limit the amount of available storage. A Hipersorting application knows the storage needs of every other Hipersorting, memory object sorting and dataspace sorting application on the system. A Hipersorting application does not try to back its Hiperspace data with storage needed by another Hipersorting, memory object sorting, or dataspace sorting application. This prevents overcommitment of storage resources if multiple large concurrent DFSORT applications start at similar times on the same system.
The installation options EXPMAX, EXPOLD, and EXPRES can also be used to further limit the amount of storage available to Hipersorting applications. EXPMAX limits the total amount of available storage that can be used at any one time to back DFSORT Hiperspaces, memory objects and data spaces. EXPOLD limits the total amount of old storage that can be used at any one time to back DFSORT Hiperspaces, memory objects and data spaces. EXPRES sets aside a specified amount of available storage for use by non-Hipersorting, non-memory object sorting, and non-dataspace sorting applications.

Some of these limits depend on system and other DFSORT activity throughout the time a Hipersorting application runs. Consequently, the amount of Hiperspace a Hipersorting application uses can vary from run to run.

HIPRMAX=n specifies a fixed value for HIPRMAX. HIPRMAX=p% specifies a value for HIPRMAX that varies as a percentage of an appropriate portion of central storage. If the storage on a system changes, HIPRMAX=p% will cause a corresponding change in the HIPRMAX value selected by DFSORT, whereas HIPRMAX=n will not. When sharing DFSORT installation options between systems, such as in a sysplex, HIPRMAX=p% can be used to tailor the HIPRMAX value to the system selected for the application, providing a more dynamic HIPRMAX value than HIPRMAX=n.

If the amount of Hiperspace available for Hipersorting is insufficient for temporary storage of the records, intermediate disk storage is used along with Hiperspace. If the amount of Hiperspace is too small to improve performance, Hipersorting is not used. DYNAUTO=NO is changed to DYNAUTO=YES for Hipersorting.

Hipersorting can cause a small CPU time increase. When CPU optimization is a concern, you can use HIPRMAX=0 to suppress Hipersorting.

Note: HIPRLIM=OPTIMAL can be used instead of HIPRMAX=OPTIMAL. HIPRLIM=m can be used instead of HIPRMAX=n. HIPRLIM=m specifies a Hiperspace limit of m times 4096 bytes rounded up to the nearest megabyte. m must be a value between 0 and 2559744. If m is 0, Hipersorting is not used.

OPTIMAL: specifies that DFSORT determines dynamically the maximum amount of Hiperspace to be used for Hipersorting.
n: specifies that DFSORT determines dynamically the maximum amount of Hiperspace to be used for Hipersorting, subject to a limit of nMB. n must be a value between 0 and 32767. If n is 0, Hipersorting is not used.
p%: specifies that DFSORT determines dynamically the maximum amount of hiperspace to be used for Hipersorting, subject to a limit of p percent of an appropriate portion of central storage. p must be a value between 0 and 100. If p is 0, Hipersorting is not used. The value calculated for p% is limited to 32767MB, and is rounded down to the nearest MB.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

LIST or NOLIST


>>-+-LIST---+--------------------------------------------------><
   '-NOLIST-'

Temporarily overrides the LIST installation option, which specifies whether DFSORT program control statements should be written to the message data set. See z/OS DFSORT Messages, Codes and Diagnosis Guide for details on use of the message data set.

LIST: specifies that DFSORT control statements are printed to the message data set.
NOLIST: specifies that DFSORT control statements are not printed to the message data set.

Note: LIST or NOLIST are processed only if they are passed on the OPTION control statement in an extended parameter list or in DFSPARM.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

LISTX or NOLISTX


>>-+-LISTX---+-------------------------------------------------><
   '-NOLISTX-'

Temporarily overrides the LISTX installation option, which specifies whether DFSORT writes to the message data set program control statements that are returned by an EFS program. See z/OS DFSORT Messages, Codes and Diagnosis Guide for details on use of the message data set.

LISTX: specifies that control statements returned by an EFS program are printed to the message data set.
NOLISTX: specifies that control statements returned by an EFS program are not printed to the message data set.

Note:

LISTX or NOLISTX are processed only if they are passed on the OPTION control statement in an extended parameter list or in DFSPARM.
If EFS=NONE is in effect after final override rules have been applied, NOLISTX is in effect.
LISTX and NOLISTX can be used independently of LIST and NOLIST.
For more information on printing EFS control statements, see z/OS DFSORT Messages, Codes and Diagnosis Guide

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

LOCALE


>>-LOCALE=-+-name----+-----------------------------------------><
           +-CURRENT-+   
           '-NONE----'

Temporarily overrides the LOCALE installation option, which specifies whether locale processing is to be used and, if so, designates the active locale.

DFSORT's collating behavior can be modified according to your cultural environment. Your cultural environment is defined to DFSORT using the X/Open locale model. A locale is a collection of data grouped into categories that describes the information about your cultural environment.

The collate category of a locale is a collection of sequence declarations that defines the relative order between collating elements (single character and multi-character collating elements). The sequence declarations define the collating rules.

If locale processing is to be used, the active locale will affect the behavior of DFSORT's SORT, MERGE, INCLUDE, and OMIT functions. For SORT and MERGE, the active locale will only be used to process character (CH) control fields. For INCLUDE and OMIT, the active locale will only be used to process character (CH) compare fields, and character and hexadecimal constants compared to character (CH) compare fields.

Note: Locale processing is not used for IFTRAIL TRLID or IFTHEN WHEN, BEGIN or END constants or compare fields.

name

specifies that locale processing is to be used and designates the name of the locale to be made active during DFSORT processing.

The locales are designated using a descriptive name. For example, to set the active locale to represent the French language and the cultural conventions of Canada, specify LOCALE=FR_CA. You can specify up to 32 characters for the descriptive locale name. The locale names themselves are not case-sensitive. See Using Locales for complete locale naming conventions.

You can use IBM-supplied and user-defined locales.

The state of the active locale prior to DFSORT being entered will be restored on DFSORT's completion.

CURRENT

specifies that locale processing is to be used, and the current locale active when DFSORT is entered will remain the active locale during DFSORT processing.

NONE

specifies that locale processing is not to be used. DFSORT will use the binary encoding of the code page defined for your data for collating and comparing.

Note:

LOCALE is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.
To use an IBM-supplied locale, DFSORT must have access to the Language Environment run-time library. For example, this library might be called SYS1.SCEERUN. If you are unsure of the name of this library at your location, contact your system administrator. To use a user-defined locale, DFSORT must have access to the load library containing it.
If you use locale processing for SORT, MERGE, INCLUDE, or OMIT fields:
- VLSHRT is not used for SORT or MERGE
- INREC or an E61 user exit must not be usedfor SORT or MERGE.
- CHALT or an EFS program must not be used.
Locale processing is not used for IFTRAIL TRLID or IFTHEN WHEN, BEGIN or END constants or compare fields.
Locale processing for DFSORT's SORT, MERGE, INCLUDE, and OMIT functions can improve performance relative to applications that must perform pre-processing or post-processing of data to produce the desired collating results. However, locale processing should be used only when required, because it can show degraded performance relative to collating, using character encoding values.
DFSORT locale processing may require an additional amount of storage that depends on the environment supporting the locale as well as the locale itself. It may be necessary to specify a REGION of several MB or more for DFSORT applications that use locale processing.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions:; See Specification/override of DFSORT options.

MAINSIZE


>>-MAINSIZE=--+-n---+------------------------------------------><
              +-nK--+   
              +-nM--+   
              '-MAX-'

Temporarily overrides the SIZE installation option, which specifies the amount of main storage available to DFSORT.

MAINSIZE applies to the total amount of main storage above and below 16MB virtual. DFSORT determines how much storage to allocate above and below 16MB virtual, but the total amount of storage cannot exceed MAINSIZE.

Storage used for OUTFIL processing will be adjusted automatically, depending upon several factors, including:

Total available storage
Non-OUTFIL processing storage requirements
Number of OUTFIL data sets and their attributes (for example, block size).

OUTFIL processing is subject to the ODMAXBF limit and your system storage limits (for example, IEFUSI) but not to DFSORT storage limits, that is, SIZE/MAINSIZE, MAXLIM, and TMAXLIM. DFSORT attempts to use storage above 16MB virtual for OUTFIL processing whenever possible.

For details on main storage allocation, see Tuning main storage.

n: specifies that n bytes of storage are to be allocated. If you specify more that 2097152000, 2097152000 is used.
Limit: 10 digits
nK: specifies that n times 1024 bytes of storage are to be allocated. If you specify more than 2048000K, 2048000K is used.
Limit: 7 digits
nM: specifies that n times 1048576 bytes of storage are to be allocated. If you specify more than 2000M, 2000M is used.
Limit: 4 digits.
MAX: instructs DFSORT to calculate the amount of virtual storage available and allocate an amount of storage up to the TMAXLIM or DSA value when Blockset is selected, or up to the MAXLIM value when Blockset is not selected.

Note: CORE=value can be used instead of MAINSIZE=value.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

MERGEIN


>>-MERGEIN=--+-ddname---------+--------------------------------><
             |   .-,------.   |   
             |   V        |   |   
             '-(---ddname-+-)-'

Specifies up to 100 ddnames to be be used for a MERGE application instead of the SORTINnn ddnames. This allows you to use any valid alternate ddnames for the MERGE data sets.

If EQUALS is in effect, records that collate identically are output in the order of their ddnames in the MERGEIN list.

Each ddname can be 1 through 8 characters. If a ddname is specified more than once in the MERGEIN operand, it will only be used once. If more than 100 unique ddnames are specified in the MERGEIN operand, only the first 100 will be used. Do not use ddnames reserved for use by DFSORT, such as SYSOUT, ccccOUT, ccccWKd, ccccWKdd, ccccDKd, or ccccDKdd , where cccc is the specified or defaulted value for the SORTDD operand and d is any character.

Note:

MERGEIN is processed only if it is passed on the OPTION control statement in an extended parameter list, or in DFSPARM.
If both MERGEIN=(ddname1,ddname2,...) and SORTDD=cccc are specified, ddname1, ddname2 and so on are used for the input files. The same ddname cannot be specified for MERGEIN and SORTOUT, or for MERGEIN and OUTFIL.

Default: SORTINnn, unless SORTDD=cccc is specified in an extended parameter list or in DFSPARM, in which case ccccINnn is the default.

Applicable Functions: See Specification/override of DFSORT options.

MOSIZE


>>-MOSIZE=--+-MAX-+--------------------------------------------><
            +-n---+   
            '-p%--'

Temporarily overrides the MOSIZE installation option, which specifies the maximum amount of memory object storage to be used for memory object sorting in 64-bit virtual storage. A memory object is a data area in virtual storage that is allocated above the bar and backed by central storage. Because I/O processing is reduced for memory object sorting, elapsed time, EXCP counts, and channel usage are also reduced.

Note: The "bar" refers to the 2-gigabyte address within the 64-bit address space. The bar separates storage below the 2-gigabyte address called "below the bar", from storage above the 2-gigabyte address called "above the bar".

There are several factors that can limit the total memory object storage used by an application:

The MEMLIMIT parameter on the JOB or EXEC JCL statement can limit the total number of usable virtual pages above the bar in a single address space.
In addition to limiting the total amount of Hiperspace and data space available to an application, the IEFUSI exit can also limit the total number of usable virtual pages above the bar in a single address space.
MOSIZE can limit the total amount of memory object storage available to an application, as detailed later in this section.
Sufficient available central storage must be present to back DFSORT's memory object storage. The amount of available central storage changes constantly, depending on current system activity. Consequently, DFSORT checks the amount of available central storage throughout a memory object sorting run and switches from using a memory object to using disk work data sets if the available central storage is too low.
Other concurrent Hipersorting, memory object sorting, and dataspace sorting applications further limit the amount of available storage. A memory object sorting application keeps track of the storage needs of all other Hipersorting, memory object sorting, and dataspace sorting applications on the system, and does not attempt to back its memory object storage with storage needed by another Hipersorting, memory object sorting, or dataspace sorting application. This prevents overcommitment of storage resources in the event of multiple large concurrent Hipersorting, memory object sorting, and dataspace sorting applications starting at similar times on the same system.
The installation options EXPMAX, EXPOLD, and EXPRES can also be used to further limit the amount of storage available to memory object sorting applications. EXPMAX limits the total amount of available storage that can be used at any one time to back DFSORT Hiperspaces, memory objects, and data spaces. EXPOLD limits the total amount of old storage that can be used at any one time to back DFSORT Hiperspaces, memory objects, and data spaces. EXPRES sets aside a specified amount of available storage for use by non-Hipersorting, non-memory object sorting, and non-dataspace sorting applications.

Some of these limits depend on system and other DFSORT activity during the time that a memory object sorting application runs. Consequently, the total amount of memory object storage that a memory object sorting application uses can vary from run to run.

MOSIZE=n specifies a fixed value for MOSIZE. MOSIZE=p% specifies a value for MOSIZE that varies as a percentage of the available central storage on the system at run-time. If the available central storage on a system changes, MOSIZE=p% will cause a corresponding change in the MOSIZE value selected by DFSORT, whereas MOSIZE=n will not. When sharing DFSORT installation options between systems, such as in a sysplex, MOSIZE=p% can be used to tailor the MOSIZE value to the system selected for the application, providing a more dynamic MOSIZE value than MOSIZE=n.

If the total memory object storage available for memory object sorting is insufficient for temporary storage of the records, intermediate disk storage can be used along with the memory object. When memory object sorting is enabled, DFSORT changes DYNAUTO=NO to DYNAUTO=YES in some cases.

MAX: specifies that DFSORT determines dynamically the maximum size of a memory object to be used for memory object sorting. In this case, DFSORT bases its memory object usage on the size of the file being sorted and the central storage usage activity.
n: specifies that DFSORT determines dynamically the maximum size of a memory object to be used for memory object sorting, subject to a limit of n MB. n must be a value between 0 and 2147483646. The actual size used does not exceed n, but may be less, depending on the size of the file being sorted and the central storage usage activity on the system. If n is 0, memory object sorting is not used
p%: specifies that DFSORT determines dynamically the maximum size of a memory object to be used for memory object sorting, subject to a limit of p percent of the available central storage. p must be a value between 0 and 100. If p is 0, memory object sorting is not used. The value calculated for p% is limited to 2147483646 MB, and is rounded down to the nearest MB.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

MOWRK or NOMOWRK


>>-+-MOWRK---+-------------------------------------------------><
   '-NOMOWRK-'

Temporarily overrides the MOWRK installation option, which specifies whether the memory object storage available to DFSORT for memory object sorting can be used as intermediate work space. DFSORT has the capability of using memory object storage as intermediate work space (similar to the way Hiperspace is used but more efficient), or as an extension of main storage. Using memory object storage as intermediate work space is the preferred and recommended choice, but can be disabled, if appropriate.

MOWRK: specifies that memory object storage can be used as intermediate work space, or as an extension of main storage, as appropriate.
NOMOWRK: specifies that memory object storage can only be used as an extension of main storage.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

MSGDDN


>>-MSGDDN=ddname-----------------------------------------------><

Temporarily overrides the MSGDDN installation option, which specifies an alternate ddname for the message data set. MSGDDN must be in effect if:

A program that invokes DFSORT uses SYSOUT (for instance, COBOL uses SYSOUT) and you do not want DFSORT messages intermixed with the program messages.
Your E15 and E35 routines are written in COBOL and you do not want DFSORT messages intermixed with the program messages.
A program invokes DFSORT more than once and you want separate messages for each invocation of DFSORT.

The ddname can be any 1- through 8- character name but must be unique within the job step; do not use a name that is used by DFSORT (for example, SORTIN). If the ddname specified is not available at run-time, SYSOUT is used instead. For details on use of the message data set, see z/OS DFSORT Messages, Codes and Diagnosis Guide

Note: MSGDDN is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

MSGPRT


>>-MSGPRT=--+-ALL------+---------------------------------------><
            +-CRITICAL-+   
            '-NONE-----'

Temporarily overrides the MSGPRT installation option, which specifies the class of messages to be written to the message data set. For details on use of the message data set, see z/OS DFSORT Messages, Codes and Diagnosis Guide.

ALL: specifies that all messages except diagnostic messages (ICE800I to ICE999I) are to be printed. Control statements print only if LIST is in effect.
CRITICAL: specifies that only critical messages will be printed. Control statements print only if LIST is in effect.
NONE: specifies that no messages and control statements will be printed.

Note:

MSGPRT is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.
PRINT=value can be used instead of MSGPRT=value.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

NOBLKSET


>>-NOBLKSET----------------------------------------------------><

Causes DFSORT to bypass the Blockset technique normally used for a sort or merge application. Using this option generally results in degraded performance.

Note: Functions such as OUTFIL processing, which are supported only by the Blockset technique, cause the NOBLKSET option to be ignored.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

NOOUTREL


>>-NOOUTREL----------------------------------------------------><

Temporarily overrides the OUTREL installation option, which specifies whether unused temporary output data set space is released. NOOUTREL means that unused temporary output data set space is not released.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

NOOUTSEC


>>-NOOUTSEC----------------------------------------------------><

Temporarily overrides the OUTSEC installation option, which specifies whether automatic secondary allocation is used for temporary or new output data sets. NOOUTSEC means that automatic secondary allocation for output data sets is not used.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

NULLOUT


>>-NULLOUT=--+-RC0--+------------------------------------------><
             +-RC4--+   
             '-RC16-'

Temporarily overrides the NULLOUT installation option, which specifies the action to be taken by DFSORT when there are no records for the SORTOUT data set, as indicated by an OUT count of 0 in message ICE054I

RC0: specifies that DFSORT should issue message ICE173I, set a return code of 0, and continue processing when there are no records for the SORTOUT data set.
RC4: specifies that DFSORT should issue message ICE173I, set a return code of 4, and continue processing when there are no records for the SORTOUT data set.
RC16: specifies that DFSORT should issue message ICE206A, terminate, and give a return code of 16 when there are no records for the SORTOUT data set.

Note:

The return code of 0 or 4 set when there are no records for the SORTOUT data set can be overridden by a higher return code set for some other reason.
NULLOUT does not apply when SORTOUT is not present, when tape work data sets are specified for a sort application, or when the Blockset technique is not selected for a merge application. DFSORT does not check if there are no records for the SORTOUT data set in these cases.
NULLOUT applies to the SORTOUT data set. NULLOFL on the OUTFIL statement applies to OUTFIL data sets.
For an ICEGENER application, NULLOUT applies to the SYSUT2 data set if DFSORT copy is used. Note that ICEGENER passes back return code 12 instead of return code 16.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

ODMAXBF


>>-ODMAXBF=-+-n--+---------------------------------------------><
            +-nK-+   
            '-nM-'

Temporarily overrides the ODMAXBF installation option, which specifies the maximum buffer space DFSORT can use for each OUTFIL data set. The actual amount of buffer space used for a particular OUTFIL data set will not exceed the ODMAXBF limit, but can be less than the limit. OUTFIL processing is supported by the Blockset technique for sort, copy, and merge applications.

The storage used for OUTFIL processing is adjusted automatically according to the total storage available, the storage needed for non-OUTFIL processing, and the number of OUTFIL data sets and their attributes (for example, block size). OUTFIL processing is subject to the ODMAXBF limit in effect and the system storage limits (for example, IEFUSI), but not to the DFSORT storage limits (that is, SIZE, MAXLIM, and TMAXLIM). DFSORT attempts to use storage above 16MB virtual for OUTFIL processing whenever possible.

Lowering ODMAXBF below 2M can cause performance degradation for the application, but may be necessary if you consider the amount of storage used for OUTFIL processing to be a problem. Raising ODMAXBF can improve EXCPs for the application but can also increase the amount of storage needed.

n: specifies that a maximum of n bytes of buffer space is to be used for each OUTFIL data set. If you specify less than 262144, 262144 is used. If you specify more than 16777216, 16777216 is used.
Limit: 8 digits
nK: specifies that a maximum of n times 1024 bytes of buffer space is to be used for each OUTFIL data set. If you specify less than 256K, 256K is used. If you specify more than 16384K, 16384K is used.
Limit: 5 digits
nM: specifies that a maximum of n times 1048576 bytes of buffer space is to be used for each OUTFIL data set. If you specify 0M, 256K is used. If you specify more than 16M, 16M is used.
Limit: 2 digits

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

OVFLO


>>-OVFLO=--+-RC0--+--------------------------------------------><
           +-RC4--+   
           '-RC16-'

Temporarily overrides the OVFLO installation option, which specifies the action to be taken by DFSORT when BI, FI, PD or ZD summary fields overflow.

RC0: specifies that DFSORT should issue message ICE152I (once), set a return code of 0 and continue processing when summary fields overflow. The pair of records involved in a summary overflow is left unsummed and neither record is deleted. Summary overflow does not prevent further summation.
RC4: specifies that DFSORT should issue message ICE152I (once), set a return code of 4 and continue processing when summary fields overflow. The pair of records involved in a summary overflow is left unsummed and neither record is deleted. Summary overflow does not prevent further summation.
RC16: specifies that DFSORT should issue message ICE195A, terminate and give a return code of 16 when summary fields overflow.

Note: The return code of 0 or 4 set for summary overflow can be overridden by a higher return code set for some other reason.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

PAD


>>-PAD=--+-RC0--+----------------------------------------------><
         +-RC4--+   
         '-RC16-'

Temporarily overrides the PAD installation option, which specifies the action to be taken by DFSORT when the SORTOUT LRECL is larger than the SORTIN/SORTINnn LRECL, for the cases where DFSORT allows LRECL padding.

RC0: specifies that DFSORT should issue message ICE171I, set a return code of 0 and continue processing when the SORTOUT LRECL is larger than the SORTIN/SORTINnn LRECL.
RC4: specifies that DFSORT should issue message ICE171I, set a return code of 4 and continue processing when the SORTOUT LRECL is larger than the SORTIN/SORTINnn LRECL.
RC16: specifies that DFSORT should issue message ICE196A, terminate and give a return code of 16 when the SORTOUT LRECL is larger than the SORTIN/SORTINnn LRECL.

Note:

The return code of 0 or 4 set for LRECL padding can be overridden by a higher return code set for some other reason.
For an ICEGENER application, the GNPAD value is used and the PAD value is ignored.
For some LRECL padding situations (for example, a tape work data set sort), DFSORT issues ICE043A and terminates with a return code of 16. The PAD value has no effect in these cases.
DFSORT does not check for LRECL padding if:
1. A SORTIN DD (sort/copy), SORTINnn DD (merge) or SORTOUT DD is not present
2. A SORTIN DD (sort/copy), SORTINnn DD (merge) or SORTOUT DD specifies a VSAM data set.
DFSORT does not check OUTFIL data sets for LRECL padding.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

RESALL


>>-RESALL=--+-n--+---------------------------------------------><
            +-nK-+   
            '-nM-'

Temporarily overrides the RESALL installation option, which specifies the number of bytes to be reserved in a REGION for system use. Usually, only 4K bytes (the standard default) of main storage must be available in a region for system use. However, in some cases, this may not be enough; for example, if your installation does not have BSAM/QSAM modules resident, you have user exits that open data sets, or you have COBOL exits. RESALL is used only when MAINSIZE/SIZE=MAX is in effect.

RESALL applies only to the amount of main storage below 16MB virtual. The ARESALL option applies to the amount of main storage above 16MB virtual.

n: specifies that n bytes of storage are to be reserved. If you specify less than 4096, 4096 is used.
Limit: 8 digits.
nK: specifies that n times 1024 bytes of storage are to be reserved. If you specify less than 4K, 4K is used.
Limit: 5 digits.
nM: specifies that n times 1048576 bytes of storage are to be reserved. If you specify 0M, 4K is used.
Limit: 2 digits.

Tip: A better way to reserve the required storage for user exits activated by the MODS statement is to use the m parameter of the MODS statement.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

RESET or NORESET


>>-+-RESET---+-------------------------------------------------><
   '-NORESET-'

Temporarily overrides the RESET installation option, which specifies whether DFSORT should process a VSAM output data set defined with REUSE as a NEW or MOD data set.

RESET: specifies that DFSORT processes a VSAM output data set defined with REUSE as a NEW data set. The high-used RBA is reset to zero and the output data set is effectively treated as an initially empty cluster.
NORESET: specifies that DFSORT processes a VSAM output data set defined with REUSE as a MOD data set. The high-used RBA is not reset and the output data set is effectively treated as an initially non-empty cluster.

Note: A VSAM output data set defined without REUSE is processed as a MOD data set.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

RESINV


>>-RESINV=--+-n--+---------------------------------------------><
            +-nK-+   
            '-nM-'

Temporarily overrides the RESINV installation option, which specifies the number of bytes to be reserved in a REGION for the invoking program. RESINV is used only when DFSORT is dynamically invoked and MAINSIZE/SIZE=MAX is in effect.

RESINV applies only to the amount of main storage below 16MB virtual. The ARESINV option applies to the amount of main storage above 16MB virtual.

This extra space is usually required for data handling by the invoking program or user exits while DFSORT is running (as is the case with some PL/I- and COBOL- invoked sort applications). Therefore, if your invoking program's user exits do not perform data set handling, you do not need to specify this parameter. The reserved space is not meant to be used for the invoking program's executable code.

The amount of space required depends upon what routines you have, how the data is stored, and which access method you use.

n: specifies that n bytes of storage are to be reserved.
Limit: 8 digits
nK: specifies that n times 1024 bytes of storage are to be reserved.
Limit: 5 digits
nM: specifies n times 1048576 bytes of main storage are to be reserved.
Limit: 2 digits.

Tip: A better way to reserve the required storage for user exits activated by the MODS statement is to use the m parameter of the MODS statement.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SDB


>>-SDB=--+-LARGE-+---------------------------------------------><
         +-YES---+   
         +-INPUT-+   
         '-NO----'

Temporarily overrides the SDB installation option, which specifies whether DFSORT should use the system-determined optimum block size for output data sets when the block size is specified as zero or defaulted to zero. System-determined block size applies to both SMS-managed and non-SMS-managed data sets and results in the most efficient use of space for the device on which the output data set resides.

DFSORT can select system-determined optimum block sizes greater than 32760 bytes for tape output data sets.

If you want DFSORT to use system-determined block sizes for disk and tape output data sets, specify one of the following values:

SDB=LARGE if you want to allow DFSORT to select tape output block sizes greater than 32760 bytes.
SDB=YES (or its alias SDB=SMALL) if you want DFSORT to select tape output block sizes less than or equal to 32760 bytes.
SDB=INPUT if you want to allow DFSORT to select tape output block sizes greater than 32760 bytes only when tape input data sets with block sizes greater than 32760 bytes are used.

DFSORT will not select a tape output block size greater than the BLKSZLIM in effect. In particular, if a default BLKSZLIM of 32760 is in effect, DFSORT will not select a tape output block size greater than 32760 bytes. Therefore, in order to allow DFSORT to select tape output block sizes greater than 32760 bytes for particular jobs, you may need to ensure that your JCL or data class supplies appropriately large BLKSZLIM values (for example, 1GB) for those jobs.

If you don't want DFSORT to use system-determined block sizes, specify SDB=NO (not recommended as an installation option).

LARGE

specifies that DFSORT is to use the system-determined optimum block size for an output data set when its block size is zero. SDB=LARGE allows DFSORT to select a block size greater than 32760 bytes for a tape output data set, when appropriate. A larger tape block size can improve elapsed time and tape utilization, but you must ensure that applications which subsequently use the resulting tape data set can handle larger block sizes.

DFSORT selects the system-determined optimum block size as follows:

For a disk output data set, the optimum block size for the device used is selected based on the obtained or derived RECFM and LRECL for the output data set. The maximum block size for disk output data sets is 32760 bytes.
For a tape output data set, the optimum block size is selected based on the obtained or derived RECFM and LRECL for the output data set, as shown in Table 4.

Table 4. SDB=LARGE Block Sizes for Tape Output Data Sets
SDB=LARGE Block Sizes for Tape Output Data SetsRECFM	BLKSIZE is set to:
F or FS	LRECL
FB or FBS	Highest possible multiple of LRECL that is less than or equal to the optimum block size for the device, subject to the BLKSZLIM in effect.
V, D, VS, or DS	LRECL + 4
VB, DB, VBS, or DBS	Optimum block size for the device, subject to the BLKSZLIM in effect.

DFSORT uses the system-determined optimum block size for the output data set in most cases when the block size is zero. However, the following conditions prevent DFSORT from using the system-determined block size:

Output data set block size is available (that is, non-zero) in the JFCB (disk or tape) or format 1 DSCB (disk) or tape label (only for DISP=MOD with AL, SL, or NSL label, when appropriate)
Output is a spool, dummy, VSAM, or unmovable data set, or a z/OS UNIX file.
The output data set is on tape with a label type of AL
DFSORT's Blockset technique is not selected.

In the previous cases, DFSORT uses the specified block size, or determines an appropriate (though not necessarily optimum) block size for the output data set. The selected block size is limited to 32760 bytes.

YES

specifies that DFSORT is to use the system-determined optimum block size for an output data set when its block size is zero, but is to limit the selected block size to a maximum of 32760 bytes. See the discussion of SDB=LARGE for more information; the only difference between SDB=LARGE and SDB=YES is that SDB=LARGE allows block sizes greater than 32760 bytes for tape output data sets, whereas SDB=YES does not.

INPUT

specifies that DFSORT is to use the system-determined optimum block size for an output data set when its block size is zero, but is to limit the selected block size to a maximum of 32760 bytes if the input block size is less than or equal to 32760 bytes. Thus, SDB=INPUT works like SDB=LARGE if the input block size is greater than 32760 bytes (only possible for tape input data sets) and works like SDB=YES if the input block size is less than or equal to 32760 bytes. See the discussions of SDB=LARGE and SDB=YES for more information.

NO

specifies that DFSORT is not to use the system-determined optimum block size. When the output data set block size is zero, DFSORT selects an appropriate (though not necessarily optimum) block size for the output data set based on the obtained or derived output or input attributes. SDB=NO limits the selected block sizes to a maximum of 32760 bytes.

SDB=NO works like SDB=YES if the input block size is greater than 32760 bytes (only possible for tape input data sets). See the discussion of SDB=YES for more information.

Note:

SDB=NO does not prevent the use of system-determined block size for the output data set at allocation or in other cases where the output data set block size is set before DFSORT gets control.
When DFSORT uses system-determined block size, the selected output data set block size may be different from the block size selected previously. Applications that require a specific output data set block size should be changed to specify that block size explicitly.
SDB and SDB=SMALL can be used instead of SDB=YES. NOSDB can be used instead of SDB=NO.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SIZE

See FILSZ.

SKIPREC


>>-SKIPREC=z---------------------------------------------------><

Specifies the number of records z you want to skip (delete) before starting to sort or copy the input data set. SKIPREC is usually used if, on a preceding DFSORT run, you have processed only part of the input data set.

An application with an input data set that exceeds intermediate storage capacity usually terminates unsuccessfully. However, for a tape work data set sort, you can use a routine at E16 (as described in Using your own user exit routines) to instruct the program to sort only those records already read in. It then prints a message giving the number of records sorted. You can use SKIPREC in a subsequent sort run to bypass the previously-sorted records, sort only the remaining records, and then merge the output from different runs to complete the application.

z: specifies the number of records to be skipped.

Limit: 28 digits (15 significant digits)

Note:

SKIPREC applies only to records read from SORTIN (not from E15 routines). (See Figure 1.)
If SKIPREC=0 is in effect, SKIPREC is not used.
You may want to consider using the STARTREC parameter of the OUTFIL statement as an alternative to using SKIPREC.

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SMF


>>-SMF=-+-SHORT-+----------------------------------------------><
        +-FULL--+   
        '-NO----'

Temporarily overrides the SMF installation option, which specifies whether a DFSORT SMF record is to be produced as described in z/OS DFSORT Installation and Customization.

SHORT: specifies that DFSORT is to produce a short SMF type-16 record for a successful run. The short SMF record does not contain record-length distribution statistics or data set sections.
FULL: specifies that DFSORT is to produce a full SMF type-16 record for a successful run. The full SMF record contains the same information as the short record, as well as record-length distribution and data set sections, as appropriate.
NO: specifies that DFSORT is not to produce an SMF type-16 record for this run.

Note:

SMF is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.
SMF=FULL can degrade performance for a variable-length record application.
The DFSORT SVC is called to write SMF type-16 records. If SMF=SHORT or SMF=FULL is in effect, the correct DFSORT SVC for this release must be loaded in LPA or MLPA.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SOLRF or NOSOLRF


>>-+-SOLRF---+-------------------------------------------------><
   '-NOSOLRF-'

Temporarily overrides the SOLRF installation option, which specifies whether DFSORT should set the SORTOUT LRECL to the reformatted record length when the SORTOUT LRECL is unknown.

SOLRF

specifies that DFSORT should use the reformatted record length for the SORTOUT LRECL when the SORTOUT LRECL is not specified or available. DFSORT will use one of the following for the SORTOUT LRECL, in the order listed:

The SORTOUT LRECL if available from the JFCB, format 1 DSCB, DFSMSrmm, ICETPEX, or tape label
The L3 length if specified in the RECORD statement
The OUTREC length if the OUTREC statement is specified
The INREC length if the INREC statement is specified
The L2 length if specified in the RECORD statement providing an E15 user exit is present
The SORTIN or SORTINnn LRECL if available from the JFCB, format 1 DSCB, DFSMSrmm, ICETPEX, or tape label
The L1 length in the RECORD statement

NOSOLRF

specifies that DFSORT should not use the reformatted record length for the SORTOUT LRECL. DFSORT will use one of the following for the SORTOUT LRECL, in the order listed:

The SORTOUT LRECL if available from the JFCB, format 1 DSCB, DFSMSrmm, ICETPEX, or tape label
The L3 length if specified in the RECORD statement providing an E35 exit, OUTREC statement or INREC statement is present
The L2 length if specified in the RECORD statement providing an E15 user exit is present
The SORTIN or SORTINnn LRECL if available from the JFCB, format 1 DSCB, DFSMSrmm, ICETPEX, or tape label
The L1 length in the RECORD statement

Note:

With SOLRF in effect (the IBM-supplied default), DFSORT sets the SORTOUT LRECL to the INREC or OUTREC record length when appropriate, which is usually what you want when you use INREC or OUTREC. If you want DFSORT to use the input length for the SORTOUT LRECL even when INREC or OUTREC is present, you can use NOSOLRF, but be aware that this can cause padding or truncation of the reformatted records, or termination.
CAOUTREC can be used instead of SOLRF.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SORTDD


>>-SORTDD=cccc-------------------------------------------------><

Specifies a four-character prefix for the ddnames to be used when you dynamically invoke DFSORT more than once in a program step. The four characters replace "SORT" in the following ddnames: SORTIN, SORTOUT, SORTINn, SORTINnn, SORTOFd, SORTOFdd, SORTWKd, SORTWKdd, SORTJNF1, SORTJNF2 and SORTCNTL. This allows you to use a different set of ddnames for each call to DFSORT.

cccc: Specifies a four-character prefix. The four characters must all be alphanumeric or national ($, #, or @). The first character must be alphabetic. The first three characters must not be SYS.
For example, if you use ABC# as replacement characters, DFSORT uses DD statements ABC#IN, ABC#CNTL, ABC#WKdd, and ABC#OUT instead of SORTIN, SORTCNTL, SORTWKdd, and SORTOUT.

Note:

SORTDD is processed only if it is passed on the OPTION control statement in an extended parameter list, or in DFSPARM.
If both SORTIN=ddname and SORTDD=cccc are specified, ddname is used for DFSORT input.
If both SORTOUT=ddname and SORTDD=cccc are specified, ddname is used for DFSORT output.
If both MERGEIN=(ddname1,ddname2,...) and SORTDD=cccc are specified, ddname1, ddname2, and so on are used for DFSORT input.

Default: SORT. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SORTIN


>>-SORTIN=ddname-----------------------------------------------><

Specifies a ddname to be associated with the SORTIN data set. This allows you to dynamically invoke DFSORT more than once in a program step, passing a different ddname for each input data set.

The ddname can be 1 through 8 characters, but must be unique within the job step. Do not use ddnames reserved for use by DFSORT, such as ccccWKd, ccccWKdd, ccccDKd, or ccccDKdd , where cccc is the specified or defaulted value for the SORTDD operand and d is any character.

Note:

SORTIN is processed only if it is passed on the OPTION control statement in an extended parameter list, or in DFSPARM.
If both SORTIN=ddname and SORTDD=cccc are specified, ddname is used for the input file. The same ddname cannot be specified for SORTIN and SORTOUT, or for MERGEIN and SORTOUT.
If SORTIN is used for a tape work data set sort, DFSORT terminates.

Default: SORTIN, unless SORTDD=cccc is specified in which case ccccIN is the default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SORTOUT


>>-SORTOUT=ddname----------------------------------------------><

Specifies a ddname to be associated with the SORTOUT data set or with an OUTFIL data set for which FNAMES and FILES are not specified. This allows you to dynamically invoke DFSORT more than once in a program step, passing a different ddname for each output data set.

Note:

SORTOUT is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.
If both SORTOUT=ddname and SORTDD=cccc are specified, ddname is used for the output file. The same ddname cannot be specified for SORTIN and SORTOUT, or for MERGEIN and SORTOUT.
If SORTOUT is specified for a conventional merge or for a tape work data set sort, DFSORT terminates.

Default: SORTOUT, unless SORTDD=cccc is specified, in which case ccccOUT is the default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SPANINC


>>-SPANINC=--+-RC0--+------------------------------------------><
             +-RC4--+   
             '-RC16-'

Temporarily overrides the SPANINC installation option, which specifies the action to be taken by DFSORT when one or more incomplete spanned records are detected in a variable spanned input data set.

RC0: specifies that DFSORT should issue message ICE197I (once), set a return code of 0 and eliminate all incomplete spanned records it detects. Valid records will be recovered.
RC4: specifies that DFSORT should issue message ICE197I (once), set a return code of 4 and eliminate all incomplete spanned records it detects. Valid records will be recovered.
RC16: specifies that DFSORT should issue message ICE204A, terminate and give a return code of 16 when an incomplete spanned record is detected.

Note:

The return code of 0 or 4 set for incomplete spanned records can be overridden by a higher return code set for some other reason.
In cases where a spanned record cannot be properly assembled (for example, it has a segment length less than 4 bytes), DFSORT issues ICE141A and terminates with a return code of 16. The SPANINC value has no effect in these cases.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

STOPAFT


>>-STOPAFT=n---------------------------------------------------><

Specifies the maximum number of records (n) you want accepted for sorting or copying (that is, read from SORTIN or inserted by E15 and not deleted by SKIPREC, E15, or the INCLUDE/OMIT statement). When n records have been accepted, no more records are read from SORTIN; E15 continues to be entered as if EOF were encountered until a return code of 8 is sent, but no more records are inserted. If end-of-file is encountered before n records are accepted, only those records accepted up to that point are sorted or copied.

n: specifies the maximum number of records to be accepted.
Limit: 28 digits (15 significant digits)

Default: None; optional. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

SZERO or NOSZERO


>>-+-SZERO---+-------------------------------------------------><
   '-NOSZERO-'

Temporarily overrides the SZERO installation option, which specifies whether DFSORT should treat numeric -0 and +0 values as signed (that is, different) or unsigned (that is, the same) for collation, comparisons, editing and conversions, minimums and maximums. The following DFSORT control statements are affected by this option: INCLUDE, INREC, MERGE, OMIT, OUTFIL, OUTREC and SORT.

SZERO

specifies that DFSORT should treat numeric zero values as signed. -0 and +0 are treated as different values, that is, -0 is treated as a negative value and +0 is treated as a positive value. SZERO affects DFSORT processing of numeric values as follows:

For collation of SORT and MERGE fields, -0 collates before +0 in ascending order and after +0 in descending order.
For comparisons of INCLUDE, OMIT, and OUTFIL compare fields and constants, -0 compares as less than +0.
For editing and conversions of INREC, OUTREC, and OUTFIL reformatting fields, decimal constants, and the results of arithmetic expressions, -0 is treated as negative and +0 is treated as positive.
For minimums and maximums of OUTFIL TRAILERx fields, -0 is treated as negative and +0 is treated as positive.

NOSZERO

specifies that DFSORT should treat numeric zero values as unsigned. -0 and +0 are treated as the same value, that is, -0 and +0 are both treated as positive values. NOSZERO affects DFSORT processing of numeric values as follows:

For collation of SORT and MERGE fields, -0 collates equally with +0.
For comparisons of INCLUDE, OMIT and OUTFIL compare fields and constants, -0 compares as equal to +0.
For editing and conversions of INREC, OUTREC, and OUTFIL reformatting fields, decimal constants, and the results of arithmetic expressions, -0 and +0 are treated as positive.
For minimums and maximums of OUTFIL TRAILERx fields, -0 and +0 are treated as positive.

Note: OPTION SZERO or OPTION NOSZERO is ignored for OUTFIL INCLUDE and OMIT, and INREC, OUTREC, and OUTFIL WHEN, BEGIN and END, if the OPTION statement is "found" after the INREC, OUTREC, or OUTFIL statement. To avoid this, specify SZERO or NOSZERO as an EXEC/DFSPARM PARM option, or in an OPTION statement before the INREC, OUTREC, or OUTFIL statement in the same source, for example:

//SYSIN DD *
 OPTION NOSZERO,COPY
 OUTFIL INCLUDE=(...)
/*

Default: Usually, the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

TRUNC


>>-TRUNC=--+-RC0--+--------------------------------------------><
           +-RC4--+   
           '-RC16-'

Temporarily overrides the TRUNC installation option, which specifies the action to be taken by DFSORT when the SORTOUT LRECL is smaller than the SORTIN/SORTINnn LRECL, for the cases where DFSORT allows LRECL truncation.

RC0: specifies that DFSORT should issue message ICE171I, set a return code of 0 and continue processing when the SORTOUT LRECL is smaller than the SORTIN/SORTINnn LRECL.
RC4: specifies that DFSORT should issue message ICE171I, set a return code of 4 and continue processing when the SORTOUT LRECL is smaller than the SORTIN/SORTINnn LRECL.
RC16: specifies that DFSORT should issue message ICE196A, terminate and give a return code of 16 when the SORTOUT LRECL is smaller than the SORTIN/SORTINnn LRECL.

Note:

The return code of 0 or 4 set for LRECL truncation can be overridden by a higher return code set for some other reason.
For an ICEGENER application, the GNTRUNC value is used and the TRUNC value is ignored.
For some LRECL truncation situations (for example, a tape work data set sort), DFSORT issues ICE043A and terminates with a return code of 16. The TRUNC value has no effect in these cases.
DFSORT does not check for LRECL truncation if:
1. A SORTIN DD (sort/copy), SORTINnn DD (merge) or SORTOUT DD is not present
2. A SORTIN DD (sort/copy), SORTINnn DD (merge) or SORTOUT DD specifies a VSAM data set.
DFSORT does not check OUTFIL data sets for LRECL truncation.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

USEWKDD


>>-USEWKDD-----------------------------------------------------><

Temporarily overrides the DYNAUTO=IGNWKDD option, which specifies that dynamic work data sets are used even if SORTWKdd DD statements are present. This option allows JCL SORTWKdd data sets to be used rather than deallocated.

Note: USEWKDD is processed only if it is passed on the OPTION control statement in an extended parameter list or in DFSPARM.

Default: None, optional. See Specification/override of DFSORT options for full override details.

Applicable Function: See Specification/override of DFSORT options.

VERIFY or NOVERIFY


>>-+-VERIFY---+------------------------------------------------><
   '-NOVERIFY-'

Temporarily overrides the VERIFY installation option, which specifies whether sequence checking of the final output records must be performed.

VERIFY: specifies that sequence checking is performed.
NOVERIFY: specifies that sequence checking is not performed.

Note:

Using VERIFY can degrade performance.
SEQ=YES can be used instead of VERIFY, SEQ=NO can be used instead of NOVERIFY.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

VLLONG or NOVLLONG


>>-+-VLLONG---+------------------------------------------------><
   '-NOVLLONG-'

Temporarily overrides the VLLONG installation option, which specifies whether DFSORT is to truncate "long" variable-length output records. A long output record is one whose length is greater than the LRECL of the SORTOUT or OUTFIL data set it is to be written to.

VLLONG is not meaningful for fixed-length output record processing.

VLLONG: specifies that DFSORT truncates long variable-length output records to the LRECL of the SORTOUT or OUTFIL data set.
NOVLLONG: specifies that DFSORT terminates if a long variable-length output record is found.

Note:

VLLONG should not be used unless you want the data at the end of long variable-length output records to be truncated for your DFSORT application; inappropriate use of VLLONG can result in unwanted loss of data.
VLLONG can be used to truncate long OUTFIL data records, but has no effect on long OUTFIL header or trailer records.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

VLSCMP or NOVLSCMP


>>-+-VLSCMP---+------------------------------------------------><
   '-NOVLSCMP-'

Temporarily overrides the VLSCMP installation option, which specifies whether DFSORT is to pad "short" variable-length INCLUDE/OMIT compare fields with binary zeros. A short field is one where the variable-length record is too short to contain the entire field, that is, the field extends beyond the record. VLSCMP and NOVLSCMP apply to the INCLUDE and OMIT statements and to the INCLUDE and OMIT parameters of the OUTFIL statement.

The compare fields are only padded temporarily for testing; they are not actually changed for output.

VLSCMP is not meaningful for fixed-length record processing.

The settings for VLSCMP/NOVLSCMP and VLSHRT/NOVLSHRT provide three levels of processing for short INCLUDE/OMIT fields in the following hierarchy:

VLSCMP allows all of the INCLUDE/OMIT comparisons to be performed even if some fields are short. Because short fields are padded with binary zeros, comparisons involving short fields are false (unless a test against binary zero is relevant, as discussed later in this section). Comparisons involving non-short fields can be true or false.
NOVLSCMP and VLSHRT treat the entire INCLUDE/OMIT logical expression as false if any field is short. Thus comparisons involving non-short fields are ignored if any comparison involves a short field.
NOVLSCMP and NOVLSHRT result in termination if any field is short.

To illustrate how this works, suppose the following INCLUDE statement is used:

  INCLUDE COND=(6,1,CH,EQ,C'1',OR,70,2,CH,EQ,C'T1')

If a variable-length input record has a length less than 71 bytes, the field at bytes 70-71 is short and the following occurs:

With VLSCMP, the record is included if byte 6 of the input record is C'1' or omitted if byte 6 is not C'1'. The comparison of bytes 70-71 equal to C'T1' is false because bytes 70-71 contain either X'hh00' (for a record length of 70 bytes) or X'0000' (for a record length of less than 70 bytes). The comparison involving the non-short field is performed even though a short field is present.
With NOVLSCMP and VLSHRT, the record is omitted because any short field makes the entire logical expression false. The comparison involving the non-short field is not performed because a short field is present.
With NOVLSCMP and NOVLSHRT, DFSORT terminates because any short field results in termination.

In general, comparisons involving short fields are false with VLSCMP. However, if a binary zero value is relevant to the comparison, the use of binary zeros for padding might make the comparison true. For example, suppose the following INCLUDE statement is used:

  INCLUDE COND=(21,2,CH,EQ,C'JX',OR,
                (55,2,CH,EQ,58,2,CH,AND,
                 70,1,BI,LT,X'08'))

If a variable-length input record has a length less than 70 bytes, the field at byte 70 is short and is padded to X'00'. This makes the comparison of byte 70 less than X'08' true even though byte 70 is a short field and so probably irrelevant.

Likewise, if a variable-length record has a length less than 55 bytes, the fields at bytes 55-56 and 58-59 are short and are each padded to X'0000', and the field at byte 70 is short and is padded to X'00'. This makes the comparison of bytes 55-56 equal to 58-59 true and the comparison of byte 70 less than X'08' true even though all three fields are short and probably irrelevant.

In such cases where padding of short fields with binary zeros may result in unwanted true comparisons, you can get the result you want by adding an appropriate check of the record length to the INCLUDE/OMIT logical expression, such as:

   INCLUDE COND=(21,2,CH,EQ,C'JX',OR,
                 (1,2,BI,GE,X'0046',AND,
                  55,2,CH,EQ,58,2,CH,AND,
                  70,1,BI,LT,X'08'))

Now the comparisons involving bytes 55-56, 58-59 and 70 can only be true for records that are 70 bytes (X'0046') or longer. Thus, the irrelevant comparisons involving short fields are eliminated.

Keep in mind that short compare fields are padded with zeros when VLSCMP is in effect and code your INCLUDE/OMIT logical expressions to allow for that or even take advantage of it.

VLSCMP: specifies that short variable-length compare fields are padded with binary zeros.
NOVLSCMP: specifies that short variable-length compare fields are not padded.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

VLSHRT or NOVLSHRT


>>-+-VLSHRT---+------------------------------------------------><
   '-NOVLSHRT-'

Temporarily overrides the VLSHRT installation option, which specifies whether DFSORT is to continue processing if a "short" variable-length SORT/MERGE control field, INCLUDE/OMIT compare field, or SUM summary field is found. A short field is one where the variable-length record is too short to contain the entire field, meaning that the field extends beyond the record. VLSHRT applies to the SORT, MERGE, INCLUDE, OMIT and SUM statements, and to the INCLUDE and OMIT parameters of the OUTFIL statement.

VLSHRT processing is not meaningful for fixed-length record processing.

The way in which DFSORT processes short INCLUDE/OMIT compare fields depends on the settings for VLSCMP/NOVLSCMP and VLSHRT/NOVLSHRT. For details, see the discussion of the VLSCMP and NOVLSCMP options.

VLSHRT: specifies that DFSORT continues processing if a short control field, compare field or summary field is found.
NOVLSHRT: specifies that DFSORT terminates if a short control field, compare field or summary field is found.

Note:

VLSHRT is not used if an INREC or OUTREC statement is specified, if you have an EFS01 or EFS02 routine, or if locale processing is used for SORT or MERGE fields. Note that none of these situations prevents the use of VLSCMP.
Unlike the OUTREC statement, the OUTREC , BUILD, OVERLAY, FINDREP or IFTHEN parameter of the OUTFIL statement does not force NOVLSHRT. Thus, you can use VLSHRT with OUTFIL to eliminate records with the INCLUDE or OMIT parameter and reformat the remaining records with the OUTREC, , BUILD, OVERLAY, FINDREP or IFTHEN parameter. If a short OUTFIL OUTREC or BUILD field is found, DFSORT terminates (even if VLSHRT is in effect) unless the VLFILL=byte parameter of OUTFIL is specified. If a short OUTFIL OVERLAY, FINDREP or IFTHEN field is found, DFSORT pads the missing bytes with blanks so it can be processed.
If VLSHRT is in effect and Blockset is selected:
- DFSORT pads short SORT or MERGE control fields with binary zeros, thus making the order predictable for records with equal control fields of different lengths. The control fields are only padded temporarily for collation; they are not actually changed for output. Padding may increase the amount of work space required.
- Records with short SUM summary fields are excluded from summation; that is, if either one of a pair of records being summed has a short SUM field, the records are left unsummed and neither record is deleted.
If VLSHRT is in effect and Blockset is not selected:
- DFSORT terminates if the first byte of the first (major) SORT or MERGE control field is not included in the record.
- DFSORT does not pad short SORT or MERGE control fields, thus making the order unpredictable for records with equal control fields of different lengths.
- In certain cases, VLSHRT is not used because of the number and position of the SORT or MERGE control fields.
- EQUALS is not used.
Tip: You can use a SORTDIAG DD statement to force message ICE800I, which gives a code indicating why Blockset could not be used.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

VSAMEMT or NVSAMEMT


>>-+-VSAMEMT--+------------------------------------------------><
   '-NVSAMEMT-'

Temporarily overrides the VSAMEMT installation option, which specifies whether DFSORT should accept an empty VSAM input data set.

VSAMEMT: specifies that DFSORT accepts an empty VSAM input data set and processes it as having zero records.
NVSAMEMT: specifies that DFSORT terminates if an empty VSAM input data set is found.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

VSAMIO or NOVSAMIO


>>-+-VSAMIO---+------------------------------------------------><
   '-NOVSAMIO-'

Temporarily overrides the VSAMIO installation option, which specifies whether DFSORT should allow a VSAM data set defined with REUSE to be sorted in-place.

VSAMIO

specifies that DFSORT can use the same VSAM data set for input and output when all of the following conditions are met:

The application is a sort.
RESET is in effect.
The VSAM data set was defined with REUSE.

These conditions ensure that the VSAM data set is processed as NEW for output and will contain the sorted input records, that is, it will be sorted in-place.

DFSORT terminates if the same VSAM data set is specified for input and output and any of the previous conditions are not met.

NOVSAMIO

specifies that DFSORT terminates if the same VSAM data set is used for input and output.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

WRKREL or NOWRKREL


>>-+-WRKREL---+------------------------------------------------><
   '-NOWRKREL-'

Temporarily overrides the WRKREL installation option, which specifies whether unused temporary SORTWKdd data set space will be released.

WRKREL: specifies that unused space is released.
NOWRKREL: specifies that unused space is not released.

Note:

If you have dedicated certain volumes for SORTWKdd data sets, and you do not want unused temporary space to be released, you should specify NOWRKREL.
If WRKREL is in effect, DFSORT releases space for the SORTWKdd data sets just prior to termination. Space is released only for those SORTWKdd data sets that were used for the sort application.
RLS=0 can be used instead of NOWRKREL. RLS=n (n greater than 0) can be used instead of WRKREL.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

WRKSEC or NOWRKSEC


>>-+-WRKSEC---+------------------------------------------------><
   '-NOWRKSEC-'

Temporarily overrides the WRKSEC installation option, which specifies whether DFSORT uses automatic secondary allocation for temporary JCL SORTWKdd data sets.

WRKSEC: specifies that automatic secondary allocation for temporary JCL SORTWKdd data sets is used and that 25 percent of the primary allocation will be used as the secondary allocation.
NOWRKSEC: specifies that automatic secondary allocation for temporary JCL SORTWKdd data sets is not used.

Note: SEC=0 can be used instead of NOWRKSEC. SEC=n (n greater than 0) can be used instead of WRKSEC.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Functions: See Specification/override of DFSORT options.

Y2PAST


>>-Y2PAST=--+-s-+----------------------------------------------><
            '-f-'

Temporarily overrides the Y2PAST installation option, which specifies the sliding (s) or fixed (f) century window. The century window is used with DFSORT's Y2 formats to correctly interpret two-digit year data values as four-digit year data values.

s: specifies the number of years DFSORT is to subtract from the current year to set the beginning of the sliding century window. Because the Y2PAST value is subtracted from the current year, the century window slides as the current year changes. For example, Y2PAST=81 would set a century window of 1925-2024 in 2006 and 1926-2025 in 2007. s must be a value between 0 and 100.
f: specifies the beginning of the fixed century window. For example, Y2PAST=1962 would set a century window of 1962-2061. f must be a value between 1000 and 3000.

Note: CENTURY=value and CENTWIN=value can be used instead of Y2PAST=value.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

ZDPRINT or NZDPRINT


>>-+-ZDPRINT--+------------------------------------------------><
   '-NZDPRINT-'

Temporarily overrides the ZDPRINT installation option, which specifies whether positive zoned-decimal (ZD) fields resulting from summing must be converted to printable numbers (that is, whether the zone of the last digit should be changed from a hexadecimal C to a hexadecimal F). See SUM control statement for further details on the use of ZDPRINT and NZDPRINT.

ZDPRINT: means convert positive ZD summation results to printable numbers. For example, change hexadecimal F3F2C5 (prints as 32E) to F3F2F5 (prints as 325).
NZDPRINT: means do not convert positive ZD summation results to printable numbers.

Note: ZDPRINT=YES can be used instead of ZDPRINT. ZDPRINT=NO can be used instead of NZDPRINT.

Default: Usually the installation default. See Specification/override of DFSORT options for full override details.

Applicable Function: See Specification/override of DFSORT options.