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 DISPLAY statement in DISPLAY operator.
ON(p,m,f)
Specifies the position, length, and format of a numeric or character field to be used for this operation. '(p,m,f)' is used for the standard column heading (see HEADER('string1'), HEADER('string1','string2'), HEADER('string1','string2','string3'), HEADER(NONE), and NOHEADER for alternative heading options).

By default, three blanks appear between columns. You can change the space between columns with BETWEEN(n).

p specifies the first byte of the field relative to the beginning of the input record. p is 1 for the first data byte of a fixed-length record and 5 for the first data byte of a variable-length record as illustrated in the following (RRRR represents the 4-byte record descriptor word):
    Fixed-length record    |    Variable-length record
    | D | A | T | A | ...  |    | R | R | R | R | D | A | T | A | ...
 p=   1   2   3   4        | p=   1   2   3   4   5   6   7   8
    

m specifies the length of the field in bytes. A field must not extend beyond position 32752 or beyond the end of a record. The maximum length for a field depends on its format.

f specifies the format of the field as follows:
Field formats of the ICETOOL RANGE operator
Format Code
Length Description
BI 1 to 8 bytes Unsigned binary
FI 1 to 8 bytes Signed fixed-point
PD 1 to 16 bytes Signed packed decimal
ZD 1 to 31 bytes Signed zoned decimal
CH 1 to 4000 bytes Character
CSF or FS 1 to 32 bytes (31 digit limit) Signed numeric with optional leading floating sign
UFF 1 to 44 bytes (31 digit limit) Unsigned free form numeric
SFF 1 to 44 bytes (31 digit limit) Signed free form numeric
DT1 4 bytes SMF date interpreted as Z'yyyymmdd'
DT2 4 bytes SMF date interpreted as Z'yyyymm'
DT3 4 bytes SMF date interpreted as Z'yyyyddd'
DC1 8 bytes TOD date interpreted as Z'yyyymmdd'
DC2 8 bytes TOD date interpreted as Z'yyyymm'
DC3 8 bytes TOD date interpreted as Z'yyyyddd'
DE1 8 bytes ETOD date interpreted as Z'yyyymmdd'
DE2 8 bytes ETOD date interpreted as Z'yyyymm'
DE3 8 bytes ETOD date interpreted as Z'yyyyddd'
TM1 4 bytes SMF time interpreted as Z'hhmmss'
TM2 4 bytes SMF time interpreted as Z'hhmm'
TM3 4 bytes SMF time interpreted as Z'hh'
TM4 4 bytes SMF time interpreted as Z'hhmmssxx'
TC1 8 bytes TOD time interpreted as Z'hhmmss'
TC2 8 bytes TOD time interpreted as Z'hhmm'
TC3 8 bytes TOD time interpreted as Z'hh'
TC4 8 bytes TOD time interpreted as Z'hhmmssxx'
TE1 8 bytes ETOD time interpreted as Z'hhmmss'
TE2 8 bytes ETOD time interpreted as Z'hhmm'
TE3 8 bytes ETOD time interpreted as Z'hh'
TE4 8 bytes ETOD time interpreted as Z'hhmmssxx'
Note: See Data format descriptions for detailed format descriptions.
For a CSF, FS, UFF, or SFF format field:
  • A maximum of 31 digits is allowed. If a value with more than 31 digits is found, ICETOOL issues an error message and terminates the operation.
For a ZD or PD format field:
  • If a decimal value contains an invalid digit (A-F), ICETOOL identifies the bad value in a message and terminates the operation.
  • F, E, C, A, 8, 6, 4, 2, and 0 are treated as equivalent positive signs. Thus the zoned decimal values F2F3C1, F2F3F1 and 020301 are counted as only one unique value.
  • D, B, 9, 7, 5, 3, and 1 are treated as equivalent negative signs. Thus the zoned decimal values F2F3B0, F2F3D0, and 020310 are counted as only one unique value.

