Default language.

Limited support BMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see BMC AMI Check for Db2 13.1.

+CLEANUP

Use the +CLEANUP parameter to determine:

The values are defined as follows:

NO

(default) The object is processed as if ERROR were selected.

Important

(PTF BQU0592 applied) You can include a return code (NO,returnCode), but the product will ignore it.

YES

The object is processed as if CLEANUP were selected.

YES,returnCode

(PTF BQU0592 applied)

(BMC.DB2.SPE2204) 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 Change 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 a 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 return code of "7" is still 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, the process must be completed 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 jobs that fail when an object is placed on the SKIPPED portion of the ERROR queue. DELETEOUTPUT, by comparison, is for jobs 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.

Important

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

Related topic

Global-parameters-UTLPARMS

 

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