XSUT0000 (utility initialization) automation control point
Use the XSUT0000 automation control point for the following tasks:
- Stop the entire job (for example, if the job is being run at the wrong time of day or by an unauthorized user)
- Initialize user-defined global variables (as an alternative to XSUTGLOB)
- Restrict execution of the utility to certain times (by checking the current time of day or day of the week)
(advanced use) Read, check, or modify SYSIN
If SYSIN is allocated to a JES spool file, you can read the file but cannot to write to the file.
The automation component invokes this automation control point before the first BMC AMI Utility of a set runs.
Variables
The following table describes the variables used in the XSUT0000 automation control point:
Variable name | Contents | Possible values |
|---|---|---|
cdb_restart_count | Current restart counter as related to the +RERUN parameter | Not applicable |
jobname | Name of the current job | Not applicable |
jobtype | Type of job that is running |
|
plan | Db2 plan used to connect to Db2 | Not applicable |
rc | Return code for this automation control point | SeeReturn codes |
restart_parm | Value of the third parameter on the EXEC statement |
|
restart | Value of the restart parameter in effect for this run |
|
ssid | Db2 subsystem ID | Not applicable |
stepname | Name of the current job step | Not applicable |
uid | Utility ID for the current job step | Not applicable |
Return codes
The XSUT0000 automation control point returns the following return codes:
Return code | Description |
|---|---|
0 | Continue the run |
4 | Abort the run before anything happens |
Any other value | Abnormal termination Set the return code to a value greater than 4 to cancel the entire job. |
Restrictions
Do not use the _dsnutil function (which invokes the IBM DSNUTILB module) anywhere in this automation control point as doing so might yield unpredictable results. For more information about this function, see _dsnutil-function.