バッチアダプタ BatchSFTP アダプタの接続マッププロパティーの設定
ここでは、接続マップからアクセスされる BatchSFTP OTD の設定プロパティーについて説明します。
BatchSFTP アダプタの接続マッププロパティーに含まれるセクションは、次のとおりです。
転送前 (BatchSFTP の接続マップ)
「転送前」プロパティーでは、保護/バックアップ/復旧の動作をカスタマイズできます。ここでは、実際のファイル転送の前にリモートまたはローカルで実行される処理について説明します。
BatchSFTP の接続マッププロパティーの「転送前」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–35 接続マップ - BatchSFTP - 転送前
名前
|
説明
|
必要な値
|
リモートディレクトリ名
|
ファイルのリネームまたはコピーの実行場所となる、リモート外部システム上のディレクトリの名前 (パス) を指定します。これは、「リモート転送前コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
アウトバウンド (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。
特殊文字を使用できます。このパラメータが使用されるたびに、
あらゆる特殊文字の展開
が実行されます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。
「リモートディレクトリ名がパターン」プロパティーを参照してください。
|
ディレクトリ名。
|
リモートディレクトリ名がパターン
|
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートディレクトリ名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「はい」です。
|
リモートファイル名
|
ファイルのリネーム先またはコピー先となる、外部システム上のファイルの名前を指定します。この設定は、「転送前コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「リモートファイル名がパターン」プロパティーを参照してください。
|
ファイル名。
|
リモートファイル名がパターン
|
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートファイル名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「はい」です。
|
リモート転送前コマンド
|
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップ/クリーンアップできます。オプションは次のとおりです。
-
リネーム: 保護または復旧のためにターゲットファイルの名前を変更します。
-
コピー: バックアップまたは復旧のためにターゲットファイルをコピーします。
-
なし: 何も行いません。
適切な保護、バックアップ、または復旧を実現するには、目的に合った適切な設定を選択する必要があります。たとえば、アウトバウンド追加転送時の障害から復旧するには、「コピー」設定を使用します。
注 –
「リネーム」使用時にリネーム後のファイルが存在している場合の動作は、FTP サーバーごとに異なる可能性があります。たとえば、一部の UNIX FTP サーバーでは、ユーザーへの確認なしに宛先のファイルが上書きされます。つまり、エラーまたは警告メッセージが表示されません。ほかの FTP サーバー、たとえば Windows XP サーバーでは、システムによってエラーが生成され、その結果、呼び出された OTD メソッド内で例外がスローされます。対応する FTP サーバーに固有の動作を必ず熟知しておいてください。自信がない場合は、コマンド行からアクションを実行してみてください。アクション実行時にエラーメッセージが表示される場合、そのアクションによっておそらく、コラボレーション内で例外がスローされます。
|
「リネーム」、「コピー」、または「なし」を選択します。
デフォルト設定は「なし」です。
注 –
「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。
|
ローカルディレクトリ名
|
「リネーム」または「コピー」で使用されるローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「ローカルディレクトリ名がパターン」プロパティーを参照してください。
注 –
パス区切り文字を入力する際には、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。
|
ディレクトリ名。
|
ローカルディレクトリ名がパターン
|
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。
「ローカルディレクトリ名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
ローカルファイル名
|
「リネーム」または「コピー」で使用されるローカルファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「ローカルファイル名がパターン」プロパティーを参照してください。
|
ファイル名。
|
ローカルファイル名がパターン
|
次のように、ローカルファイル名が
リテラルを表すか、あるいは正規表現または名前パターンを表すかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「ローカルファイル名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
ローカル転送前コマンド
|
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップできます。オプションは次のとおりです。
-
リネーム: 保護または復旧のためにターゲットファイルの名前を変更します。
-
コピー: バックアップまたは復旧のためにターゲットファイルをコピーします。
-
なし: 何も行いません。
適切な保護、バックアップ、または復旧を実現するには、目的に合った適切な設定を選択する必要があります。たとえば、アウトバウンド追加転送時の障害から復旧するには、「コピー」設定を使用します。
注 –
「ローカルディレクトリ名」および「ローカルファイル名」プロパティーで指定されるファイルが存在している場合、「リネーム」および「コピー」はそのファイルを上書きします。
「名前パターンの使用」を参照してください。
|
「リネーム」、「コピー」、または「なし」を選択します。
デフォルト設定は「なし」です。
注 –
「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。
|
SFTP 設定 (BatchSFTP の接続マップ)
BatchSFTP の接続マッププロパティーの「SFTP 設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–36 接続マップ - BatchSFTP - SFTP 設定
名前
|
説明
|
必要な値
|
転送モード
|
転送の形式がバイナリコード、ASCII テキストのいずれであるかを指定します。
|
「BINARY」または「ASCII」を選択します。
デフォルト設定は「Binary」です。
|
リモート EOL
|
リモートサーバーの行末を指定します。オプションは「CR」、「LF」、「CRLF」です。
|
「CR」、「LF」、または「CRLF」を選択します。
「CRLF」がデフォルト設定になります。
|
転送ブロックサイズ
|
ファイル転送時に使用されるブロックサイズを指定します。デフォルトを増やさないでください。リモートサーバーがデフォルトよりも大きなブロックサイズをサポートできない可能性があるからです。
|
ファイル転送時に使用されるブロックサイズを示す整数。
デフォルト設定は 32768 です。
|
ローカル読み取りバッファーサイズ
|
ローカルファイルシステムからの読み取り時に使用されるバッファーのサイズ (バイト) を指定します。
|
ローカル読み取りバッファーのサイズ (バイト) を示す整数。値 -1 は、ローカルファイルの全体が一度に読み取られることを示します。
|
認証タイプ
|
クライアント認証タイプを指定します。オプションは次のとおりです。
|
「PASSWORD」、「 HOST BASED」、または「PUBLICKEY」を選択します。
デフォルト設定は「PASSWORD」です。
|
ホスト鍵の検証を行うか
|
公開鍵の検証による SSH サーバーの認証が有効かどうかを指定します。
|
「はい」または「いいえ」を選択します。「はい」を選択すると、公開鍵の検証による SSH サーバーの認証が有効になります。
デフォルト設定は「はい」です。
|
リモートディレクトリ
|
データの送受信場所となる、SSH サーバー (SFTP サブシステムを含む) 上のディレクトリ名 (パス) を指定します。このディレクトリのアクセス可能性は通常、ログインユーザーに依存します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
「リモートディレクトリ名がパターン」プロパティーを参照してください。
|
リモートディレクトリ名。
|
リモートディレクトリ名がパターン
|
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートディレクトリ」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
リモートファイル
|
リモートサーバー上のファイルの名前を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
「リモートファイル名がパターン」プロパティーを参照してください。
|
リモートファイル。
|
リモートファイル名がパターン
|
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートファイル」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
ローカルディレクトリ
|
リモートサーバー上のファイルを送受信するためのローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
「ローカルディレクトリ名がパターン」プロパティーを参照してください。
|
ローカルディレクトリ。
|
ローカルディレクトリ名がパターン
|
次のように、「ローカルディレクトリ名」プロパティーの意味を指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「ローカルディレクトリ」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
ローカルファイル
|
リモートサーバー上で送受信されるローカルファイルを指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
「ローカルファイル名がパターン」プロパティーを参照してください。
|
ローカルファイル。
|
ローカルファイル名がパターン
|
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「ローカルファイル」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
転送後 (BatchSFTP の接続マップ)
BatchSFTP の接続マッププロパティーの「転送後」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–37 接続マップ - BatchSFTP - 転送後
名前
|
説明
|
必要な値
|
リモートディレクトリ名
|
ファイルのリネームまたはコピーの実行場所となる、リモートシステム上のディレクトリの名前 (パス) を指定します。これは、「転送後コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
アウトバウンド (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。
特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「リモートディレクトリ名がパターン」プロパティーを参照してください。
|
ディレクトリ名。
|
リモートディレクトリ名がパターン
|
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートディレクトリ名がパターン」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「はい」です。
|
リモートファイル名
|
外部システム上のファイル名を指定します。この設定は、「転送後コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「リモートファイル名がパターン」プロパティーを参照してください。
|
ファイル名。
|
リモートファイル名がパターン
|
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「リモートファイル名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「はい」です。
|
リモート転送後コマンド
|
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合にこれを適用すれば、自動バックアップを行う (リネーム) か転送済みのファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。アウトバウンド転送の場合にこれを適用すれば、転送済みのファイルをリネームすることで、ほかのクライアントがそのファイルを使用できるようにすることができます。
|
「リネーム」、「削除」、または「なし」を選択します。
デフォルト設定は「なし」です。
|
ローカルディレクトリ名
|
「リネーム」で使用されるローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。
特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
が実行されます。
「ローカルディレクトリ名がパターン」プロパティーを参照してください。
パス区切り文字を入力する際には、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。
|
ディレクトリ名。
|
ローカルディレクトリ名がパターン
|
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「ローカルディレクトリ名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。デフォルト設定は「いいえ」です。
|
ローカルファイル名
|
「リネーム」で使用されるローカルファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。
特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。
「ローカルファイル名がパターン」プロパティーを参照してください。
|
ファイル名。
|
ローカルファイル名がパターン
|
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
-
はい: ユーザーが入力する名前の値が名前パターンまたは正規表現とみなされることを示します。
-
いいえ: 入力される名前の値がリテラル、つまり正確に一致すべき対象であることを示します。パターンマッチングや名前の展開は実行されません。
「ローカルファイル名」プロパティーを参照してください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は「いいえ」です。
|
ローカル転送後コマンド
|
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合、
自動バックアップを行う (リネーム) かターゲットファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。
アウトバウンド転送の場合、ターゲットファイルをリネームすることで、ほかのクライアントからそのファイルを使用できるようにすることができます。オプションは次のとおりです。
-
リネーム: ターゲットファイルの名前を変更します。
-
削除: ターゲットファイルを削除します (インバウンド転送の場合のみ)。
-
なし: 何も行いません。
注 –
「ローカルディレクトリ名」および「ローカルファイル名」プロパティーで指定されるファイルが存在している場合、「リネーム」はそのファイルを上書きします。
|
「リネーム」、「削除」、または「なし」を選択します。
デフォルト設定は「なし」です。
|
ファイアウォール設定 (BatchSFTP の接続マップ)
BatchSFTP の接続マッププロパティーの「ファイアウォール設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–38 接続マップ - BatchSFTP - ファイアウォール設定
名前
|
説明
|
必要な値
|
ファイアウォールを使用
|
ファイアウォールが使用されるかどうかを指定します。
|
「はい」または「いいえ」を選択します。
「はい」は、ファイアウォールを使用することを示します。
デフォルト設定は「いいえ」です。
|
SOCKS バージョン
|
ファイアウォールの SOCKS のバージョンを指定します。サポートされるオプションは、SOCKS version 4 を表す「4」と、SOCKS version 5 を表す「5」です。
|
SOCKS version 4 の場合は「4」を、SOCKS version 5 の場合は「5」を、それぞれ選択します。
デフォルト設定は 5 です。
|
同期 (BatchSFTP の接続マップ)
BatchSFTP の接続マッププロパティーの「同期」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–39 接続マップ - BatchSFTP - 同期
名前
|
説明
|
必要な値
|
同期
|
バージョン 5.1 より前のアダプタは同期的に実行されますが、その動作をこのアダプタにシミュレートさせるか、あるいはこのアダプタを並列的に実行するかを指定します。選択肢は次のとおりです。
-
はい: アダプタが同期モードで実行され、コラボレーションのインスタンスが一度に 1 つずつ作成されます。
-
いいえ: アダプタが並列モードで実行されます。コラボレーションのインスタンスが複数作成され、それらが同時に実行されます。
注 –
1 つのプロジェクト内で使用されるすべての OTD インスタンスで、このプロパティーが同じ値になるようにしてください。
|
「はい」または「いいえ」を選択します。
デフォルト設定は、「いいえ」です。
|