z/OS DFSORT Application Programming Guide
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Operand descriptions

z/OS DFSORT Application Programming Guide
SC23-6878-00

The operands described in this section can be specified in any order.
FROM(indd)
See the discussion of this operand on the COPY statement in COPY operator.
USING(xxxx)
Specifies the first 4 characters of the ddname for the control statement data set to be used by DFSORT for this operation. xxxx must be four characters that are valid in a ddname of the form xxxxCNTL. xxxx must not be SYSx.

If USING is specified, an xxxxCNTL DD statement must be present and the control statements in it:

  1. Must conform to the rules for DFSORT's SORTCNTL data set.
  2. Should generally be used only for an INCLUDE or OMIT statement or comments statements.

Refer to JCL restrictions for more information regarding the selection of ddnames.

VSAMTYPE(x)
See the discussion of this operand on the COPY statement in COPY operator.
LOCALE(name)
See the discussion of this operand on the COPY statement in COPY operator.
LOCALE(CURRENT)
See the discussion of this operand on the COPY statement in COPY operator.
LOCALE(NONE)
See the discussion of this operand on the COPY statement in COPY operator.
RC4
Can be used to set RC=4 for this COUNT operator if the record count meets the specified criteria. RC4 can be specified only if EMPTY, NOTEMPTY, HIGHER(x), LOWER(y), EQUAL(v), or NOTEQUAL(w) is specified. RC4 overrides the default of setting RC=12 for this COUNT operator if the record count meets the specified criteria
RC8
Can be used to set RC=8 for this COUNT operator if the record count meets the specified criteria. RC8 can be specified only if EMPTY, NOTEMPTY, HIGHER(x), LOWER(y), EQUAL(v), or NOTEQUAL(w) is specified. RC8 overrides the default of setting RC=12 for this COUNT operator if the record count meets the specified criteria.
RC12
Can be used to set RC=12 for this COUNT operator if the record count meets the specified criteria. RC12 can be specified only if EMPTY, NOTEMPTY, HIGHER(x), LOWER(y), EQUAL(v), or NOTEQUAL(w) is specified. RC12 is equivalent to the default used when RC4 or RC8 is not specified.
EMPTY
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the input data set or subset is empty, or sets RC=0 for this COUNT operator if the input data set or subset is not empty.

EMPTY is equivalent to EQUAL(0).

NOTEMPTY
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the input data set or subset is not empty, or sets RC=0 for this COUNT operator if the input data set or subset is empty.

EMPTY is equivalent to NOTEQUAL(0).

HIGHER(x)
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the record count is higher than x, or sets RC=0 for this COUNT operator if the record count is equal to or lower than x.

x must be specified as n or +n where n can be 0 to 562949953421310.

LOWER(y)
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the record count is lower than y, or sets RC=0 for this COUNT operator if the record count is equal to or higher than y.

y must be specified as n or +n where n can be 0 to 562949953421310.

EQUAL(v)
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the record count is equal to v, or sets RC=0 for this COUNT operator if the record count is not equal to v.

v must be specified as n or +n where n can be 0 to 562949953421310.

NOTEQUAL(w)
Sets RC=12 (or RC=8 if RC8 is specified, or RC=4 if RC4 is specified) for this COUNT operator if the record count is not equal to w, or sets RC=0 for this COUNT operator if the record count is equal to w.

w must be specified as n or +n where n can be 0 to 562949953421310.

SUB(q)
Subtracts q from the record count, but does not reduce the count below 0. The resulting modified record count is displayed in the count message in TOOLMSG. If WRITE(countdd) is specified, the modified record count is used in the count record. If EMPTY, NOTEMPTY, HIGHER(x), LOWER(y), EQUAL(v) or NOTEQUAL(w) is specified, the modified record count is used to determine if the criteria is satisfied.

SUB(q) is especially useful for getting the count of just the data records for a data set that contains header, data and trailer records.

q must be specified as n or +n where n can be 1 to 999.

ADD(r)
Adds r to the record count. The resulting modified record count is displayed in the count message in TOOLMSG. If WRITE(countdd) is specified, the modified record count is used in the count record. If EMPTY, NOTEMPTY, HIGHER(x), LOWER(y), EQUAL(v) or NOTEQUAL(w) is specified, the modified record count is used to determine if the criteria is satisfied.

ADD(r) is especially useful for getting the count of header, data and trailer records for a data set that just contains data records to which you want to add header and trailer records.

r must be specified as n or +n where n can be 1 to 999.

