The SFTP receive channel allows the connection of a directory via SFTP protocol. Messages from the directory stored in the channel are placed in the message basket (incoming).
In case of error code
and a “Retries on error” > 0, the error is written to the log and the download is retried after one second. A task is created if the error still occurs on the last attempt.
| Properties | |
|---|---|
| Name | Description |
| Name | The name of the channel |
| Channel type name | The Type of the channel |
| Message direction | For receive channels the direction of the received message (but require also for send channels) |
| Message box | The message box |
| Public | True if the channel should be visible in the sub node |
| Host | IP address of the email server e. g. 175.11.214.25. |
| Port | Port (preferably 22). |
| Username | Login to SFTP server |
| Password | The password for logging in to the SFTP server |
| Path | The directory from which the files are to be read. |
| File mask | The file mask, which may contain the placeholders * and ? |
| Advanced file mask | After the 'File mask' application and the file names read with it, the 'Extended File Mask' is applied. Regular expressions can be used here, see Regular Expressions. |
| Fetch sub directory levels | If the value is greater than zero, then the files in the subdirectories are also read. The value specifies up to which level the subdirectories are read. |
| Identify partner by sub directory | The relative path is used and with this a sftp address of a partner is searched and if found, then this partner is assigned to the message. |
| Action after receive file | Specifies whether the files should be: Deleted, Moved, Move with time stamp |
| Move to path | The fetched files are moved to the path |
| Rename file | An optional parameter to rename the file name after retrieval. Is only evaluated if 'Action after receive file' is set to 'Move' or 'Move with timestamp'. You can use ${fn} and ${extension}. Renaming the file from e.g. 'info.csv' to 'info.sic' is achieved with the value: ${fn}.sic |
| Change logs | The changes to the element are logged. The logging is activated in the System settings, which is possible if a versioning license is available. |
| Properties (advanced) | |
| Name | Description |
| Sender validation | How the sender address should be validated |
| Default sender | The default sender |
| Recipient validation | How the recipient address should be validated |
| Default recipient | The default recipient |
| Immediate retries | Retries, used by send channels. For some receive channels, the number of pickup attempts. |
| Auto uncompress | Check if receipt data are compressed and then uncompress them |
| Transfer mode | Setting the transmission mode. Mode (Auto, Text, Binary) can be selected in the corresponding look main table. |
| Protocol version | The default value -1 at this point means that the current default value for SFTP is used, which is currently version 3. We had a case where version 4 was necessary to achieve the desired replacement of CR to CRLF in connection with the text mode. |
| Sort order of read files | Sequence in which the received data are read and processed. |
| Authentication certificate | The private certificate1) of the client, if the authentication with the server should be done via the certificate. |
| Auth. certificate password | Password of the certificate specified in “Certificate for Authentication”. |
| Auth. certificate subject | |
| Certificate info | If a certificate has been stored and recognized, the FingerPrint, the serial number and the expiration date are displayed here. |
| SSH encryption algorithms | Encryption algorithms supported by this component for the encryption of the ssh session. Values can be entered as a comma separated list, using the following values: 'aes256-ctr, aes256-cbc, aes192-ctr, aes192-cbc, aes128-ctr, aes128-cbc, 3des-ctr, 3des-cbc, cast128-cbc, blowfish-cbc, arcfour, arcfour128, arcfour256, aes256-gcm@openssh.com, aes128-gcm@openssh.com'. By default this component supports 'aes256-cbc' and '3des-cbc'. |
| SSH MAC algorithms | MAC algorithms supported by this component for the ssh session. Values can be entered as a comma separated list, using the following values: 'hmac-sha1, hmac-md5, hmac-sha1-96, hmac-md5-96, hmac-sha2-256, hmac-sha2-256-96, hmac-sha2-512, hmac-sha2-512-96, hmac-ripemd160, hmac-ripemd160-96'. By default this component supports 'sha1', 'sha1-96', 'md5' and 'md5-96'. |
| Additional SSH parameters | This value is passed directly to the SSH component and should never be set. A case we know of is 'The server key seems to be invalid when using the 'diffie-hellman-group-exchange' key exchange algorithms' solved with the value: SSHKeyExchangeAlgorithms=ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521 |