Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

FTP 送信アダプタに関する設定

FTP 送信アダプタ EnsLib.FTP.OutboundAdapterOpens in a new tab の設定に関する参照情報を提供します。

概要

送信 FTP アダプタには以下の設定があります。

グループ 設定
基本設定 [外部レジストリ ID][FTPサーバ][FTPポート][認証情報][ファイルパス][ファイル名]
SFTP 設定 [SFTP AppendMode][SFTP 認証メソッド][SFTP公開鍵ファイル][SFTP秘密鍵ファイル][SFTP Server Character Set][SFTP Local Character Set][SFTP パスフレーズ資格情報][SFTPInteractiveDTL][SFTPSetFileAccessMode]
接続設定 [プロトコル][SSL構成][SSL でサーバIDを確認する][SSL セッション再開を使用][UsePASV][接続中を維持][接続タイムアウト]
追加設定 [上書き][文字セット][TempFileName]

残りの設定はすべてのビジネス・オペレーションに共通しています。詳細は、"プロダクションの構成" の "すべてのビジネス・オペレーションに含まれる設定" を参照してください。

Charset

出力ファイルに必要な文字セットを指定します。InterSystems IRIS® は、自動的に、文字をこの文字エンコーディングに変換します。"文字セット" を参照してください。

[接続タイムアウト]

FTP サーバへの接続試行を待機する秒数です。デフォルトは 5 秒です。

Credentials

FTP サーバへの接続を承認できるプロダクション認証情報エントリを識別します。"認証情報" を参照してください。

ファイル名

ドキュメントの出力先のファイルの名前。タイム・スタンプ指定子を含めることができます。%f 指定子が存在する場合、これはドキュメントの元のソース・ファイル名 (ターゲットのファイル名で不正な文字を削除したもの) に置換されます。タイム・スタンプのオプションのドキュメントについては、メソッド Ens.Util.File.CreateTimestamp() を参照してください。

File Path

FTP サーバ上でのファイルの書き込み先ディレクトリの完全パス名です。このディレクトリは実在する必要があり、指定された [認証情報] を使用してアクセスできる必要があります。

[FTPポート]

接続先の FTP サーバ上の TCP ポートを指定します。デフォルト値は 21 です。

[FTPサーバ]

接続先の FTP サーバを指定します。 ここには IP アドレスか、ドメイン・ホスト・コントローラが名前を解決できるのであればサーバ名を指定できます。

Overwrite

真または偽。真のときに、出力ファイルがある場合は、これを上書きします。偽のときに、出力ファイルがある場合は、これに追加します。デフォルトは真です。

[プロトコル]

FTP (ファイル転送プロトコル) と SFTP (SSH ファイル転送プロトコル) のどちらを使用するかを示します。プロトコルが FTP である場合は、[SSL構成] 設定を使用して FTP over TLS を構成できます。プロトコルが SFTP である場合は、以下のとおりです。

  • [UsePASV] 設定と [ServerListStyle] 設定は無視されます。

  • [FTPポート] 設定は通常、22 に設定する必要があります。

  • [認証情報] 設定の値を指定する必要があります。

  • [SFTPPublicKeyFile] 設定と [SFTPPrivateKeyFile] 設定の値を指定した場合、アダプタは鍵ペア認証を試行します。アダプタはこの認証を試行する際に、[認証情報] 設定で指定されたユーザ名とパスワードも使用し、[認証情報] のパスワードを秘密鍵のパスフレーズとして使用します。KeyFile の設定を使用しない場合、アダプタは、[認証情報] 設定に基づくユーザ名/パスワード認証のみを試行します。

この設定は、FTP と SFTP のどちらを使用するかを指定します。空白のままの場合は、[SSL構成] 設定が [!SFTP] に設定されていなければ、FTP が使用されます。これが設定されている場合は、[プロトコル] 設定に関係なく、SFTP が使用されます。

SFTP Append モード

SFTP サーバの append (追加) を使用するか (サーバ・モード)、クライアントで append (追加) をエミュレートするか (クライアント・モード) を制御します。一部の SFTP サーバは、append (追加) アクセスをサポートしていません。append (追加) をサポートしていないサーバを使用する場合は、[クライアント・モード] を選択し、FTP 送信アダプタによって SFTP サーバからのファイルを読み取り、データをファイルに append (追加) し、さらにファイルを SFTP サーバに返送して既存ファイルを上書きします。この設定は、[SSL構成][!SFTP] に設定され、[上書き] が偽に設定されている場合にのみ効力があります。