WRITE(countdd)
Specifies the ddname of the count data set to be produced by ICETOOL for this operation. A countdd DD statement must be present. ICETOOL sets the attributes of the count data set as follows:
  • RECFM is set to FB.
  • LRECL is set to one of the following:
    • If WIDTH(n) is specified, LRECL is set to n. Use WIDTH(n) if your count record length and LRECL must be set to a particular value (for example, 80), or if you want to ensure that the count record length does not exceed a specific maximum (for example, 20 bytes).
    • If WIDTH(n) is not specified, LRECL is set to the calculated required record length. If your LRECL does not need to be set to a particular value, you can let ICETOOL determine and set the appropriate LRECL value by not specifying WIDTH(n).
  • BLKSIZE is set to one of the following:
    • The BLKSIZE from the DD statement, DSCB, or label, if it is a multiple of the LRECL used.
    • The LRECL if the BLKSIZE from the DD statement, DSCB, or label is not a multiple of the LRECL used.
    • The system determined blocksize if the BLKSIZE is not available from the DD statement, DSCB, or label.
TEXT('string')
Specifies a string to be printed starting in the first byte of the count record. The count follows the string. TEXT can only be specified if WRITE(countdd) is specified.

The string (1 to 50 characters) must be enclosed in single apostrophes. To include a single apostrophe (') in the string, specify two single apostrophes (''). To suppress printing of a string, do not specify TEXT('string') or specify TEXT('') using two single apostrophes.

DIGITS(d)
Specifies d digits for the count in the output record, overriding the default of 15 digits. d can be 1 to 15. The count is written as d decimal digits with leading zeros. DIGITS can only be specified if WRITE(countdd) is specified.

If you know that your count requires less than 15 digits, you can use a lower number of digits (d) instead by specifying DIGITS(d). For example, if DIGITS(10) is specified, 10 digits are used instead of 15.

If you use DIGITS(d) and the count overflows the number of digits used, ICETOOL terminates the operation. You can prevent the overflow by specifying an appropriately higher d value for DIGITS(d). For example, if DIGITS(5) results in overflow, you can use DIGITS(6) instead.

EDCOUNT(formatting)
Specifies formatting items that indicate how the count in the output record is to be formatted, overriding the default of 15 digits with leading zeros. Formatting items can be specified in any order, but each item can only be specified once. EDCOUNT can only be specified if WRITE(countdd) is specified.
mask
See the discussion of mask under ON(p,m,f,formatting) in "DISPLAY Operator" on page mask.
E'pattern'
specifies an edit pattern to be applied to the count. The pattern (1 to 24 characters) must be enclosed in single apostrophes. Each 9 in the pattern (up to 15) is replaced by a corresponding digit from the count. Characters other than 9 in the pattern appear as specified. To include a single apostrophe (') in the pattern, specify two single apostrophes (''). F'string' or a mask cannot be specified with E'pattern'.
When E'pattern' is specified for the count:
  • If the number of significant digits in the count is less than the number of 9's in the pattern, 0's are filled in on the left. For example, 1234 is shown as 001234 with EDCOUNT(E'999999').
  • If the number of significant digits in the count is greater than the number of 9's in the pattern, digits are truncated from the left. For example, 1234567 is shown as *4567* with EDCOUNT(E'*9999*').
L'string
See the discussion of L'string' under ON(p,m,f,formatting) in "DISPLAY Operator" on page L'string'
F'string'
See the discussion of F'string' under ON(p,m,f,formatting) in "DISPLAY Operator" on page F'string'
T'string'
See the discussion of T'string' under ON(p,m,f,formatting) in "DISPLAY Operator" on page T'string'
LZ
See the discussion of LZ under ON(p,m,f,formatting) in "DISPLAY Operator" on page LZ
Udd
specifies the number of digits to be used for the count. dd specifies the number of digits and must be a two-digit number between 01 and 15. The default number of digits (d) for the count is 15.

If you know that your count requires less than 15 digits, you can use a lower number of digits (dd) instead by specifying Udd. For example, if EDCOUNT(U09) is specified, 9 digits (from U09) is used instead of 15 (default for the count).

If you use Udd and the count overflows the number of digits used, ICETOOL terminates the operation. You can prevent the overflow by specifying an appropriately higher dd value for Udd. For example, if EDCOUNT(U05) results in overflow, you can use EDCOUNT(U06) instead.

If E'pattern' is specified, Udd is ignored, because d is determined from the pattern.

WIDTH(n)
Specifies the record length and LRECL you want ICETOOL to use for the count data set. n can be from 1 to 32760. WIDTH can only be specified if WRITE(countdd) is specified. ICETOOL always calculates the record length required to write the count record and uses it as follows:
  • If WIDTH(n) is specified and the calculated record length is less than or equal to n, ICETOOL sets the record length and LRECL to n. ICETOOL pads the count record on the right with blanks to the record length.
  • If WIDTH(n) is specified and the calculated record length is greater than n, ICETOOL issues an error message and terminates the operation.
  • If WIDTH(n) is not specified, ICETOOL sets the record length and LRECL to the calculated record length.

Use WIDTH(n) if your count record length and LRECL must be set to a particular value (for example, 80), or if you want to ensure that the count record length does not exceed a specific maximum (for example, 20 bytes). Otherwise, you can let ICETOOL calculate and set the appropriate record length and LRECL by not specifying WIDTH(n).

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014