已调度的文件传输日志消息格式

代理每次处理已调度文件传输的请求时,都会向协调队列管理器发布一条调度日志消息(在其 SYSTEM.FTE/Log/agent name/schedule ID 主题中)。 该消息符合 ScheduleLog.xsd XML 模式。

模式

以下模式描述哪些元素在调度日志 XML 消息中有效。

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

    <xsd:element name="schedulelog">         
        <xsd:complexType>         	
            <xsd:sequence>         	    
                <xsd:element name="originator"       type="hostUserIDType"  
                             maxOccurs="1"           minOccurs="0"/>         		
                <xsd:element name="action"           type="actionType"      
                             maxOccurs="1"           minOccurs="1"/> 				
                <xsd:element name="schedule" 	      type="scheduleType"    
                             maxOccurs="1"           minOccurs="0"/> 				
                <xsd:element name="sourceAgent"      type="agentType"       
                             maxOccurs="1"           minOccurs="0"/>            		
                <xsd:element name="destinationAgent" type="agentClientType" 
                             maxOccurs="1"           minOccurs="0" /> 	        	
                <xsd:element name="status"           type="statusType"      
                             maxOccurs="1"           minOccurs="0"/>         		
                <xsd:element name="transferSet"      type="transferSetType" 
                             maxOccurs="1"           minOccurs="0"/>         		
                <xsd:element name="job"              type="jobType"         
                             maxOccurs="1"           minOccurs="0" />   		         	
            </xsd:sequence>         	
            <xsd:attribute name="version"   type="versionType" use="required"/> 			
            <xsd:attribute name="ID"        type="xsd:string"  use="required"/>         
        </xsd:complexType>     
    </xsd:element>           

    <xsd:complexType name="actionType"> 		
        <xsd:simpleContent>     		
            <xsd:extension base="actionEnumType">     			
                <xsd:attribute name="time" type="xsd:dateTime" use="required" />     		
            </xsd:extension>     	
        </xsd:simpleContent> 	
    </xsd:complexType> 	 	

    <xsd:simpleType name="actionEnumType"> 			
        <xsd:restriction base="xsd:token">     			
            <xsd:enumeration value="submit"/>     			
            <xsd:enumeration value="delete"/>     			
            <xsd:enumeration value="expire"/>     			
            <xsd:enumeration value="skipped"/>     		
        </xsd:restriction>
    </xsd:simpleType>          	

    <xsd:complexType name="transferSetType">         
        <xsd:sequence>             
            <xsd:element name="item"            type="itemType" 
                         maxOccurs="unbounded"  minOccurs="1" />         
        </xsd:sequence>         
        <xsd:attribute name="size" type="xsd:int" use="required" />         
        <xsd:attribute name="priority" type="priorityType" use="optional" />     
    </xsd:complexType>         	

    <xsd:complexType name="itemType"> 		
        <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="mode" type="modeType" use="required" /> 		
        <xsd:attribute name="checksumMethod" type="checkSumMethod" use="required" /> 	
    </xsd:complexType>     

</xsd:schema>

了解调度日志消息

下面描述了调度日志消息中使用的元素和属性:

<schedulelog>
用于描述单个提交的已调度文件传输的组元素。
属性 描述
版本 指定此元素的版本,如 Managed File Transfer所详述。
标识 已提交的调度文件传输的唯一标识。
<originator>
包含指定请求发起方的元素的组元素。
<hostName>
源文件所在系统的主机名。
<userID>
发起文件传输的用户标识。
<mqmdUserID>
在消息描述符 (MQMD) 中提供的 MQ 用户标识
<action>
指定要对与 <schedulelog> 元素的 ID 属性匹配的已调度传输执行的操作。 该元素必须是以下某个值:
  • submit - 新建已调度传输
  • delete - 取消调度传输
  • expire - 即将处理调度传输条目
  • skipped - 由于代理处于脱机状态,因此无法启动调度的传输。 当代理变得可用时,将记录该消息以指明跳过了该传输。
属性 描述
时间 指定发布日志条目的日期和时间(采用日期时间格式)。
<sourceAgent>
指定源文件所在系统上的代理的名称。
属性 描述
客服 指定代理的名称。
QMgr 代理队列管理器的名称。
<destinationAgent>
指定您要向其传输文件的系统上代理的名称。
属性 描述
客服 指定代理的名称。
QMgr 代理队列管理器的名称。
<status>
结果代码和补充消息。
<transferSet>
指定一组要一起执行的文件传输。 在传输期间,<transferSet> 是包含 <item> 元素的组元素。
属性 描述
size 指定传输项数。
priority 传输的优先级。 优先级为 0-9 之间的一个值,其中 0 为最低优先级。 缺省优先级为 0,并且缺省情况下,传输使用源代理的优先级。
<item>
包含指定源和目标文件名和位置的元素的组元素。
属性 描述
mode 将传输方式指定为二进制或文本。
checksumMethod 指定生成消息摘要以创建数字签名的散列算法的类型。 允许的值包括 MD5 或 none
<source>
包含源系统上文件的 <file> 和 <checksum> 元素的组元素。
属性 描述
recursive 指定当 <source> 元素为目录或包含通配符时,以递归方式传输子目录中的文件。
disposition 指定在 <source> 已成功传输到其目标时要在 <source> 元素上执行的操作。 有效选项如下:
  • leave - 源文件保持不变。
  • delete - 在成功传输源文件后将源文件从源系统中删除。
<destination>
包含目标系统上文件的 <file> 和 <checksum> 元素的组元素。
属性 描述
类型 位于目标的文件或目录的类型。 有效选项如下:
  • file - 将文件指定为目标
  • directory - 将目录指定为目标
  • [z/OS]dataset-将 z/OS® 数据集指定为目标
  • [z/OS]PDS-将 z/OS 分区数据集指定为目标
exist 指定在目标系统上已存在目标文件时执行的操作。 有效选项如下:
  • error - 报告一个错误,并且未传输文件。
  • overwrite - 覆盖现有的目标文件。
<file>
指定要传输的文件的名称。 使用与操作系统格式一致的标准路径,例如 C:/from/here.txt。 请勿使用文件 URI。
属性 描述
编码 文本文件传输的编码。
EOL 指定行结束标记符。 允许的值包括:
  • LF - 仅限换行字符
  • CRLF - 回车符和换行符序列
<job>
组元素,包含一个指定任务详细信息的元素。 <job> 是用户定义的任务名称标识符,传输开始后会添加到日志信息中。 This <job> element is the same as the <job> element that is included in the transfer request message, which is described in the following topic: 文件传输请求消息格式.
<name>
名称可以是任意字符串。

示例

为以下每个已调度传输操作提供了符合该模式的 XML 消息示例:根据调度启动的传输与标准传输采用相同的记录方式。 有关调度启动的传输的日志消息示例,请参阅 调度文件传输日志消息示例