ICETOOL Return Codes and MODE

Step Return Code

ICETOOL runs each operator in order. Each operator (COPY, SORT, COUNT, etc.) returns a return code. ICETOOL keeps the maximum return code and sets the step return code to that value. So one failure (e.g. 16) makes the whole step fail even if earlier or later operators succeeded (0 or 4).

Common Return Codes

MODE Operator

MODE controls behavior when an operator returns a non-zero return code:

• STOP — Stop processing. No further operators run. This is often the default.
• CONTINUE — Continue with the next operator even if the current one failed. Use when you want all operations attempted and the step return code to reflect the worst result.
• SCAN — Continue in a way that may still process or scan remaining operators; exact behavior is product-dependent. Check your manual.

1
2
3
  COUNT FROM(INDD) USING(CTL1)
  MODE CONTINUE
  SORT FROM(INDD) TO(OUTDD) USING(CTL2)

Here if COUNT fails, ICETOOL still runs SORT. The step return code is the higher of the two operators’ return codes.

Using Return Codes in JCL

You can use the step return code in conditional execution. For example run a backup step only if ICETOOL succeeded (RC 0 or 4), or run an error-handling step only if RC > 4. Syntax is site-dependent (COND on EXEC, or IF/THEN/ELSE in JCL).

Explain It Like I'm Five

Imagine you have a list of three chores. Each chore can end with “done” (0), “done but with a small warning” (4), or “failed” (16). The step’s overall result is the worst outcome: if any chore failed, the whole step is “failed.” MODE STOP means “stop doing chores as soon as one fails.” MODE CONTINUE means “try all three chores no matter what; at the end we’ll still say the step failed if any chore failed.”

Exercises

1. If COPY returns 0 and SORT returns 16, what is the step return code?
2. When would you use MODE CONTINUE instead of the default?
3. What should you check first if the step return code is 20?