Configuring the sftp.properties File

The sftp.properties file in the properties directory provides settings for the SFTP Client adapter and the SFTP Server adapter.

1. Locate the sftp.properties.in file in the properties directory where you installed Sterling B2B Integrator.
2. Edit the sftp.properties.in file.
3. Configure the properties.
   The properties are listed in the following table:

   Property	Description
   BannerMessage	Indicates the message displayed when an SFTP Client logs in. Supports messages with multiple lines if desired. Example: BannerMessage=Sterling B2B Integrator SFTP Server \n \line 2 \n\line 3 \n\ end of banner
   listStagedDocuments	Indicates whether or not partial documents held in a temporary document staging area on the server should be included in list requests. Valid values: True - Partial documents are listed and transfer can be resumed False (default) - Transfer resumption is disabled
   checkpointInterval	Controls the amount of uploaded data between checkpoints. Checkpoints save the incomplete uploaded file for later resumption. Actual checkpoint is at the end of the buffer write that exceeds the interval. The checkpoint occurs only if the server adapter is configured for resumption, and if the upload is to a Global Mailbox. If you set the property to 0, automatic checkpoint is disabled. Default value for the property is 100M. You can also specify the value in kilobytes or gigabytes. Valid value is any integer with one of the following units: G = gigabyte M = megabyte K = kilobyte Default is 100M. Setting to 0 disables automatic checkpoints.
   defaultKeyUpdateDataSize	Specifies a data unit for forced key exchange from client to server. Works in conjunction with defaultKeyUpdatePeriod. Valid values are any integer with: G = gigabyte M = megabyte K = kilobyte Default is 1G. With the default settings, if new activity occurs, the client performs another key exchange with the server to refresh the session key each hour or each gigabyte transferred, whichever occurs first.
   defaultKeyUpdatePeriod	Specifies an interval in milliseconds for forced key exchange from client to server. Works in conjunction with defaultKeyUpdateDataSize. Default is 3,200,000 ms (one hour). With the default settings, if new activity occurs, the client performs another key exchange with the server to refresh the session key each hour or each gigabyte transferred, whichever occurs first.
   CEU_SUPPRESS_NOT_SUPPORTED_ERROR	Used to ignore the errors, generated from the unsupported commands, during file upload to mailbox. Note: This property is not supported for SFTP Server Adapter 2.0.
   connectionIdleTimeout	Specifies the time period (in seconds) until the connection remains idle. By default, when you set USE_APACHE_SFTP=no in sandbox.cfg and defaultSFTP=1.0 in sftp.properties files, you can see the connectionIdleTimeout property in the sftp.properties file. If you modify USE_APACHE_SFTP=yes in sandbox.cfg, you cannot see the connectionIdleTimeout property in the sftp.properties file. Note: This property is not supported for SFTP Server Adapter 2.0.
   transferMode	Specifies file transfer mode. Valid values are ASCII or BINARY. The default mode is BINARY. By default, when you set USE_APACHE_SFTP=no in sandbox.cfg and defaultSFTP=1.0 in sftp.properties files, you can see the transferMode property in the sftp.properties file. If you modify USE_APACHE_SFTP=yes in sandbox.cfg, you cannot see the transferMode property in the sftp.properties file. Note: This property is not supported for SFTP Server Adapter 2.0.
   endSessionResponseTimeout	Specifies the time taken (in milliseconds) by the SFTP client to wait for a response from server. The default value is 30 milliseconds. Note: This property is not supported when defaultSFTP is set to 2.0 in sftp.properties.
   sshTransportTimeout	Specifies the timeout period (in milliseconds) at the socket level when it times out if the SFTP client does not receive response from the server. The default value is 30 milliseconds. Note: This property is not supported when defaultSFTP is set to 2.0 in sftp.properties.
   defaultSFTP	Used to switch between SFTP Client Adapters. The values are 1.0 for SFTP Client Adapter (Maverick) and 2.0 for SFTP Client Adapter (Apache SSD). The default value is 1.0, which means the system uses SFTP Client Adapter (Maverick). Note: To check whether the SFTP Client Business Process uses Maverick or Apache SSD based implementation, you must see the status report of BeginSession Service. The strings are: maverick : SFTPClientAdapter apache : SFTPClientAdapter2.0
   useSftpClientGet	It is set to 'false', by default. If this property is set to 'true', you can achieve better SFTP Client GET/download throughput in certain high latency network conditions. Note: You must test this parameter for compatibility with the SFTP server before applying in production.
   sessionMaxWindowSpace	Specifies the maximum session window size for the maverick ssh2context. The default value is 131072.
   blockSize	Specifies the block size used by sftpclient get API. The default value 32768.
   maxAsyncRequests	Specifies the maximum Async requests used by sftpclient get API. The default value is 100.
   Note: You can use the properties sessionMaxWindowSpace, blockSize, and maxAsyncRequests only if you set useSftpClientGet to 'true'. Important: You can expect better performance if you set useSftpClientGet to 'true'. For optimal performance, you can tune sessionMaxWindowSpace and maxAsyncRequests from sftp.properties and related properties from perimeter.properties, with the assistance of Sterling B2B Integrator product team.
   disableRSA	This Boolean property controls if the Host Identity Key can display RSA as an option in the Key type. Setting this property to true will not display RSA as an option in the Key type. The default value is false.