XSUTTIME (SYSIN-based job termination) automation control point

Use the XSUTTIME automation control point to stop processing at the SYSIN read phase so that no new work is scheduled.

The utility can invoke this automation control point two times:

After the XSUTSYIN automation control point (when the SYSIN input statements are placed in the processing queue)
When +TIMEEXEC is YES, after the XSUTFUNC automation control point (before scheduling new work)

Variables

The following table describes the variables used in the XSUTTIME automation control point:

Variable name	Contents	Possible values
call_type	When this automation exit was called	SYSIN Indicates the first call to XSUTTIME EXECUTE Indicates a second call to XSUTTIME RESTART Indicates that a utility has been restarted
dbdname	Database name of the object being processed	Blank if function name is IBM FUNC
dbname	Database name of the object being processed	Blank if function name is IBM FUNC
function_name	Name of the utility being processed	LOAD REORG UNLOAD For any IBM utility, the value is IBM FUNC
indexspace	Name of the index space	Blank if a non-index function
ixname	Name of the index being processed	Blank if a non-index function
ixcreator	Creator of the index being processed	Blank if a non-index function
jobname	Current job name	Not applicable
plan	Db2 plan used to connect to Db2	Not applicable
restart	Value of the third parameter on the EXEC statement	Not applicable
restart_parm	Specified restart parameter	RESTART NORESTART QUICKEXIT
restartable	Whether the utility is to be restartable	Y Inactive work is set to pending. N Inactive work is placed on the COMPLETE queue.
ssid	Db2 subsystem ID	Not applicable
stepname	Current step name	Not applicable
stmt	Sequence number of the current SYSIN statement	Not applicable
stmt_count	Total number of statements in the SYSIN	Not applicable
tsname	Name of the table space being processed	Not applicable
runstats	Whether to collect RUNSTATS on this object, based on the value of the +RUNSTATS parameter	A (collect all statistics) N (do not collect statistics)
uid	Utility ID	Not applicable

Return codes

The XSUTTIME automation control point returns the following return codes:

Return code	Description
0	Continue the run as normal.
Any other value	Stop processing any new work. The current and subsequent SYSIN statements are ignored. Any active work already processed from SYSIN completes.

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.

Usage considerations

Review the following information before using this automation control point:

This automation control point receives control as SYSIN statements are put on the processing queue. This automation control point enables you to stop SYSIN processing so that no new work is scheduled. You can also use it to stop the selection of new statements that have already been through SYSIN processing but have not yet executed. The XSUTTIME automation control point will not stop the execution of any work already in progress.
To enable a second call to XSUTTIME when object processing is about to start, set the +TIMEEXEC global parameter to YES.