XRTSEXCL (RTS excluded objects) automation control point
Use the XRTSEXCL automation control point to list objects that have been excluded from processing based on RTS values.
The product invokes this automation control point after the object selection process based on RTS criteria has completed.
When BMC AMI Utility Manager excludes objects from processing, a list of excluded objects is passed to the automation routine. A logic can be added to create a report and insert them into a table. The automation provides a way to track objects excluded by BMC AMI Utility Manager because they did not meet the thresholds to process. XRTSEXCL is called once for each excluded object with the name of the executing utility and the qualified name of the excluded object and the reason for exclusion.
Following is an example of simple XRTSEXCL that writes the list to SYSTSPRT. Ensure to include a SYSTSPRT DD in the JCL file to see the list.
if OBJECT TYPE = 'TS' then
say FUNCTION_NAME,
OBJECT TYPE DBNAME'.'TSNAME 'part 'PART' of 'PARTS,
' 'RTS_REASON
if OBJECT TYPE = 'IX' then
say FUNCTION_NAME' ',
OBJECT_TYPE IXCREATOR'.'IXNAME 'part 'PART' of 'PARTS,
' 'RTS_REASON
Exit
Variables
The following table describes the variables used in the XRTSEXCL automation control point.
Variable name | Contents | Possible values |
|---|---|---|
function_name | Name of the utility that is executing |
|
object_type | Type of object |
|
dbname | Database name | Not applicable |
tsname | Table space name | Not applicable |
ixname | Index name | Not applicable |
ixcreator | Index creator | Not applicable |
part | Number of the partition that is being excluded | Not applicable |
parts | Total number of partitions in the object | Not applicable |
rts_reason | RTS reason for exclusion | Not applicable |
Return codes
The XRTSEXCL automation control point returns the following return codes:
Return code | Description |
|---|---|
0 | (default value) Normal completion No action is required. |
Any other value | Abnormal termination Set the return code to any nonzero value to cancel the entire job. |