FTPScript - FTPスクリプトの実行

FTPサーバーに接続して、指定したスクリプトファイルに記述されているFTPコマンドを順次実行します。
途中で、あるFTPコマンドが失敗した場合はコンポーネントはそこで実行を中止し、失敗したFTPコマンド以降のスクリプト内のコマンド列は実行されずにエラー処理に制御が移ります。
FTPコマンドで操作するローカルファイルはローカルディレクトリからの相対パスで指定します。ローカルディレクトリとは、ホームディレクトリで指定したホームディレクトリまたはlcdコマンドで指定したディレクトリを指します。
本コンポーネントでサポートしているコマンドは、下記トピック「コマンド一覧」を参照してください。

■ストリーム情報

入力	フォーマット	すべて
	接続数	1
	説明	すべてのストリームを入力できます。
出力	フォーマット	すべて
	説明	入力ストリームをそのまま出力します。

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

名前	プロパティ型	マッピング	説明
スクリプトの設定方法	choice	-	スクリプトの設定方法を指定します。 ファイル [File] - スクリプトの指定にスクリプトファイル情報以下のプロパティを使用します。 直接入力 [Inline] - スクリプトの指定にスクリプトを使用します。
スクリプトファイル情報	group	-	スクリプトの設定方法が「ファイル」の場合に使用するプロパティ群です。
相対パスの起点	pathResolver	-	スクリプトの設定方法が「ファイル」の場合、下のファイルパスの相対パスのベースディレクトリを指定します。 プロジェクトフォルダ [Relative] プロジェクトファイルと同じフォルダを起点にします。 ホームディレクトリ [ProjectOwner] ユーザーのホームディレクトリを起点にします。 実行ユーザーのホームディレクトリ [ExecuteUser] 実行ユーザーのホームディレクトリを起点にします。
ファイルパス	remoteFile	入力＆出力	スクリプトの設定方法が「ファイル」の場合、FTPコマンドを記述したスクリプトファイルのファイルパスを指定します。
エンコーディング	choice	入力＆出力	スクリプトの設定方法が「ファイル」の場合、FTPスクリプトファイルのエンコーディングを指定します。 utf-8 - unicode utf-8 shift_jis - シフトJIS euc-jp - EUC-JP iso-2022-jp - ISO-2022-JP Windows-31J - Windows-31J utf-16 - unicode utf-16
スクリプト	string	入力＆出力	スクリプトの設定方法が「直接入力」の場合、FTPスクリプトの内容を記述します。
コネクションを使用	boolean	-	接続先にコネクション名に指定されたコネクションを使用するかどうか選択します。 はい [true] - コネクション名で指定されたFTP接続名の接続設定を使ってFTPによる接続を行います。 いいえ [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コンポーネントではタイムアウトが有効にならないことがあります。
ユーザー名	string	入力＆出力	FTPまたはSFTPサーバーへのログイン名を指定します。 コネクションを使用が「いいえ」の場合、この設定を参照します。
パスワード	password	入力＆出力	上記ログイン名に対応するパスワードを指定します。 接続先がSFTPサーバーで、公開鍵認証のキーファイルが指定されている場合、この設定は参照されません。 コネクションを使用が「いいえ」の場合、この設定を参照します。
公開鍵認証のキーファイル	string	入力＆出力	SFTPサーバーが公開鍵認証である場合に、認証で使用する秘密鍵のファイル名を絶対パスで指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用が「いいえ」の場合、この設定を参照します。
キーファイルのパスフレーズ	password	入力＆出力	公開鍵認証のキーファイルで指定した秘密鍵がパスフレーズで保護されている場合には、そのパスフレーズを指定します。 接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用が「いいえ」の場合、この設定を参照します。
ホームディレクトリ	pathResolver	-	FTPのホームディレクトリとして使うローカルディスクのベースディレクトリを指定します。 プロジェクトフォルダ [Relative] プロジェクトファイルと同じフォルダを起点にします。 ホームディレクトリ [ProjectOwner] ユーザーのホームディレクトリを起点にします。 実行ユーザーのホームディレクトリ [ExecuteUser] 実行ユーザーのホームディレクトリを起点にします。
条件	group	-	条件関連のプロパティ群です。
操作対象日時	choice	入力＆出力	mput、mget、mdeleteの各コマンドでファイル操作を行う場合の日付でのフィルターリングの基準を指定します。 すべて [None] - すべてのファイルを各コマンドのオペレーションの操作対象にします。 指定日時以前 [Before] - 指定日時で設定された日時より前の更新日付をもったファイルを対象にします。 指定日時以降 [Since] - 指定日時で設定された日時より後の更新日付をもったファイルを対象にします。
指定日時	datetime	入力＆出力	上記操作対象日時で使用するベースとなる日時を設定します。 ここで設定できる日付フォーマットは「yyyyMMddhhmmss」形式のみです。 操作対象日時が「None」の場合はこの値は無視されます。
ログ	group	-	ログ関連のプロパティ群です。
ログ内容	choice	入力＆出力	FTPスクリプトの実行ログレベルを選択します。 出力しない [None] - ログを出力しません。 結果情報のみ出力する [Info] - FTPスクリプト中の各コマンドの成功・失敗の情報のみをログに出力します。 詳細情報を出力する [Detail] - FTPのプロトコルレベルのログを出力します。
相対パスの起点	pathResolver	-	相対パスの起点は下のログファイルパスの相対パスのベースディレクトリを指定します。 プロジェクトフォルダ [Relative] プロジェクトファイルと同じフォルダを起点にします。。 ホームディレクトリ [ProjectOwner] ホームディレクトリを起点にします。 実行ユーザーのホームディレクトリ [ExecuteUser] 実行ユーザーのホームディレクトリを起点にします。
ログファイルパス	remoteFile	入力＆出力	ログファイルのファイルパスを指定します。 すでに存在する場合は上書きされます。

■トランザクション処理

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

■エラー処理

タイプ	パラ メータ	エラー処理フロー へのストリーム	エラー コード	説明
汎用	No. 名前 説明 1 ScriptFilename エラーが発生したときに使われていたスクリプトファイルのフルパスの文字列 2 ErrorDetail エラーが発生した理由のエラーの詳細 3 ErrorLine スクリプトファイル中のエラーになった行の行番号。スクリプトのコマンドでのエラーでない場合は「0」が設定されます	コンポーネントの入力ストリーム	なし	コネクション名に指定したコネクションが見つからない場合
			なし	FTPサーバーに接続できない場合
			なし	FTPサーバーからエラーが返された場合
			なし	スクリプト中のFTPコマンドが解釈できない場合
			なし	スクリプト中のFTPコマンドの書式が不正の場合

■制限事項

シングルクォート（'）を含むファイル名を扱うことはできません。
ダブルクォート（"）を含むファイル名を扱う場合には、ファイル名をシングルクォートで囲んでください。

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

■フローの強制終了

フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。

■コマンド一覧

本コンポーネントは以下のコマンドをサポートしています。

コマンド名	説明
cd dir	リモートディレクトリの変更
lcd dir	ローカルディレクトリの変更
delete remoteFile	FTPサーバー上のファイルの削除
mdelete remoteFileWildcard	ワイルドカードによる、指定した複数ファイルのFTPサーバー上のファイルの削除
put localFile remoteFile	FTPサーバーへのファイルのアップロード
mput localFileWildcard	ワイルドカードによる、指定した複数ファイルのアップロード
append localFile remoteFile	FTPサーバー上の存在するファイルへの追加
ascii	ファイル転送モードを「ascii」に設定
binary	ファイル転送モードを「binary」に設定
get remoteFile localFile	FTPサーバーからのファイルのダウンロード
mget remoteFileWildcard	ワイルドカードによる、指定した複数ファイルのダウンロード
mkdir remoteDir	FTPサーバー側にディレクトリを作成
rmdir remoteDir	FTPサーバー側のディレクトリを削除
rename remoteFile newRemoteFile	FTPサーバー上のファイル名を変更
quote command	任意のFTPコマンドの実行 (※SFTPサーバではサポートされません)