転送の応答本体の属性

qmgrName

ソース・システム上のキュー・マネージャーの名前

name (デフォルト)

ソース・システム上のエージェントの名前。

qmgrName

宛先システム上のキュー・マネージャーの名前

name (デフォルト)

宛先システム上のエージェントの名前。

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

host (デフォルト)

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

userID (デフォルト)

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

mqmdUserId

メッセージ記述子 (MQMD) に指定された IBM® MQ ユーザー ID。

まとめて実行するファイル転送のグループを示します。 送信中、transferSet は item オブジェクトの配列を格納するグループ・エレメントです。

項目

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

bytesSent

合計送信バイト数

startTime

一連の転送が開始した時刻を、UTC 形式の表記で記録します

source

file エレメントまたは queue エレメント、およびソース・システム上のファイルの checksum エレメントを含むグループ・エレメント。

destination

file エレメントまたは queue エレメントと、宛先システムのファイルに関する checksum エレメントを格納するグループ・エレメント

file と queue のいずれかを宛先の子エレメントとして記述します。

状況

transferSet 内にある特定の項目オブジェクトについての転送の状態

mode

転送モードがバイナリーであるかテキストであるかを示します。

recursive

ソース・エレメントがディレクトリーであるかそこにワイルドカード文字が含まれる場合に、ファイルがサブディレクトリーで再帰的に転送されることを示します。

disposition

ソースがその宛先に正常に転送されたときに、ソース・エレメントに対して取るアクションを示します。 有効なオプションは以下のとおりです。

leave

ソース・ファイルは変更されません

削除

ソース・ファイルは、それが正常に転送された後にソース・システムから削除されます。

ファイル

転送されたファイルの絶対パスを示します。 完全修飾パスは、ご使用のオペレーティング・システムと整合した形式です (例: C:/from/here.txt)。 ファイル URI は使用されないことに注意してください。

有効なオプションは以下のとおりです。

lastModified

ファイルの最終変更日時 (UTC 形式)

size

ファイル・サイズ

path

ファイルのパスの場所

encoding

テキスト・ファイル転送のエンコード

endOfLine

行末マーカーを指定します。 許可されている値は以下のとおりです。

• LF - 改行文字のみ
• CRLF - 復帰と改行の文字シーケンス

checksum

チェックサムが実行されなかった場合、checksum は表示されません。

デジタル署名を作成するためにメッセージ・ダイジェストを生成したハッシュ・アルゴリズムのタイプを示します。 Managed File Transfer は、メッセージ・ダイジェスト・アルゴリズム 5 (md5) のみをサポートします。 転送されたファイルの完全性が損なわれていないことを確認する方法として、チェックサムが備えられています。

有効なオプションは次のとおりです。

メソッド (method)

checksum を生成する方式

値

生成されたチェックサム値

タイプ

ソースのタイプを示します。 有効なオプションは以下のとおりです。

キュー

IBM MQ キューをソースとして指定します。

ファイル

ソースがファイルまたはディレクトリーの場合、ソースがファイルであることを示します

dataset

z/OS® データ・セットをソースとして指定します。

dataset

z/OS データ・セットを指定します。 有効なオプションは以下のとおりです。

属性

データ・セットに関連した属性

size

ファイル・サイズ

名前

データ・セットの名前

転送メッセージの読み取り元のキュー (ソース・エージェントのキュー・マネージャーに存在するキュー) の名前を示します。

messageCount

キューから読み取られたメッセージの数

名前

キューの名前とキュー・マネージャー名。次のようになります

queueName@queueManagerName

setMqProperties

ファイル内の最初のメッセージに IBM MQ メッセージ・プロパティーを設定するかどうか、およびエラー発生時にキューにメッセージを書き込むかどうかを指定するブール演算子。

actionIfExists

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

エラー

エラーを報告し、ファイルは転送されません

overwrite

既存の宛先ファイルを上書きします

ファイル

転送されたファイルの絶対パスを示します。 完全修飾パスは、ご使用のオペレーティング・システムと整合した形式です (例: C:/from/here.txt)。 ファイル URI は使用されないことに注意してください。

有効なオプションは以下のとおりです。

lastModified

ファイルの最終変更日時 (UTC 形式)

size

ファイル・サイズ

path

ファイルのパスの場所

checksum

チェックサムが実行されなかった場合、checksum は表示されません。

