FTPScript - FTPスクリプトの実行
FTPサーバーに接続して、指定したスクリプトファイルに記述されているFTPコマンドを順次実行します。途中で、あるFTPコマンドが失敗した場合はコンポーネントはそこで実行を中止し、失敗したFTPコマンド以降のスクリプト内のコマンド列は実行されずにエラー処理に制御が移ります。
FTPコマンドで操作するローカルファイルはローカルフォルダーからの相対パスで指定します。ローカルフォルダーとは、ホームフォルダー で指定したホームフォルダーまたはlcdコマンドで指定したフォルダーを指します。
本コンポーネントでサポートしているコマンドは、下記トピック「コマンド一覧」を参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 1 | |
| 説明 | すべてのストリームを入力できます。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| スクリプトの設定方法 | choice | - |
スクリプトの設定方法を指定します。
|
||||||||||||||||||
| スクリプトファイル情報 | group | - | スクリプトの設定方法 が「ファイル」の場合に使用するプロパティ群です。 | ||||||||||||||||||
| 相対パスの起点 | pathResolver | - | スクリプトの設定方法 が「ファイル」の場合、下のファイルパス の相対パスのベースフォルダーを指定します。
|
||||||||||||||||||
| ファイルパス | remoteFile | 入力＆出力 | スクリプトの設定方法 が「ファイル」の場合、FTPコマンドを記述したスクリプトファイルのファイルパスを指定します。 | ||||||||||||||||||
| エンコーディング | choice | 入力＆出力 | スクリプトの設定方法 が「ファイル」の場合、FTPスクリプトファイルのエンコーディングを指定します。
|
||||||||||||||||||
| スクリプト | string | 入力＆出力 | スクリプトの設定方法 が「直接入力」の場合、FTPスクリプトの内容を記述します。 | ||||||||||||||||||
| コネクションを使用 | boolean | - |
接続先にコネクション名 に指定されたコネクションを使用するかどうか選択します。
|
||||||||||||||||||
| コネクション名 | connection | - | コネクションを使用 が「はい」の場合に接続先のFTPサーバーを指定します。 コネクションペインまたは管理コンソールにて作成したFTP接続名を選択します。 | ||||||||||||||||||
| コネクション情報 | group | - | コネクションを使用 が「いいえ」の場合に使用されるプロパティ群です。 | ||||||||||||||||||
| プロトコル | choice | 入力＆出力 |
接続先がFTPサーバーであるかSFTPサーバーであるかを指定します。
コネクションを使用 が「いいえ」の場合、この設定を参照します。
|
||||||||||||||||||
| サーバー名 | string | 入力＆出力 |
接続先のFTPまたはSFTPサーバー名を指定します。
コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| ポート番号 | int | 入力＆出力 |
接続先のFTPまたはSFTPサーバーのポート番号を指定します。
コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| パッシブモード | boolean | 入力＆出力 |
FTP接続のモードでパッシブモードを使うかどうかを指定します。
接続先がSFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。
|
||||||||||||||||||
| ファイル名のエンコーディング | choice | 入力＆出力 |
転送されるファイルのファイル名のエンコーディングを指定します。
日本語のファイル名を使わない場合（US-ASCII文字のみの場合）にはどれを指定しても構いません。
接続先がSFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| タイムアウト（秒） | int | 入力＆出力 |
FTPまたはSFTPクライアントとして、接続がタイムアウトするまでの時間を指定します。
最後に通信が行われてから指定時間経過するとタイムアウトとなります。
コネクションを使用 が「いいえ」の場合、この設定を参照します。 FTPPutコンポーネントやFTPScriptコンポーネント、FTPUploadコンポーネントではタイムアウトが有効にならないことがあります。 |
||||||||||||||||||
| プロキシサーバー | choice | 入力＆出力 |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用が「いいえ」の場合にこの設定が参照されます。
|
||||||||||||||||||
| ユーザー名 | string | 入力＆出力 |
FTPまたはSFTPサーバーへのログイン名を指定します。
コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| パスワード | password | 入力＆出力 |
上記ログイン名に対応するパスワードを指定します。
接続先がSFTPサーバーで、公開鍵認証のキーファイル が指定されている場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| 公開鍵認証のキーファイル | string | 入力＆出力 |
SFTPサーバーが公開鍵認証である場合に、認証で使用する秘密鍵のファイル名を絶対パスで指定します。
接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| キーファイルのパスフレーズ | password | 入力＆出力 | 公開鍵認証のキーファイル で指定した秘密鍵がパスフレーズで保護されている場合には、そのパスフレーズを指定します。
接続先がFTPサーバーの場合、この設定は参照されません。 コネクションを使用 が「いいえ」の場合、この設定を参照します。 |
||||||||||||||||||
| ホームフォルダー | pathResolver | - |
FTPのホームフォルダーとして使うローカルディスクのベースフォルダーを指定します。
|
||||||||||||||||||
| 条件 | group | - | 条件 関連のプロパティ群です。 | ||||||||||||||||||
| 操作対象日時 | choice | 入力＆出力 |
mput、mget、mdeleteの各コマンドでファイル操作を行う場合の日付でのフィルターリングの基準を指定します。
|
||||||||||||||||||
| 指定日時 | string | 入力＆出力 | 上記操作対象日時 で使用するベースとなる日時を設定します。 ここで設定できる日付フォーマットは「yyyyMMddHHmmss」形式のみです。 操作対象日時 が「すべて」の場合はこの値は無視されます。 | ||||||||||||||||||
| ログ | group | - | ログ 関連のプロパティ群です。 | ||||||||||||||||||
| ログ内容 | choice | 入力＆出力 |
FTPスクリプトの実行ログレベルを選択します。
|
||||||||||||||||||
| 相対パスの起点 | pathResolver | - | 相対パスの起点 は下のログファイルパス の相対パスのベースフォルダーを指定します。
|
||||||||||||||||||
| ログファイルパス | remoteFile | 入力＆出力 | ログファイルのファイルパスを指定します。 すでに存在する場合は上書きされます。 |
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | 「汎用のパラメーター
」
を参照してください。 | コンポーネントの入力ストリーム | 1 | 指定日時が指定されていない場合 |
| 2 | スクリプト中のFTPコマンドが解釈できない場合 | |||
| 3 | スクリプト中のFTPコマンドの書式が不正の場合 | |||
| 4 | FTPコマンドの引数にパスが含まれていた場合 | |||
| 5 | FTPコマンドの引数の形式が不正だった場合 | |||
| 10 | コネクション名 に指定したコネクションが見つからない場合 | |||
| 11 | FTPサーバーに接続できない場合 | |||
| 12 | FTPサーバーからエラーが返された場合 | |||
| なし | その他のエラーが発生した場合 |
■「汎用」のパラメーター
| No. | 名前 | 説明 |
|---|---|---|
| 1 | ScriptFilename | エラーが発生したときに使われていたスクリプトファイルのフルパスの文字列 |
| 2 | ErrorDetail | エラーが発生した理由のエラーの詳細 |
| 3 | ErrorLine | スクリプトファイル中のエラーになった行の行番号。スクリプトのコマンドでのエラーでない場合は「0」が設定されます |
■制限事項
シングルクォート（'）を含むファイル名を扱うことはできません。ダブルクォート（"）を含むファイル名を扱う場合には、ファイル名をシングルクォートで囲んでください。
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サーバーではサポートされません) |