XSVRXERR (server processing error) automation control point
Use the XSVRXERR automation control point to specify the action to take when a database object receives an error.
The product invokes this automation control point when a database object receives an error any time after the object has connected to the BMC AMI Utilities Subsystem started task, also known as CDBSS. This automation control point is called twice for each error condition encountered: first, when the error occurs, and then for any cleanup activity.
Variables
The following table describes the variables used in the XSVRXERR automation control point:
Variable name | Contents | Possible values |
|---|---|---|
action | Action to be taken on error You can set the value of this variable. |
|
call_type | Type of XSVRXERR call |
|
child | Whether the object is the child of another object |
|
cleanup_rc (PTF BQU0592 applied) | Return code available during cleanup processing The returnCode value that you specify in the +CLEANUP (YES,returnCode) parameter determines the cleanup_rc value. You can override the cleanup_rc value in XSVRXERR. If you did not specify a returnValue value in the CLEANUP parameter, the cleanup_rc value is 0. After execution of the XSVRXERR cleanup:
| 5 through 15 |
dbname | Name of the database for the object that received the error | Not applicable |
ixcreator | Index creator, if applicable, of the object that received the error | Blank if not an index |
ixname | Index name, if applicable, of the object that received the error | Blank if not an index |
function_name | Name of the function that was being executed when the error occurred | Function name, such as REORG or COPY |
part | Partition number of the object that received the error | Not applicable |
queue | Name of the work element being processed when the error occurred |
|
reason | Message, set by the work element, describing the cause of the error | Not applicable |
retry_count | Number of retries | Not applicable |
step_must_complete | Whether processing is in a must-complete state |
|
stmt | Statement number of the function | Not applicable |
tbcreator | Table creator, if applicable, of the object that received the error | Not applicable |
tbname | Table name, if applicable, of the object that received the error | Not applicable |
tsname | Name of the table space for the object that received the error | Not applicable |
Return codes
The XSVRXERR automation control point returns return code 0, indicating normal completion.
Usage considerations
Review the following information before using this automation control point:
- For drain failures, check for the value of the queue variable to be CHG APPLY ANAL. The only options in this case are to perform cleanup (by setting the action variable to CLEANUP) or to trigger an error condition (by setting the action variable to ERROR).
- If +ONERROR(ABEND) has been specified in a utility job, the action variable is automatically set to ERROR. If +ONERROR(CONTINUE) has been specified in a utility job, the action variable is automatically set to CLEANUP. You can override these values for the action variable; however, the default actions will prevent situations in which inactive utility IDs appear to stall processing due to potentially conflicting utility ID entries in the matrix.
Related topic