デジタル署名を作成するためにメッセージ・ダイジェストを生成したハッシュ・アルゴリズムのタイプを示します。 Managed File Transfer は、メッセージ・ダイジェスト・アルゴリズム 5 (md5) のみをサポートします。 転送されたファイルの完全性が損なわれていないことを確認する方法として、チェックサムが備えられています。

有効なオプションは次のとおりです。

メソッド (method)

checksum を生成する方式

値

生成されたチェックサム値

タイプ

ソースのタイプを示します。 有効なオプションは以下のとおりです。

キュー

IBM MQ キューをソースとして指定します。

ファイル

ソースがファイルまたはディレクトリーの場合、ソースがファイルであることを示します

dataset

z/OS データ・セットをソースとして指定します。

dataset

z/OS データ・セットを指定します。 有効なオプションは以下のとおりです。

属性

データ・セットに関連した属性

size

ファイル・サイズ

名前

データ・セットの名前

転送先のキュー (宛先エージェント・キュー・マネージャーに接続しているいずれかのキュー・マネージャーに存在するキュー) の名前を示します。

messageCount

キューに書き込まれたメッセージの数

messageLength

キューに書き込まれたメッセージの長さ

名前

キューの名前とキュー・マネージャー名。次のようになります

queueName@queueManagerName

messageOrGroupId

転送要求でファイルが複数のメッセージに分割されるように指定されていない場合、この属性の値は、キューに書き込まれるメッセージの IBM MQ メッセージ ID です。

転送要求でファイルが複数のメッセージに分割されるように指定されている場合、この属性の値は、キューに書き込まれるメッセージの IBM MQ グループ ID です。

delimiter

delimiterType.size の場合は、1K などです

delimiterType.binary の場合は、12 などです

delimiter が空ストリング (つまり “") の場合、転送の開始中にフィールドは設定されません

delimiterType

メッセージの分割に使用されている区切り文字のタイプ。 有効な値は以下のとおりです。

size

サイズによる分割

binary

区切り文字のバイト数による分割

delimiterType が空ストリング (つまり “") の場合、転送の開始中にフィールドは設定されません

includeDelimiterInMessage

delimiterType.binaryにのみ有効です。

このオプションは true または false にすることができます。 以下に例を示します。

"includeDelimiterInMessage" : true

delimiterPosition

delimiterType.binaryにのみ有効です。 有効な値は以下のとおりです。

"prefix"

各メッセージの前

"postfix"

各メッセージの後

delimiterPosition が空ストリング (つまり “") の場合、転送の開始中にフィールドは設定されません

delimiterType が size の場合、includeDelimiterInMesage と delimiterPosition はどちらも JSON に組み込まれないことに注意してください。

転送の状況情報のグループ・エレメント。

state (デフォルト)

転送の状態。 以下のいずれかを値にすることができます。

• 開始済み
• inProgress
• 成功しました。
• 失敗
• partiallySuccessful
• 取り消し済み
• malformed - ファイル転送の要求メッセージの内容を解釈できなかったことを示します
• notAuthorized
• deleted
• inProgressWithFailures
• inProgressWithWarnings

lastStatusUpdate

転送状況が収集された最近の時刻を、UTC 形式で表記します

description

状況の完了についてのより詳しい説明。 以下のいずれであるかを示します。

• 一部成功
• 成功
• 失敗、または
• その他の関連情報

転送の統計情報に関するグループ・エレメント (使用可能な場合)。

startTime (デフォルト)

転送を実行依頼した時刻 (UTC 形式)

retryCount

転送がリカバリー状態に入り、エージェントによって再試行された回数。

IBM MQ ネットワーク・エラーのため、またはエージェントが一定期間データまたは確認応答メッセージを受信していないために、ソース・エージェントと宛先エージェントが通信を失ったために、転送がリカバリー状態になることがあります。

この期間は、エージェント・プロパティー transferAckTimeout および transferAckTimeoutRetries によって決定されます。

numberOfFilefailures (デフォルト)

transferSet に含まれているファイルのうち、正常に転送できなかったファイルの数

numberOfFileWarnings (デフォルト)

transferSet に含まれているファイルのうち、転送時に警告が生成されたが、それ以外の点では正常に転送されたファイルの数

numberOfFiles (デフォルト)

この数値は、現在の転送要求に含まれるファイルの総数を示します。 この数値には、転送操作のために検討されたすべてのファイルが含まれます

endTime (デフォルト)

転送が完了した時刻。 このフィールドは、転送が完了したときにのみ更新されます。

転送が他のいずれかの状態である場合、“endTime" は空ストリングとなります

numberOfFileSuccesses (デフォルト)

正常に転送されたファイルの数