MFT schedule list message format

MFT schedule list message format

The XML message that is published to a retained publication to the topic string SYSTEM.FTE/Scheduler/agent_name conforms to the ScheduleList.xsd schema. This XML message lists all active schedules belonging to that agent. This information is used by the fteListScheduledTransfers command and the IBM MQ Explorer to display a list of schedules to the user. The ScheduleList.xsd schema document is located in the MQ_INSTALLATION_PATH/mqft/samples/schema directory. The ScheduleList.xsd schema imports FileTransfer.xsd, which is in the same directory.

Schema
The following schema describes which elements are valid in a monitor list XML message.
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

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

    <xsd:element name="schedules">         
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="managedTransfer" type="scheduledManagedTransferType" minOccurs="0" maxOccurs="unbounded"/>
            </xsd:sequence>
            <xsd:attribute name="version" type="versionType"            use="required"/>
            <xsd:attribute name="size"    type="xsd:nonNegativeInteger" use="required"/>
            <xsd:attribute name="agent"   type="xsd:string"             use="required"/>
        </xsd:complexType>
    </xsd:element> 

    <xsd:complexType name="scheduledManagedTransferType">
        <xsd:sequence>
            <xsd:element name="originator"       type="origRequestType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="schedule"         type="scheduleListType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="sourceAgent"      type="agentType"        maxOccurs="1" minOccurs="1"/>  
            <xsd:element name="destinationAgent" type="agentClientType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="trigger"          type="triggerType"      maxOccurs="1" minOccurs="0"/>
            <xsd:element name="reply"            type="replyType"        maxOccurs="1" minOccurs="0"/>
            <xsd:element name="transferSet"      type="transferSetType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="job"              type="jobType"          maxOccurs="1" minOccurs="0" />
        </xsd:sequence>
        <xsd:attribute name="id" type="idType" use="required"/>
    </xsd:complexType>      

    <xsd:complexType name="scheduleListType">
        <xsd:sequence>
            <xsd:element name="submit" type="submitType"      maxOccurs="1" minOccurs="1"/>
            <xsd:element name="repeat" type="repeatType"      maxOccurs="1" minOccurs="0"/>
            <xsd:element name="next"   type="noZoneTimeType"  maxOccurs="1" minOccurs="1"/>
        </xsd:sequence>
    </xsd:complexType>

</xsd:schema>
Understanding the schedule list message
The elements and attributes used in the schedule list messages are described in the following list:

<schedules>

Group element containing information about all of the schedules defined on a single agent.
Attribute Description

agent Required. The name of the source agent that the schedule is defined on.

size Required. The number of schedules defined on this agent.

version Required. The version of the schedule list message format.

<managedTransfer>

Group element containing information about a single schedule.
Attribute Description

id Required. The hexadecimal string ID of the schedule request message.

<originator>

The originator of the schedule request.

<hostName>

The host name of the machine that the schedule request was submitted from.

<userID>

The user ID of the user that submitted the schedule request.

<mqmdUserID>

The MQMD user ID of the user that submitted the schedule request.

<schedule>

Element that contains the elements that describe when the scheduled transfer occurs.

<submit>

Specifies the date and time that the scheduled transfer is due to start.
Attribute Description

timebase Specifies which time zone to use. The value of this attribute can be one of the following values:

source - use the time zone of the source agent
admin - use the time zone of the administrator issuing the command
UTC - use Coordinated Universal Time

timezone The time zone description according to the timebase value

<repeat>

Group element that contains details about how often a scheduled transfer repeats, how many times a scheduled transfer repeats, and when a scheduled transfer stops repeating.
Attribute Description

interval The interval units, which must be one of the following values:

minutes
hours
days
weeks
months
years

<frequency>

The time period that must elapse before the transfer repeats.
Attribute Description

interval The interval units, which must be one of the following values:

minutes
hours
days
weeks
months
years

<expireTime>

Optional element that specifies the date and time that a repeating scheduled transfer stops. This element and the <expireCount> element are mutually exclusive.

