Setting Up SSHFTP for a Trading Partner

To make a transport available for a trading partner, you have to:
  1. Configuring SSHFTP Outbound
  2. Select this transport for the partner in a specific business agreement.

Configuring SSHFTP Outbound

To configure SSHFTP for a trading partner, perform the following steps:

Procedure

  1. On Partner Management tile, click Partners> partner’s name
  2. In the Edit Partner window, select a protocol and click Edit Configurations.
  3. On Protocol configurations page, click Transport > Add Outbound Transport or transport respectively and configure the options listed in the following table:
    Outbound SSHFTP Settings
    Field Description
    Transport Name Specify an identifier for these transport settings.
    URL

    Specify the URL for the directory on the FTP server, which is sshftp://host_name:port/path_name/, where

    • host_name is the name of the machine (server) where the SSHFTP server is running

    • port is the port on the machine to which the SSHFTP server is listening to

    • path_name is the relative path that starts from the base directory of the SSHFTP server

    Authentication Mode

    Select one authentication mode that you want to use from this list.

    • Password The user account’s password must be configured.

    • Keyboard Interactive It is a generic authentication method that can be used to implement different types of authentication mechanisms.

    • Public Key BusinessConnect Server SSH private key must be configured

    • Public Key and Password BusinessConnect Server SSH private key and user account’s password must be configured
    Note: ClientAuthenticationIdentity (for SSHFTP) under Business Agreement must have the TIBCO BusinessConnect Container Edition Server SSH private key if either Public Key or Public Key and Password is selected.
    Username Specify the user name for the trading partner’s SSHFTP server. The user name must always be configured
    Password Specify the password for the user account with the name specified in the Username field on the trading partner's SSH server.

    Preferred Cipher

    Preferred MAC

    Preferred Compression

    File Processing

    File Mask

    Scripts

    Scripts Engine

    		For information about these fields, see, SSHFTP Settings.
    Retry Count Specify the number of retries.
    Retry Interval Specify the interval between retries.
    PGP Processing

    When PGP processing is selected, the PGP keys used for the processing are configured in the Outbound Document Exchange portion of the Document Exchange tab for a Business Agreement.

    These settings do not take effect if an SSHFTP script is uploaded and used. If the SSHFTP script is used, the PGP options are set up in the script using PGP API.

    Sign Specify whether the files have to be signed.
    Encrypt Specify whether the files have to be encrypted.
    Compress Specify whether the files have to be compressed.
    Compression Algorithm Select the compression algorithm: ZIP or ZLIB.
    ASCII Armor Specify whether the files have to be sent in the ASCII armor format
    TCPNoDelay

    Select this check box to enable the TCP No Delay feature.

    This property is used to manage the TCP_NODELAY option that controls the Transmission Control Protocol (TCP) packet batching on the TCP level. By default, this property is enabled.

    • If the property is enabled, the client sends TCP packets by using the SSHFTP transport regardless of the packet size, which increases the volume of network traffic.

    • If the property is disabled, the client does not send a TCP packet by using the SSHFTP transport until it has collected a significant amount of outgoing data.

    You can weigh the network efficiency versus your application requirements to decide whether to enable this property. Disable this property if the SSHFTP client or server of your trading partner do not handle the message well with the property enabled.

Selecting SSHFTP Transport in the Business Agreement

This option is used to allow a particular business agreement to receive messages if the option is not enabled, then the host will not be able to receive any messages over these transports from the partner with whom he has this business agreement.

Procedure

  1. On TIBCO BusinessConnect Container Edition UI, expand Partner Management > Business Agreements.
  2. Click the business agreement for which you wish to select SSHFTP transport.
  3. On Protocols tab, select the protocol you wish to configure and click Edit Configurations.
  4. On the Transport tab, select SSHFTP (or the name you provide while creating an SSHFTP transport) as Primary Transport and then click Save.
    You can edit settings for the selected transport. For more information on configuring these settings, see Outbound SSHFTP Settings.