fteCreateTransfer (新規ファイル転送の開始)

fteCreateTransfer コマンドは、コマンド行から新規のファイル転送を作成して開始します。 このコマンドは、ファイル転送の即時開始、将来の日時におけるファイル転送のスケジュール、ファイル転送の 1 回以上の繰り返し、および特定の条件に基づくファイル転送の起動を実行できます。

目的

fteCreateTransfer コマンドを使用して、 Managed File Transfer エージェントから新規ファイル転送を作成して開始します。
注: ファイル転送は、同じ Managed File Transfer トポロジー内のエージェント間でのみ実行できます。

ファイルを転送する方法については、 ファイル転送のガイドラインを参照してください。z/OS プラットフォームの場合は、テキスト・ファイル、データ・セット、および世代別データ・グループ (GDG) を転送できます。

fteCreateTransfer コマンドは、 IBM® MQ ネットワークに接続してからソース・エージェント・キュー・マネージャーに経路指定できる任意のシステムから実行できます。 具体的には、このコマンドを実行するには、 Managed File Transfer コンポーネント (サービスまたはエージェントのいずれか) をこのシステムにインストールし、 IBM MQ ネットワークと通信するようにこのシステム上の Managed File Transfer コンポーネントを構成する必要があります。

このコマンドは、command.properties tというプロパティー・ファイルを使用して、IBM MQ ネットワークに接続します。 command.properties ファイルにプロパティー情報が含まれていない場合、ローカル・システムのデフォルト・キュー・マネージャーに対してバインディング・モードで接続されます。 command.properties ファイルが存在しない場合、エラーが生成されます。 詳しくは、 MFT command.properties ファイルを参照してください。

1 つのファイル転送で複数のソース・ファイルを指定することができますが、それらのソース・ファイルの起点は 1 つのソース・エージェントでなければならず、終点も 1 つの宛先エージェントでなければなりません。 1 つの転送で、1 つのソース・ファイルを同じエージェントまたは複数の異なるエージェントに存在する複数の宛先ファイルに転送する操作は、サポートされていません。 Ant スクリプトを使用して、同じソース・ファイルを 1 つ以上のエージェントの複数の宛先に送信できます。 詳しくは、 MFTでの Apache Ant の使用を参照してください。

特殊文字

特殊文字が含まれているパラメーターを使用する場合には、予期しない形で特殊文字がコマンド・シェルで解釈されないように注意してください。 例えば、単一引用符を含む完全修飾データ・セット名およびアスタリスク文字を含むソース指定は、転送要求で渡されずに、コマンド・シェルで解釈されてしまう可能性があります。 文字がコマンド・シェルによって解釈される動作を回避するには、パラメーター全体を二重引用符で囲むか、またはコマンド・シェルのエスケープ・シーケンスを使用して特殊文字をエスケープします。

相対パス

fteCreateTransfer コマンドは、 相対ファイル・パスの使用をサポートします。 次のプラットフォームの場合、デフォルトでは、エージェントを実行しているユーザーのホーム・ディレクトリーからの相対パスとみなされます。
  • [UNIX、Linux、Windows、IBM i]Multiplatforms
  • [z/OS]z/OS® UNIX System Services
パス名が相対パスと評価されるディレクトリーを変更するには、agent.properties ファイルに transferRoot プロパティーを設定します。 このファイルは MQ_DATA_PATH/mqft/config/coordination_qmgr/agents/agent_name ディレクトリーにあります。 次の行をファイルに追加します。
transferRoot=directory_name

[Windows]例えば、 C:\TransferRootC:\\TransferRoot または C:/TransferRootと指定します。

[z/OS] z/OSでは、デフォルトで、エージェントを実行しているユーザー名が、高位修飾子接頭部として、完全修飾されていないデータ・セット仕様に追加されます。 例えば、//ABC.DEFです。 接頭部としてデータ・セット名に追加される 値を変更するには、transferRootHLQ プロパティーを agent.properties ファイルで設定します。 このファイルは MQ_DATA_PATH/mqft/config/coordination_qmgr/agents/agent_name ディレクトリーにあります。 次の行をファイルに追加します。
transferRootHLQ=prepend_value
[z/OS]ただし、 z/OS システム上の Connect:Direct® ノードに関係する転送の場合、データ・セットの指定は完全修飾名として解釈されます。 データ・セット名に高位修飾子が追加されることはありません。

Syntax

fteCreateTransfer

Read syntax diagramSkip visual syntax diagram fteCreateTransfer -sa source_agent_name -smsource_agent_qmgr_name -da destination_agent_name -dmdestination_agent_qmgr_name-gttransfer_template_file_path-ssschedule_start_time-tbADMINSOURCEUTC-oiminuteshoursdaysweeksmonthsyears-ofoccurrence_frequency-ococcurrence_count-esschedule_end_time-trcondition,namelist-tlyesno-cschecksumMD5none-mdname-value_pairs-jnjob_name-prtransfer_priority-wtimeout-rtrecovery_timeout-presrcpre_source_call-predstpre_destination_call-postsrcpost_source_call-postdstpost_destination_call-pconfiguration_options-tdtransfer_definition_file-dfdestination_file-dddestination_directory-dsdestination_sequential_data_set-dpdestination_partitioned_data_set-dqdestination_queue-dqppersistent-qmpbooleanFile splitting options-dedestination_file_behavior-ttransfer_typebinarytext-dcedestination_character_encoding,noswaplfnl-dledestination_line_ending-dtr-dfaattributes-sdsource_file_disposition-r-scesource_character_encoding,noswaplfnl-srdbdelimiter-srdpprefixpostfix-skeep-sq-sqgi-sqdttext_delimiter-sqdpprefixpostfix-sqdbhexadecimal_delimiter-sqdpprefixpostfix-sqwtwait_time
File splitting options
Read syntax diagramSkip visual syntax diagram-qsmessage_size-dqdbhexadecimal_delimiter-qi-dqdpprefixpostfix-dqdtpattern_delimiter-qi-dqdpprefixpostfix
Parameters for MQ security
Read syntax diagramSkip visual syntax diagram-mquseriduser_id-nolpw-mqpasswordpassword-nolpw
Read syntax diagramSkip visual syntax diagram source_specification

 エージェント指定のパラメーター

- ソースエージェント名
必須。 ソース・ファイルの転送元のエージェントの名前。

[z/OS]プロトコル・ブリッジ・エージェントをソース・エージェントとして指定する場合は、データ・セットをソース・ファイルとして指定することはできません。

-tdパラメーターを指定し、転送に使用するソース・エージェントが転送定義ファイルに含まれている場合は、-saパラメーターを指定しないでください。

-sm source_agent_qmgr_name
オプション。 ソース・エージェントの接続先のキュー・マネージャーの名前。

-smパラメーターを指定しない場合、使用されるキュー・マネージャーは、ソース・エージェント名に基づく、使用中の構成オプションのセットによって決定されます。 ソース・エージェントの agent.properties ファイルが 見つからなかった場合、ファイル転送は失敗します。

-da 宛先エージェント名
必須。 ソース・ファイルの転送先のエージェントの名前。

-tdパラメーターを指定し、転送に使用する宛先エージェントが転送定義ファイルに含まれている場合は、-daパラメーターを指定しないでください。

-dm destination_agent_qmgr_name。
オプション。 宛先エージェントの接続先のキュー・マネージャーの名前。

-dmパラメーターを指定しない場合、使用されるキュー・マネージャーは、宛先エージェント名に基づいて、使用中の構成オプションのセットによって決定されます。 宛先エージェントの agent.properties ファイルが 見つからなかった場合、ファイル転送は失敗します。

 転送テンプレートの生成に関するパラメーター

-gt transfer_template_file_path
オプション。 転送テンプレート XML メッセージを生成して、このメッセージをファイルに書き込みます。 このパラメーターを指定すると、転送要求は Managed File Transferに送信されません。 その代わりに、転送要求メッセージの内容が指定された XML 文書に書き込まれます。 その後、この XML 文書を使用して、リソースをモニターするタスクを定義できます。 リソースモニターの作成方法については、fteCreateMonitorコマンドを参照してください。 このパラメーターを指定しない場合、デフォルトの動作が行われ、実際に転送要求が実行されます。

