Canceling a sending-side transferring instance

You can cancel sending that is in progress or the processing of the record in the Send Queue.

(1) Send Cancel command

Program interface

CALL library name/UTLSCAN PARM(['LIB=library name'] ['F=fileid'] ['H=hostname']
   ['TRID=transfer-id'] ['G'] ['OUTPUT=filename'] ['EXIT' CL variable name])

Explanation of parameters

LIB=Library name

Library name in which HULFT is installed ("HULFT" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.

F=fileid

File ID of the target record for cancelation, of which status is "Transferring" or "Send Queue" (Optional)

Specify this parameter as an alphanumeric character string of 50 bytes or less.

Specify this when you cancel all sending-side transferring instances for specified IDs at the same time.

To cancel all instant transfers at the same time, specify "_INSTANT_TRANSFER_".

To cancel an individual sending-side transferring instance, specify "TRID=".

If omitted, sending-side transferring instances for all relevant host names are canceled.

H=hostname

Remote host name of the target record for cancelation, of which status is "Transferring" or "Send Queue" (Optional)

Specify this parameter as an alphanumeric character string of 68 bytes or less.

If omitted, sending-side transferring instances for all relevant file IDs are canceled.

TRID=transfer-id

Transfer ID of the ongoing or waiting sending-side transferring instance to cancel (Optional)

Specify this parameter as an alphanumeric character string of 64 bytes.

If omitted, all sending-side transferring instances for file IDs and host IDs specified with "F=" and "H=" will be canceled.

G

Control of error messages that the Send Cancel command outputs (Optional)

When omitted, HULFT displays error messages.

OUTPUT=filename

Destination of the error messages that the Send Cancel command outputs (Optional)

Specify this parameter in the format of Library name/File name(Member name).

When omitted, error messages are not output.

The number of log records that a log file can retain is unlimited.

EXIT CL variable name

Specifies to receive the error code output by the Send Cancel command and specifies the CL variable name to set the error code value (Optional)

The CL variable name must immediately follow the EXIT tag.

HULFT sets an error code to the CL variable only if the command ends unsuccessfully.

When omitted, an error code is not set.

Note

  • When the same host names and the same file IDs exist, sending-side transferring instances for all relevant records are canceled.

  • The Post-send Job specified in the canceled sending does not start.

  • For sending-side transferring instances terminated with the status code (603) at cancelation, information about the send file is not output to the Resend Queue file.

  • When you cancel sending, even if the request that you made was executed successfully, it may take a while until the actual cancelation takes place in the following cases:

    • Where the Transfer Interval is too long

    • Where the sending host has been waiting for response from remote hosts

  • If the execution of the Post-send Job has already started, you cannot cancel the sending.

Command interface

UTLSCAN FILEID( ) HOSTNAME( ) TRID( ) LIBRARY( ) MSG( ) FILE( ) MBR( )

Explanation of parameters

FILEID

File ID of the target record for cancelation, of which status is "Transferring" or "Send Queue" (Optional)

Specify this parameter as an alphanumeric character string of 50 bytes or less.

Specify this when you cancel all sending-side transferring instances for specified IDs at the same time.

To cancel all instant transfers at the same time, specify "_INSTANT_TRANSFER_".

To cancel an individual sending-side transferring instance, specify "TRID".

If omitted, sending-side transferring instances for all relevant host names are canceled.

HOSTNAME

Remote host name of the target record for cancelation, of which status is "Transferring" or "Send Queue" (Optional)

Specify this parameter as an alphanumeric character string of 68 bytes or less.

If omitted, sending-side transferring instances for all relevant file IDs are canceled.

TRID

Transfer ID of the ongoing or waiting sending-side transferring instance to cancel (Optional)

Specify this parameter as an alphanumeric character string of 64 bytes.

If omitted, all sending-side transferring instances for file IDs and hosts specified with "FILEID" and "HOSTNAME" will be canceled.

LIBRARY

Library name in which HULFT is installed ("HULFT" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.

MSG

Control of error messages ("*YES" by default)

*NO :

Suppress error messages.

*YES :

Show error messages.

FILE

Name of the library and the file to which error messages are output (Optional)

Specify this parameter in the format of Library name/File name.

Specify these names as an alphanumeric character string of 10 bytes or less starting with an alphabet, respectively.

When omitted, error messages are not output. The number of log records that a log file can retain is unlimited.

MBR

Member name of the file to which error messages are output ("*FILE" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.