The fields of records that do not meet the specified criteria are not checked for invalid digits (PD and ZD) or excessive digits (CSF, FS, UFF, and SFF).

For a DT1, DT2 or DT3 format field:
  • An invalid SMF date can result in a data exception (0C7 ABEND) or an incorrect ZD date.
  • SMF date values are always treated as positive.
For a DC1, DC2, DC3, DE1, DE2, or DE3 format field:
  • TOD and ETOD date values are always treated as positive.
For a TM1, TM2, TM3 or TM4 format field:
  • An invalid SMF time can result in an incorrect ZD time.
  • SMF time values are always treated as positive.
For a TC1, TC2, TC3, TC4, TE1, TE2, TE3, or TE4 format field:
  • TOD and ETOD time values are always treated as positive.
ON(p,m,f,formatting)
Specifies the position, length and format of a numeric or character field to be used for this operation and how the data for this field is to be formatted for printing. The BLANK operand is automatically in effect.

See ON(p,m,f) for further details.

formatting
Read syntax diagramSkip visual syntax diagram
   .-,------------------.   
   V                    |   
>>---+-+-mask-------+-+-+--------------------------------------><
     | '-E'pattern'-' |     
     +-L'string'------+     
     +-F'string'------+     
     +-T'string'------+     
     +-LZ-------------+     
     '-+-Ndd-+--------'     
       '-Udd-'              

specifies formatting items that indicate how the data for this field is to be formatted for printing. Formatting items can be specified in any order, but each item can only be specified once. Any formatting item can be specified for a numeric field, but only L'string' and T'string' can be specified for a character field.

The column width is dynamically adjusted to accommodate the maximum bytes to be inserted as a result of all formatting items specified.

mask
See the discussion of mask under ON(p,m,f,formatting) in DISPLAY operator.
E'pattern'
See the discussion of E'pattern' under ON(p,m,f,formatting) in DISPLAY operator.
L'string'
See the discussion of L'string' under ON(p,m,f,formatting) in DISPLAY operator.
F'string'
See the discussion of F'string' under ON(p,m,f,formatting) in DISPLAY operator.
T'string'
See the discussion of T'string' under ON(p,m,f,formatting) in DISPLAY operator.
LZ
See the discussion of LZ under ON(p,m,f,formatting) in DISPLAY operator.
Ndd or Udd
specifies the number of digits to be used for the numeric field. Ndd or Udd can be used to change the column width for numeric fields. dd specifies the number of digits and must be a two-digit number between 01 and 31.

The default number of digits (d) for a numeric field is the maximum number of digits for that field. For example, d is 5 for ON(1,5,ZD). If you know that your numeric field requires less than d digits, you can use a lower number of digits (dd) instead by specifying Udd, thus reducing the column width if it is determined by d. For example, ON(1,5,ZD,U03) reduces d from 5 to 3. If you want your numeric field to be displayed with more than d digits, you can use a higher number of digits (dd) instead by specifying Ndd or Udd, thus increasing the column width if it is determined by d. For example, ON(1,5,ZD,U10) increases d from 5 to 10.

Either Ndd or Udd can be used to set d greater than the maximum for a numeric field, but only Udd can be used to set d less than the maximum for a numeric field.

For Udd:

dd is used for d. For example:
  • If ON(1,5,ZD) is specified, 5 digits (default for 5,ZD) are used.
  • If ON(1,5,ZD,U10) is specified, 10 digits (from U10) are used.
  • If ON(1,5,ZD,U03) is specified, 3 digits (from U03) are used.
  • If ON(1,16,FS) is specified, 16 digits (default for 16,FS) are used.
  • If ON(1,16,FS,U16) is specified, 16 digits (from U16) are used.
  • If ON(1,16,FS,U15) is specified, 15 digits (from U15) are used.

If you use Udd and a numeric value overflows dd digits, ICETOOL terminates the operation. You can prevent the overflow by specifying an appropriately higher dd value for Udd. For example, if ON(1,12,ZD,U09) results in overflow, you can use ON(1,12,ZD,U10) instead.

