When you run a spool housekeeping operation, the return code is displayed on the console log. Possible values are as follows:
| Return code | Reason |
|---|---|
| 0 | The operation completed successfully without errors. |
| 4 | No spool records were found. You would expect this when a server is first started, if spool housekeeping is scheduled via CICS. |
| 8 | This is a warning, and the processing continues. It indicates that a spool record that was a candidate for deletion could not be deleted (possibly in use), or a catalog entry for a spool record that was a candidate for deletion is not present. |
| 16 | This indicates a fatal error. Processing is terminated. Generally, it is the result of an unexpected file status code from IO on casspool.dat, mvsspl01.dat or catalog.dat. |
These return codes indicate that the file i/o on the associated file has returned an unexpected status code. This can happen for a number of reasons. For example, because another process has the file locked, because an expected record no longer exists or an invalid catalog or archive location has been specified. If the resulting return code indicates a serious error (16) or the errors are persistent, CTF tracing for the housekeeping process is available (which will log the file status codes encountered for a precise diagnosis). The appropriate settings for CTF are:
mftrace.level.mf.mvs.mvsp0027 = debug mftrace.comp.mf.mvs.mvsp0027#entry = true mftrace.comp.mf.mvs.mvsp0027#delete = true mftrace.comp.mf.mvs.mvsp0027#warning = true
This configures that when the spool housekeeping operation fails, the return is accompanied by a reason code. These reason codes can help locate the source of the spool houskeeping problem, and they can also help to diagnose errors.
| Return code | Reason |
|---|---|
| 01, 02 | Read next record on casspool. operation failed. |
| 03 | Purge record on casspool operation failed. |
| 04 | Delete record on casspool operation failed. |
| 05 | Start on casspool operation failed. |
| 10 | Open on mvsspool operation failed. |
| 11 | Delete record on mvsspool operation failed. |
| 12 | Read next record on mvsspool operation failed. |
| 13 | Keyed read on mvsspool operation failed. |
| 20 | Open on profile (the .pro file describes the spool archive file for data file editor - only when archiving requested ) operation failed. |
| 21 | Write on profile ( only when archiving requested ) operation failed. |
| 30 | The Copy spool to archive operation failed. The spool archive directory may not exist. |
| 40 | The Read record on catalog.dat file operation failed. |
| 41 | The delete record from catalog.dat file operation failed. |