FTPGet - FTPサービスからの入力

FTPサーバーからファイルを取得してストリームに出力します。

■ストリーム情報

入力	フォーマット	すべて
	接続数	1
	説明	入力ストリームは使用せず、すべて無視します。
出力	フォーマット	XML,CSV,FixedLength,Text,HTML,Binary,MIME,JSON
	説明	読み込んだストリームの種類に応じて設定します。

出力ストリーム変数

名前	データ型	説明
FilePath	String	読み込んだファイルのファイル名
FileDate	DateTime	読み込んだファイルの最終更新日時
FileSize	Integer	読み込んだファイルのサイズ

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

名前	プロパティ型	マッピング	説明
コネクションを使用	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	入力＆出力	FTPまたはSFTPクライアントとして、接続がタイムアウトするまでの時間を指定します。 最後に通信が行われてから指定時間経過するとタイムアウトとなります。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 FTPPutコンポーネントやFTPScriptコンポーネント、FTPUploadコンポーネントではタイムアウトが有効にならないことがあります。
ユーザー名	string	入力＆出力	FTPまたはSFTPサーバーへのログイン名を指定します。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
パスワード	password	入力＆出力	上記ログイン名に対応するパスワードを指定します。 接続先がSFTPサーバーで、公開鍵認証のキーファイル が指定されている場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
公開鍵認証のキーファイル	string	入力＆出力	SFTPサーバーが公開鍵認証である場合に、認証で使用する秘密鍵のファイル名を絶対パスで指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
キーファイルのパスフレーズ	password	入力＆出力	公開鍵認証のキーファイル で指定した秘密鍵がパスフレーズで保護されている場合には、そのパスフレーズを指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
ファイルパス	string	入力＆出力	取得するファイルのフォルダーパスおよびファイルパスを相対パスで指定します。絶対パスでの指定はできません。 「*」と「?」の2つのワイルドカードが使用できます。「*」は0個以上の任意の文字に、「?」は任意の1文字にマッチします。
ファイル日時を取得する	boolean	-	出力ストリーム変数FileDateにファイルの最終更新日時を設定するかどうかを選択します。 最終更新日時が不要な場合、本プロパティで「いいえ」を選択するとパフォーマンスが向上します。 はい [true] - ファイルの最終更新日時を設定します。 いいえ [false] - グリニッジ標準時のローカルタイムを設定します。
転送モード	choice	入力＆出力	FTPの転送モードを指定します。 Ascii - ASCIIモード。改行コードをプラットフォームに合わせて変換します。 Binary - バイナリモード。
ファイルのエンコーディング	choice	入力＆出力	転送されるファイルのエンコーディングを指定します。 出力ストリームがCSV/Text/HTMLの場合にこの設定が参照されます。 ファイルの内容として日本語を使わない場合（US-ASCII文字のみの場合）にはどれを指定しても構いません。
ループを開始	loopProcess	-	ファイルパス にワイルドカードが指定され、複数のファイルが指定にマッチする場合に、ファイルをまとめて出力するか1ファイルずつループして出力するかを選択します。 はい [true] - ループの起点となって1ファイルずつストリームに出力します。 いいえ [false] - すべてのファイルをコンテナ化してまとめてストリームに出力します。
コミット時の処理	choice	-	コミット時の処理を選択します。 ファイルを削除 [true] - 削除します。 何もしない [false] - 削除しません。

■ループ処理

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

■トランザクション処理

コミット	コミット時の処理 が「ファイルを削除」の場合、ファイルをFTPサーバーから削除します。
ロールバック	何もしません。

■エラー処理

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

■フローの強制終了

フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。強制終了された場合、トランザクションをロールバックします。

■制限事項

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