The agent configuration consists of the following tabs:
- Connection
- Source
- Advanced
- Security
| Note | ||
|---|---|---|
| ||
You can configure part of the parameters in the Filename Sequence or Sort Order service tabs. For further information, see Workflow Template (3.0). |
Connection Tab
The Connection tab contains configuration settings related to the remote host and authentication.
| Setting | Description | |||||
|---|---|---|---|---|---|---|
Host | Enter the primary host name or IP-address of the remote host to be connected. If a connection cannot be established to this host, the Additional Hosts, specified in the Advanced tab, are tried. | |||||
| Enable Bind Address | Select this checkbox to explicitly bind a specific virtual network IP as the source of the SFTP agent’s connection. | |||||
| Bind Address | This mandatory field is enabled only when the Enable Bind Address checkbox is selected. | |||||
File System Type | Enter the type of file system on the remote host. This information is used for naming the remote files.
| |||||
Authenticate With | Choose between authentication using a password or a private key. | |||||
Username | Enter the username for an account on the remote host, enabling the SFTP session to login. | |||||
Password | Enter the password for the specified Username. This option only applies if you have selected password authentication. | |||||
Private Key | Click to display a window where you enter the private key. If the private key is protected by a passphrase, you must also enter the passphrase in Key Password. This option only applies if you have selected private key authentication. | |||||
Enable Collection Retries | Select this check box to enable repeated attempts to connect and start a file transfer. When you select this option, the agent tries to connect to the host as many times as you enter in the Max Retries field described below. If the connection fails, a new attempt is made after the number of seconds that you enter in the Retry Interval (s) field described below. | |||||
Retry Interval (s) | Enter the time interval in seconds, between retries. If a connection problem occurs, the actual time interval before the first attempt to reconnect is the time that you set in the Timeout field in the Advanced tab plus the time set in the Retry Interval (s) field. For the remaining attempts, the actual time interval is the number seconds entered in this field. | |||||
Max Retries | Enter the maximum number of retries to connect. If more than one connection attempt has been made, the number of used retries is reset as soon as a file transfer is completed successfully.
| |||||
Enable Restart Retries | Select this check box to enable the agent to send a RESTART command if the connection has been broken during a file transfer. The RESTART command contains information about where in the file you want to resume the file transfer.
| |||||
Retry Restarts Interval (s) | Enter the time interval, in seconds, for which you want to wait before initiating a restart in this field. This time interval will be applied for all restart retries. If a connection problem occurs, the actual time interval before the first attempt to send a RESTART command will be the time set in the Timeout field in the Advanced tab plus the time set in the Retry Interval (s) field. For the remaining attempts, the actual time interval will be the number seconds entered in this field. | |||||
Max Restarts | Enter the maximum number of restarts per file you want to allow. In case more than one attempt to send the RESTART command has been made, the number of used retries will be reset as soon as a file transfer is completed successfully. |
...
| Setting | Description | |||||
|---|---|---|---|---|---|---|
| Duplicate Criteria - Filename | Select this option to have only the filename compared for the duplicate check. If the filename is in the list of files which have already been collected once, the file is ignored by the agent. | |||||
| Duplicate Criteria - Filename and Timestamp | Select this option to have both the filename and the time stamp of the last modification, compared when checking for duplicates.
|
Advanced Tab
The Advanced tab contains configurations related to more specific use of the SFTP Advanced service.
| Setting | Description | |||||
|---|---|---|---|---|---|---|
| Max Async Request | Advance setting to tune the maximum asynchronous request a SFTP server can be handle, leave it empty, will use the default value(100) from library. | |||||
Port | Enter the port number that the SFTP service is to use on the remote host. | |||||
Timeout (s) | Enter the maximum time, in seconds, to wait for response from the server. 0 (zero) means to wait forever. | |||||
Accept New Host Keys | If you select this check box, the agent overwrites the existing host key when the host is represented with a new key. The check box is empty by default so that the default behavior is to abort when the key does not match.
| |||||
Enable Key Re-Exchange | Use this check box to enable and disable automatic re-exchange of session keys during ongoing connections. This can be useful if you have long lived sessions as you may experience connection problems for some servers if one side initiates a key re-exchange during the session. | |||||
Additional Hosts | You can add additional host names or IP-addresses that may be used to establish a connection. These hosts are tried, in sequence from top to bottom, if the agent fails to connect to the remote host set on the Connection tab. Use the buttons , , , and to configure the host list. |
...