このパラメーターの入力として、XML 出力ファイルの絶対パスおよび名前を指定する必要があります。例えば、C:\templates\transfer_reports.xml のように指定します。

[z/OS] z/OSでは、 z/OS UNIX System Services上の UNIX ファイルに転送テンプレート文書を保管する必要があります。 z/OS の順次ファイルまたは PDS メンバーに、 転送テンプレート文書を保管することはできません。

[IBM i] IBM iでは、転送テンプレート文書を統合ファイル・システムに保管する必要があります。

-gt パラメーターを 使用して作成した転送テンプレート XML メッセージは、 fteCreateTemplate コマンドを使用して作成した転送と同じではありません。 つまり、この 2 つの異なるタイプのテンプレートを交換して使用することはできません。

注: -gt パラメーターを指定して fteCreateTransfer コマンドを実行して転送テンプレート XML 文書を生成し、その転送テンプレート XML 文書を -td パラメーターを使用して fteCreateTransfer コマンドへの入力として指定する場合は、 -td オプションと相互に排他的なパラメーターを指定して転送テンプレート XML 文書が生成されていることを確認する必要があります。
-tdオプションと同時に指定できないパラメーターは、以下のとおりです。
  • -dd destination_directory
  • ソース・パス
  • -df destination_file
  • -cs checksum
  • -de destination_file_behavior
  • -dq destination_queue
  • -t transfer_type
  • -sd source_file_disposition

例えば、 fteCreateTransfer コマンドで -td パラメーターと -t パラメーター (転送がバイナリー転送かテキスト転送かを示す) の両方を指定することはできません。 つまり、転送テンプレート XML 文書をコマンドに渡し、転送がテキスト転送であることを指定する場合は、-gtおよび-tテキスト・パラメーターを指定して XML 文書を作成する必要があります。

このパラメーターは、 REST APIではサポートされていません。

 転送のスケジューリングに関するパラメーター

-ss スケジュール開始時間
オプション。 スケジュール済み転送を実行する日時を示します。 日時の指定には、次のいずれかの形式を使用します。 24 時間クロックを使用して、時刻を指定します。
yyyy-MM-ddThh:mm

hh:mm

スケジュール済みファイル転送は、転送に影響する可能性がある問題がなければ、スケジュール開始時刻から 1 分以内に開始します。 例えば、スケジュール済み転送の開始を妨げるネットワークまたはエージェントの問題があるかもしれません。

-tb
オプション。 スケジュール済みファイル転送で使用する時間基準を示します。 つまり、システム時刻を使用するか、協定世界時 (UTC) を使用するかを示します。 このパラメーターは、-ssパラメーターと一緒にのみ使用する必要があります。 以下のいずれかのオプションを指定します。
admin
転送の開始と終了に使用される時刻は、転送が開始されたシステムの時間と日付に基づきます。 例えば、 fteCreateTransfer コマンドまたは IBM MQ Explorer で転送が開始されたマシンの日時がこれに該当する可能性があります。
注: REST API を使用して転送が開始されると、 管理オプションはIBM MQ Web Server が実行されているマシンの日時に対応付けられます。
source
スケジュール済み転送で使用する開始および終了時刻は、ソース・エージェントがあるシステムの日時を基準とします。
UTC
スケジュール済み転送で使用する開始および終了時刻は、協定世界時 (UTC) を基準とします。
-oi
オプション。 スケジュール済み転送が発生する間隔を示します。 このパラメーターは、-ssパラメーターと一緒にのみ使用する必要があります。 以下のいずれかのオプションを指定します。
minutes
hours
days
weeks
months
years
- 発生頻度の
オプション。 スケジュール済み転送が発生する頻度を示します。 例えば、5 週ごと、2 カ月ごとなどです。 このパラメーターは、-oiパラメーターおよび-ssパラメーターと一緒にのみ指定する必要があります。 このパラメーターを指定しない場合、デフォルト値の 1 が使用されます。
- 発生回数
オプション。 このスケジュール済み転送が発生する回数を示します。 この発生数になると、スケジュール済み転送は削除されます。

このパラメーターは、-oiパラメーターおよび-ssパラメーターと一緒にのみ指定してください。

-ocパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-esパラメーターを指定することはできません。

無期限に繰り返す転送を作成するには、-ocパラメーターと-esパラメーターの両方を省略できます。

- スケジュール終了時刻
オプション。 スケジュール済み繰り返し転送が終了する日時。

このパラメーターは、-oiパラメーターおよび-ssパラメーターと一緒にのみ指定する必要があります。

-esパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-ocパラメーターを指定することはできません。

無期限に繰り返す転送を作成するには、-esパラメーターと-ocパラメーターの両方を省略できます。

終了日時の指定には、次のいずれかの形式を使用します。 24 時間クロックを使用して、時刻を指定します。
yyyy-MM-ddThh:mm

hh:mm

 転送のトリガーに関するパラメーター

-tr
オプション。 このファイル転送が実行されるために満たす必要がある条件を指定します。 ソース・エージェントにおいて条件が満たされなかった場合、ファイル転送は廃棄され、転送は行われません。 次のフォーマットで指定します。
condition,namelist
ここで、 conditionは以下の値のいずれかである:
file=exist
名前リストの少なくとも 1 つのファイルが存在します。 つまり、namelistに含まれるファイルのどれかが存在すれば、その条件は真となる。
file!=exist
名前リストの少なくとも 1 つのファイルが存在しません。 つまり、 名前リストのいずれかの ファイルが存在しない場合、この条件は TRUE となります。
filesize> =サイズ
名前リストの少なくとも 1 つのファイルが存在し、size で指定した最小サイズ以上です。 size は、オプションで KB、MB、または GB のサイズ単位がある整数です。 例: filesize">"=10KB。 サイズの単位が指定されなかった場合は、 バイト単位が想定されます。 すべてのオペレーティング・システムで、コマンドラインで filesize オプションを指定するときは、この例に示すように、大なり記号(>)をダブルクォーテーションで囲む必要がある。

さらに、namelist はソース・エージェントと同じシステムにあるファイル名のコンマ区切りリストです。 ご使用のオペレーティング・システムによっては、 スペースが含まれる名前リストでパス名またはファイル名を使用する場合、 パス名とファイル名を二重引用符で囲む必要があることがあります。

-trパラメーターを複数回使用して、複数のトリガー条件を指定できます。 ただしその場合、ファイル転送が実行されるには、それぞれすべてのトリガー条件が満たされることが必要です。
注: トリガー条件が真であるリソースを継続的にモニターするには、 リソース・モニターを使用することを強くお勧めします。 コマンドを使用してリソースモニタを作成することができます。 fteCreateMonitor コマンドを使用します。

以下の例では、 ファイル file1.doc が以下の条件で AGENT1 から AGENT2 へ転送されます。ファイルA.txtたは ファイル e B.txt のいずれか、あるいは両方のファイルが AGENT1 に存在し、かつ ファイル A.txt またはファイル B.txt のいずれか、または 両方のファイルが 1 GB 以上の場合

fteCreateTransfer -sa AGENT1 -sm QM_JUPITER -da AGENT2 -dm QM_NEPTUNE
-tr file=exist,C:/export/A.txt,C:/export/B.txt
-tr filesize">"=1GB,C:/export/A.txt,C:/export/B.txt
-df C:/import/file1.doc C:/export/file1.doc 

トリガー・パラメーターとスケジューリング・パラメーターは結合できます。 両方のタイプのパラメーターを指定した場合、スケジューリング・パラメーターにより作成されたファイル転送にトリガー条件が適用されます。

-tr パラメーターは、プロトコル・ブリッジ・エージェントまたは CreateTransfer REST APIではサポートされません。

-tl
オプション。 トリガー障害を転送ログに書き込むかどうかを指定します。 以下のいずれかのオプションを指定します。
yes
失敗したトリガー転送についての転送ログ項目が作成されます。 -tlパラメーターを指定しない場合でも、これがデフォルトの動作です。
いいえ
失敗したトリガー転送についての転送ログ項目は作成されません。

 転送オプションの指定に関するパラメーター

