Reply message format

When an agent receives an XML message on its agent command queue, if a response is required, the agent will send an XML reply message to the reply queue defined in the original message. The reply XML conforms to the Reply.xsd schema. The Reply.xsd schema document is located in the MQ_INSTALLATION_PATH/mqft/samples/schema directory. The Reply.xsd schema imports fteutils.xsd, which is in the same directory.

Schema

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

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

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

    <xsd:element name="reply">
    	<xsd:complexType>
    		<xsd:sequence>
    		    <xsd:element name="transferSet" type="transferSetType" minOccurs="0" maxOccurs="1"/>
    			<xsd:element name="status" type="statusType" minOccurs="1" maxOccurs="1"/>
    		</xsd:sequence>
        	<xsd:attribute name="version"   type="versionType"       use="required"/>
        	<xsd:attribute name="ID"        type="IDType"            use="required"/>
        	<xsd:attribute name="detailedReplyMessagesDisabled" type="xsd:boolean" use="optional"/>
    	</xsd:complexType>    	
    </xsd:element>

</xsd:schema>

Understanding the reply message

The elements and attributes used in the reply messages are described in the following list:
<reply>
Element containing the elements that specify the reply information.
Attribute Description
ID The ID of the reply.
version The version of the reply message format.
detailedReplyMessagesDisabled A notification that the agent has disabled the detailed reply enableDetailedReplyMessages agent property is set to false).
<transferSet>
Specifies the transfer result information of the files requested for transfer. For more information, see File transfer log message formats.

<status>
The status of the action that the agent was requested to perform.
Attribute Description
resultCode The result code returned from the action that the agent performed.
<supplement>
Additional response information about the action that the agent was requested to perform.

Example

In the following section is an example reply message: 

<reply version="1.00"           xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
                                xsi:noNamespaceSchemaLocation="Reply.xsd" 
                                ID="010202030000000000000000000000000000000000000000">
    <status resultCode="65">
        <supplement>Additional reply information</supplement>
    </status>
</reply>