Important We are integrating BMC AMI LOBMaster technology into the BMC AMI Reorg product and discontinuing BMC AMI LOBMaster as a separate product. For the latest integrated documentation, see BMC AMI Reorg for Db2 13.1.

XULDTERM (unload termination) automation control point


Use the XULDTERM automation control point to supply information about a just-completed unload process for reporting purposes.

The product invokes this automation control point after an unload operation completes.

Variables

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


Variable name

Contents

Possible values

blksize

Block size of the unload output data set

Not applicable

dbname

Database name of the unloaded table space

Not applicable

ddname

DD name associated with the unload operation

Not applicable

dsname

Data set name for the unload procedure

Not applicable

fileseqn

Sequence number for the unload file

This number begins at 0 and is incremented by 1 for each unload operation.

Not applicable

filesize

Size of the unload file, in kilobytes

Not applicable

format

Format in which the data was unloaded to the output file

  • ARC (archive)
  • DSN (DSNTIAUL)
  • EXT (external)
  • REP (report)
  • UNL (unload)

media

Media to which the unload data set is written

  • DASD
  • TAPE

nparts

Number of partitions in the table space

Not applicable

nrowsdel

Number of rows deleted using a WHERE clause

The number of row deletions that XULDTERM reports is the number of skipped rows (not the number of discarded rows). The number of discarded rows is not available to XULDTERM.

Not applicable

nrowsin

Number of rows used as input for the unload operation before any discards due to a WHERE clause

Not applicable

nrowsout

Number of rows written to the output data set

Not applicable

obid

Object ID of the table that was unloaded

Not applicable

primary

Size of the output data set in primary allocation units

Not applicable

rc

Return code for this automation control point

recfm

Record format for the output data set

Not applicable

rowsize

Length of reach row of data, in bytes

Not applicable

secondry

Size of the output data set in secondary allocation units

Not applicable

sunit

Unit of space to which the primary and secondary variables refer

  • BLK (blocks)
  • TRK (tracks)
  • CYL (cylinders)

tbcre8

Table creator

Not applicable

tbname

Name of the table that was unloaded

Not applicable

tsname

Name of the table space containing the unloaded table

Not applicable

unitname

Unit name for the storage device that the unload data set unit specifies

Not applicable

volsern

Number of volume serials specified

Not applicable

volsers

List of volume serials, separated by spaces

Not applicable

Return codes

The XULDTERM 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 rc variable 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*