ファイル転送要求メッセージ・フォーマット

ファイル転送は、通常、ユーザーがファイル転送コマンドを発行した結果として、または IBM® MQ Explorerを使用して、エージェント・コマンド・キューに到着する XML メッセージによって開始されます。転送要求 XML は、FileTransfer.xsd スキーマに準拠していて、 <request> エレメントをルート・エレメントとして持っている必要があります。 FileTransfer.xsd スキーマ文書は MQ_INSTALLATION_PATH/mqft/samples/schema ディレクトリーにあります。 FileTransfer.xsd スキーマは、同じディレクトリーにある fteutils.xsd をインポートします。

ファイル転送メッセージは、以下の 3 つのルート・エレメントのいずれかを含むことができます。

<request> - 新しい転送要求、管理対象呼び出し要求、または保留中のスケジュール済み転送の削除のためのもの
<cancel> - 進行中のファイル転送を取り消すためのもの
<transferSpecifications> - 複数の転送ファイルグループを指定するために使用され、 fteCreateTransfer コマンドで使用されます

transferSpecificationsエレメントを使用して複数の転送グループを指定する方法については、転送定義ファイルの使用を参照してください。

スキーマ

次のスキーマは、転送要求 XML メッセージで有効なエレメントについて示します。

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

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

    <!--
        Defines the request of a managed transfer and version number
        <request version="1.00" ...
            <managedTransfer>
                ...
            </managedTransfer>
        </request>
     -->
    <xsd:element name="request">
        <xsd:complexType>
            <xsd:choice>
                <xsd:element name="managedTransfer" type="managedTransferType"/>
                <xsd:element name="deleteScheduledTransfer" type="deleteScheduledTransferType" />
                <xsd:element name="managedCall" type="managedCallType"/>
            </xsd:choice>
            <xsd:attribute name="version" type="versionType" use="required" />
        </xsd:complexType>
    </xsd:element>

    <!--
        Defines the cancel request of a managed transfer and version number
        <cancel version="1.00"
                  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
                  xsi:noNamespaceSchemaLocation="FileTransfer.xsd">
            <originator>
                <hostName>myMachine</hostName>
                <userID>myUserId</userID>
            </originator>     - Delete a scheduled transfer.
            
            <transfer>
               Transfer ID to Cancel
            </transfer>
        </cancel>
     -->
    <xsd:element name="cancel">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="originator" type="hostUserIDType" maxOccurs="1" minOccurs="1" />
                <xsd:choice> 
                    <xsd:element name="transfer" type="IDType" maxOccurs="1" minOccurs="1" />
                    <xsd:element name="call"     type="IDType" maxOccurs="1" minOccurs="1" />
                </xsd:choice>
                <xsd:element name="reply"      type="replyType"      maxOccurs="1" minOccurs="0" />
            </xsd:sequence>
            <xsd:attribute name="version" type="versionType" use="required" />
        </xsd:complexType>
    </xsd:element>

    <!--
        Defines the transfer definition element structure.
        <transferSpecifications>
            <item ...
            <item ...
        </transferSpecifications>
     -->
    <xsd:element name="transferSpecifications">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="item" type="itemType" minOccurs="1" maxOccurs="unbounded" />
            </xsd:sequence>
        </xsd:complexType>
    </xsd:element>

    <!--
        Define a managed transfer of an instigator and request
        <managedTransfer>

            <originator>
                ...
            </originator>

            <schedule>
                <submit timebase="source"|"UTC">2008-12-07T16:07"</submit>
                <repeat>
                    <frequency interval="hours">2</frequency>
                    <expireTime>2008-12-0816:07</expireTime>
                </repeat>
            </schedule>

            <sourceAgent agent="here" QMgr="near" />
            <destinationAgent agent="there" QMgr="far" />

            <trigger>
            ...
            </trigger>

            <transferSet>
                ...
            </transferSet>
        </managedTransfer>
     -->

     <xsd:complexType name="managedTransferType">
         <xsd:sequence>
            <xsd:element name="originator"       type="origTransferRequestType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="schedule"         type="scheduleType"     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:complexType>

    <!--
         This is a modified form of origRequestType which is used on a managed transfer request.
         The hostName and userID are mandatory attributes in this case.
     -->
    <xsd:complexType name="origTransferRequestType">
        <xsd:sequence>
            <xsd:element name="hostName" type="xsd:string" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="userID" type="xsd:string" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="mqmdUserID" type="xsd:string" minOccurs="0" maxOccurs="1"/>
            <xsd:element name="webBrowser" type="xsd:string" minOccurs="0" maxOccurs="1"/>
            <xsd:element name="webUserID" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
    </xsd:complexType>

    <!--
        Defines the transferset of source and destination agent and one or more files
        <transferset priority="1">
            <metaDataSet>
                <metaData key="keyname">keyvalue</metaData>
                <metaData key="keyname">keyvalue</metaData>
            </metaDataSet>

            <item>
                ...
            </item>
        </transferset>
     -->
    <xsd:complexType name="transferSetType">
        <xsd:sequence>
            <xsd:element name="metaDataSet"         type="metaDataSetType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="preSourceCall"       type="commandActionType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="postSourceCall"      type="commandActionType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="preDestinationCall"  type="commandActionType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="postDestinationCall" type="commandActionType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="item" type="itemType" maxOccurs="unbounded" minOccurs="0" />
        </xsd:sequence>
        <xsd:attribute name="priority" type="priorityType" use="optional" />
    </xsd:complexType>


    <!--
        Define a file pair with source and destination
        <item mode=[binary|text]>
            <source recursive="false" disposition="leave">
                <file>filename</file>
            </source>

            <destination type="file" exist="error">
                <file>filename</file>
            </destination>

        </item>
    -->
    <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>

    <!--
        Defines the request to delete scheduled file transfer.
        <deleteScheduledTransfer>
            <originator>
                <delete>
                    <hostName>myMachine</hostName>
                    <userID>myUserId</userID>
                </delete>
            </originator>
            <ID>56</ID>
        </deleteScheduledTransfer>
     -->
    <xsd:complexType name ="deleteScheduledTransferType">
        <xsd:sequence>
            <xsd:element name="originator" type="origDeleteType" maxOccurs="1" minOccurs="1" />
            <xsd:element name="ID"         type="idType"         maxOccurs="1" minOccurs="1" />
            <xsd:element name="reply"      type="replyType"      maxOccurs="1" minOccurs="0" />
        </xsd:sequence>
    </xsd:complexType>


    <xsd:complexType name="managedCallType">
        <xsd:sequence>
            <xsd:element name="originator"  type="origRequestType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="agent"       type="agentType"        maxOccurs="1" minOccurs="1"/>
            <xsd:element name="reply"       type="replyType"        maxOccurs="1" minOccurs="0" />
            <xsd:element name="transferSet" type="callTransferSetType"  maxOccurs="1" minOccurs="1" />
            <xsd:element name="job"         type="jobType"          maxOccurs="1" minOccurs="0"/>
        </xsd:sequence>
    </xsd:complexType>

    <xsd:complexType name="callTransferSetType">
        <xsd:sequence>
            <xsd:element name="metaDataSet" type="metaDataSetType" maxOccurs="1" minOccurs="0" />
            <xsd:element name="call" type="commandActionType" maxOccurs="1" minOccurs="1" />
        </xsd:sequence>
        <xsd:attribute name="priority" type="priorityType" use="optional" />
    </xsd:complexType>
