SCP

Operation (action)

Determines which file transfer operation is performed on the processed files or folders.

Possible values:

• Send: Send a file specified in parameter documentname, located in a local folder specified in parameter localPath, to a remote folder specified in parameter remotePath.

• Receive: receive file whose path was defined in remotePath parameter and whose filename was defined in documentName parameter and save it in a local folder specified in localPath parameter.

Adapter

Main class of the adapter (do not change!)

Possible values: de.softproject.integration.adapter. scpadapter.SCPAdapter : Main class (default)

host

IP address or host name of the remote computer

Possible values: Any valid string (e.g. server.tld)

port

Port number of the remote computer

Possible values:

• Any positive integer

• 22: SCP default port (default)

login

Username for the SCP connection

password

Password for the SCP connection; If parameter privateKeyFile is set: Password of the Private Key.

remotePath

Path on the remote computer with which a file is to be exchanged

Possible values: Any string (e.g. folder/subfolder)

documentname

Name of the file to be sent or received

Possible values: Any string (e.g. Data.xml)

localPath

Local folder for sending and receiving a file

Possible values: Any valid path (e.g. C:\Directory)

timeout

Time limit for TCP connection establishment and transmission in milliseconds

Possible values:

• Any positive integer (e.g. 50000)

• 0: No time limit (default)

hostValidationEnabled

Enable host validation to ensure that the requested remote host also corresponds to the host to which you are connecting. Ideally, deactivate for test purposes only!

Possible values:

• Yes: Enable host validation (set flag)

• No: Disable host validation (not recommended for production systems) (default)

privateKeyFile

Path to a Private Key file (not: Java Keystore). If you want to authenticate on the remote machine with a Private Key, then the password parameter serves as the password for your Private Key file.

Possible values: Any valid path (e.g. C:\Data\X4Keys\id_rsa)

hostsFileName

Path to the Known Hosts file, which contains a list of confirmed hosts and their associated public keys.

Possible values: Any valid path (e.g. C:\Data\known_hosts)

useProxy

Use proxy server to establish connection

Possible values:

• Yes: Use proxy server

• No: Do not use a proxy server (default)

proxyType

Proxy server type

Possible values:

• HTTP: Use HTTP proxy (default)

• SOCKS4: Use proxy based on SOCKS 4 protocol

• SOCKS5: Proxy auf Basis des SOCKS 5 -Protokolls verwenden

proxyAddress

IP address or host name of the proxy server

Possible values: Any valid string (e.g. server.tld)

proxyPublicAddress

Public IP address or host name of the proxy server if the proxy does not return an address.

Possible values: Any valid string (e.g. server.tld)

proxyPort

Port number of the proxy server

Possible values: Any positive integer

proxyUsername

Username for the proxy server

proxyPassword

Password for the proxy server

1

The operation was executed successfully.

0

The operation was executed successfully, but without any result.

-1

The operation failed due to a technical error.