-jn ジョブ名
オプション。 転送が開始されたときに、転送ログ・メッセージに追加されるユーザー定義ジョブ名 ID。
-md
オプション。 エージェントにより実行される出口点に渡される、ユーザー定義のメタデータを指定します。 -mdパラメーターは、コンマで区切られた 1 つ以上の名前と値のペアを取ることができます。 それぞれの名前ペアは、 name=valueで構成されます。 1 つのコマンドで-md パラメーターを複数回使用することができます。

エージェント・プロパティーenableUserMetadataOptionsの値が true に設定されている場合、特定のユーザー定義メタデータ・キーは、転送に対して追加のオプションを提供します。 現在サポートされているユーザー定義のメタデータ・キーについて詳しくは、enableUserMetadataOptions: サポートされている MFT ユーザー定義メタデータ・キー を参照してください enableUserMetadataOptionsプロパティーが true に設定されている場合、com.ibm.wmqfte.で始まるキー名はユーザー定義での使用はサポートされません。

fteCreateTransfer コマンドで提供されたユーザー・メタデータは、presrcpostsrcpredst、または postdst パラメーターで呼び出されたプロセスで環境変数として利用できます。

例えば、以下の転送の結果、procnameという環境変数が圧縮 (procname=圧縮) に設定され、proc.shスクリプトで使用できるようになります。
fteCreateTransfer -sa ESBPA1 -sm ESBP10 -da INFOPA1 
-dm INFOP1 -md procname=compress -df /home/mqm/hosts.out /etc/hosts -de overwrite 
-postdst /home/mqm/proc.sh
-cs チェックサム
オプション。 転送されたファイルの整合性を検査するためにファイル転送データに対してチェックサム・アルゴリズムが実行されるかどうかを指定します。 以下のいずれかのオプションを指定します。
MD5
データの MD5 チェックサムを計算します。 ソース・ファイルと宛先ファイルの結果チェックサムが検証のために転送ログに書き込まれます。 デフォルトでは、 Managed File Transfer はすべてのファイル転送の MD5 チェックサムを計算します。
なし
ファイル転送データの MD5 チェックサムは計算されません。 転送ログにはチェックサムが none に設定されたことが記録され、チェックサムの値はブランクになります。 以下に例を示します。
<checksum method="none"></checksum>
none オプションを使用すると、ご使用の環境によってはファイル転送のパフォーマンスが向上する場合があります。 ただし、このオプションを選択した場合、ソース・ファイルまたは宛先ファイルの検証はありません。

-csパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-tdパラメーターを指定することはできません。 ただし、転送定義ファイルにチェックサムの動作を 指定することができます。

-pr transfer_priority
オプション。 転送の優先順位を示します。 priority は 0 から 9 までの範囲の値で、0 が最低の優先順位です。 デフォルトの優先順位は、ソース・エージェントの優先順位です。

この値は、 IBM MQのメッセージ優先順位の値と一致します。詳しくは、 キューからのメッセージの読み取り: 優先順位 を参照してください。 ファイル転送データのメッセージ・トラフィックは、デフォルトで優先順位 0 になります。これにより、 IBM MQ メッセージ・トラフィックを優先させることができます。

-qmp ブール
オプション。 転送によって宛先キューに書き込まれる最初のメッセージに IBM MQ メッセージ・プロパティーが設定されているかどうかを指定します。 有効なオプションは以下のとおりです。
true
転送で作成する最初のメッセージでメッセージ・プロパティーを設定します。
false
転送で作成する最初のメッセージでメッセージ・プロパティーを設定しません。 これがデフォルト値です。
-qmpパラメーターは、-dqパラメーターも指定する場合にのみ指定できます。 詳細は、 宛先キューに書き込まれたメッセージの MQ メッセージプロパティセットを参照してください
-qs メッセージ・サイズ
オプション。 ファイルを複数の固定長メッセージに分割するかどうかを指定します。 すべてのメッセージは同じ IBM MQ グループ ID を持ち、グループ内の最後のメッセージには IBM MQ LAST_MSG_IN_GROUP フラグが設定されます。 メッセージのサイズは、message_size の値で指定します。 message_size のフォーマットは、lengthunits です (length は正整数値、units は以下のいずれかの値です)。
B
バイト。 指定できる最小値は、宛先メッセージのコード・ページの 1 文字あたりの最大バイト数の値の 2 倍です。
K
1024 バイトに相当します。
M
1048576 バイトに相当します。
ファイルをテキスト・モードで転送していて、ファイルが 2 バイト文字セットまたはマルチバイト文字セットのファイルである場合、そのファイルは、指定のメッセージ・サイズに最も近い文字境界で複数のメッセージに分割されます。

-qsパラメーターは、-dqパラメーターも指定する場合にのみ指定できます。 -qs-dqdb、および-dqdtパラメーターのいずれか 1 つのみを指定できます。

-qi

オプション。 このオプションを使用すると、ファイルを複数のメッセージに分割するために使用する区切り文字がメッセージに組み込まれます。 区切り文字は、-dqdpパラメーター (接頭部または接尾部を指定する) に応じて、メッセージの先頭または末尾に組み込まれます。 デフォルトでは、メッセージに区切り文字は組み込まれません。

-qiパラメーターは、-dqdtパラメーターと-dqdbパラメーターのいずれか 1 つも指定した場合にのみ指定できます。

-p configuration_options
オプション。 このパラメーターは、ファイル転送を作成するために使用される構成オプションのセットを決定します。 このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。

このパラメーターを指定しない場合、デフォルトの調整キュー・マネージャーに基づいた構成オプションのセットが使用されます。

このパラメーターは、 REST API インターフェースではサポートされません。

-w Timeout
オプション。 -w パラメーターを指定すると、fteCreateTransfer コマンドはエージェントからの応答を待機してから戻ります。 このパラメーターを指定しなかった場合、fteCreateTransfer コマンドは、転送要求を受け取ったという確認応答を転送のソース・エージェントから受け取るまで、最大 5 秒間待機します。 5 秒間の待機中に確認応答を受け取らなかった場合、fteCreateTransfer コマンドは以下の警告メッセージを返します。
BFGCL0253W: No acknowledgment to command from agent within timeout.

コマンド行で-wオプションを使用しない限り、戻りコードは0になります。

timeout 引数はオプションです。 timeout を指定すると、fteCreateTransfer コマンドは timeout で示される秒数までエージェントの応答を待機します。 制限時間に達する前にエージェントが応答しない場合、コマンドは警告を生成し、戻りコード2または 3で終了します。 timeout 値を指定しない場合、または timeout 値に -1 を指定した場合、コマンドはエージェントが応答するまで待機します。

REST サービスの実装では最適な待機時間が推奨されていないので、REST サービスには、このパラメーターに相当するオプションはありません。
- リカバリー・タイムアウト
オプション。 停止したファイル転送のリカバリーをソース・エージェントが試行し続ける時間 (秒単位) を設定します。 以下のいずれかのオプションを指定します。
-1
エージェントは、停止した転送のリカバリーを、転送が完了するまで試行し続けます。 このオプションを使用すると、このプロパティーを設定しない場合のエージェントのデフォルトの動作と同じになります。
0
エージェントは、リカバリーに入るとすぐにファイル転送を停止します。
>0
エージェントは、指定された正整数値で設定された時間 (秒単位) だけ、停止した転送のリカバリーを試行し続けます。 例えば、
-rt 21600
これは、エージェントがリカバリーに入ってから 6 時間にわたって転送のリカバリーを試行し続けることを示しています。 このパラメーターの最大値は999999999です。

このように指定した場合、転送のリカバリー・タイムアウト値は転送単位で設定されます。 Managed File Transfer ネットワーク内のすべての転送にグローバル値を設定するには、 agent.properties ファイルにプロパティーを追加します。

プログラムの呼び出しに関するパラメーター

Managed File Transferからプログラムを開始する方法について詳しくは、 MFTで実行するプログラムの指定を参照してください。 ここで説明するパラメータを使用して起動するプログラムを指定する例については、 fteCreateTransferを使用してプログラムを起動する例を参照のこと。