</xsd:schema>

転送要求メッセージについて

転送要求メッセージで使用するエレメントと属性を以下のリストにまとめます。

エレメントの説明

<request>

ファイル転送要求を指定するために必要なすべてのエレメントが含まれるグループ・エレメント。

属性	説明
バージョン	Managed File Transferによって提供されるこのエレメントのバージョンを指定します。

<managedTransfer>

1 つのファイル転送または 1 つのファイル転送グループで必要なすべてのエレメントが含まれるグループ・エレメント。

<deleteScheduledTransfer>

スケジュール転送を取り消すための発信元と ID 情報が含まれるグループ・エレメント。

<managedCall>

プログラムまたは実行可能ファイルの 1 つの管理対象呼び出しで必要なすべてのエレメントが含まれるグループ・エレメント。

<ID>

保留中のスケジュール済み転送のリストから削除する転送要求を指定する固有 ID。

<originator>

要求の発信元を示すエレメントが含まれるグループ・エレメント。

<hostName>

ソース・ファイルが置かれているシステムのホスト名。

<userID>

ファイル転送を開始したユーザーの ID。

<mqmdUserID>

オプション。メッセージ記述子 (MQMD) に指定されている IBM MQ ユーザー ID。

<schedule>

ファイル転送の予定時間、繰り返し動作、および次の実行予定を示すグループ・エレメント。