append (追加) をエミュレートする影響として、アダプタがファイルを読み取ってから追加されたデータをファイルに書き込む間に、他のプロセスが SFTP サーバの同じファイルを変更した場合、他のプロセスによる更新が消失してしまいます。

Note:

SFTP サーバが append アクセスをサポートしているかどうかわからない場合は、サーバ append テストを使用することができます。これは、[SFTP Append モード] ポップアップ・ヘルプの文中にあるリンクによってアクセスできます。

SFTPPrivateKeyFile

SSH 秘密鍵証明書を含むファイルへのファイル・パス秘密鍵は PEM でエンコードする必要があります。AutheticateWithKeyPairOpens in a new tab と共に使用する場合は、秘密鍵と公開鍵の両方が必要です。

SFTPPublicKeyFile

SSH 公開鍵証明書を含むファイルへのファイル・パス公開鍵は OpenSSH 形式である必要があります。AutheticateWithKeyPairOpens in a new tab と共に使用する場合は、秘密鍵と公開鍵の両方が必要です。

SFTPSetFileAccessMode

SFTP ファイル・アクセス・モードは、転送時にリモート・システム上のファイルに割り当てるアクセス権を指定します。0600 のように 8 進表現で、または u+rw,g+r のように記号で指定できます。デフォルト値は 0600 です。8 進で指定する場合、4 桁にする必要があります。記号で "すべて" を指定するには、'ugo' を使用します。

SetPermissions 呼び出しでエラーが発生した場合 (ターゲット・ファイルが削除されている場合など)、そのエラーは警告として記録され、これを使用して Put の失敗を示すことはありません。

[SSL構成]

この接続の認証に使用する既存のクライアント TLS 構成の名前。アダプタから通信が開始されるため、サーバ TLS 構成ではなく、クライアント TLS 構成を選択します。"FTP 受信アダプタに関する設定" の "SSL構成" を参照してください。

以前のバージョンとの互換性を確保するため、!SFTP の値により、プロトコルが SFTP であることが示されます。ただし、[プロトコル] 設定を使用して、SFTP を使用することをお勧めします。

SSL チェック・サーバ ID

この設定は、TLS を介して FTP サーバに接続する場合に、証明書のサーバ名を、そのサーバへの接続に使用する DNS 名と一致させる必要があるかどうかを指定します。この一致は、RFC 2818 のセクション 3.1 に規定されているルールに基づきます。

SSL セッション再開を使用

この設定は、データ・チャンネルの SSL 接続を確立する際に、そのコマンド・チャンネルのセッション・パラメータを再利用するかどうかを指定します。セッション・パラメータを再利用する機能では、OpenSSL v1.1.x+ が必要です。

接続を維持

正の値の場合は、アダプタはオペレーションの完了後に、ここで指定された秒数だけリモート・システムとの接続を維持します。値がゼロの場合は、オペレーションが完了するたびに直ちに切断します。値がデフォルトの -1 の場合、アイドル・タイムでも常時接続になります。アダプタは起動時にはアイドルと見なされるため、この値が -1 に設定されている場合にのみ自動接続します。

TempFileName

ドキュメントの出力先の一時ファイルの名前。この名前のファイルの FTP サーバへのアップロードが完了すると、このファイルの名前は [ファイル名] 設定で指定された名前に変更されます。この設定が空白の場合、一時ファイルは使用されません。タイム・スタンプ指定子を含めることができます。%f 指定子が存在する場合、これはドキュメントの元のソース・ファイル名 (ターゲットのファイル名で不正な文字を削除したもの) に置換されます。 タイム・スタンプのオプションのドキュメントについては、メソッド Ens.Util.File.CreateTimestamp() を参照してください。

[UsePASV]

パッシブ FTP モードを使用します。このモードでは、サーバがデータ・ポート・アドレスを返し、クライアントがそれに接続します。制御 TCP 接続とデータ TCP 接続の両方がクライアントから開始されるため、ほとんどのファイアウォールでパッシブ・モード FTP を受け入れやすくなります。

FeedbackOpens in a new tab