FTPFileList - FTPファイル一覧の取得

FTPサーバーから条件に一致したファイル名のリストを取得します。

■ストリーム情報

入力	フォーマット	すべて
	接続数	無制限
	説明	入力ストリームは使用せず、すべて無視します。
出力	フォーマット	Record
	説明	出力ストリームは以下の決められたフィールドをもつレコードです。 各フィールドの順序は固定です。順序を変更したり途中のフィールドを削除したりした場合、正しくデータが取得できないので注意してください。 フィールド名 データ型 説明 FileName String ファイル名 FilePath String ファイルのフルパス FileDate DateTime ファイルの更新日時 FileSize Integer ファイルサイズ FileType String ファイル種別「file」または「directory」

■コンポーネントプロパティ

名前	プロパティ型	マッピング	説明
コネクションを使用	boolean	-	接続先にコネクション名 に指定されたコネクションを使用するかどうか選択します。 はい [true] - コネクション名 で指定されたFTP接続名の接続設定を使ってFTPまたはSFTPによる接続を行います。 いいえ [false] - コネクション情報 以下の値を使ってFTPまたはSFTPによる接続を行います。
コネクション名	connection	-	コネクションを使用 が「はい」の場合に接続先のFTPサーバーを指定します。 コネクションペインまたは管理コンソールにて作成したFTP接続名を選択します。 各コネクションの詳細については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「コネクションプロパティ」を参照してください。
コネクション情報	group	-	コネクションを使用 が「いいえ」の場合に使用されるプロパティ群です。
プロトコル	choice	入力＆出力	接続先がFTPサーバーであるかSFTPサーバーであるかを指定します。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 ftp - 接続先がFTPサーバーの場合 sftp - 接続先がSFTPサーバーの場合
サーバー名	string	入力＆出力	接続先のFTPまたはSFTPサーバー名を指定します。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
ポート番号	int	入力＆出力	接続先のFTPまたはSFTPサーバーのポート番号を指定します。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
パッシブモード	boolean	入力＆出力	FTP接続のモードでパッシブモードを使うかどうかを指定します。 接続先がSFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 はい [true] - パッシブモードを使用します。 いいえ [false] - パッシブモードを使用しません。
ファイル名のエンコーディング	choice	入力＆出力	転送されるファイルのファイル名のエンコーディングを指定します。 日本語のファイル名を使わない場合（US-ASCII文字のみの場合）にはどれを指定しても構いません。 接続先がSFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
タイムアウト（秒）	int	入力＆出力	接続時のタイムアウト時間（秒）を設定します。初期値は60です。0を指定すると無制限になります。接続後のアイドルタイムアウト指定はなく無制限です。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
プロキシサーバー	choice	入力＆出力	管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。 コネクションを使用が「いいえ」の場合にこの設定が参照されます。 使用する [true] - プロキシ設定を使用します。 使用しない [false] - プロキシ設定を使用しません。
ユーザー名	string	入力＆出力	FTPまたはSFTPサーバーへのログイン名を指定します。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
パスワード	password	入力＆出力	上記ログイン名に対応するパスワードを指定します。 接続先がSFTPサーバーで、公開鍵認証のキーファイル が指定されている場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
公開鍵認証のキーファイル	string	入力＆出力	SFTPサーバーが公開鍵認証である場合に、認証で使用する秘密鍵のファイル名を絶対パスで指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
キーファイルのパスフレーズ	password	入力＆出力	公開鍵認証のキーファイル で指定した秘密鍵がパスフレーズで保護されている場合には、そのパスフレーズを指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
ファイル名のパターン	string	入力＆出力	一覧に含めるファイルのマスク。 「*」と「?」の2つのワイルドカードが使用できます。「*」は0個以上の任意の文字に、「?」は任意の1文字にマッチします。 空の場合はマスクによる絞込みを行いません。 ※このコンポーネントでは「**」は使用できません。
対象フォルダー	string	入力＆出力	ファイル一覧を取得するサーバー上のフォルダーを指定します。 空の場合はFTPユーザーのホームフォルダーの一覧を取得します。
種別	choice	入力＆出力	ファイル一覧に含めるファイル種別を選択します。 フォルダーとファイル [All] - ファイルおよびフォルダー。 ファイルのみ [File] - ファイルのみ。 フォルダーのみ [Directory] - フォルダーのみ。
ファイル日時を取得する	boolean	-	出力ストリームのフィールド名FileDateにファイルの最終更新日時を設定するかどうかを選択します。 最終更新日時が不要な場合、本プロパティで「いいえ」を選択するとパフォーマンスが向上します。 はい [true] - ファイルの最終更新日時を設定します。 いいえ [false] - グリニッジ標準時のローカルタイムを設定します。
対象更新日時	group	-	取得するリストをファイルの更新日時で絞り込む場合に使用されるプロパティ群です。
これ以前	datetime	入力＆出力	この値が設定された場合、設定された日時以前の更新日付をもったファイルを対象にします。 この値の表記は、yyyy-MM-dd'T'HH:mm:ss'.'SSS z形式で指定します。時刻情報の省略はできません。 また、取得するファイルリストには更新日時が設定時刻ちょうどのファイルは含まれません。 この値を設定する場合はファイル日時を取得する を「はい」にします。
これ以後	datetime	入力＆出力	この値が設定された場合、設定された日時以後の更新日付をもったファイルを対象にします。 この値の表記は、yyyy-MM-dd'T'HH:mm:ss'.'SSS z形式で指定します。時刻情報の省略はできません。 また、取得するファイルリストには更新日時が設定時刻ちょうどのファイルは含まれません。 この値を設定する場合はファイル日時を取得する を「はい」にします。
ソート順	choice	入力＆出力	ファイル一覧のソート順を指定します。 ファイルパス(昇順) [FilePath] ファイルパスでソート（昇順） ファイルパス(降順) [FilePath(Desc)] ファイルパスでソート（降順） 更新日時(昇順) [FileDate] 更新日時でソート（昇順） 更新日時(降順) [FileDate(Desc)] 更新日時でソート（降順） ファイルサイズ(昇順) [FileSize] ファイルサイズでソート（昇順） ファイルサイズ(降順) [FileSize(Desc)] ファイルサイズでソート（降順）
ループを開始	loopProcess	-	ファイル一覧をまとめて出力するか1レコードずつループして出力するかを選択します。 はい [true] - ループの起点となって1レコードずつストリームに出力します。 いいえ [false] - すべてのレコードをまとめてストリームに出力します。

■ループ処理

ループを開始 が「はい」の場合、このコンポーネントが起点となってファイル一覧を1レコードずつ出力ストリームに出力します。

■トランザクション処理

コミット	何もしません。
ロールバック	何もしません。

■エラー処理

タイプ	パラメーター	エラー処理フロー へのストリーム	エラー コード	説明
フォルダーが存在しない	なし	コンポーネントの入力ストリーム	1	対象フォルダー で指定したフォルダーが見つからない場合
ファイルが存在しない	なし	コンポーネントの入力ストリーム	2	対象フォルダー で指定したフォルダーにファイルがない場合
汎用	なし	コンポーネントの入力ストリーム	10	コネクション名 に指定したコネクションが見つからない場合
			11	FTPサーバーに接続できない場合
			12	FTPサーバーからエラーが返された場合
			なし	その他のエラーが発生した場合

■制限事項

LISTコマンドの結果が、Windows, Unixスタイルのファイルリストのみ対応しています。それ以外の場合にはエラーとなることがあります。