-presrc pre_source_call
オプション。 転送開始前にソース・エージェントで呼び出すプログラムを指定します。 pre_source_call には次の形式を使用します。
[type:]commandspec[,[retrycount][,[retrywait][,successrc]]]
この構文の変数は、以下のとおりです。
タイプ
オプション。 有効な値は、executableantscript、およびjclです。 デフォルト値は executableです。

[z/OS] jcl の値は、 環境のエージェントを対象とする場合にのみ適用されます。 z/OS その場合は、このコマンドで、ZFS ファイル、QSAM 読み取り可能データ・セット、PDS メンバーのいずれかを参照します。 その内容は、実行可能な JCL でなければなりません。

commandspec
必須。 コマンドの指定。 以下のいずれかの形式を使用します。
  • タイプexecutable: command[(arg1,arg2,...)]

    置換がリソース・モニターによって開始された場合にのみ有効な変数置換 (${FilePath}${FileName}など) が引数に含まれている場合、変数は転送要求の最初の項目に置換されます。

    例えば、転送要求がファイル「reports01.csvreports02.csvreports03.csv」で構成され、宛先ディレクトリーが「/output」の場合、転送要求は次のようになります。
    
    fteCreateTransfer -sa 1 -da 2 -presrc "executable:archive(${FileName})" 
    -dd TargetDir "${FilePath}" -gt task.xml
    は、以下と置換されます
    
    fteCreateTransfer -sa 1 -da 2 -presrc "executable:archive(reports01.csv)" 
    -dd TargetDir "/ouptut" -gt task.xml
  • タイプantscript: command[(name1=var1|target1,name2=var2|target2,...)]
  • タイプjcl: command
ここで、
コマンド
必須。 呼び出すプログラムの名前。

jcl値は、z/OS環境内のエージェントをターゲットとする場合にのみ適用されます。

大括弧 ([ ]) 内の引数はオプションです。また構文はコマンドのタイプによって異なります。 MFT コマンドでは、括弧、コンマ (,)、および円記号 (¥) は特殊文字であり、円記号 (¥) 文字でエスケープする必要があります。 [Windows]Windowsでのファイルパスは、区切り文字として2つのバックスラッシュ(\)を使用するか、または1つのスラッシュ(/)を使用して指定することができます。

retrycount
オプション。 プログラムが成功を示す戻りコードを戻さなかった場合に、プログラムの呼び出しを再試行する回数。 デフォルト値は 0 です。
retrywait
オプション。 プログラム呼び出しを再度試行するまでの待機時間 (秒数)。 デフォルト値は 0 (次の再試行まで待機なし)。
successrc
オプション。 プログラム呼び出しが正常に実行される条件を決定するために使用される式。 この式は、1 つ以上の式の組み合わせにすることができます。 それらの式は、ブール値の OR を表す垂直バー文字 (|)、またはブール値の AND を表すアンパーサンド (&) 文字で結合します。 それぞれの式は、次の形式になります。
[>|<|!]value
説明:
>
オプション。 value より大きい値であるかのテスト。
<
オプション。 value より小さい値であるかのテスト。
!
オプション。 が等しくないかどうかを検査します。
必須。 有効な整数。

このパラメーターを指定しない場合、デフォルト値の0が使用されます。

-predst pre_destination_call
オプション。 転送開始前に宛先エージェントで呼び出すプログラムを指定します。 pre_destination_callpre_source_call と同じ形式です。
-postsrc post_source_call
オプション。 転送完了後にソース・エージェントで呼び出すプログラムを指定します。 post_source_callpre_source_call と同じ形式です。
-postdst post_destination_call
オプション。 転送完了後に宛先エージェントで呼び出すプログラムを指定します。 post_destination_callpre_source_call と同じ形式です。

宛先の指定に関するパラメーター

-td-df-dd-ds-dq、および-dpパラメーターのいずれかが必要です。 これらのパラメーターは、相互に排他的であるため、転送要求に複数指定することができません。

-td 転送定義ファイル
オプション。 転送のためのソースおよび宛先のファイル仕様を 1 つ以上定義する XML 文書の名前。 あるいは、管理対象転送要求を含む XML 文書の名前 (-gtパラメーターによって生成された可能性があります)。 -tdパラメーターを指定し、コマンド行で他のパラメーターも指定した場合、これらのパラメーターは転送定義ファイルの対応する値をオーバーライドします。

fteCreateTransfer コマンドは、 現行ディレクトリーを基準として、転写定義ファイルの場所を探索します。 相対パス表記を使用して転送定義ファイルの場所を指定することができない場合は、 代わりに、転送定義ファイルの完全修飾パスとファイル名を使用します。

[z/OS] z/OS では、 ファイルを に保存する必要があります。 UNIX z/OS UNIX System Services z/OS の順次ファイルまたは PDS メンバーに、 転送定義ファイルを保管することはできません。

[IBM i] IBM i では、統合ファイルシステムに転送定義ファイルを保存する必要があります。

詳しくは、 転送定義ファイルの使用を参照してください。

-df destination_file

オプション。 宛先ファイルの名前。

宛先エージェントが Connect:Direct ブリッジ・エージェントの場合は、宛先ファイルが connect_direct_node_name:file_path という形式で指定されます。 Connect:Direct ブリッジ・エージェントは、この形式で指定されたファイル・パスのみを受け入れます。 [z/OS]宛先エージェントが Connect:Direct ブリッジエージェントであり、宛先がPDSメンバーである場合は、 -de パラメータを上書きの値で指定する必要があります。

次のことに注意してください。
  • 宛先エージェントがプロトコル・ブリッジ・エージェントであり、ファイルのエンドポイントを指定する場合は、次の形式を使用します。
    protocol_server:file_path
    protocol_server はプロトコル・サーバーの名前 (これはオプション) で、file_path はプロトコル・サーバー・システム上のファイルのパスです。 プロトコル・サーバーを指定しない場合は、デフォルトのプロトコル・サーバーが使用されます。
  • 宛先エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送で-dfパラメーターを使用できます。
  • [z/OS]宛先エージェントが z/OS の場合、指定されたファイルが // で始まる場合、パーティション化された z/OS データセットであると想定されます。

-dd 宛先ディレクトリ

オプション。 ファイルの転送先となるディレクトリーの名前。 宛先エージェントが実行されているシステムの有効なディレクトリー名を指定します。

宛先エージェントが Connect:Direct ブリッジ・エージェントの場合、宛先ディレクトリーは connect_direct_node_name:directory_path という形式で指定されます。 宛先エージェントがConnect:Directブリッジ・エージェントであり、宛先が PDS である場合は、-deパラメーターに上書きの値を指定する必要もあります。

次のことに注意してください。
  • 宛先エージェントがプロトコル・ブリッジ・エージェントであり、特定のエンドポイントにあるディレクトリーを指定する場合は、次の形式を使用します。
    protocol_server:directory_path
    protocol_server はプロトコル・サーバーの名前 (これはオプション) で、directory_path はプロトコル・サーバー・システム上でのディレクトリーのパスです。 プロトコル・サーバーを指定しない場合は、デフォルトのプロトコル・サーバーが使用されます。
  • 宛先エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送で-ddパラメーターを使用できます。

  • [z/OS]宛先エージェントが z/OS の場合、指定されたファイルが // で始まる場合、 z/OS でパーティショニングされたデータセットであると想定されます。

[z/OS]- ds destination_sequential_data_set

z/OSのみ。 オプション。 ファイルの転送先の順次データ・セットまたは PDS メンバーの名前。 順次データ・セット名または区分データ・セット・メンバーを指定します。 データセットの転送に関する情報は、「ファイル転送のガイドライン」 を参照してください。

データ・セット名の構文は次のとおりです。
 //data_set_name{;attribute(value);..;attribute(value)} 
または
 //pds_data_set_name(member_name){;attribute(value);..;attribute(value)}
