File transfer status message format

Messages are published to the coordination queue manager to indicate transfer status of each file in the transfer set. Every time a request for file transfer is processed by the agent, a transaction message is published to the coordination queue manager (on its SYSTEM.FTE/Transfers/agent_name/transfer ID topic), which conforms to the TransferStatus.xsd XML schema. The TransferStatus.xsd file is located in the MQ_INSTALLATION_PATH/mqft/samples/schema directory of your WMQMFT installation.

Schema

The following schema describes which elements are valid in a transfer status XML message.

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <xsd:include schemaLocation="fteutils.xsd"/>

    <xsd:element name="transaction"> 		
        <xsd:complexType> 			
            <xsd:sequence> 				
                <xsd:element name="sourceAgent"      type="agentType" 		
                             maxOccurs="1"           minOccurs="1"/> 				
                <xsd:element name="destinationAgent" type="agentType" 		
                             maxOccurs="1"           minOccurs="1"/> 				
                <xsd:element name="transferSet"      type="transferSetType" 
                             maxOccurs="1"           minOccurs="1"/> 			
            </xsd:sequence> 			
            <xsd:attribute name="version" type="versionType"   use="required"/> 			
            <xsd:attribute name="ID"      type="IDType"        use="required"/> 		
        </xsd:complexType> 	
    </xsd:element>  	

    <xsd:complexType name="transferSetType"> 		
        <xsd:sequence> 			
            <xsd:element name="stats"   type="statsType"	
                         maxOccurs="1" minOccurs="1" /> 			
            <xsd:element name="current"	type="currentType"	
                         maxOccurs="1" minOccurs="0" /> 		
        </xsd:sequence> 		
        <xsd:attribute name="time" type="xsd:dateTime" use="required" /> 	
    </xsd:complexType>  	

    <xsd:complexType name="currentType"> 		
        <xsd:sequence> 			
            <xsd:element name="source"      type="fileSourceType"      
                         maxOccurs="1"      minOccurs="1" /> 			
            <xsd:element name="destination" type="fileDestinationType" 
                         maxOccurs="1"      minOccurs="1" /> 		
        </xsd:sequence> 		
        <xsd:attribute name="transferred" type="xsd:nonNegativeInteger"	use="required" /> 		
        <xsd:attribute name="size" type="xsd:nonNegativeInteger"		use="required" /> 	
    </xsd:complexType>  	

    <xsd:complexType name="statsType"> 		
        <xsd:attribute name="bytes"        type="xsd:nonNegativeInteger"  use="required" /> 		
        <xsd:attribute name="seconds"      type="xsd:decimal"             use="required" /> 		
        <xsd:attribute name="currentItem"  type="xsd:nonNegativeInteger"  use="required" /> 		
        <xsd:attribute name="totalItems"   type="xsd:nonNegativeInteger"  use="required" /> 	
    </xsd:complexType> 

</xsd:schema>

Understanding the transfer status message

<transaction>

Group element that contains all of the elements for the file transfers.

Attribute	Description
version	Specifies the version of this element as supplied by Managed File Transfer.
ID	The unique identifier for the file transfer.

<sourceAgent>

Specifies the name of the agent on the system where the source file is located.

Attribute	Description
agent	The name of the agent.
QMgr	The name of the agent queue manager.

<destinationAgent>

Specifies the name of the agent on the system you want to transfer the file to.

Attribute	Description
agent	The name of the agent.
QMgr	The name of the agent queue manager.

<transferset>

Specifies a group of file transfers being performed together. All of the files in the transfer must originate at the same source agent and end at the same destination agent.

Attribute	Description
time	Specifies the date and time (in date time format).

<stats>

Required. Defines metrics about the transfer, including the number of bytes copied so far, in the given number of seconds. Also supplies the current item number out of the total number of items in the <transferSet>.

Attribute	Description
bytes	Number of bytes copied so far.
seconds	Number of seconds taken to transfer those bytes.
currentItem	The index of the current item being transferred.
totalItems	The total number of items being transferred.

<current>

Optional element. Group element that contains elements that specify the file transfer currently in progress. The <current> element indicates how many bytes of data have been transferred so far for the current item and the expected total number of bytes

<source>

Group element that contains the element specifying the source file name.

<file>

Specifies the source path of the file that is being transferred. The path is as specified for the transfer. This path might differ from the path that is output as part of the transfer log, which is the absolute form the of path.

<destination>

Group element that contains the element specifying the destination file name or specification.

<file>

Specifies the destination path of the file that is being transferred. The path is as specified for the transfer. This path might differ from the path that is output as part of the transfer log, which is the absolute form the of path.

Attribute	Description
alias	Specifies an alias for the destination file. This alias is the name of the source file, excluding any directory path specified for the transfer.
filespace	Specifies the name of the file space where the destination file is written.

<queue>

When used with the <destination> element, specifies the name of the queue you want to transfer to. This name is in the format QUEUE or QUEUE@QUEUE_MANAGER.