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
whereagentname
is the name of the agent andqmgrname
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 managerhost
is the optional host name of the system where the queue manager is runningport
is the optional port number that the queue manager is listening onchannel
is the optional SVRCONN channel to use
host
,port
, orchannel
information for the command queue manager, the connection information specified in the command.properties file is used. For more information, see The MFT command.properties file. - 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 managerqm0
. 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 bobuser ID.
<fte:cancel cmdqm="qm0@localhost@1414@SYSTEM.DEF.SVRCONN"
agent="agent1@qm1"
id="${transfer.id}"
origuser="bob"/>