つまり、データ・セット名指定子の前に // があり、その指定子の後にはオプションで、セミコロンで区切られたいくつかの属性が続きます。
例:
//'TEST.FILE.NAME';DSNTYPE(PDS);RECFM(F,B);BLKSIZE(800);LRECL(80);CYL;SPACE(2,2)
データ・セットが Connect:Direct ノードにある場合は、データ・セット名の前にノード名を付ける必要があります。 以下に例を示します。
CD_NODE1://'OBJECT.LIB';RECFM(F,B);BLKSIZE(800);LRECL(80)
宛先エージェントがConnect:Directブリッジ・エージェントであり、宛先が PDS メンバーである場合は、-deパラメーターに上書きの値を指定する必要もあります。 データセットの転送の詳細については、 Connect:Direct ノードについては、 [z/OS]Connect:Direct ノードとの間でデータ セットを転送します
Managed File Transfer エージェントのみを含む転送では、データ・セット名の部分が単一引用符文字で囲まれている場合は、完全修飾データ・セット名を指定します。 データ・セット名を単一引用符文字で囲まないと、システムによって宛先エージェントのデフォルトの高位修飾子 (transferRootHLQ エージェント・プロパティーの値か、transferRootHLQ が設定されていない場合は、エージェントを実行しているユーザー ID) が追加されます。
注: [z/OS]ただし、 Connect:Direct ノードが z/OS システムに含まれる転送の場合、データセットの指定は完全修飾名として解釈されます。 データ・セット名に高位修飾子が追加されることはありません。 これは、データ・セット名が単一引用符文字で囲まれている場合でも当てはまります。

ファイルまたはデータ・セットを磁気テープに転送すると、磁気テープ内の既存データ・セットが置き換えられます。 新しいデータ・セットの属性は、転送定義で渡された属性を基にして設定されます。 属性は、何も指定されていなければ、ソース・データ・セットと同様、またはデフォルト値 (ソースがファイルである場合) に設定されます。 既存の磁気テープ・データ・セットの属性は無視されます。

データ・セット属性は、データ・セットを作成するため、または既存のデータ・セットが互換性を持つようにするために使用されます。 データ・セット属性の指定は、BPXWDYN に適した形式になります (詳細については、 『Requesting dynamic allocation』を参照してください)。 エージェントが宛先データ・セットを作成する場合、BPXWDYN 属性 DSN(data_set_name) NEW CATALOG MSG(numeric_file_descriptor) が自動的に指定されます。 numeric_file_descriptor の値は Managed File Transfer によって生成されます。 データ・セットからのデータ・セットへの転送では、ソースから RECFM、LRECL、および BLKSIZE の属性が、新規宛先データ・セット用に選択されます。 新規宛先データ・セットの SPACE 設定は Managed File Transfer によって設定されず、システム・デフォルトが使用されます。 そのため、 新規データ・セットが作成されるときに、SPACE 属性を指定することを お勧めします。 agent.propertiesファイル内のbpxwdynAllocAdditionalPropertiesプロパティーを使用して、すべての転送に適用される BPXWDYN オプションを設定できます。 詳しくは、MFT agent.properties ファイルを参照してください。

[z/OS] fteCreateTemplate コマンド、 コマンド、または プロパティを ファイルで使用する際には、一部のBPXWDYNオプションを指定してはなりません。 fteCreateTransfer bpxwdynAllocAdditionalProperties agent.properties これらのプロパティの一覧については、 MFTでは使用できないBPXWDYNプロパティを参照してください。

宛先エージェントがプロトコル・ブリッジ・エージェントである場合、-dsパラメーターはサポートされません。

エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送に-ds パラメーターを指定しないでください。 -dsパラメーターを使用すると、転送入出力ユーザー出口が宛先に対して呼び出されなくなり、代わりに標準Managed File Transfer入出力が使用されます。

[z/OS]- dp destination_partitioned_data_set
z/OSのみ。 オプション。 ファイルの転送先となる宛先 PDS の名前。 区分データ・セット名を指定します。 PDS が転送の結果として作成されると、この PDS はデフォルトで PDSE として作成されます。 DSNTYPE=PDS を 指定することにより、デフォルトをオーバーライドすることができます。
PDS データ・セット名の構文は次のとおりです。
//pds_data_set_name{;attribute;..;attribute}

データ・セット名の構文は、-ds destination_sequential_data_set パラメーターについて説明したものと同じです。 Connect:Directノードにあるデータ・セットを指定するための構文の詳細はすべて、-dpパラメーターにも適用されます。 宛先エージェントがConnect:Directブリッジ・エージェントの場合は、-deパラメーターに上書きの値を指定する必要もあります。

宛先エージェントがプロトコル・ブリッジ・エージェントである場合、-dpパラメーターはサポートされません。

エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送に-dp パラメーターを指定しないでください。 -dpパラメーターを使用すると、転送入出力ユーザー出口が宛先に対して呼び出されなくなり、代わりに標準Managed File Transfer入出力が使用されます。

-dq destination_queue

オプション。 ファイルの転送先となる宛先キューの名前。 この指定に QUEUE@QUEUEMANAGER というフォーマットでキュー・マネージャー名を含めることもできます。 キュー・マネージャー名を指定しない場合は、宛先エージェントのキュー・マネージャー名が使用されます。 対象のキュー・マネージャーに存在する有効なキュー名を指定する必要があります。

-dqパラメーターは、宛先エージェントがプロトコル・ブリッジ・エージェントまたはConnect:Directブリッジ・エージェントである場合、またはソース仕様がキューである場合はサポートされません。

エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送に-dq パラメーターを指定しないでください。 -dqパラメーターを使用すると、転送入出力ユーザー出口が宛先に対して呼び出されなくなり、代わりに標準Managed File Transfer入出力が使用されます。

-dqp 永続
オプション。 宛先キューに書き込むメッセージを永続メッセージにするかどうかを指定します。 有効なオプションは以下のとおりです。
true
宛先キューに永続メッセージを書き込みます。 これがデフォルト値です。
false
宛先キューに非永続メッセージを書き込みます。
qdef
永続性の値を宛先キューの DefPersistence 属性から取り込みます。
-dqpパラメーターは、-dqパラメーターも指定する場合にのみ指定できます。
-dqdb 16 進数の区切り文字

オプション。 バイナリー・ファイルを複数のメッセージに分割するときに使用する 16 進数区切り文字を指定します。 すべてのメッセージは同じ IBM MQ グループ ID を持ち、グループ内の最後のメッセージには IBM MQ LAST_MSG_IN_GROUP フラグが設定されます。 区切り文字として 16 進バイトを指定するための形式は、xNNです。ここで、N0-9またはa-fの範囲の文字です。 16 進バイトのコンマ区切りリストを指定することにより、16 進バイトのシーケンスを区切り文字として指定できます (例: x3e,x20,x20,xbf)。

-dqdbパラメーターを指定できるのは、-dqパラメーターも指定し、転送がバイナリー・モードの場合のみです。 -qs-dqdb、および-dqdtパラメーターのいずれか 1 つのみを指定できます。

-dqdt pattern

オプション。 テキスト・ファイルを複数のメッセージに分割するときに使用する Java 正規表現を指定します。 すべてのメッセージは同じ IBM MQ グループ ID を持ち、グループ内の最後のメッセージには IBM MQ LAST_MSG_IN_GROUP フラグが設定されます。 正規表現を区切り文字として指定するためのフォーマットは、括弧で囲まれた正規表現(regular_expression)、または二重引用符で囲まれた正規表現 regular_expressionです。 詳細は、 MFTで使用される正規表現を参照してください。

デフォルトでは、正規表現にマッチング可能なストリングの長さは、宛先エージェントによって 5 文字に制限されています。 この動作を変更するには、maxDelimiterMatchLengthエージェント・プロパティーを編集します。 詳しくは、拡張エージェント・プロパティーを参照してください。

-dqdtパラメーターは、-tパラメーターに-dqパラメーターと値textも指定した場合にのみ指定できます。 -qs-dqdb、および-dqdtパラメーターのいずれか 1 つのみを指定できます。

-dqdp position

