1,126
edits
Difference between revisions of "Collecting Return Codes from CMOD utilities"
Collecting Return Codes from CMOD utilities (view source)
Revision as of 17:54, 27 June 2020
, 17:54, 27 June 2020Added section on IBM CMOD arsload command parameters, reorganized article, many formatting changes.
(Added section on IBM CMOD arsload command parameters, reorganized article, many formatting changes.) |
|||
| Line 1: | Line 1: | ||
{{TOCright}} | |||
== Background == | == Background == | ||
In almost all operating systems, in addition to processing data and providing output (either processed data, or a log of the work that was performed) processed provide what is called a 'Return Code' to quickly and easily indicate the status of the program at the time it stopped processing -- and Content Manager OnDemand is no different. All of the utilities provide 'return codes' or 'exit codes' when a utility stops processing. The return code is normally a single integer number, whose meaning is determined by the author of the utility, and normally available as part of the documentation. The only real standard is that 0 means a successful completion, and any other integer indicates a warning or error condition. Think of a '0' return code as "nothing to report" value. | In almost all operating systems, in addition to processing data and providing output (either processed data, or a log of the work that was performed) processed provide what is called a 'Return Code' or 'Result Code' to quickly and easily indicate the status of the program at the time it stopped processing -- and Content Manager OnDemand is no different. All of the utilities provide 'return codes' or 'exit codes' when a utility stops processing. The return code is normally a single integer number, whose meaning is determined by the author of the utility, and normally available as part of the documentation. The only real standard is that 0 means a successful completion, and any other integer indicates a warning or error condition. Think of a '0' return code as "nothing to report" value. | ||
== | == IBM CMOD arsdoc Return Codes == | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+IBM Content Manager OnDemand's ARSDOC Return Codes | ||
!style="text-align:center;"|Return Code | !style="text-align:center;"|Return Code | ||
!style="text-align:center;"|Description | !style="text-align:center;"|Description | ||
|- | |- | ||
|style="text-align:center;"|0 | |style="text-align:center;"|0 | ||
|Success | |Success - There was no error. | ||
|- | |- | ||
|style="text-align:center;"|1 | |style="text-align:center;"|1 | ||
| Line 25: | Line 26: | ||
|} | |} | ||
Unfortunately, utilities like arsdb, arsload, arssockd, and arsxml don't have documented return codes in IBM's Content Manager OnDemand official documentation. However, it's safe to assume that a non-zero exit code means there was a warning or error encountered, and the results should be investigated. | Unfortunately, utilities like arsdb, arsload, arssockd, and arsxml don't have documented return codes in IBM's Content Manager OnDemand official documentation. However, it's safe to assume that a non-zero exit code means there was a warning or error encountered, and the results should be investigated. | ||
== IBM CMOD arsload Return Codes == | |||
The Return Codes for Content Manager OnDemand's [[arsload]] utility are not well documented. | |||
{| class="wikitable" | |||
|+IBM Content Manager OnDemand's ARSLOAD Return Codes | |||
!style="text-align:center;"|Return Code | |||
!style="text-align:center;"|Description | |||
|- | |||
|style="text-align:center;"|0 | |||
|Success - There was no error. | |||
|- | |||
|style="text-align:center;"|2 | |||
|Server is offline, unavailable, or unreachable. Check to see that your IBM OnDemand Server is operational, or that you can connect across the network if you are attempting to load remotely. | |||
|- | |||
|style="text-align:center;"|6 | |||
|Syntax Error. The parameters you entered on the command line are incomplete or invalid. The [[arsload]] command parameter help was likely displayed. | |||
|- | |||
|style="text-align:center;"|13 | |||
|Invalid User ID or Password. See [[ARS1105E]] for troubleshooting. | |||
|} | |||
== Capturing the Return Code from IBM CMOD ARSLOAD command on UNIX / Linux == | == Capturing the Return Code from IBM CMOD ARSLOAD command on UNIX / Linux == | ||