Configuring Java CAPS Environment Components for Communications Adapters

Configuring Batch Adapter BatchSFTP Environment Properties

This topic describes the configuration properties for the BatchSFTP OTD, accessed from the Environment Explorer.

The BatchSFTP Adapter Environment properties include the following sections:

SFTP Settings (BatchSFTP Environment)

The SFTP Settings section of the BatchSFTP Environment properties contains the top-level parameters displayed in the following table.

Table 46 Environment - BatchSFTP - SFTP Settings


Name	Description	Required Value
SSH Host	Specifies the host name or IP address of the SSH server.	The host name or IP address of the SSH server.
SSH Port	Specifies the port number of the SSH server.	The port number of the SSH server.
User ID	Specifies the user login name for the SSH server.	A user login name for the SSH server.
Password	Specifies a login password for the user.	A password.
Key File	Specifies the folder (path) that holds the private key for client authentication of type PUBLIC KEY or HOST BASED.	The folder (path) that holds the private key for client authentication.
Key File Password	Specifies the password used to protect the key file.	The Key File password.
Server Public Key	Specifies the folder (path) that holds the public key used by the SSH server. This key is generated on the server and sent to the client through a, safe channel, and stored on the client machine for host key verification.	The the folder (path) that contains the server public key for host key verification.
Server Name For Host Key Verification	Specifies the full domain name of the SSH server used for host key verification.	The expected SSH host name when doing host key verification.
Preferred Public Key Algorithm	Specifies the preferred public key algorithm for SSH authentication. The options are DSA and RSA	Select DSA or RSA. The configured default is DSA.

Firewall Settings (BatchSFTP Environment)

The Firewall Settings section of the BatchSFTP Environment properties contains the top-level parameters displayed in the following table.

Table 47 Environment - BatchSFTP - Firewall Settings


Name	Description	Required Value
Firewall Host	Specifies the proxy server host name or IP address.	The proxy server host name or IP address. The configured default is localhost.
Firewall Port	Specifies the proxy server port number.	The proxy server port number. The configured default is 1080.
User ID	Specifies a user login ID for the proxy server.	A user login ID for the proxy server.
Password	Specifies a login password for the proxy server.	A password for the proxy server login ID.

General Settings (BatchSFTP Environment)

The General Settings section of the BatchSFTP Environment properties contains the top-level parameters displayed in the following table.

Table 48 Environment - BatchSFTP - General Settings


Name	Description	Required Value
Connection Mode	Specifies whether a physical connection is established when an external connection is instantiated. Options: Automatic: Establishes a physical connection when an external connection is instantiated. Manual: Does not automatically establish a physical connection when an external connection is instantiated. If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the `connect()` method). If BatchSFTP Connection Mode is set to Automatic, the following SFTP Settings Environment parameters must be set with valid values: SSH Host SSH Port User Password Key File (this must be set if the BatchSFTP Connectivity Map property, Authentication Type , is set to HOSTBASED or PUBLICKEY) Key File Password (required by the Key File property)	Select Automatic or Manual. The configured default is Automatic.
	Server Public Key (this must be set if the BatchSFTP Connectivity Map property, Do Host Key Verification is set to Yes) Server Name for Host Key Verification (this must be set if the BatchSFTP Connectivity Map property, SFTP Settings ⇒ Do Host Key Verification is set to Yes) Also, if a firewall is enabled and the Connectivity Map property, Firewall Settings ⇒ Use Firewall, is set to Yes, the following Environment parameters must be set with valid values: Firewall Host Firewall Port User Password

Connection Pool Settings (BatchSFTP Environment)

The Connection Pool Settings section of the BatchSFTP Environment properties contains the top-level parameters displayed in the following table.

Table 49 Environment - BatchSFTP - Connection Pool Settings


Name	Description	Required Value
Steady pool size	Specifies the minimum number of physical connections the pool keeps available at all times.	An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed. The configured default is 2.
Maximum pool size	Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.	An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum. The configured default is 10.
Max Idle Timeout In Seconds	Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.	An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely. The configured default is 300 (5 minutes).

Connection Retry Settings (BatchSFTP Environment)

The General Settings section of the BatchSFTP Environment Map properties contains the top-level parameters displayed in the following table.

Table 50 Environment - BatchSFTP - Connection Retry Settings


Name	Description	Required Value
Connection Retries	Specifies the number of retries to establish a connection upon failure to acquire a connection.	An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. The default value is 0.
Connection Retry Interval	Specifies the length of the pause (in milliseconds) between each reattempt to access the destination file. Used in conjunction with the Connection Retries setting.	An integer indicating length of the pause (in milliseconds). The default value is 1000 (1 second).