XSUTDISP (display utility status) automation control point


Use the XSUTDISP automation control point to trigger QUICKEXITS, DELETES, or other actions in processing.

The product invokes this automation control point when encountering the keywords GENQE or GENDELETES in the SYSIN.

Variables

The following table describes the variables used in the XSUTDISP automation control point. Variable names with a period (.) following the name are stem variables. For more information about stem variables, see the IBM REXX documentation.


Variable name

Contents

Possible values

action

Code to trigger the generation of QUICKEXITS or DELETES

  • GEND
  • GENQ

uid

Utility ID

Not applicable

jobname

Utility job name

Not applicable

stepname

Utility step name

Not applicable

jobid

Utility job ID

Not applicable

utility_rc

Utility return code

Not applicable

status

Utility status

  • RESTARTABLE
  • QUICKEXIT
  • JOB RUNNING
  • COMPLETED OK
  • FORCEID RUN
  • QEXIT ERROR
  • ERROR
  • NO RESTART
  • UNMATCHEDUID

work_prefix

Utility work data set prefix

Not applicable

userid

User ID of the person submitting the utility

Not applicable

start_date

Utility start date

Not applicable

start_time

Utility start time

Not applicable

end_date

Utility end date

Not applicable

end_time

Utility end time

Not applicable

database.

Stem variable indicating a list of database names

Not applicable

spacename.

Stem variable indicating a list of object names

Not applicable

part.

Stem variable indicating a list of partition numbers

Not applicable

type.

Stem variable indicating a list of object types (index, table space, and so on)

Not applicable

lock_type.

Stem variable indicating a list of lock types

Not applicable

lock_status.

Stem variable indicating a list of lock statuses

Not applicable

uid.

Stem variable indicating a list of utility IDs

Not applicable

jobname.

Stem variable indicating a list of job names.

Not applicable

jobid.

Stem variable indicating a list of job IDs

Not applicable

entry_time

Stem variable indicating a list of job entry times

Not applicable

cdbckpt

Name of the BMC AMI Utilities checkpoint data set

Not applicable

syspds

Name of the BMC AMI Utilities SYSPDS data set

Not applicable

logpds

Name of the BMC AMI Utilities LOGPDS data set

Not applicable

Return codes

The XSUTDISP automation control point returns the following return codes:


Return code

Description

0

(default value) Signifies normal completion

No action is required.

Any other value

Abnormal termination

Set the the return code to any non-zero value to cancel the entire job.


 

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