Manage the CA XCOM Data Transport Queue

Contents
xdtw
Use XCOMQM at the command line to control the activity of the 
CA XCOM Data Transport for Windows
 (
CA XCOM Data Transport
) transfer queue, including stopping transfers and displaying the status of a transfer.
This functionality can also be performed from the Get History Records page of the GUI.
XCOMQM
The XCOMQM command lets you maintain the 
CA XCOM Data Transport
 queue from the command prompt. This command lets you delete entries from the queue, suspend transfers, resume suspended transfers, put scheduled transfers on hold, release held transfers, display the list of entries in the queue and display detailed information about the queue entries.
Syntax
The syntax for XCOMQM is as follows:
XCOMQM [
option
] [
option
]
. . .
You can use more than one option on a command line. You can also use the same option more than once. Each option must be separated by a space. These options can be listed in any order, but note that when the shell encounters options such as the 
-r
 option, it performs the command and exits XCOMQM without reading the rest of the command line.
Options
The following list explains the options for XCOMQM:
  • -r
    Display the release level of XCOMQM and exit.
  • -A
    entryname
     
    Release a held transfer.
  • -C
    entryname
     
    Get a trace of a transfer.
  • -D
    entryname
     
    Display details about a queue entry.
  • -H
    entryname
     
    Hold a scheduled transfer.
  • -L[a]
    List your queued transfers. Use -La for all queued transfers.
  • -R
    entryname
     
    Remove a queue entry.
  • -Rf
    entryname
     
    Force an entry to be removed from the queue, even if the entry's status does not allow you to remove it. Use this command only as a last resort when a transfer does not respond to the -T or -Tf commands.
  • -R*
    Remove all completed or scheduled entries from the queue.
    If you use this option on an active transfer, it will interrupt the transfer.
  • -T
    entryname
     
    Terminate an active transfer.
  • -T[f]
    entryname
     
    Force termination of the transfer. Use this command only as a last resort to terminate a transfer if it does not respond to the -T command.
    Note: When using SNA/APPC protocols, the TP will abend and it may be necessary to restart the underlying SNA software. When using TCP/IP, XCOMTCP will abend.
  • -S
    entryname
     
    Suspend a transfer.
  • -E
    entryname
     
    Resume a suspended transfer.
  • -d
    Display debugging information.
  • no option
    Display the help information.
entryname
 represents the Transaction ID, which is the six-digit name of the transfer entry in the queue.
Transfer Failure in Starting State
When a queued transfer is initiated, it is entered into the transfer queue. Then, when it is scheduled to run, it goes into the starting state. If for some reason the transfer fails to go beyond this state within 10 minutes and does not go into the started state (where the transfer connection has been initialized and the transfer of information begins), it is treated as an abend. The transfer is attempted again, depending on the values in the Version 2 window for number of retries and Retry interval. The corresponding parameters are RESTART_SUPPORTED, NUMBER_OF_RETRIES, and RETRY_TIME.
ERRORLEVEL Return Codes from xcomqm.exe
When executing the command-line program xcomqm.exe, the ERRORLEVEL indicates successful or failed processing. An ERRORLEVEL set to ZERO indicates successful operation and termination. An ERRORLEVEL set to NON_ZERO values indicates program processing was not successful, and that the program has terminated.