<submit>

スケジュール済み転送の開始日時を示します。

属性	説明
timebase	使用するタイム・ゾーンを示します。この属性には、以下のいずれかの値を使用できます。 source - ソース・エージェントのタイム・ゾーンを使用します。 admin - コマンドを発行する管理者のタイム・ゾーンを使用します。 UTC - 協定世界時を使用します。
timezone	時間基準値に従ったタイム・ゾーンの記述

<repeat>

スケジュール済み転送の繰り返し頻度、スケジュール済み転送の繰り返し回数、およびスケジュール済み転送の繰り返しの停止日時の詳細を含むグループ・エレメント。

<frequency>

転送を繰り返す時間間隔。

属性	説明
interval	以下のいずれかで示される間隔の単位。 minutes hours days weeks months years

<expireTime>

スケジュール済み転送の繰り返しを停止する日時を指定するオプションのエレメント。このエレメントと <expireCount> エレメントは相互に排他的です。

<expireCount>

スケジュール済みファイル転送を終了するまでの実行回数を指定するオプションのエレメント。このエレメントと <expireTime> エレメントは相互に排他的です。

<sourceAgent>

ソース・ファイルがあるシステム上のエージェントの名前を示します。

属性	説明
エージェント	エージェントの名前を示します。
キュー・マネージャー	エージェントのキュー・マネージャーの名前。

<destinationAgent>

ファイルの転送先にするシステム上のエージェントの名前を示します。

属性	説明
エージェント	エージェントの名前を示します。
キュー・マネージャー	エージェントのキュー・マネージャーの名前。
hostName	エージェントのキュー・マネージャーのホスト名または IP アドレス。
portNumber	宛先エージェントのキュー・マネージャーとのクライアント接続で使用されるポート番号。
channel	宛先エージェントのキュー・マネージャーとの接続に使用されるチャネル名。

<trigger>

ファイル転送の実行のために満たす必要がある条件を指定するオプションのエレメント。

属性	説明
log	トリガー障害がログに記録されるかどうかを示すフラグ。有効な値は以下のとおりです。 yes - 失敗したトリガー転送についてのログ項目が作成されます。 no - 失敗したトリガー転送についてのログ項目が作成されません。

<fileExist>

ソース・エージェントと同じシステムにあるファイル名のコンマ区切りリストを指定します。この名前リスト内のファイルがトリガーの条件を満たす場合、転送が実行されます。このエレメントと <fileSize> エレメントは相互に排他的です。

属性	説明
comparison	名前リストに対してソース・ファイル名を評価する方法を示します。有効な値は以下のとおりです。 = 名前リスト内の少なくとも 1 つのファイル名が一致しなければなりません。 != 名前リストの少なくとも 1 つのファイルが存在しません。
値	比較タイプを示します。 exist: ファイルが存在しなければなりません

<fileSize>

ソース・エージェントと同じシステムにあるファイル名のコンマ区切りリストを指定します。この名前リスト内のファイルがトリガーの条件を満たす場合、転送が実行されます。このエレメントと <fileExist> エレメントは相互に排他的です。

属性	説明
comparison	名前リストに対してソース・ファイル名を評価する方法を示します。有効な値は以下のとおりです。 >= 名前リスト内のファイル名のいずれかが存在し、value 属性で指定した最小サイズを有しています。
値	次のいずれかの単位を持つ整数値で指定したファイル・サイズ B - バイト KB - キロバイト MB - メガバイト GB - ギガバイト (単位値の大/小文字は区別されません)

<reply>

同期ファイル転送用に生成される一時応答キューの名前を指定します (コマンド行で-wパラメーターを使用して指定します)。キューの名前は、command.properties構成ファイル内のキーdynamicQueuePrefix、またはデフォルトの WMQFTE.* によって定義されます。指定されていない場合、

