Agent status message format

When an agent is created or started, the agent publishes its details to the SYSTEM.FTE topic on its coordination queue manager (on the SYSTEM.FTE/Agents/agent name topic).

The following information is included:
  • Agent name
  • Platform the agent is running on
  • Agent description (if provided)
  • Agent's queue manager
  • Time zone that the agent is running in
  • Agent version
  • Agent transfer limits
  • State of each of the agent's current transfers. These states are listed in Agent transfer states
  • Type of agent
If the agent is a protocol bridge agent the following information is also included:
  • Type of protocol bridge agent
  • Host name or IP address of the protocol bridge server
If the agent is a web agent the following information is also included:
  • Name of the Web Gateway the web agent connects to
The agent status is republished whenever the agent transfer states change, but by default no more than every 30 seconds. You can change this default setting using the agentStatusPublishRateLimit agent property, which is described in: Advanced agent properties.
The following example output shows the keys used for each data element in the agent status: 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <entry key="agentOsName">Windows 7</entry>
    <entry key="agentDescription"/>
    <entry key="queueManager">QM1</entry>
    <entry key="agentTimeZone">Europe/London</entry>
    <entry key="agentVersion">1.00</entry>
    <entry key="agentName">FTEAGENT</entry>
    <entry key="maxDestinationTransfers">25</entry>
    <entry key="maxSourceTransfers">25</entry>
    <entry key="maxQueuedTransfers">100</entry>
    <entry key="DestinationTransferStates">414d51204d554e474f20202020202020d857374a60a72622=RunningTransfer
                                           414d51204d554e474f20202020202020d857374a69a72622=RunningTransfer
                                           414d51204d554e474f20202020202020d857374a75a72622=RunningTransfer
    </entry>
    <entry key="SourceTransferStates">414d51204d554e474f20202020202020d857374a93a72622=NegotiatingTransfer
                                      414d51204d554e474f20202020202020d857374a78a72622=RunningTransfer
                                      414d51204d554e474f20202020202020d857374aaba72622=NewSenderTransfer
                                      414d51204d554e474f20202020202020d857374a63a72622=RunningTransfer
    </entry>
</properties>
The following example output shows the keys used for each data element in the agent status of a protocol bridge agent:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <entry key="agentOsName">Windows 7</entry>
    <entry key="agentDescription"/>
    <entry key="queueManager">QM1</entry>
    <entry key="agentTimeZone">Europe/London</entry>
    <entry key="agentVersion">1.00</entry>
    <entry key="agentName">BRIDGE</entry>
    <entry key="protocolBridgeType">ftp</entry>
    <entry key="protocolBridgeServerHost">ftpserver.example.org</entry>
    <entry key="maxDestinationTransfers">25</entry>
    <entry key="maxSourceTransfers">25</entry>
    <entry key="maxQueuedTransfers">100</entry>
    <entry key="DestinationTransferStates">414d51204d554e474f20202020202020d857374a60a72622=RunningTransfer
    </entry>
    <entry key="SourceTransferStates">414d51204d554e474f20202020202020d857374a93a72622=NegotiatingTransfer
    </entry>
</properties>