FTPトリガー

オペレーション名

FTPトリガー

機能概要

FTPトリガーは、DataSpiderServer上で動作するFTPサーバ(以下、「FTPサーバ」)、またはSFTPサーバ(以下、「SFTPサーバ」)にアップロードされたファイルを検知して、スクリプトを実行するトリガー機能です。

FTPサーバ、SFTPサーバについては、「FTPサーバの設定」を参照してください。

発火イメージ

FTPクライアントからFTPサーバに対して、またはSFTPクライアントからSFTPサーバに対して、ファイルをアップロードします。

FTPサーバまたはSFTPサーバへのファイルのアップロードが完了します。

ファイルのアップロードが完了したらFTPトリガーを発火します。

FTPトリガーがスクリプトを実行します。

スクリプトを実行する際、以下の情報をスクリプトに渡すことができます。
- アップロードされたファイルのファイルパス
- アップロードされたファイルのファイル名
- アップロードを実行したFTPユーザ名

プロパティ

FTPトリガーの設定

項目名	内容	備考
トリガー名	トリガーの名前を入力します。
FTPユーザ名	FTPクライアントまたはSFTPクライアントから、ファイルのアップロードを実行するFTPユーザ名を指定します。	FTPユーザはDataSpider Servistaで管理しているユーザを使用します。ユーザ管理については、「ユーザ管理」を参照してください。 DataSpider Servistaで管理しているユーザ以外に以下を指定することができます。 (指定しない): 任意のFTPユーザがアップロードしたファイルを監視対象とします。 anonymous: anonymousユーザを使用するには、FTPサーバの設定で[Anonymousログインを許可する]にチェックが入っている必要があります。 SFTPサーバでanonymousユーザは使用できません。
監視ファイル	監視対象にするファイルのFTPサーバ、SFTPサーバ上のファイルパスを指定します。	複数のファイルパスを指定することができます。ファイルパスはFTPサーバ、SFTPサーバのルートディレクトリ("/")から始まる絶対パスを入力してくださいファイル名の指定には、ワイルドカード(「」・「?」)が使用できます。例: /upload/.csv /uploadディレクトリ直下にアップロードされた拡張子がcsvのファイルを監視します。例: /upload/売り上げデータ??.xls uploadディレクトリ直下にアップロードされた「売り上げデータ」で始まり、そのあとに2文字続く拡張子がxlsのファイルを監視します。パス区切り文字「/」およびワイルドカード(「」・「?」)以外のDataSpiderファイルシステムの使用禁止文字は使用できません。大文字小文字を区別します。そのほか、[監視ファイル]*に関する注意事項については、こちらを参照してください。

実行内容の設定

項目名	内容	備考
トリガー所有者	作成するトリガーの所有者を選択します。	管理者権限を持ったユーザのみ選択できます。 (一般ユーザは自分以外を選択することはできません。)
実行ユーザ名	[スクリプト]で指定したスクリプトを実行するユーザを選択します。
パスワード	[実行ユーザ名]で指定したユーザに対応したパスワードを入力します。
サービス	トリガーで実行するスクリプトを含むサービスを選択します。	サービスとして登録されたプロジェクトが表示されます。
スクリプト	トリガーで実行するスクリプトを選択します。	[サービス]で指定したサービス内のスクリプトが表示されます。
スクリプト引数	[スクリプト]で指定したスクリプトに設定されているスクリプト入力変数が表示されます。	スクリプト出力変数は表示されません。スクリプトにスクリプト入力変数を設定し、使用する方法については、「入出力変数について」を参照してください。
スクリプト引数/変数名	スクリプト変数名が表示されます。	編集はできません。
スクリプト引数/型	スクリプト変数の型が表示されます。	編集はできません。
スクリプト引数/値	スクリプト変数の値を入力します。	[高度な操作]ウィンドウからトリガー変数を指定できます。

実行オプションの設定

実行オプションの設定については、「実行オプションの設定」を参照してください。

トリガー変数

トリガー変数をスクリプト入力変数に設定することで、FTPトリガーの設定情報をスクリプト実行時に使用することができます。

トリガー変数名	値	内容	備考
アップロードファイルパス	trigger.uploadedFilePath	アップロードの完了を検知したファイルパスです。ファイルパスはDataSpiderファイルシステムのパスになります。	指定例:${trigger.uploadedFilePath}
アップロードファイル名	trigger.uploadedFileName	アップロードの完了を検知したファイル名です。	指定例:${trigger.uploadedFileName}
FTPユーザ名	trigger.ftpUserName	ファイルのアップロードを実行したFTPユーザ名です。	指定例:${trigger.ftpUserName}

監視ファイルのファイルパスについて

[監視ファイル]に複数のファイルパスを指定した場合、指定したファイルパスにマッチするファイルが1つでもアップロードされると、トリガーが発火します。

[監視ファイル]にワイルドカード(「*」・「?」)を使用した際に、1つのファイルパスにマッチする複数のファイルがアップロードされた場合、トリガーは1つのファイルにつき1回ずつ発火します。

FTPサーバ、SFTPサーバにアップロードされた1つのファイルが[監視ファイル]に設定した複数のファイルパスにマッチしても、トリガーの発火回数は1回になります。

仕様制限

アップロードとして検知するFTPコマンドはSTORのみとなります。STOU(固有のファイル名でアップロード)、APPE(挿入)、MKD(ディレクトリ作成)は検知されません。

ファイルのアップロード途中でアップロードを中断した場合でも、その時点でアップロード完了とみなしトリガーが発火します。

STORの応答コードが「226」以外はファイルのアップロードが失敗したとみなし、トリガーは発火しません。

再帰的なファイル監視は行いません。

例:[監視ファイル]の[ファイルパス]が「/Upload/*」の場合
- ファイル「/Upload/test.txt」がアップロード
  → トリガーが発火します。
- ファイル「/Upload/20100429/test.txt」がアップロード
  → トリガーは発火しません。

主な例外

ありません。

注意事項

トリガーの登録後、トリガーに設定されているサービスやスクリプトの状態が変更された場合(サービス名・スクリプト名の変更や、スクリプト変数の追加・削除など)、登録済みのトリガーにその変更は反映されません。
対象のトリガーのプロパティ設定ダイアログを開き、サービスやスクリプトの再選択を行ったあと[完了]ボタンを押下して再登録してください。

FTPサーバ、SFTPサーバが停止中でもトリガーを「有効」な状態で登録することができますが、以下の警告メッセージが表示されます。