SFTP Connector

Version 24.1.8910


SFTP Connector


The SFTP Connector transfers files to and from a remote SFTP server.

Overview

Each SFTP Connector connects uploads to a specified folder and downloads from a set of folders on the remote SFTP server.

Files that reach the SFTP Connector in the CData Arc flow are uploaded to the upload target folder, and files found in the download target folder(s) are downloaded and entered into the Arc flow. The connector supports upload and download filters to only send and receive specified file names and/or file extensions.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Host Configuration

Settings related to establishing the connection to the remote SFTP host.

  • コネクタId コネクタの静的な一意の識別子。
  • コネクタの種類 コネクタ名とその機能の説明が表示されます。
  • コネクタの説明 コネクタとフローにおけるロールについて自由形式の説明を記載するオプションのフィールド。
  • Remote Host The hostname or IP address of the SFTP server.
  • Remote Port The port on which to connect to the SFTP server.

Client Authentication

Settings related to authenticating to the SFTP server.

  • Authentication Mode The type of authentication to use with the SFTP server.
  • User The username for logging in to the SFTP server.
  • Password The password for logging in to the SFTP server.
  • Client Certificate The certificate with a private key to use during public key authentication. Only available when Authentication Mode is set to Public Key or Multi-Factor Authentication. Optionally, you can use the Create Certificate button to create a new certificate.
  • Certificate Password The password required to access the Client Certificate.

Server Authentication

Setting related to verifying the SFTP server’s identity.

  • Server Thumbprint The thumbprint of the certificate that identifies the SFTP server. You can also set this to a certificate file containing the server’s public key. When you test the connection, the connector prompts you to accept/trust the thumbprint presented by the server.

Upload

Setting related to uploading files to the SFTP server.

  • Remote Path Files processed by the connector are uploaded to this remote folder.

Download

Settings related to downloading from the SFTP server.

  • Remote Path The remote folder from which files are downloaded. Use a comma-delimited list to specify multiple paths.
  • File Mask A glob pattern that determines which files in the Remote Path should be downloaded (for example, *.txt).
  • Delete files (after received) Check this to delete successfully downloaded files from the SFTP server.

Caching

Settings related to caching and comparing files between multiple downloads.

  • File Size Comparison Check this to keep a record of downloaded file names and sizes. Previously downloaded files are skipped unless the file size is different than the last download.
  • Timestamp Comparison Check this to keep a record of downloaded file names and last-modified timestamps. Previously downloaded files are skipped unless the timestamp is different than the last download.

Note: When you enable caching, the file names are case-insensitive. For example, the connector cannot distinguish between TEST.TXT and test.txt.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

  • Upload Whether files arriving at the connector should automatically be uploaded.
  • Retry Interval The number of minutes before a failed upload is retried.
  • Max Attempts The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connect retries the file indefinitely.
  • Download Whether the connector should automatically poll the remote download path(s) for files to download.
  • Download Interval The interval between automatic download attempts.
  • 毎時何分 時間単位のスケジュールの分オフセット。上記の受信間隔の設定が Hourly に設定されている場合にのみ適用されます。例えば、この値を5 に設定すると、自動的に1:05、2:05、3:05 のようにダウンロードを行います。
  • 試行が行われる時刻。上記の受信間隔の設定が DailyWeekly、または Monthly に設定されている場合にのみ適用されます。
  • 曜日/日付 試行が行われる日。上記の受信間隔の設定が Weekly または Monthly に設定されている場合にのみ適用されます。
  • ダウンロードを試行するまでの待機時間。上記の受信間隔の設定が Minute に設定されている場合にのみ適用されます。
  • Cron 式 いつ試行するかを決定するcron 式を表す5つの欄の文字列。上記の受信間隔の設定が Advanced に設定されている場合にのみ適用されます。

Performance

コネクタへのリソースの割り当てに関する設定。

  • 最大ワーカー数 このコネクタでファイルを処理するためにスレッドプールで消費されるワーカースレッドの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。
  • 最大ファイル数 コネクタに割り当てられた各スレッドが送信するファイルの最大数。設定された場合、これは設定 > オートメーションページのデフォルト設定をオーバーライドします。

アラートタブ

アラートとサービスレベル(SLA)の設定に関連する設定。

コネクタのE メール設定

サービスレベル(SLA)を実行する前に、通知用のE メールアラートを設定する必要があります。アラートを設定をクリックすると、新しいブラウザウィンドウで設定ページが開き、システム全体のアラートを設定することができます。詳しくは、アラートを参照してください。