属性	説明
detailed	応答メッセージで詳細な転送結果情報が必要かどうか。転送ごとに複数の応答メッセージを生成できます。有効な値は以下のとおりです。 true - 詳細な応答情報が必要です。情報の形式は、転送ログの進行メッセージ (つまり <transferSet> エレメント) に公開されるものと同じです。詳しくは、ファイル転送ログ・メッセージ・フォーマットを参照してください。詳細な応答情報は、転送ソース・エージェントの enableDetailedReplyMessages プロパティーが true に設定されている場合にのみ存在します。 false - 詳細な応答情報は不要です。デフォルト値は false です。
QMGR	応答を受け取るために一時動的キューが生成されるコマンド・キュー・マネージャーの名前。
persistent	応答キューに書き込まれるメッセージが永続メッセージかどうか。有効な値は以下のとおりです。 true - メッセージは永続メッセージです false - メッセージは永続メッセージではありません qdef - メッセージの永続性を応答キューのプロパティーで定義しますデフォルト値は false です。

<transferSet>

まとめて実行するファイル転送のグループ、またはまとめて実行する管理対象呼び出しのグループを示します。送信中は、<transferSet> は <item> エレメントが含まれるグループ・エレメントです。

属性	説明
priority	転送の優先順位。 priority は 0 から 9 までの範囲の値で、0 が最低の優先順位です。デフォルトの優先順位は 0 で、デフォルトではソース・エージェントの優先順位が転送で使用されます。

<metaDataSet>

1 つ以上のメタデータ項目を含むオプションのグループ・エレメント。

<metaData>

エージェントにより呼び出される出口点に渡される、ユーザー定義のメタデータを指定します。このエレメントは、ストリングとしてメタデータ値を含みます。

属性	説明
key	ストリングとしてのメタデータ名

<call>

呼び出すプログラムまたは実行可能ファイルを指定する <command> エレメントを含むグループ・エレメント。

< コマンド>

呼び出すプログラムまたは実行可能ファイルを指定します。このコマンドは、エージェント・コマンド・パスに存在していなければなりません。詳しくは、拡張エージェント・プロパティーを参照してください。このエレメントには、オプションの <argument> エレメントを含めることができます。

属性	説明
名前	コマンドの名前.
successRC	このコマンドによって返される、コマンドの成功を示す戻りコード。デフォルトは 0 です。
retryCount	コマンドが失敗したときに、コマンドを再試行する回数。
retryWait	コマンドを次に再試行するまで待機する時間 (秒数)。
タイプ	呼び出すプログラムのタイプ。有効な値は antscript、jcl、または executable です。

<argument>

コマンドに渡す引数を指定します。

<item>

ソースおよび宛先のファイル名と位置を示すエレメントが含まれるグループ・エレメント。

属性	説明
mode	転送モードがバイナリーであるかテキストであるかを示します。
checksumMethod	デジタル署名を作成するためにメッセージ・ダイジェストを生成するハッシュ・アルゴリズムのタイプを示します。有効な値は MD5 または none です。

<source>

ソース・システム上のファイルと、転送完了後にそれらのファイルを除去するかどうかを指定するグループ・エレメント

属性	説明
recursive	<source> エレメントがディレクトリーであるかそこにワイルドカード文字が含まれる場合にファイルが再帰的にサブディレクトリーに転送されることを指定します。
disposition	<source> がその宛先に正常に転送されたときに <source> エレメントに対して取るアクションを指定します。有効な値は以下のとおりです。 leave - ソース・ファイルは変更されません。 delete - ソース・ファイルは、それが正常に転送された後にソース・システムから削除されます。

<file>

転送ソースを指定します。 [UNIX、Linux、Windows、IBM i]

Multiplatforms の場合、転送ソースはファイル名またはディレクトリー名にすることができます。z/OS プラットフォームでは、ファイル名、ディレクトリー名、データ・セット名、または PDS 名を転送のソースにすることができます。ご使用のオペレーティング・システムと整合するフォーマットの完全修飾パスを使用します (例えば C:/from/here.txt)。ファイル URI は使用しないでください。