<expireCount>

Optional element that specifies the number of times the scheduled file transfer occurs before stopping. This element and the <expireTime> element are mutually exclusive.

<next>

Specifies the date and time when the next scheduled transfer is due to start.

<sourceAgent>

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

agent Specifies 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 Specifies the name of the agent.

QMgr The name of the agent queue manager.

<trigger>

Optional element that specifies a condition that must be true for the file transfer to take place.
Attribute Description

log A flag indicating whether trigger failures are logged. The following are valid values:

yes - log entries are created for failed triggered transfers
no - log entries are not created for failed triggered transfers

<reply>

Specifies the name of the temporary reply queue generated for synchronous file transfers (specified with the -w parameter on the command line). The name of the queue is defined by the key dynamicQueuePrefix in the command.properties configuration file or the default of WMQFTE.* if not specified.
Attribute Description

QMGR The name of the command queue manager on which the temporary dynamic queue is generated to receive replies.

<transferSet>

Specifies a group of file transfers you want the scheduled transfer to perform together. During transmission <transferSet> is a group element containing <item> elements.
Attribute Description

priority Priority level of the transfer. Priority is a value in the range 0-9, where 0 is the lowest priority. The default priority level is 0 and by default the transfer uses the priority level of the source agent.

<job>

Optional group element containing job information for the entire transfer specification. <job> is a user-defined job name identifier that is added to the log message when the transfer has started. This <job> element is the same as the <job> element that appears in the transfer log message, which is described in the following topic: File transfer log message formats.

Example
<?xml version="1.0" encoding="UTF-8"?>
<schedules xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           size="2" 
           version="4.00" 
           agent="AGENT_JUPITER" 
           xsi:noNamespaceSchemaLocation="ScheduleList.xsd">   
    <managedTransfer id="1">     
        <originator>       
            <hostName>example.com.</hostName>       
            <userID>mqm</userID>     
        </originator>     
        <schedule>       
            <submit timebase="admin" timezone="Europe/London">2010-01-01T21:00+0000</submit>       
            <next>2010-01-01T21:00+0000</next>     
        </schedule>     
        <sourceAgent agent="AGENT_JUPITER" QMgr="QM_JUPITER"/>     
        <destinationAgent agent="AGENT_SATURN" QMgr="QM_JUPITER"/>     
        <reply QMGR="QM_JUPITER">WMQFTE.4D400F8B20004E06</reply>     
        <transferSet>       
            <item mode="binary" checksumMethod="MD5">         
                <source recursive="false" disposition="leave">           
                    <file>/etc/passwd</file>         
                </source>         
                <destination type="directory" exist="overwrite">           
                    <file>/tmp</file>         
                </destination>       
            </item>     
        </transferSet>   
    </managedTransfer>   
    <managedTransfer id="2">     
        <originator>       
            <hostName>example.com.</hostName>       
            <userID>mqm</userID>     
        </originator>     
        <schedule>       
            <submit timebase="admin" timezone="Europe/London">2010-12-31T09:00+0000</submit>       
            <next>2010-12-31T09:00+0000</next>     
        </schedule>     
        <sourceAgent agent="AGENT_JUPITER" QMgr="QM_JUPITER"/>     
        <destinationAgent agent="AGENT_NEPTUNE" QMgr="QM_JUPITER"/>     
        <reply QMGR="QM_JUPITER">WMQFTE.4D400F8B20004E09</reply>     
        <transferSet>       
            <item mode="binary" checksumMethod="MD5">         
                <source recursive="false" disposition="leave">           
                    <file>/etc/passwd</file>         
                </source>         
                <destination type="directory" exist="overwrite">           
                    <file>/tmp</file>         
                </destination>       
            </item>     
        </transferSet>   
    </managedTransfer>
</schedules
Parent topic: XML message formats used by MFT

Attribute	Description
agent	Required. The name of the source agent that the schedule is defined on.
size	Required. The number of schedules defined on this agent.
version	Required. The version of the schedule list message format.

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