XSUTFUNC (utility dispatch) automation control point

Use the XSUTFUNC automation control point to stop processing. For example, you can use it to check the current time of day and stop execution if it would violate the batch window.

The product invokes this automation control point before initiating each product function.

Variables

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

Related topics

Automation-control-points

General-automation-control-points 


Variable name

Contents

Possible values

Notes

dbname

Database name of the selected object

Blank if function_name is IBM FUNC


function_attr

Type of function

  • MINOR

    If function_attr is MINOR and the current function_name is COPY, then the current process is a concurrent copy being run with a reorganization, load or other writing utility.

  • MAJOR

    All functions other than that described for a value of MINOR are MAJOR .

function_name

Name of the utility to be processed

  • CHECKIX
  • LOAD
  • REORG
  • UNLOAD
  • For any IBM utility, IBM FUNC


indexspace

Name of the index space

Blank if a non-index function


ixcreator

Creator of the index

Blank if a non-index function


ixname

Name of the index

Blank if a non-index function


jobname

Name of the current job

Not applicable


plan

Db2 plan used to connect to Db2

Not applicable


rc

Return code for this automation control point


restart

Value of the third parameter on the EXEC statement

  • RESTART
  • NORESTART
  • QUICKEXIT


restart_parm

Value of the third parameter on the EXEC statement

  • RESTART
  • NORESTART
  • QUICKEXIT


rts_reason.

Reason that a database object was selected by RTS for processing

Not applicable


runstats

Activation of run statistics for the currently processed table space

  • A (collect all statistics)
  • N (do not collect statistics)


ssid

Db2 subsystem ID

Not applicable


stepname

Name of the current job step

Not applicable


stmt

Sequence number of the current SYSIN statement

Not applicable

Statements with wildcards might result in skipped statement numbers for subsequent statements.

stmt_count

Total number of SYSIN statements

Not applicable


tsname

Name of the table space

Not applicable


uid

Utility ID

Not applicable


Return codes

The XSUTFUNC automation control point returns the following return codes:


Return code

Description

0

Continue the run as normal.

4

Pause. Abort the run and let it be restartable at this point.

8

Terminate. Abort the run and clean up. Restart will start from the beginning of the job is resubmitted.

12

Skip the current executing utility and continue to the next one.

Any other value

Abnormal termination

Usage considerations

Review the following information before using this automation control point:

  • BMC AMI Utilities run in parallel. Therefore, simply stopping processing is likely to result in many utilities failing. Many different objects might be in progress and in different stages of processing. You can use the XSUTFUNC automation control point to control shutdown, but we recommend that you use the XSUTTIME automation control point instead.
  • The XSUTFUNC automation control point can determine whether to delay or skip the current function only.


 

  • 13.1
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*