属性	説明
alias	ソース・ファイルの別名を指定します。この別名は、転送で指定されているディレクトリー・パスを除外したソース・ファイルの名前です。
EOL	テキスト転送の行末マーカーを指定します。有効な値は以下のとおりです。 LF - 改行文字のみ CRLF - 復帰と改行の文字シーケンス
encoding	テキスト・ファイル転送のソース・ファイルのエンコード。
delimiter	レコード単位のソース・ファイル ( z/OS® データ・セットなど) のレコード間に組み込まれる区切り文字を指定します。区切り文字の値は、00-FF の範囲にある 2 桁の 16 進数に接頭部 x を付けた形式で指定してください。例えば、 x12 または x03,x7F などです。
delimiterType	宛先ファイルで個々のメッセージ・データの後に組み込む区切り文字のタイプを指定します。有効な値は以下のとおりです。 binary - 16 進数区切り文字この属性は、バージョン 7.0.4.1 の機能が使用可能に設定されている場合のみ使用できます。
delimiterPosition	レコード単位ソース・ファイル・レコードを通常のファイルに書き込むときに、区切り文字を挿入する位置を指定します。有効な値は以下のとおりです。 prefix - 区切り文字は、宛先ファイルの各ソース・レコード単位ファイル・レコードのデータの前に挿入されます。 postfix - 区切り文字は、宛先ファイルの、ソース・レコード単位の各ファイル・レコードからのデータの後に挿入されます。
includeDelimiterInFile	レコード単位ソース・ファイルでレコードとレコードの間に区切り文字を組み込むかどうかを指定します。
keepTrailingSpaces	テキスト・モード転送の一部として固定長形式のデータ・セットから読み取られるソース・レコードの末尾スペースを保持するかどうかを指定します。デフォルトでは、末尾スペースは削除されます。有効な値は以下のとおりです。 true - テキスト・モード転送の一部として固定長形式のデータ・セットから読み取られるソース・レコードの末尾スペースを保持します false - テキスト・モード転送の一部として固定長形式のデータ・セットから読み取られるソース・レコードから末尾スペースを削除します

<queue>

<source> エレメントと一緒に使用する場合には、転送元のキューの名前を指定します。そのキューは、ソース・エージェントのキュー・マネージャーに存在していなければなりません。 QUEUEの形式を使用します。キュー・マネージャー名を組み込むことはできません。ソース・エージェントのキュー・マネージャーに存在しているキューを指定する必要があります。 <queue> エレメントを <destination> エレメント内で使用した場合、<source> エレメント内では使用できません。

属性	説明
useGroups	ソース待ち行列上のすべてのメッセージを転送するか, あるいは完全なメッセージ・グループを転送するか, あるいはグループに入っていない個々のメッセージを転送するかを指定します。有効な値は以下のとおりです。 true-メッセージの最初の完全なグループのみ、またはグループに含まれない最初の個々のメッセージのみを転送します。 false - ソース・キューにあるすべてのメッセージを転送します
groupId	ソース・キューから読み取る完全なメッセージ・グループのグループ ID、またはグループに含まれない個々のメッセージのメッセージ ID を指定します。この属性は、useGroups 属性の値が true の場合のみ有効です。
messageInGroup	groupId 属性の ID がメッセージ・グループを表すか、グループに含まれない個々のメッセージを表すかを指定します。この属性は、useGroups 属性の値が true の場合のみ有効です。有効な値は以下のとおりです。 true- groupId 属性の ID はグループ ID を表します。 false- groupId 属性の ID はメッセージ ID を表します。
delimiterType	宛先ファイルで個々のメッセージ・データの後に組み込む区切り文字のタイプを指定します。有効な値は以下のとおりです。 text - テキスト区切り文字または Java リテラル区切り文字 binary - 16 進数区切り文字
delimiter	宛先ファイルで個々のメッセージ・データ間に組み込む区切り文字を指定します。
delimiterPosition	宛先ファイルで、区切り文字を個々のメッセージ・データの前に組み込むか、後に組み込むかを指定します。有効な値は以下のとおりです。 prefix - 区切り文字はデータの前に組み込まれます postfix - 区切り文字はデータの後ろに組み込まれます。
encoding	ソース・キューのエンコード方式を指定します。
waitTime	ソース・エージェントが以下のいずれかの状態の発生を待つ時間を秒単位で指定します。キューがもともと空だったか、後で空になった場合は、ソース・キューにメッセージが出現する、という状態 useGroups 属性が true に設定されている場合は、完全に揃ったグループがソース・キューに出現する、という状態 waitTime 値の設定については、メッセージからファイルへの転送の待機時間の指定に関するガイダンスを参照してください。

<destination>

宛先と、宛先エージェントにファイルが存在する場合の動作を指定するグループ・エレメント。

<file> と <queue> のいずれかを destination の子エレメントとして指定できます。

