FTP スクリプト記述ゲートウェイのセットアップ
FTP スクリプト記述ゲートウェイは、設定されたスケジュールに従って動作します。FTP スクリプト記述ゲートウェイの動作は、FTP コマンド・スクリプトで制御します。
FTP スクリプトの作成
FTP スクリプト記述ゲートウェイを使用するには、必要な FTP コマンドのうち、ご使用の FTP サーバーで認められているものをすべて記載したファイルを作成します。
- ゲートウェイに対して実行するアクションを指定したスクリプトを作成します。例えば、以下のスクリプトは、名前とパスワードで指定された FTP サーバーに接続して、FTP サーバー上で指定のディレクトリーに移動し、その中のすべてのファイルをサーバー上の指定のディレクトリーに送信するという例です。
open %BCGSERVERIP% %BCGUSERID% %BCGPASSWORD% %BCGOPTIONx%
cd %BCGOPTIONx%
mput *
quit
ゲートウェイがサービスを提供するとき、プレースホルダー (例えば、%BCGSERVERIP% など) は、FTP スクリプト記述ゲートウェイの特定の
インスタンスを作成するときに入力した値に置き換えられます (以下の表を参照してください)。
表 3. スクリプト・パラメーターの FTP スクリプト記述ゲートウェイのフィールド記入項目へのマップ
スクリプト・パラメーター |
FTP スクリプト記述ゲートウェイのフィールド記入項目 |
%BCGSERVERIP% |
サーバー IP |
%BCGUSERID% |
ユーザー ID |
%BCGPASSWORD% |
パスワード |
%BCGOPTIONx% |
ユーザー定義属性の下のオプション x |
ユーザー定義オプションは、最大 10 個まで設定できます。
- ファイルを保存します。
FTP スクリプト・コマンド
スクリプトを作成する場合は、以下のコマンドを使用できます。
- ascii、binary、passive
これらのコマンドは FTP サーバーに送信されません。各コマンドは、FTP サーバーへの
転送モード (ASCII、バイナリー、またはパッシブ) を変更します。
- cd
このコマンドは、指定されたディレクトリーに移動します。
- delete
このコマンドは、FTP サーバーからファイルを削除します。
- mkdir
このコマンドは、FTP サーバー上にディレクトリーを作成します。
- mput
このコマンドは、リモート・システムに転送する 1 つ以上のファイルを指定する単一の引数を取ります。この引数に標準のワイルドカード文字 (「*」および「?」) を指定して、複数のファイルを示すこともできます。
- open
このコマンドは、FTP サーバーの IP アドレス、ユーザー名、およびパスワードの、3 つのパラメーターを取ります。これらは、%BCGSERVERIP%、%BCGUSERID%、%BCGPASSWORD% 変数にそれぞれマップされます。FTP スクリプト記述ターゲットのスクリプトの最初の行は open %BCGSERVERIP% %BCGUSERID% %BCGPASSWORD% である必要があります。
- quit、bye
このコマンドは、FTP サーバーへの既存の接続を終了します。
- quote
このコマンドは、QUOTE の後に指定されているものをすべてコマンドとしてリモート・システムに送信するように指定します。これにより、標準の FTP プロトコルに定義されていないコマンドをリモート FTP サーバーに送信できるようになります。
- rmdir
このコマンドは、FTP サーバー上からディレクトリーを除去します。
- site
このコマンドは、サイト固有のコマンドをリモート・システムに発行するときに使用できます。リモート・システムは、このコマンドの内容が有効かどうかを判別します。
FTP スクリプト記述ゲートウェイ
FTP スクリプト記述ゲートウェイを使用する場合は、以下の作業を実行します。
FTP スクリプト記述ゲートウェイを作成するには、以下の手順を実行します。
- 「アカウント管理」>「プロファイル」>「ゲートウェイ」をクリックします。
- 「作成」をクリックします。
ゲートウェイの詳細
「ゲートウェイ・リスト」ページから、以下のステップを実行します。
- ゲートウェイを示す名前を入力します。このフィールドは必須です。
- (オプション) ゲートウェイの状況を指定します。デフォルトは「使用可能」です。使用可能状態のゲートウェイは、文書を送信することができます。
使用不可状態のゲートウェイは、文書を送信できません。
- (オプション) ゲートウェイがオンラインかオフラインかを指定します。
デフォルトは「オンライン」です。
- (オプション) ゲートウェイの説明を入力します。
ゲートウェイの構成
このページの「ゲートウェイ構成」セクションで、以下のステップを実行します。
- 「トランスポート」リストから、「FTP Scripting」を選択
します。
- 文書の送信先となる FTP サーバーの IP アドレスを入力します。FTP スクリプトが実行されると、ここに入力した値で %BCGSERVERIP% が置き換えられます。
- FTP サーバーへのアクセスに必要なユーザー ID とパスワードを入力します。FTP スクリプトが実行されると、ここに入力した値で %BCGUSERID% および %BCGPASSWORD% が置き換えられます。
- ターゲットがセキュア・モードの場合は、「FTPS モード」に対して
デフォルトの「はい」を使用してください。それ以外は、「いいえ」をクリックします。
- 以下の手順に従い、スクリプト・ファイルをアップロードします。
- 「スクリプト・ファイルのアップロード」をクリックします。
- 文書を処理するためのスクリプトを含むファイルの名前を入力するか、「参照」をクリックしてファイルにナビゲートします。
- 「ファイルのロード」をクリックして、スクリプト・ファイルを「現在ロードされているスクリプト・ファイル」テキスト・ボックスにロードします。
- このスクリプト・ファイルが使用したいスクリプト・ファイルである場合は、「保管」をクリックします。
- 「ウィンドウを閉じる」をクリックします。
- 「再試行カウント」フィールドには、失敗するまでにゲートウェイが行う文書の送信試行回数を入力します。デフォルトは 3 です。
- 「再試行間隔」フィールドには、ゲートウェイで文書の再送付を行うまで待機する時間を入力します。デフォルトは 300 秒です。
- 「接続タイムアウト」に、トラフィックがなくてもソケットを開いたままにしておく時間 (秒数) を入力します。デフォルトは 120 秒です。
- 「ロック・ユーザー」フィールドに、ゲートウェイがロックを要求して、FTP スクリプト記述ゲートウェイの他のインスタンスが同時に同じ FTP サーバー・ディレクトリーに
アクセスできないようにするかどうかを指定します。
ユーザー定義属性
追加の属性を指定する場合は、以下のステップを実行します。FTP スクリプトが実行されると、オプションに入力した値で %BCGOPTIONx% が置き換えられます (x はオプション番号に対応します)。
- 「新規」をクリックします。
- 「オプション 1」の横に値を入力します。
-
追加の属性を指定する場合は、「新規」を再びクリックして、値を入力します。
- 必要なだけステップ 3 を繰り返して、すべての属性を定義します。
例えば、FTP スクリプトが次のようになっているとします。
Open %BCGSERVERIP% %BCGUSERID% %BCGPASSWORD%
cd %BCGOPTION1%
mput *
quit
この場合、%BCGOPTION% はディレクトリー名です。
スケジュール
このページの「スケジュール」セクションから、以下のステップを実行します。
- 間隔を基にしたスケジューリングとカレンダーを基にしたスケジューリングのどちらが必要なのかを指定します。
- 「間隔を基にしたスケジューリング」を
選択した場合は、ゲートウェイがポーリングされるまでの経過秒数を選択します (またはデフォルト値を受け入れます)。
- 「カレンダーを基にしたスケジューリング」を
選択した場合は、スケジューリングのタイプ (「日次スケジュール」、「週次スケジュール」、または「カスタム・スケジュール」) を選択します。
- 「日次スケジュール」を選択した場合は、ゲートウェイがポーリングされる時刻を入力します。
- 「週次スケジュール」を選択した場合は、時刻のほかに曜日を 1 つ以上選択します。
- 「カスタム・スケジュール」を選択した場合は、まず時刻を選択し、次に週および月に
ついて「範囲」または「選択できる日」を選択します。「範囲」では、開始日と終了日を指定します。(例えば、平日の特定の時刻にのみサーバーをポーリングする場合は、「月」および「金」をクリックします。) 「選択できる日」では、週および月の特定の日付を選択します。
- ゲートウェイのプリプロセスまたはポストプロセス・ステップを構成する場合は、ハンドラーの構成を参照してください。
それ以外の場合は、「保管」をクリックします。