サービスレベル(SLA)の設定

サービスレベルでは、フロー内のコネクタが送受信すると予想される処理量を設定し、その量が満たされると予想される時間枠を設定できます。CData Arc は、サービスレベルが満たされていない場合にユーザーに警告するE メールを送信し、SLA を At Risk(危険) としてマークします。これは、サービスレベルがすぐに満たされない場合に Violated(違反) としてマークされることを意味します。これにより、ユーザーはサービスレベルが満たされていない理由を特定し、適切な措置を講じることができます。At Risk の期間内にサービスレベルが満たされなかった場合、SLA はViolated としてマークされ、ユーザーに再度通知されます。

サービスレベルを定義するには、予想処理量の条件を追加をクリックします。

  • コネクタに個別の送信アクションと受信アクションがある場合は、ラジオボタンを使用してSLA に関連する方向を指定します。
  • 検知基準(最小)を、処理が予想されるトランザクションの最小値(量)に設定し、フィールドを使用して期間を指定します。
  • デフォルトでは、SLA は毎日有効です。これを変更するには、毎日のチェックをOFF にし、希望する曜日のチェックをON にします。
  • 期間終了前にステータスを’At Risk’ に設定するタイミングを使用して、SLA がAt Risk としてマークされるようにします。
  • デフォルトでは、通知はSLA が違反のステータスになるまで送信されません。これを変更するには、‘At Risk’ 通知を送信のチェックをON にします。

次の例は、月曜日から金曜日まで毎日1000ファイルを受信すると予想されるコネクタに対して構成されたSLA を示しています。1000ファイルが受信されていない場合、期間終了の1時間前にAt Risk 通知が送信されます。

Advanced Tab

Server Commands

These options allow you to execute custom commands on the remote server at various times during connector execution.

  • After Connect Execute this command directly after connecting.
  • After Get Execute this command after downloading each file.
  • After Put Execute this command after uploading each file.
  • Before Get Execute this command before downloading each file.
  • Before Put Execute this command before uploading each file.

You can use the following commands:

  • onerror: Pass the fail argument to instruct the connector to treat errors that come from the custom scripts as errors for the overall transaction. Wthout fail the connector logs any exceptions and continues processing.
  • cd: Change directory.
  • mkdir: Create directory.
  • rn or move: Rename or move file.
  • del or rm: Delete or remove file.
  • rmdir: Remove directory.

CData Arc supports the following macros with these commands. They all use the following syntax: %Macro%. Some macros, such as %Date% and %SourceFilename%, do not require an argument, but others do. The macros that take an argument use the following syntax: %Macro:argument%.

Macro Description
MsgHeader:headername Evaluates to the header value of the message (for example: %MsgHeader:headername%).
SourceFilename Evaluates to the filename (extension included) of the file currently being processed.
SourceFilenameNoExt Evaluates to the filename (without the extension) of the file currently being processed.
Date Evaluates to the date the file was last modified in a yyyy-MM-dd format (for example, 2024-02-13).
DateTime Evaluates to the datetime the file was last modified in a yyyy-MM-dd’T’HH:mm:ss format (for example, 2024-02-13T08:14:22).
Time Evaluates to the time the file was last modified in a HH:mm:ss format (for example, 08:14:22).
DateTime.tz Evaluates to the datetime the file was last modified in a yyyy-MM-dd’T’HH:mm:ss zzz format (for example, 2024-02-13T08:14:22 PST).
Time.tz Evaluates to the time the file was last modified in a HH:mm:ss zzz format (for example, 08:14:22 PST).
DateFormat:format Evaluates to the current datetime of the system in the specified format (format). See Sample Date Formats for the available datetime formats.

Example: After downloading, you want to move each file from the download folder to a History subfolder. Use the After Get field to supply the move command with the %SourceFilename% macro.

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the SFTP connection should be routed. By default, this section uses the global settings on the Settings Page. Clear the checkbox to supply settings specific to your SFTP connector.

  • プロキシの種類 プロキシベースのファイアウォールで使用されるプロトコル。
  • プロキシホスト プロキシベースのファイアウォールの名前またはIP アドレス。
  • プロキシポート プロキシベースのファイアウォールのTCP ポート。
  • プロキシユーザー プロキシベースのファイアウォールでの認証に使用するユーザー名。
  • プロキシパスワード プロキシベースのファイアウォールに認証するために使われるパスワード。
  • 認証スキーム デフォルトのNone のままにするか、以下の認証スキームから1つを選択します:BasicDigestProprietaryNTLM