If E'pattern' is specified, Udd is ignored, because the number of digits is determined from the pattern.

For Ndd:

If dd is greater than or equal to d, dd is used. If dd is less than d, d is used. For example:
  • If ON(1,5,ZD) is specified, 5 digits (default for 5,ZD) are used.
  • If ON(1,5,ZD,N10) is specified, 10 digits (from N10) are used.
  • If ON(1,5,ZD,N03) is specified, 5 digits (from 5,ZD) are used.

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

ON(p,m,HEX)
Specifies the position and length of a character field to be used for this operation and printed in hexadecimal format (00-FF for each byte). '(p,m,HEX)' is used for the standard column heading (see HEADER('string1'), HEADER('string1','string2'), HEADER('string1','string2','string3'), HEADER(NONE), and NOHEADER for alternative heading options).

See ON(p,m,f) for a discussion of p.

m specifies the length of the field in bytes. A field must not extend beyond position 32752 or beyond the end of a record. A field can be 1 to 2000 bytes.

ON(VLEN)
Equivalent to specifying ON(1,2,BI); a two-byte binary field starting at position 1. For variable-length records, ON(VLEN) represents the record-length for each record. 'RECORD LENGTH' is used for the standard column heading. See HEADER('string1'), HEADER('string1','string2'), HEADER('string1','string2','string3'), HEADER(NONE), and NOHEADER for alternative heading options.
ON(VLEN,formatting)
Equivalent to specifying ON(1,2,BI,formatting); a two-byte binary field starting at position 1, and how the data for this field is to be formatted for printing. The BLANK operand is automatically in effect.

See ON(VLEN) for further details.

formatting
Read syntax diagramSkip visual syntax diagram
   .-,------------------.   
   V                    |   
>>---+-+-mask-------+-+-+--------------------------------------><
     | '-E'pattern'-' |     
     +-L'string'------+     
     +-F'string'------+     
     +-T'string'------+     
     +-LZ-------------+     
     '-+-Ndd-+--------'     
       '-Udd-'              

specifies formatting items that indicate how the data for this field is to be formatted for printing. Formatting items can be specified in any order, but each item can only be specified once.

The column width is dynamically adjusted to accommodate the maximum bytes to be inserted as a result of all formatting items specified.

mask
See the discussion of mask under ON(p,m,f,formatting) in DISPLAY operator.
E'pattern'
See the discussion of E'pattern' under ON(p,m,f,formatting) in DISPLAY operator.
L'string'
See the discussion of L'string' under ON(p,m,f,formatting) in DISPLAY operator.
F'string'
See the discussion of F'string' under ON(p,m,f,formatting) in DISPLAY operator.
T'string'
See the discussion of T'string' under ON(p,m,f,formatting) in DISPLAY operator.
LZ
See the discussion of LZ under ON(p,m,f,formatting) in DISPLAY operator.
Ndd or Udd
See the discussion of Ndd or Udd under ON(p,m,f,formatting) in OCCUR operator.
ON(VALCNT)
Specifies that the number of occurrences for each unique value is to be printed. ' VALUE COUNT' is used for the standard column heading (see HEADER('string1'), HEADER('string1','string2'), HEADER('string1','string2','string3'), HEADER(NONE) and NOHEADER for alternative heading options).
ON(VALCNT,formatting)
Specifies that the number of occurrences for each unique value is to be printed, and how the value count is to be formatted for printing. The BLANK operand is automatically in effect.

See ON(VALCNT) for further details.

formatting
Read syntax diagramSkip visual syntax diagram
   .-,------------------.   
   V                    |   
>>---+-+-mask-------+-+-+--------------------------------------><
     | '-E'pattern'-' |     
     +-L'string'------+     
     +-F'string'------+     
     +-T'string'------+     
     +-LZ-------------+     
     '-+-Ndd-+--------'     
       '-Udd-'              