属性	説明
タイプ	宛先のタイプ。有効な値は以下のとおりです。 file - ファイルを宛先として指定します directory - ディレクトリーを宛先として指定します dataset -宛先として z/OS データ・セットを指定します pds -宛先として z/OS 区分データ・セットを指定します。 queue -宛先として IBM MQ キューを指定します。 filespace - 宛先としてファイル・スペースを指定します値 queue が有効なのは、<destination> エレメントに子エレメント <queue> がある場合に限られます。値 filespace が有効なのは、<destination> エレメントに子エレメント <filespace> がある場合に限られます。その他の値は、 <destination> エレメントに子エレメント <file> がある場合に限り有効です。
exist	宛先システムに宛先ファイルが存在する場合に取る処置を示します。有効な値は以下のとおりです。 error - エラーを報告し、ファイルは転送されません。 overwrite - 既存の宛先ファイルを上書きします。 <destination> エレメントに子エレメント <queue> または <filespace> がある場合は、この属性が無効になります。

属性

説明

タイプ

宛先のタイプ。有効な値は以下のとおりです。

file - ファイルを宛先として指定します
directory - ディレクトリーを宛先として指定します
dataset -宛先として z/OS データ・セットを指定します
pds -宛先として z/OS 区分データ・セットを指定します。
queue -宛先として IBM MQ キューを指定します。
filespace - 宛先としてファイル・スペースを指定します

値 queue が有効なのは、<destination> エレメントに子エレメント <queue> がある場合に限られます。

値 filespace が有効なのは、<destination> エレメントに子エレメント <filespace> がある場合に限られます。

その他の値は、 <destination> エレメントに子エレメント <file> がある場合に限り有効です。

exist

宛先システムに宛先ファイルが存在する場合に取る処置を示します。有効な値は以下のとおりです。

error - エラーを報告し、ファイルは転送されません。
overwrite - 既存の宛先ファイルを上書きします。

<destination> エレメントに子エレメント <queue> または <filespace> がある場合は、この属性が無効になります。

<file>

前述の <destination> エレメントの追加設定を指定します。ご使用のオペレーティング・システムと整合した形式の完全修飾パス (例: C:/from/here.txt) を使用してください。ファイル URI は使用しないでください。

属性	説明
alias	<destination> ファイルの別名を指定します。この別名は、転送で指定されているディレクトリー・パスを除外したソース・ファイルの名前です。
encoding	テキスト・ファイル転送の <destination> ファイルのエンコード。
EOL	テキスト転送の行末マーカーを指定します。有効な値は以下のとおりです。 LF - 改行文字のみ CRLF - 復帰と改行の文字シーケンス
truncateRecords	オプション。 LRECL データ・セット属性よりも長い <destination> レコードが切り捨てられることを指定します。 true - それらのレコードは切り捨てられます false - それらのレコードは折り返されますデフォルト設定は false です。

<queue>

<destination> エレメントと一緒に使用する場合には、転送先のキューの名前を指定します。そのキューは、宛先エージェントのキュー・マネージャーに接続しているいずれかのキュー・マネージャーに存在していなければなりません。 QUEUE@QM というフォーマットを使用してください (QUEUE は、メッセージの書き込み先のキューの名前、QM は、そのキューが存在しているキュー・マネージャーです)。 <queue> エレメントを <source> エレメント内で使用した場合、<destination> エレメント内では使用できません。

属性	説明
delimiter	ファイルを複数のメッセージに分割するための区切り文字。
delimiterType	区切り文字のタイプを指定します。有効な値は以下のとおりです。 text - Java 正規表現 binary - 16 進数バイトのシーケンス size - バイト数、キビバイト数、メビバイト数のいずれか。例えば、1 B、1 K、または 1 M のようにします。
delimiterPosition	区切り文字が個々のメッセージ内で、データの前に組み込まれると想定されているか、データの後ろに組み込まれると想定されているかを指定します。有効なオプションは以下のとおりです。 prefix - 区切り文字はデータの前にあると想定されています postfix - 区切り文字はデータの後ろにあると想定されています
includeDelimiterInMessage	ファイルを複数のメッセージに分割するために使用した区切り文字をそれらのメッセージの末尾に組み込むかどうかを指定するブール値。
encoding	宛先キューのエンコード方式を指定します。
persistent	メッセージが永続メッセージであるかどうかを指定します。有効な値は以下のとおりです。 true - メッセージは永続メッセージです false - メッセージは永続メッセージではありません qdef - メッセージの永続性の値を宛先キューの設定で定義します
setMqProps	ファイル内の最初のメッセージに IBM MQ メッセージ・プロパティーを設定するかどうか、およびエラー発生時にキューにメッセージを書き込むかどうかを指定するブール値。
unrecognisedCodePage	宛先キュー・マネージャーがデータのコード・ページを認識できない場合に、テキスト・モードの転送が失敗するか、それとも変換が実行されるかを指定します。有効な値は以下のとおりです。 fail - 転送は失敗を報告します。 binary-データは宛先コード・ページに変換され、データの形式を記述する IBM MQ メッセージ・ヘッダーは MQFMT_NONE に設定されます。デフォルトの動作は fail です。

