/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

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.

ErrorThresholdThe maximum number of errors before the adapter shuts down.
FileMaskIndicates the type of files to download from the SSH server.
FirewallA set of properties related to firewall access.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
OtherDefines a set of configuration settings to be used by the adapter.
PersistentConnectionInstructs the adapter whether to keep the connection to the server open.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedFileNameThe name of the remote file received by the SCP adapter.
ReceivedFilePathThe remote path of the received file.
ReceivedFileSizeThe size of the remote file received by the SCP adapter.
ReceivedFileSSHUserThe SSH user name used by the SCP adapter when downloading the remote file.
RemotePathThe current path on the SSH server.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TempPathA temporary local directory where data can be stored before the adapter processes it.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe 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.

ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
OtherDefines a set of configuration settings to be used by the adapter.
RemoteFileThe name of the destination file on the SSH server for uploading.
RemotePathThe current path on the SSH server.
SSHAcceptServerHostKeyInstructs the adapter to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the adapter.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe 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.

LocalFileSpecifies the local file or file mask when uploading.
RecursiveModeIf set to true the adapter will recursively upload or download files.
ServerResponseWindowThe time to wait for a server response in milliseconds.
FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrintInstructs the adapter to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the signature algorithm when attempting public key authentication.
DownloadSingleFileIf set to true, the send adapter will download a file instead of upload.
DownloadIf set to true, the send adapter will download files instead of upload.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]