specifies formatting items that indicate how the value count is to be formatted for printing. Formatting items can be specified in any order, but each item can only be specified once.

The column width is dynamically adjusted to accommodate the maximum bytes to be inserted as a result of all formatting items specified.

mask
See the discussion of mask under ON(p,m,f,formatting) in DISPLAY operator.
E'pattern'
specifies an edit pattern to be applied to the value 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 numeric value. 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 value count:
  • If the number of significant digits in a value 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 ON(VALCNT,E'999999').
  • If the number of significant digits in a value 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 ON(VALCNT,E'*9999*').
L'string'
See the discussion of L'string' under ON(p,m,f,formatting) in DISPLAY operator.
F'string'
See the discussion of F'string' under ON(p,m,f,formatting) in DISPLAY operator.
T'string'
See the discussion of T'string' under ON(p,m,f,formatting) in DISPLAY operator.
LZ
See the discussion of LZ under ON(p,m,f,formatting) in DISPLAY operator.
Ndd or Udd
Specifies the number of digits to be used for the value count when determining the column width. 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 value count is 15. If you know that your value counts require less than 15 digits, you can use a lower number of digits (dd) instead by specifying Ndd or Udd, thus reducing the column width if it is determined by d. For example, if ON(VALCNT,N06) or ON(VALCNT,U06) is specified, 6 digits (from N06 or U06) is used instead of 15 (default for value count).

If you use Ndd or Udd and a value count overflows the number of digits used, ICETOOL terminates the operation. You can prevent the overflow by specifying an appropriately higher dd value for Ndd or Udd. For example, if ON(VALCNT,N05) results in overflow, you can use ON(VALCNT,N06) instead.

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

LIST(listdd)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TITLE('string')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TITLE('string1','string2')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TITLE('string1','string2','string3')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TLEFT
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TFIRST
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
PAGE
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
DATE
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
DATE(abcd)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
DATENS(abc)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
YDDD(abc)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
YDDDNS(ab)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TIME
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TIME(abc)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TIMENS(ab)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
BLANK
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
PLUS
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.

For ON(VALCNT), PLUS is treated as BLANK.

NOCC
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
HEADER('string1')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
HEADER('string1','string2')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
HEADER('string1','string2','string3')
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
HEADER(NONE)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
NOHEADER
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
LINES(n)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
INDENT(n)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
BETWEEN(n)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
TBETWEEN(n)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
ALLDUPS
Limits the ON values printed to those that occur more than once (that is, those with duplicate field values). The ON values are printed when value count > 1.

ALLDUPS is equivalent to HIGHER(1).

NODUPS
Limits the ON values printed to those that occur only once (that is, those with no duplicate field values). The ON values are printed when value count = 1.

NODUPS is equivalent to EQUAL(1) or LOWER(2).

HIGHER(x)
Limits the ON values printed to those that occur more than x times. The ON values are printed when value count > x.

x must be specified as n or +n where n can be 1 to 15 decimal digits.

LOWER(y)
Limits the ON values printed to those that occur less than y times. The ON values are printed when value count < y.

y must be specified as n or +n where n can be 1 to 15 decimal digits.

EQUAL(v)
Limits the ON values printed to those that occur v times. The ON values are printed when value count = v.

v must be specified as n or +n where n can be 1 to 15 decimal digits.

VSAMTYPE(x)
See the discussion of this operand on the COPY statement in COPY operator.
WIDTH(n)
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
LONGLINE
See the discussion of this operand on the DISPLAY statement in DISPLAY operator.
UZERO
Specifies that -0 and +0 are to be treated as unsigned zero values, that is, as the same value. With UZERO, -0 and +0 are treated as positive for ON processing.

UZERO overrides the default of treating -0 and +0 as signed zero values, that is, as different values. Without UZERO, -0 is treated as negative and +0 is treated as positive for ON processing.

LISTSDB or LISTNOSDB
See the discussion of these operands on the DISPLAY statement in DISPLAY operator.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014