User exit message formats
When a transfer is in progress, messages are published to the SYSTEM.FTE topic with a topic string of Log/agent_name/transfer_ID. The XML examples show the log messages that are created when a file transfer occurs that contains calls to user exits.
Exit single file transfer proceed - started
<?xml version="1.0" encoding="UTF-8"?>
<transaction version="1.00"
ID="414d5120514d312020202020202020207e970d492000d502" agentRole="sourceAgent"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="TransferLog.xsd"
xmlns="">
<action time="2008-11-02T22:36:13.046Z">started</action>
<sourceAgent agent="FTEAGENT" QMgr="QM1">
<systemInfo architecture="x86" name="Windows 7"
version="6.1 build 7601 Service Pack 1"/>
</sourceAgent>
<destinationAgent agent="FTEAGENT" QMgr="QM1"/>
<originator>
<hostName>reportserver.com</hostName>
<userID>USER1</userID>
<mqmdUserID>USER1 </mqmdUserID>
</originator>
<transferSet startTime="2008-11-02T22:36:13.046Z" total="1">
<metaDataSet>
<metaData key="testkey1">testvalue1</metaData>
<metaData key="testkey2">testvalue2</metaData>
</metaDataSet>
</transferSet>
</transaction>
Exit single file transfer proceed - completed
<?xml version="1.0" encoding="UTF-8"?>
<transaction version="1.00"
ID="414d5120514d312020202020202020207e970d492000d502"
agentRole="sourceAgent"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="TransferLog.xsd"
xmlns="">
<action time="2008-11-02T22:36:13.546Z">completed</action>
<sourceAgent agent="FTEAGENT" QMgr="QM1">
<startExits>
<exit name="class testExits.SourceExit1">
<status resultCode="proceed">
<supplement>Source Start, modified metadata</supplement>
</status>
</exit>
</startExits>
<endExits>
<exit name="class testExits.SourceExit1">
<status>
<supplement>Source End</supplement>
</status>
</exit>
</endExits>
<systemInfo architecture="x86" name="Windows 7"
version="6.1 build 7601 Service Pack 1"/>
</sourceAgent>
<destinationAgent agent="FTEAGENT" QMgr="QM1">
<startExits>
<exit name="class testExits.DestinationExitProceed">
<status resultCode="proceed">
<supplement>Destination start, with proceed</supplement>
</status>
</exit>
</startExits>
<endExits>
<exit name="class testExits.DestinationExitProceed">
<status>
<supplement>destination end</supplement>
</status>
</exit>
</endExits>
<systemInfo architecture="x86" name="Windows 7"
version="6.1 build 7601 Service Pack 1"/>
</destinationAgent>
<originator>
<hostName>reportserver.com</hostName>
<userID>USER1</userID>
<mqmdUserID>USER1 </mqmdUserID>
</originator>
<transferSet startTime="2008-11-02T22:36:13.046Z" total="1">
<metaDataSet>
<metaData key="newkey2">newvalue2</metaData>
<metaData key="newkey1">newvalue1</metaData>
<metaData key="newkey4">newvalue4</metaData>
<metaData key="newkey3">newvalue3</metaData>
<metaData key="newkey5">newvalue5</metaData>
<metaData key="testkey1">testvalue1</metaData>
<metaData key="testkey2">testvalue2</metaData>
</metaDataSet>
</transferSet>
</transaction>
<!--
In this example the source transfer start exit has modified the
metadata as follows:
Added keys and values for:
newkey1, newvalue1
newkey2, newvalue2
newkey3, newvalue3
newkey4, newvalue4
newkey5, newvalue5
Replaced values for:
key1 to modifiedValue1
Deleted keys and values for:
key2
-->
Exit single file transfer cancel - canceled
<?xml version="1.0" encoding="UTF-8"?>
<transaction version="1.00"
ID="414d5120514d312020202020202020207e970d492000c702" agentRole="sourceAgent"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="TransferLog.xsd"
xmlns="">
<action time="2008-11-02T22:25:59.328Z">cancelled</action>
<sourceAgent agent="FTEAGENT" QMgr="QM1">
<startExits>
<exit name="class testExits.SourceExit1">
<status resultCode="proceed">
<supplement>Source Start, modified metadata</supplement>
</status>
</exit>
</startExits>
<endExits>
<exit name="class testExits.SourceExit1">
<status>
<supplement>Source End</supplement>
</status>
</exit>
</endExits>
<systemInfo architecture="x86" name="Windows 7"
version="6.1 build 7601 Service Pack 1"/>
</sourceAgent>
<destinationAgent agent="FTEAGENT" QMgr="QM1">
<startExits>
<exit name="class testExits.DestinationExit1">
<status resultCode="cancelTransfer">
<supplement>Destination start, with cancel</supplement>
</status>
</exit>
</startExits>
<endExits>
<exit name="class testExits.DestinationExit1">
<status>
<supplement>destination end</supplement>
</status>
</exit>
</endExits>
<systemInfo architecture="x86" name="Windows 7"
version="6.1 build 7601 Service Pack 1"/>
</destinationAgent>
<originator>
<hostName>reportserver.com</hostName>
<userID>USER1</userID>
<mqmdUserID>USER1 </mqmdUserID>
</originator>
<transferSet startTime="2008-11-02T22:25:59.078Z" total="1"/>
</transaction>