SCP Adapter
Properties Configuration Settings
The SCP Adapter adds SSH-secured file transfer capabilities to your BizTalk Server.
Remarks
The SCP Adapter adds a SCP client to your BizTalk Server that enables it with SSH-secured file download and upload functionality.
SCP Receive Adapter
The SCP Receive Adapter 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 adapter 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 BizTalk Message Engine as individual messages.
SCP Send Adapter
The SCP Send Adapter 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 adapter will connect to the SCP server whenever it has a message to send. The adapter 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 adapter with short descriptions. Click on the links for further details.
| ErrorThreshold | The maximum number of errors before the adapter shuts down. |
| FileMask | Indicates the type of files to download from the SSH server. |
| Firewall | A set of properties related to firewall access. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| PersistentConnection | Instructs the adapter whether to keep the connection to the server open. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileName | The name of the remote file received by the SCP adapter. |
| ReceivedFilePath | The remote path of the received file. |
| ReceivedFileSize | The size of the remote file received by the SCP adapter. |
| ReceivedFileSSHUser | The SSH user name used by the SCP adapter when downloading the remote file. |
| RemotePath | The current path on the SSH server. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| SSHAcceptServerHostKey | Instructs the adapter to accept the server host key that matches the supplied key. |
| SSHAuthMode | The type of authentication used by the adapter. |
| 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. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application.. |
| TempPath | A temporary local directory where data can be stored before the adapter processes it. |
| Timeout | A timeout for the adapter. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Sender Property List
The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.
| ConnectionLifetime | Instructs the adapter whether or not to leave the connection to the server open. |
| Firewall | A set of properties related to firewall access. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| RemoteFile | The name of the destination file on the SSH server for uploading. |
| RemotePath | The current path on the SSH server. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| SSHAcceptServerHostKey | Instructs the adapter to accept the server host key that matches the supplied key. |
| SSHAuthMode | The type of authentication used by the adapter. |
| 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. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application.. |
| Timeout | A timeout for the adapter. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| LocalFile | Specifies the local file or file mask when uploading. |
| RecursiveMode | If set to true the adapter 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 adapter 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. |
| DownloadSingleFile | If set to true, the send adapter will download a file instead of upload. |
| Download | If set to true, the send adapter will download files instead of upload. |
| 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 adapter whether or not to use the system security libraries or a managed implementation. |
| PersistedConnectionTimeout | How long to leave a persisted connection alive. |