<filespace>

転送先のファイル・スペースの名前を指定するグループ・エレメント。

<name>

<filespace> エレメントと一緒に使用する場合には、ファイル・スペースの名前を値として指定します。

<preSourceCall>

転送のソースで転送の開始前に呼び出すコマンドを指定するグループ・エレメント。

<postSourceCall>

転送のソースで転送の完了後に呼び出すコマンドを指定するグループ・エレメント。

<preDestinationCall>

転送の宛先で転送の開始前に呼び出すコマンドを指定するグループ・エレメント。

<postDestinationCall>

転送の宛先で転送の完了後に呼び出すコマンドを指定するグループ・エレメント。

< コマンド>

<preSourceCall>、<postSourceCall>、<preDestinationCall>、<postDestinationCall> のいずれかのエレメントと一緒に使用する場合には、呼び出すコマンドを指定します。このコマンドは、エージェント・コマンド・パスに存在していなければなりません。詳しくは、拡張エージェント・プロパティーを参照してください。

属性	説明
名前	実行するコマンドの名前。
successRC	コマンドが正常に実行された場合に返される戻りコード。

<argument>

<command> エレメントと一緒に使用する場合には、コマンドに渡す引数を指定します。 <command> エレメントの中に <argument> エレメントをいくつでも記述できます。

<job>

転送仕様全体のジョブ情報を含むオプションのグループ・エレメント。<job> は、転送が開始されたときに、ログ・メッセージに追加されるユーザー定義ジョブ名 ID です。この < job> エレメントは、転送ログ・メッセージに表示される < job> エレメントと同じです。これについては、ファイル転送ログ・メッセージ・フォーマットのトピックで説明されています。

<name>

<job> エレメントと一緒に使用する場合には、ジョブの名前を値として指定します。

<transferSpecifications>

複数の転送グループの <item> エレメントを含むグループ・エレメント。このエレメントの使用方法について詳しくは、転送定義ファイルの使用を参照してください。

<cancel>

進行中のファイル転送を取り消すために必要なすべてのエレメントが含まれるグループ・エレメント。

属性	説明
バージョン	Managed File Transferによって提供されるこのエレメントのバージョンを指定します。

<transfer>

<cancel> エレメントと一緒に使用する場合、このエレメントの値は取り消す転送要求 ID を示します。

<job>

ジョブ情報が入ったグループ・エレメント。

<jobName>

論理ジョブ ID を指定します。

ファイル転送取り消しメッセージ・フォーマット

ファイル転送要求は、特定のエージェントに対する転送を識別する 48 文字の ID を返します。この ID は転送を取り消すために使用されます。

転送取り消しメッセージについて

転送取り消しメッセージで使用されるエレメントと属性について説明します。

<cancel>

進行中のファイル転送を取り消すために必要なすべてのエレメントが含まれるグループ・エレメント。

属性	説明
バージョン	Managed File Transferによって提供されるこのエレメントのバージョンを指定します。

<originator>

要求の発信元を示すエレメントが含まれるグループ・エレメント。

<hostName>

ソース・ファイルが置かれているシステムのホスト名。

<userID>

ファイル転送を開始したユーザーの ID。

<mqmdUserID>

オプション。メッセージ記述子 (MQMD) に指定されている IBM MQ ユーザー ID。

<transfer>

<cancel> エレメントと一緒に使用する場合、このエレメントの値は取り消す転送要求 ID を示します。

<job>

オプション。ジョブ情報が入ったグループ・エレメント。

<jobName>

論理ジョブ ID を指定します。

例

このスキーマに準拠する XML メッセージの例が、以下の要求用に提供されています。