ICETOOL - Job Format


ICETOOL can be used for SORT, COPY and MERGE applications.

ICETOOL can be called directly or from a program and operators can be supplied by a calling program parameter list.

ICETOOL prints messages and gives a return code for each operation.

The ICETOOL operators are: COPY, COUNT, DATASORT, DEFAULTS, DISPLAY, MERGE, MODE, OCCUR, RANGE, RESIZE, SELECT, SORT, SPLICE, STATS, SUBSET, UNIQUE and VERIFY. By using combinations of these 17 operators, applications can create easily that perform many complex tasks.


General ICETOOL Job Format:


ICETOOL job representation shown below -
//EXAMPLE JOB ...
//TOOL EXEC PGM=ICETOOL
//TOOLMSG DD SYSOUT=A
//DFSMSG DD SYSOUT=A
//TOOLIN DD *
<ICETOOL statements here>
/*
<Additional JCL statements added here>
//

ICETOOL Required JCL Statements:


  • EXEC PGM=ICETOOL - Used to call ICETOOL utility directly.
  • TOOLMSG - ICETOOL message data set.
    This data set has the same attributes as the DFSORT SYSOUT data set.
  • DFSMSG - DFSORT message data set.
    This data set has the same attributes as the DFSORT SYSOUT data set.
  • TOOLIN - ICETOOL statements for DFSORT.
    This data set has the same attributes as the DFSORT SYSIN data set.
  • Additional JCL Stmts - as required for operators specified.

ICETOOL Operator Statements:


  • Each ICETOOL operator statement designates a task that ICETOOL needs to perform.
  • Any number of operators can be specified and in any order.
  • The general format for all ICETOOL statements is -
  • operator operand ... operand

  • Operator is one of the seventeen ICETOOL operator names (COPY, COUNT, DATASORT, DEFAULTS, DISPLAY, MERGE, MODE, OCCUR, RANGE, RESIZE, SELECT, SORT, SPLICE, STATS, SUBSET, UNIQUE and VERIFY COPY, COUNT, DATASORT, DEFAULTS, DISPLAY, MERGE, MODE, OCCUR, RANGE, RESIZE, SELECT, SORT, SPLICE, STATS, SUBSET, UNIQUE and VERIFY).
  • Operand is keyword or keyword(parameter,...).
  • One or more blanks can be used before the operator and between operands.
  • Columns 1-72 are considered and columns 73-80 are ignored.
  • Continuation can be indicated by a dash (-) after the operator or any operand. Each operand must be completely specified on one line.

Comment Statements


Asterisk (*) in column 1 indicates a comment statement.

Comment statements are printed normally with other ICETOOL statements.


Blank Statements


Blank in columns 1-72 indicates a blank statement.

Blank statements are ignored since ICETOOL prints blank lines where suitable.


ICETOOL Return Codes


ICETOOL sets a return code for each operation it performs.

ICETOOL sets the return code to the highest operator return code for the step.

The return codes are –


  • 0 - Successful completion. No errors were detected.
  • 4 - Successful completion. DFSORT detected one or more warning conditions.
  • 8 - Unsuccessful completion. RC8 was used for COUNT when the criteria were met.
  • 12 - Unsuccessful completion. ICETOOL detected one or more errors, or RC12 was used (or defaulted) for COUNT when the criteria were met.
  • 16 - Unsuccessful completion. DFSORT detected one or more errors.
  • 20 - Message data set error. The TOOLMSG DD statement was not present or the TOOLMSG data set was not opened.
  • 24 - Unsupported operating system.