オプション。 ファイルを分割するときの、宛先テキストおよびバイナリー区切り文字の想定される位置を指定します。 -dqdpパラメーターは、-dqdtパラメーターと-dqdbパラメーターのいずれか 1 つも指定した場合にのみ指定できます。

以下のいずれかのオプションを指定します。
接頭部
区切り文字が各行の先頭にあることが想定されます。
postfix
区切り文字が各行の末尾にあることが想定されます。 これはデフォルト設定です。
- デスティネーション_ファイル_ビヘイビア
オプション。 宛先システムに宛先ファイルが存在する場合に取る処置を示します。 有効なオプションは以下のとおりです。
エラー
エラーを報告し、ファイルは転送されません。 これがデフォルト値です。
overwrite
既存の宛先ファイルを上書きします。

-deパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-tdパラメーターを指定することはできません。 ただし、宛先ファイルが存在する場合の動作を転送定義ファイルに指定することができます。

--t 転送タイプ
オプション。 ファイル転送のタイプ (バイナリー・モードまたはテキスト・モード) を指定します。
binary
ファイル内のデータは変換されずに転送されます。 これがデフォルト値です。
text
ファイルのコード・ページおよび行末文字は変換されます。 -sce-dce、または-dleパラメーターを使用して、変換に使用するコード・ページと行の末尾を指定できます。 -sce-dce、または-dleパラメーターを指定しない場合、実行される正確な変換は、ソース・エージェントと宛先エージェントのオペレーティング・システムによって異なります。

[z/OS]例えば、 Windows から z/OS に転送されるファイルは、コードページがASCIIからEBCDICに変換されます。 ファイルを ASCII から EBCDIC に変換すると、行末文字は、ASCII 復帰 (CR) および改行 (LF) 文字のペアから EBCDIC 改行 (NL) 文字に変換されます。

[z/OS] z/OS データセットの転送方法の詳細については、「 と分散システム間のファイルおよびデータセットの転送 z/OS 」および 「 上のデータセット間の転送」 z/OS を参照してください。

-tパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-tdパラメーターを指定することはできません。 ただし、転送定義ファイルに転送モードの動作を 指定することができます。

-dce 宛先文字エンコーディング
オプション。 宛先でのファイルの書き込みに使用する文字エンコードを指定します。 このオプションはテキスト・ファイルにのみ適用されるため、-t textも指定する必要があります。 変換に使用可能なコード・ページは、宛先エージェントのプラットフォームによって異なることになります。 使用可能なコード・ページのリストについては、 MFT で使用可能なコード・ページを参照してください。
noswaplfnl
デフォルトでは、 Managed File Transfer はサポートされる EBCDIC 文字セットで swaplfnl を使用します。 swaplfnl を使用すると、EBCIDIC LF 0x25 文字との間の文字セット・マッピングの動作が変わります。 ただし、これにより、望ましくないマッピングが生じることがあります。 この動作をオーバーライドするには、noswaplfnl を使用します。
-dle destination_line_ending
オプション。 宛先でファイルが書き込まれるときに使用される行末文字を指定します。 このオプションはテキスト・ファイルにのみ適用されるため、-t textパラメーターも指定する必要があります。 有効なオプションは次のとおりです。
LF
改行。 次のプラットフォームでは、これがデフォルトです。
  • [AIX][Linux]AIX® and Linux® プラットフォーム
  • [z/OS]z/OS UNIX System Services ファイル
Managed File Transfer で提供されている標準 EBCDIC コード・ページを EBCDIC ファイルに使用する場合、行末文字は LF 文字 (0x25) ではなく NL 文字 (0x15) にマップされます。
CRLF
復帰の後に改行。 [Windows]これは Windows のデフォルトです。

[z/OS]転送先が z/OS データセットの場合、このオプションは無視されます。

[z/OS]-dtr
オプション。 LRECL データ・セット属性よりも長い宛先レコードが切り捨てられることを指定します。 このパラメーターを指定しない場合、それらのレコードは折り返されます。 このパラメーターは、宛先がデータ・セットであるテキスト・モードの転送のみに有効です。
-dfa 属性
オプション。 4690 で実行されている IBM MQ 8.0 Managed File Transfer エージェントに転送する場合、このパラメーターを使用して、転送の宛先ファイルに関連付けられているファイル属性のセミコロン区切りリストを指定します。 -dfaパラメーターは、値の有無にかかわらず指定できます。 例えば、値を指定しない場合は、以下のようにします。
-dfa ATTRIBUTE1;ATTRIBUTE2 
例えば、値を指定する場合は以下のようにします。
-dfa ATTRIBUTE1(VALUE);ATTRIBUTE2(VALUE)
例えば、1 つの属性に値を指定し、もう 1 つの属性に値を指定しない場合は、以下のようにします。
-dfa ATTRIBUTE1;ATTRIBUTE2(VALUE)
1 つのコマンドで-dfaパラメーターを複数回使用することができます。

4690 のファイル属性について詳しくは、 IBM MQ 8.0 資料の「 ファイル配布属性 」を参照してください。

セキュリティーに関するパラメーター

-mquserid ユーザー ID
オプション。 コマンド・キュー・マネージャーで認証するユーザー ID を指定します。
-mqpassword パスワード
オプション。 調整キュー・マネージャーで認証するパスワードを指定します。
-mqpassword パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquseridを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードの入力を求めるプロンプトが出されますが、これは表示されません。

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022] IBM MQ 9.3 以降、コマンドは MQCSP認証を使用するようデフォルト設定され、認証対象のユーザーIDとパスワードをMQCSP構造のキューマネージャに送信します。

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]-ノルプウ
オプション。 12 文字を超えるパスワードをサポートしないキュー・マネージャーにコマンドが接続する場合は、このパラメーターを指定します。
-nolpw パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquserid および -nolpwを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。
注: -nolpw オプションを指定し、パスワードが 12 文字より長い場合、コマンドは失敗し、エラー・メッセージ BFGCL0829Eが表示されます。

ソースの指定に関するパラメーター

-sd source_file_disposition
オプション。 ファイルからファイルへの転送またはファイルからメッセージへの転送で、ソース・ファイルが宛先に正常に転送された場合にそのソース・ファイルに対して実行するアクションを指定します。 有効なオプションは以下のとおりです。
leave
ソース・ファイルは変更されません。 これがデフォルト値です。
削除
ソース・ファイルは、それが正常に転送された後にソース・システムから削除されます。
注: メッセージからファイルへの転送の場合、ソース・キュー上のメッセージは、正常に転送されると常に削除されます。 つまり、メッセージからファイルへの転送で -sd パラメーターを leave に設定しても、その値は無視されます。

[z/OS] z/OS において、ソースがテープデータセットであり、 削除オプションを指定すると、データセットを削除するためにテープが再マウントされます。 この動作は、システム環境の動作のためにこのようになっています。

ソースがキューの場合に leave オプションを指定すると、このコマンドからエラーが返され、転送は要求されません。

ソース・エージェントが Connect:Direct ブリッジ・エージェントであり、 delete オプションを指定した場合の動作は、通常のソース後処理の動作とは異なります。 以下のいずれかになります。
  • Connect:DirectManaged File Transfer によって生成されたプロセスを使用してファイルまたはデータ・セットをソースから移動する場合、 delete オプションを指定すると転送が失敗します。 ソース・ファイルを削除することを指定するには、ユーザー定義の Connect:Direct プロセスを実行依頼する必要があります。 詳しくは、 ファイル転送要求からのユーザー定義の Connect:Direct プロセスの実行依頼を参照してください。
  • Connect:Direct がユーザー定義プロセスを使用してファイルまたはデータ・セットをソースから移動する場合、このパラメーターは %FTEFDISP 組み込みシンボリック変数を介してプロセスに渡されます。 ソースを削除するかどうかは、ユーザー定義プロセスによって決まります。 転送から返される結果も、ユーザー定義プロセスから返される結果によって決まります。

-sdパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-tdパラメーターを指定することはできません。 ただし、転送定義ファイルにソースの後処理の動作を 指定することができます。

