Client

<< Click to Display Table of Contents >>

Navigation:  Reference > Partner management > SFTP >

Client

Ref_Partner_SFTP_Client

Remote server

 

Host / IP address

Host name or IP address under which the partner's SFTP server can be reached.

 

Port

Port used by the partner's SFTP server. The default port for SFTP is port 22.

 

Server key

Each SFTP server identifies itself to the client by its public server key. Whenever a connection is established !MC5 checks if the server key transmitted by the remote peer matches the key stored for the respective encryption algorithm. Only if this is the case, the connection is established. It is therefore necessary to store the corresponding keys for the algorithm(s) used by the server. The SFTP client of !MC5 supports the algorithms RSA, DSS, ECDSA and EDDSA. For each of these algorithms you can store a key. Often only the key for one algorithm is needed. Using the Add button, the key can be entered as text or loaded from a PEM file. Alternatively, the Test Connection / Get Server Key button can be used to retrieve, display and save the key via a direct connection to the SFTP server. The prerequisite for this is that the host name or IP address and port are specified correctly and a connection to the server can be established.

 

Login

 

Method

Method for logging in to the SFTP server. Currently, only Username / Password and Username / Key methods are available.

 

Username

Username to be used to log on to the SFTP server.

 

Password

The password to use to log in to the SFTP server if Username / Password is selected as the method.

 

Client key

Client key to be used for logging on to the SFTP server.

 

Test Connection / Get Server Key

Attempts to establish a connection to the SFTP server using the data entered under Remote server and Login. If no server key or a server key that differs from the received key is specified, then this key is displayed and can be used for the algorithm used by the server.

 

Download files

 

Enable downloading

Enables or disables the download of files via the client connection.

 

Remote source directory

The directory on the SFTP server to search for new files. Enter without final "/" (will be removed automatically when saving). If connection and login data have already been entered correctly, the directory can be selected via a directly browsing the server directories using the magnifying glass icon.

 

Remote file mask

File mask for selecting the files to be downloaded in the source directory of the server. The file mask can contain * as a placeholder for no or any number of characters and ? as a placeholder for any character. Multiple masks can be specified separated by |.

Examples:

* - matches all files

*.txt - all files ending in ".txt".

*.txt|*edi* - all files ending in ".txt" and all files containing "edi" in the name.

 

After download...

Here you can set what to do with successfully downloaded files on the server. The following options are available:

 

leave remote file unchanged - do nothing

delete remote file from server - delete the file from the server

move remote file to another directory - move the file to the specified directory on the server

 

Upload files

 

Enable uploading

Enables or disables the upload of files via the client connection.

 

Remote target directory

The directory on the SFTP server to upload files to. Enter without final "/" (will be removed automatically when saving). If connection and login data have already been entered correctly, the directory can be selected via the magnifying glass icon using a direct connection to the server.

 

File name during upload

Here you can set whether files are to be uploaded to the server with a name other than the local file name.

 

local file name - file name remains unchanged during upload.

custom (rename to local file name after successful upload) - files are uploaded with a different name and only renamed back to the local file name after successful upload. The partner may use the alternative upload name as an indicator that the file has not yet been processed further. The name to be used for the upload can be freely selected. A * in the upload name is replaced by the local file name. For example, if *.tmp is specified as the upload name, the file test.txt will be uploaded with the name test. txt.tmp and, if successful, renamed to test.txt on the server.

 

If a file already exists...

Here you can define what should happen if a file with the same name already exists on the server during the file upload.

 

skip upload - do not upload file

overwrite existing file - overwrite existing file