fte:cancel Ant task

Cancels a Managed File Transfer managed transfer or managed call. A managed transfer might have been created using the fte:filecopy or fte:filemove tasks. A managed call might have been created using the fte:call task.

Attributes

agent
Required. Specifies the agent to submit the fte:cancel request to. The value is in the form: agentname@qmgrname where agentname is the name of the agent and qmgrname is the name of the queue manager that this agent is directly connected to.
cmdqm
Optional. The command queue manager to submit the request to. Specify this information in the form qmgrname@host@port@channel, where:
  • qmgrname is the name of the queue manager
  • host is the optional host name of the system where the queue manager is running
  • port is the optional port number that the queue manager is listening on
  • channel is the optional SVRCONN channel to use
If you omit the host, port, or channel information for the command queue manager, the connection information specified in the command.properties file is used.
Attention: If no value is specified for the:
  • host variable, bindings mode is used
  • port variable, the value 1414 is used
  • channel variable, the SYSTEM.DEF.SVRCONN is used.
See The MFT command.properties file for more information.

However, you cannot skip the attributes in the middle, for example, qmgrname@host@@channel. You can have, for example, qmgrname@host, or qmgrname@host@port, or qmgrname@hostport@@channel.

MFT splits the given attribute using the @ delimiter. Depending on the number of tokens found, it takes the first token as qmgrname, the second one as host, the third one as port and finally channel.

For more information, see The MFT command.properties file.
You can use the com.ibm.wmqfte.propertySet property to specify which command.properties file to use. For more information, see com.ibm.wmqfte.propertySet.
If you do not use the cmdqm attribute, the task defaults to using the com.ibm.wmqfte.ant.commandQueueManager property, if this property is set. If the com.ibm.wmqfte.ant.commandQueueManager property is not set, a connection to the default queue manager, defined in the command.properties file, is attempted. The format of the com.ibm.wmqfte.ant.commandQueueManager property is the same as the cmdqm attribute, that is, qmgrname@host@port@channel.
id
Required. Specifies the transfer identifier of the transfer to cancel. Transfer identifiers are generated at the point a transfer request is submitted by both the fte:filecopy and fte:filemove tasks.
origuser
Optional. Specifies the originating user identifier to associate with the cancel request. If the origuser attribute is not used, the task defaults to using the user ID that is used to run the Ant script.

Example

The example sends a fte:cancel request to the command queue manager qm0. The fte:cancel request is targeted at agent1 on queue manager qm1 for the transfer identifier populated by the transfer.id variable. The request is run using the bob user ID. 
<fte:cancel cmdqm="qm0@localhost@1414@SYSTEM.DEF.SVRCONN" 
            agent="agent1@qm1"
            id="${transfer.id}"
            origuser="bob"/>