-r
オプション。 source_specification がワイルドカード文字を含んでいる場合に、サブディレクトリーのファイルを再帰的に転送します。 Managed File Transferにワイルドカード文字を source_specification として指定した場合、そのワイルドカード文字に一致するサブディレクトリーは、-rパラメーターを指定した場合にのみ転送されます。 source_specification がサブディレクトリーに一致する場合、 そのディレクトリーとサブディレクトリー内のすべてのファイル (隠しファイルも含む) は常に転送されます。

Managed File Transfer がワイルドカード文字をどのように処理するかについての詳細は、「MFTでのワイルドカード文字の使用」 を参照してください

-rパラメーターを指定する場合、これらのパラメーターは相互に排他的であるため、-tdパラメーターを指定することはできません。 ただし、転送定義ファイルに再帰的動作を 指定することができます。

- ソース文字エンコーディング
オプション。 文字変換を実行するときにソース・ファイルの読み取りに使用する文字エンコードを指定します。 このオプションはテキスト・ファイルにのみ適用されるため、-t textも指定する必要があります。 変換に使用可能なコード・ページは、宛先エージェントのプラットフォームによって異なります。 変換は宛先システムで実行されるからです。 利用可能なコードページの一覧については、「MFTで利用可能なコードページ 」を参照してください。
noswaplfnl
デフォルトでは、 Managed File Transfer はサポートされる EBCDIC 文字セットで swaplfnl を使用します。 swaplfnl を使用すると、EBCIDIC LF 0x25 文字との間の文字セット・マッピングの動作が変わります。 ただし、これにより、望ましくないマッピングが生じることがあります。 この動作をオーバーライドするには、noswaplfnl を使用します。
[z/OS]-skeep
オプション。 固定長形式のレコード単位ファイルからテキスト・モード転送の一部として読み取ったソース・レコードで (z/OS データ・セットなど)、末尾のスペースを保持することを指定します。 このパラメーターを指定しない場合、末尾のスペースはソース・レコードから除去されます。
[z/OS]- srdb区切り文字
オプション。 レコード単位である (z/OS データ・セットなど) ソース・ファイルの場合、バイナリー・ファイルにレコードを追加するときに区切り文字として挿入する 1 つ以上のバイト値を指定します。 それぞれの値は、接頭部 x を付けた 00 から FF の範囲の 2 桁の 16 進数字として指定する必要があります。 複数のエントリーはコンマで区切ってください。 以下に例を示します。
 -srdb x0A 
または
 -srdb x0D,x0A
この転送はバイナリー・モードで構成してください。
[z/OS]- srdp位置

オプション。 ソース・レコードの区切り文字を挿入する位置を指定します。 -srdpパラメーターは、-srdbパラメーターも指定する場合にのみ指定できます。

以下のいずれかのオプションを指定します。
接頭部
区切り文字は各レコードの先頭に挿入されます。
postfix
区切り文字は各レコードの末尾に挿入されます。 これはデフォルト設定です。
-sq

オプション。 転送のソースがキューであることを指定します。

エージェントに対して定義したManaged File Transfer転送入出力ユーザー出口のいずれかを呼び出したい場合は、転送に-sq パラメーターを指定しないでください。 -sqパラメーターを使用すると、転送入出力ユーザー出口はソースに対して呼び出されなくなり、代わりに標準のManaged File Transfer入出力が使用されます。

-sqgi

オプション。 メッセージを IBM MQ グループ ID でグループ化することを指定します。 完全に揃った最初のグループが宛先ファイルに書き込まれます。 このパラメーターを指定しない場合は、ソース・キューに存在するすべてのメッセージが宛先ファイルに書き込まれます。

-sqgiパラメーターは、-sqパラメーターも指定する場合にのみ指定できます。

-sqdt テキスト区切り文字

オプション。 1 つのテキスト・ファイルに複数のメッセージを追加するときに区切り文字として挿入するテキストのシーケンスを指定します。 ストリング・リテラルの Java エスケープ・シーケンスを区切り文字に含めることもできます。 例えば、-sqdt \u007d\nなどです。

テキスト区切り文字は、転送のソース・エンコード方式に基づいてバイナリー・フォーマットにエンコードされます。 各メッセージはバイナリー・フォーマットで読み取られます。 エンコードされた区切り文字は、(-sqdp パラメーターで指定されたように) メッセージの先頭またまたは末尾にバイナリー・フォーマットで付加され、その結果はバイナリー・フォーマットで宛先エージェントに転送されます。 ソース・エージェントのコード・ページにシフトイン状態とシフトアウト状態が含まれていれば、エージェントは、各メッセージがメッセージの末尾でシフトアウト状態になると想定します。 宛先エージェントでは、ファイルからファイルへのテキスト転送の場合と同じ要領でバイナリー・データが変換されます。

-sqdtパラメーターは、-tパラメーターに-sqパラメーターと値textも指定した場合にのみ指定できます。

-sqdb 16進デリミタ

オプション。 1 つのバイナリー・ファイルに複数のメッセージを追加するときに区切り文字として挿入する 1 つ以上のバイト値を指定します。 各値は、00-FFの範囲内の 2 桁の 16 進数に接頭部xを付けた形式で指定する必要があります。 複数バイトの場合はコンマで区切る必要があります。 例: -sqdb x08,xA4

-sqdbパラメーターは、-sqパラメーターも指定する場合にのみ指定できます。 -tパラメーターに値textも指定した場合は、-sqdbパラメーターを指定できません。

-sqdp 位置

オプション。 ソース・テキストおよびバイナリー区切り文字の挿入位置を指定します。 -sqdpパラメーターは、-sqdtパラメーターと-sqdbパラメーターのいずれか 1 つも指定した場合にのみ指定できます。

以下のいずれかのオプションを指定します。
接頭部
区切り文字は各メッセージの先頭に挿入されます。
postfix
区切り文字は各メッセージの末尾に挿入されます。 これはデフォルト設定です。
-sqwt wait_time
オプション。 以下のいずれかの条件が満たされるのを待つ時間を秒単位で指定します。
  • 新しいメッセージがキューに書き込まれるという条件
  • -sqgiパラメーターが指定されている場合、グループ全体がキューに表示されます。
wait_time で指定した時間内にどちらの条件も満たされなければ、ソース・エージェントは、キューからの読み取りを停止して、転送を完了します。 -sqwtパラメーターが指定されていない場合、ソース・キューが空であれば、ソース・エージェントはソース・キューからの読み取りを即時に停止します。-sqgiパラメーターが指定されていれば、キューに完全なグループが存在しないことになります。

-sqwt パラメータの使用方法については、「メッセージからファイルへの転送における待機時間の指定に関するガイダンス」 を参照してください。

-sqwtパラメーターは、-sqパラメーターも指定する場合にのみ指定できます。

source_specification
ファイル転送のソース (複数可) を決める 1 つ以上のファイル指定。

