+CLEANUP

Use the +CLEANUP parameter to determine:

CLEANUP_FPE1711.png


Related topic

Global-parameters-UTLPARMS

The values are defined as follows:

NO

(Default) The object is processed as if you had specified ERROR.

YES

The object is processed as if you had specified  CLEANUP.

YES,returnCode


The returnCode value can be 4 through 15.

The returnCode value determines the cleanup_rc value in the XSVRXERR automation control point during the cleanup call after the object receives an error. You can subsequently override the cleanup_rc value in the XSVRXERR automation control point.

After execution of the XSVRXERR cleanup:

  • If the cleanup_rc value is 0, you did not specify a returnValue value, and XSVRXERR determines the cleanup_rc value and the product's final return code.
  • If the cleanup_rc value is not 0, the product's final return code is the greater of its previously set value and the cleanup_rc value.

Important

  • If you are using SmartSwitch or worklist processing in BMC AMI Catalog Manager for Db2, the returnCode value is ignored and the product's final return code is its previously set value.

  • If you configure or specify +CLEANUP(YES) with no return code specified, the cleanup returns RC=4.
  • If you configure +CLEANUP(YES,7) and then in the utility job specify +CLEANUP(YES), which does not override the return code, the configured RC=7 remains in effect.
  • Cleanup does not occur with objects left in a Must Complete (RC16) status in BMC AMI Utilities. Must Complete means cleanup is not possible, and you must complete the process by rerunning with RESTART or QUICKEXIT.

+CLEANUP and DELETEOUTPUT have different functions. The appropriate function depends on whether the outcome of a job was successful. +CLEANUP is for utilities that fail. DELETEOUTPUT, by comparison, is for utilities that have run successfully. DELETEOUTPUT determines whether to delete output data sets at the successful end of a job (that is, when the job is marked COMPLETE). 

Example
+CLEANUP(NO)

If an error occurs, and the XSVRXERR automation control point is not in use, processing behaves as if ERROR were selected, meaning that the object is not removed from the matrix.

Example
+CLEANUP(YES)

If an error occurs, and the XSVRXERR automation control point is not in use, processing behaves as if CLEANUP were selected, meaning that the object is removed from the matrix (unless the object is in must-complete status).

Example
+CLEANUP(YES,8)

If an error occurs, and the XSVRXERR automation control point is not in use:

  • Processing behaves as if CLEANUP were selected, meaning that the object is removed from the matrix (unless the object is in must-complete status).
  • Processing ends with return code 8.

Best practice
BMC AMI Load and BMC AMI Unload generally use +CLEANUP(YES,8), which cleans up the UID without the need to -DIS UTIL and -TERM UTIL, and gives an error. You can then rerun the job step with any required changes. However, specify +CLEANUP(NO) with RESUME YES SHRLEVEL CHANGE load where inserts are used, this prevents the cleanup and allows for restarting at the last checkpoint.

BMC AMI Reorg generally uses +CLEANUP(YES,4), which cleans up and gives a warning. You can review the job output sometime after the reorganization to make sure that the object is successfully reorganized with the next run. However, for reorganizations that must complete, such as a reorganization step that discards rows, specify +CLEANUP(NO).

Important

The BMC AMI Load BACKOUT keyword overrides the +CLEANUP parameter value if the conditions for BACKOUT processing are met.

For the rules that apply to parameter syntax, see Parameter syntax rules.

  

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*