Advanced Settings

Settings not included in the previous categories.

  • Connection Pooling Check this to have the connector utilize a pool to access and store connections. This is useful in scenarios where the server places restrictions on the frequency of logon attempts.
  • Download Excluded Extensions A comma-delimited list of file extensions that should not be downloaded by the connector.
  • Download Excluded Prefixes A comma-delimited list of prefixes that instructs the connector not to download filenames that begin with a specified prefix.
  • Max Download Files The maximum number of files to be downloaded from the SFTP server in one polling interval. Set to -1 to allow all files to be downloaded.
  • Minimum File Size The minimum file size to process. If a file being uploaded is smaller than the specified size, it is finalized as Skipped. For files being downloaded, the connector adds a transaction log entry indicating that the file was skipped because of its size.
  • Monitor File Growth Check this to have the application store the file sizes of the remote files between polling intervals, and only download files that do not change in size. This prevents the connector from downloading files that are still in the process of being written on the server.
  • 処理の遅延 インプットフォルダに置かれたファイルの処理を遅延させる時間(秒)。これは旧式の設定です。代替として、ローカルファイルシステムの管理にはFile コネクタの使用がベストプラクティスです。
  • Recurse Check this to download files in subfolders of the target remote path. The subdirectories are preserved for the received files.
  • Resume Downloads If enabled, when an error occurs during a file download, the connector stores the portion of the file that was downloaded and attempts to download the remainder of the file on the next download attempt.
  • Resume Uploads If enabled, when an error occurs during a file upload, the connector notes the number of bytes that were transferred and attempts to upload the remainder of the file on the next upload attempt.
  • SSH Encryption Algorithms A comma-delimited list of algorithms to use during SSH encryption. By default, all algorithms are enabled. Arc supports the following algorithms:

    aes256-ctr, aes256-cbc, aes192-ctr, aes192-cbc, aes128-ctr, aes128-cbc, 3des-ctr, 3des-cbc, cast128-cbc, blowfish-cbc, arcfour, arcfour128, arcfour256, aes128-gcm@openssh.com, aes256-gcm@openssh.com, chacha20-poly1305@openssh.com
  • ローカルファイルスキーム コネクタがアウトプットするメッセージにファイル名を割り当てるスキーム。ファイル名にマクロを動的に使用して、識別子やタイムスタンプなどの情報を含めることができます。詳しくは、マクロ を参照してください。
  • Receive Filter A glob pattern filter to determine which files should be downloaded from the remote storage (for example, *.txt). You can use negative patterns to indicate files that should not be downloaded (for example, -*.tmp). Use this setting when you need multiple File Mask patterns. Multiple patterns can be separated by commas, with later filters taking priority except when an exact match is found.
  • Temp Download Extension A temporary file extension to append to file downloads while the transfer is in progress.
  • Temp Upload Extension A temporary file extension to append to file uploads while the transfer is in progress.
  • Temp Upload Prefix A temporary file prefix to prepend to file uploads while the transfer is in progress.
  • Temp Upload Path A temporary path on the remote SFTP server where files are uploaded. The file is moved into the permanent upload path after the transfer is complete.
  • Timeout The duration the connector waits for a connection response before throwing a timeout error.
  • Wait for Channel Close Check this to have the conector wait for the server to close the SSH channel before disconnecting. If timeouts occur during the logoff sequence, you should disable this setting.

Message

  • Sent フォルダに保存 チェックすると、コネクタで処理されたファイルをコネクタのSent フォルダにコピーします。
  • Sent フォルダのスキーム 選択された時間間隔に従ってSent フォルダ内のメッセージをグループ化するようコネクタに指示します。例えば、Weekly オプションを選択すると、コネクタは毎週新しいサブフォルダを作成してその週のすべてのメッセージをそのフォルダに格納します。ブランクに設定すると、コネクタはすべてのメッセージをSent フォルダに直接保存します。多くのメッセージを処理するコネクタの場合、サブフォルダを使用するとメッセージが整理されてパフォーマンスが向上します。

Logging

  • Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
  • Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
  • Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

  • Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.

Establishing a Connection

The following settings are required to connect to a remote SFTP server:

  • Remote Host
  • Remote Port
  • Authentication Mode
  • User
  • Password or Client Certificate/Certificate Password
  • Server Thumbprint

When testing the connection to the server, the connector prompts you to accept/trust the thumbprint of the server’s public key.