-df-dd-dp-dq、または -ds のいずれかのパラメーターを指定する場合は必須です。 -tdパラメーターを指定する場合は、source_specification を指定しないでください。

  • -sqパラメーターを指定しなかった場合、source_specification は、ファイル転送のソースを決定する 1 つ以上のファイル指定になります。 ファイルの指定では 5 つの形式のうちの 1 つを使用することができ、ワイルドカード文字を含めることができます。 ワイルドカード文字の詳細については、「MFTでのワイルドカード文字の使用 」を参照してください。 ファイル指定でアスタリスク文字を 2 つ (**) 使用することにより、ファイル指定の一部を成すアスタリスクをエスケープすることができます。

    複数のソース・ファイルをスペース文字で区切って指定することができます。 ただし、-dfパラメーターまたは-dsパラメーターに複数のソース仕様を指定し、-de overwriteも指定した場合、宛先には最後に指定したソース・ファイルのデータのみが含まれます。 -de overwriteを指定しない場合、転送は部分的にしか成功しません。 宛先ファイルが存在していなかった場合は、最初に指定したソース・ファイルのデータが入ります。

    ファイル名にスペースが含まれているファイル (例えば、a b.txt) をファイルc d.txtに転送するには、スペースが含まれているファイル名を二重引用符で囲みます。 fteCreateTransfer コマンドの一部として次のテキストを指定します。
    -df "c d.txt" "a b.txt"
    ファイル指定はそれぞれ、以下のカテゴリーのいずれかでなければなりません。
    ファイル名
    ソース・エージェントが実行されているシステムに適切な表記で表現される、ファイルの名前。 ファイル名をソース・ファイルとして指定すると、ファイルの内容がコピーされます。
    ディレクトリー
    ソース・エージェントが実行されているシステムに適切な表記で表現される、ディレクトリーの名前。 ディレクトリーをソース・ファイルとして指定すると、ディレクトリーの内容がコピーされます。 もっと正確に表現すると、ディレクトリーとそのすべてのサブディレクトリー内のすべてのファイル (隠しファイルを含む) がコピーされます。
    例えば、DIR1 の内容を DIR2 のみにコピーするには、fteCreateTransfer ... -dd DIR2 DIR1/*と指定します。
    [z/OS]順次データ・セット
    順次データ・セットまたは区分データ・セット・メンバーの名前。 データ・セットは、名前の先頭に 2 つのスラッシュ文字 (//) を付けて表します。

    プロトコル・ブリッジ・エージェントをソース・エージェントとして指定する場合は、データ・セットをソース・ファイルとして指定することはできません。

    [z/OS]区分データ・セット
    区分データ・セットの名前。 データ・セット名は、先頭に 2 つのスラッシュ文字 (//) を付けて表します。

    プロトコル・ブリッジ・エージェントをソース・エージェントとして指定する場合は、データ・セットをソース・ファイルとして指定することはできません。

    Connect:Direct ノードのファイル名またはディレクトリー
    (Connect:Direct ブリッジ・エージェントのみ)。 Connect:Direct ノードをホストしているシステム上の Connect:Direct ノードの名前、コロン文字 (:)、およびファイル・パスまたはディレクトリー・パス。 例えば、connect_direct_node_name:file_pathなどです。

    ソース・エージェントが Connect:Direct ブリッジ・エージェントの場合、この形式のソース仕様のみを受け入れます。

    注: ソース・エージェントが Connect:Direct ブリッジ・エージェントである場合、ファイル・パスでワイルドカード文字はサポートされません。
    プロトコル・ファイル・サーバー上のファイル名またはディレクトリー
    プロトコル・ファイル・サーバーの名前、コロン文字 (:)、およびプロトコル・サーバー・システムでのファイルまたはディレクトリー・パス。 例えば、 protocol_server:file_pathなどです。

    プロトコル・サーバーを指定しない場合は、デフォルトのプロトコル・サーバーが使用されます。

  • -sqパラメーターを指定する場合、source_specification は、ソース・エージェント・キュー・マネージャー上のローカル・キューの名前です。 指定できるソース・キューは、1 つだけです。 ソース・キューを指定するためのフォーマットは、以下のとおりです。
    QUEUE_NAME
    ソース・キューの指定には、キュー・マネージャー名を含めません。そのキュー・マネージャーは、ソース・エージェントのキュー・マネージャーと同じでなければならないからです。
  • [z/OS]ソースエージェントが z/OS の場合、 // で始まるソースファイルは、 z/OS のパーティション化されたデータセットであると想定されます。

その他のパラメーター

- ? または -h
オプション。 コマンド構文を表示します。

この基本的な例では、ファイル originalfile.txt は同じシステム上の AGENT1 から AGENT2 に転送され、transferredfile.txt に名前変更されます。
fteCreateTransfer -sa AGENT1 -da AGENT2 -df C:/import/transferredfile.txt C:/export/originalfile.txt

この例では、originalfile.txt ファイルと originalfile2.txt ファイルを同じシステムにある AGENT1 から AGENT2 に転送します。宛先のディレクトリーは、C:/import です。
fteCreateTransfer -sa AGENT1 -da AGENT2 -dd C:/import C:/export/originalfile.txt C:/export/originalfile2.txt
この例では、ファイル originalfile.txt は AGENT1 のシステムから AGENT2 のシステムに転送されます。 ファイル転送は、ソース・エージェントのシステムのシステム時刻を基準として 09:00 に実行されるようにスケジュールされます。これは 2 時間ごとに 4 回実行されます。
fteCreateTransfer -sa AGENT1 -sm QM_JUPITER -da AGENT2 -dm QM_NEPTUNE
-tb source -ss 09:00 -oi hours -of 2 -oc 4
-df C:/import/transferredfile.txt C:/export/originalfile.txt 

ファイルが送信されると、ファイル originalfile.txt は、ファイルA.txt が AGENT1 に存在するという条件で、AGENT1 から AGENT2 に転送されます。
fteCreateTransfer -sa AGENT1 -sm QM_JUPITER -da AGENT2 -dm QM_NEPTUNE
-tr file=exist,C:/export/A.txt -df C:/import/transferredfile.txt C:/export/originalfile.txt 
[z/OS]この例では、 originalfile.txt というファイルが、 AGENT1 のシステムから AGENT2 のシステム上のデータセット//' USERID.TRANS.FILE.TXT 'に転送されます。 ASCII から EBCDIC へのデータ変換にテキスト・モードが選択されています。
fteCreateTransfer -t text -sa AGENT1 -da AGENT2 
-ds "//TRANS.FILE.TXT;RECFM(V,B);BLKSIZE(6144);LRECL(1028);
SPACE(5,1)" C:/export/originalfile.txt 

[z/OS]この例では、 AGENT1 のシステムの完全修飾データ・セットのメンバーが、AGENT2 のシステム上のファイルに転送されます。 EBCDIC から AGENT2 のシステムのデフォルト・コード・ページにファイルを変換するためにテキスト・モードが選択されています。
fteCreateTransfer -t text -sa AGENT1 -da AGENT2 -df /tmp/IEEUJV.txt "//'SYS1.SAMPLIB(IEEUJV)'"

この例では、宛先エージェント BRIDGE1 を使用して、エージェント AGENT1 にある file.bin というファイルが、プロトコル・ファイル・サーバー accountshost.ibm.com 上の file.bin という宛先ファイルに転送されます。
fteCreateTransfer -sa AGENT1 -da BRIDGE1 -df accountshost.ibm.com:/tmp/file.bin /tmp/file.bin

次の例では、引用符を付けないワイルドカードを使用しています。 .txt で終わる AGENT1 の現行作業ディレクトリー内のすべてのファイルは、AGENT2 上のディレクトリーC:/importに転送されます。 ファイル名は変更されません。
fteCreateTransfer -sa AGENT1 -da AGENT2 -dd C:/import  *.txt

次の例では、二重引用符を付けたワイルドカードを使用しています。 .txt で終わる AGENT1 の転送ルート・ディレクトリー内のすべてのファイルは、AGENT2 上のディレクトリーC:/importに転送されます。 ファイル名は変更されません。
fteCreateTransfer -sa AGENT1 -da AGENT2 -dd C:/import  "*.txt"

戻りコード

表 1. 戻りコード名と説明
戻りコード 説明
0 コマンドは正常に完了しました。
1 コマンドは失敗しました。
2 コマンドはタイムアウトになりました。 コマンドはメッセージをエージェントに送信しましたが、エージェントは指定された時間内に応答しませんでした。
3 コマンドはタイムアウトになりました。 コマンドは、エージェントからの確認応答を待っていましたが、タイムアウト期間内に受信しませんでした。
20 コマンドが部分的に成功して完了し、一部のファイルが転送されました。
21 fteCreateTransfer コマンドの接続先のキュー・マネージャーが、転送結果の判定前に停止されました。
40 失敗しました。 指定したどのファイルも転送できませんでした。
41 転送は取り消されました。
42 転送が条件付きであり、必要な条件が満たされなかったため、転送は実行されませんでした。
43 転送要求メッセージの形式が誤っていました。
44 ソース・エージェントに、転送を実行するための容量が十分に存在しません。
45 宛先エージェントに、転送を実行するための容量が十分に存在しません。
46 転送ファイル数が、ソース・エージェントの制限を超過しました。
47 転送ファイル数が、宛先エージェントの制限を超過しました。
注: コマンド・ラインで -w パラメーターを使用しない限り、戻りコードは常に 0 または 1になります。