SCP Activities
Properties Configuration Settings
The SCP Activity adds SSH-secured file transfer capabilities to your WorkFlow.
Remarks
The SCP Activity adds a SCP client to your WorkFlow that enables it with SSH-secured file download and upload functionality.
SCP Receive Activity
The SCP Receive Activity requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The activity will connect to the SCP server every PollingInterval and download the file(s) specified by FileMask. All files that match the FileMask will be downloaded and submitted to the WorkFlow as individual messages.
SCP Send Activity
The SCP Send Activity requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The activity will connect to the SCP server whenever it has a message to send. The activity will attempt to upload to the specified RemotePath.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver activity with short descriptions. Click on the links for further details.
| FileMask | Indicates the type of files to download from the SSH server. |
| Firewall | A set of properties related to firewall access. |
| LocalDirectory | The directory on the local machine where files are downloaded. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during activity execution. |
| Other | Defines a set of configuration settings to be used by the activity. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| PersistentConnection | Instructs the activity whether to keep the connection to the server open. |
| RemotePath | The current path on the SSH server. |
| RuntimeLicense | Specifies the activity runtime license key. |
| SSHAcceptServerHostKey | Instructs the activity to accept the server host key that matches the supplied key. |
| SSHAcceptServerHostKeyAcceptAny | Tells the activity to accept any server certificate. |
| SSHAuthMode | The type of authentication used by the activity. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| Timeout | A timeout for the activity. |
Sender Property List
The following is the full list of the properties of the sender activity with short descriptions. Click on the links for further details.
| Firewall | A set of properties related to firewall access. |
| LocalFile | The path to a local file for upload. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during activity execution. |
| Other | Defines a set of configuration settings to be used by the activity. |
| PersistentConnection | Instructs the activity whether to keep the connection to the server open. |
| RemoteFile | The name of the destination file on the SSH server for uploading. |
| RemotePath | The current path on the SSH server. |
| RuntimeLicense | Specifies the activity runtime license key. |
| SSHAcceptServerHostKey | Instructs the activity to accept the server host key that matches the supplied key. |
| SSHAcceptServerHostKeyAcceptAny | Tells the activity to accept any server certificate. |
| SSHAuthMode | The type of authentication used by the activity. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| Timeout | A timeout for the activity. |
Configuration Settings
The following is a list of configuration settings for the activity with short descriptions. Click on the links for further details.
| RecursiveMode | If set to true the activity will recursively upload or download files. |
| ServerResponseWindow | The time to wait for a server response in milliseconds. |
| FilePermissions | Specifies the permissions of a file to be set after a successful upload. |
| LogSSHPackets | If True, detailed SSH packet logging is performed. |
| SSHAcceptServerHostKeyFingerPrint | Instructs the activity to accept the server's host key with this fingerprint. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseManagedSecurityAPI | Tells the activity whether or not to use the system security libraries or a managed implementation. |
| PersistedConnectionTimeout | How long to leave a persisted connection alive. |