Uploading Files

The SFTP Connector uploads files from the Input Folder. Files are automatically uploaded to the SFTP server if Upload Automation is enabled in the connector.

Remote Path should be set to the folder on the remote SFTP server where files should be uploaded. The application changes directories to the specified folder after logging in to the server.

If any files could not be uploaded, the connector attempts to send them again after Retry Interval minutes have elapsed. This process continues until the Max Attempts setting is reached, after which the connector raises an error and the file is longer sent automatically.

Downloading Files

Downloaded files are displayed in the Output tab of the connector, or passed along to the next connector in the flow. Files are automatically downloaded from the SFTP server if Download Automation is enabled in the connector, and can be manually downloaded by clicking the Receive button on the Output tab.

Remote Path should be set to the folder on the remote SFTP server from which files should be downloaded. The application changes directories to the specified folder after logging in to the server. The File Mask property filters files so that only filenames matching the glob pattern are downloaded from the server.

You can use the Delete files (after download) setting to delete the files on the remote server after successfully downloading them. On the Output tab, click the Receive button to test the settings and retrieve the matching files from the server.

Subfolder Headers

If Recurse is checked on the Advanced tab, when receiving a file from the Remote Path in the SFTP connector:

  • The message for the file that is received contains a Subfolder header in its metadata.
  • This header contains the subfolder, relative to the Remote Path in the SFTP connector, that the file was received from.
  • This subfolder header is supported by other connectors that support a subfolder header in Send operations.

When sending files, if a Subfolder header is present on the message that is sent to the Upload Path in the SFTP connector:

  • The file is placed in the subfolder, relative to the Upload Path in the SFTP connector, that is specified in the subfolder header.
  • The subfolder is created if permissions are available.

Macros

ファイルの命名規則にマクロを使用することで、組織の効率とデータの文脈的理解を高めることができます。マクロをファイル名に組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を動的に含めることができ、各ファイルに有益なコンテキストを付与できます。これにより、組織にとって重要な詳細をファイル名に反映させることができます。

CData Arc はこれらのマクロをサポートしており、すべて次の構文を使用します:%Macro%

Macro 説明
ConnectorID コネクタのConnectorID を返します。
Ext コネクタが処理中のファイルの拡張子を返します。
Filename コネクタが処理中のファイルのファイル名(拡張子を含む)を返します。
FilenameNoExt コネクタが処理中のファイルのファイル名(拡張子なし)を返します。
MessageId コネクタがアウトプットするメッセージのMessageId を返します。
RegexFilename:pattern コネクタで処理中のファイルのファイル名にRegEx パターンを適用します。
Header:headername コネクタが処理中のメッセージのヘッダー(headername)の値を返します。
LongDate システムの現在の日時を長い形式(例:Wednesday, January 24, 2024)で返します。
ShortDate システムの現在の日時をyyyy-MM-dd 形式(例:2024-01-24)で返します。
DateFormat:format システムの現在の日時を指定されたフォーマット(format)で返します。使用可能な日付フォーマットについては、サンプル日付フォーマット を参照してください。
Vault:vaultitem 指定されたvault 項目の値を返します。

%Ext% や%ShortDate% などの引数を必要としないマクロもありますが、引数を必要とするマクロもあります。引数を渡すマクロはすべて次の構文を用います:%Macro:argument%

以下は、引数を渡すマクロの例です。

  • %Header:headername%:headername はメッセージのヘッダー名です。
  • %Header:mycustomheader% は、インプットメッセージで設定されたmycustomheader ヘッダーの値を返します。
  • %Header:ponum% は、インプットメッセージで設定されたponum ヘッダーの値に対応します。
  • %RegexFilename:pattern%:pattern は正規表現パターンです。例えば、%RegexFilename:^([\w][A-Za-z]+)% はファイル名の最初の単語と照合し、大文字と小文字を区別せずに結果を返します(test_file.xmltest に変換されます)。
  • %Vault:vaultitem%:vaultitem は、vault のアイテム名です。例えば、%Vault:companyname% はVault に保存されているcompanyname アイテムの値を返します。
  • %DateFormat:format%:format は使用可能な日付フォーマットです(詳細はサンプル日付フォーマット を参照してください)。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% はファイルの日付とタイムスタンプを返します。

以下の例に示すように、より詳細なマクロを作成することもできます。

  • 複数のマクロを1つのファイル名にまとめる:%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
  • マクロの外側にテキストを含める:MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
  • マクロ内にテキストを含める:%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%