Selecting and Configuring FTP/S Inbound

  1. On Partner Management tile, click Business Agreements.
  2. In the Business Agreement page, click the business agreement for which you want to configure FTP/S Inbound.
  3. In the Edit Business Agreement page, on the Bind Protocol tab, enable any protocol you wish to use and click Edit Configurations.
  4. Click Transports tab select FTP or FTPS in the Inbound transport for Partner section.
  5. Click Edit Setting of the selected Inbound transport and edit the options listed below.
    Inbound FTP/S Settings
    Field Description
    URL The URL for the directory on the FTP server, which is ftp://host_name:port/path_name/, where
    • host_name is the name of the machine (server) where the FTP server is running
    • port is the port on the machine to which the FTP server is listening to.
    • path_name is the relative path that starts from the base directory of the FTP server.
    Server Certificate (FTPS only) The partner certificate used to encrypt transport communication.
    Client Authentication Identity (FTPS only) The host key to be used when the remote server requires authentication of the SSL sender.
    Data Transfer The format for transferring files: ASCII or Binary.
    Username The user name for authenticating the host on the partner FTP/S service.
    Password The password for authenticating the host on the partner FTP/S service.
    File Processing The mechanism for deciding which files to retrieve. There are two choices:
    • File Mask Select it to control file renaming. Enter a mask in the File Mask field.
    • Script Select it for processing files. Specify a script in the Scripts field.
    File Mask Controls which files to retrieve. If you enter an asterisk (*), BCCE searches for all files in the specified FTP directory. To prevent the retrieval of files that have already been retrieved, there are two options:
    • Select the Delete File check box, which causes each file to be deleted after it is retrieved, if this is allowed by the FTP server.
    • Specify a file mask that prevents the retrieval of the same files again.
    Include Full File Path The complete file path is enabled to distinguish this file from other files.

    If the complete file path is required, select this check box to send the getting request by FTP/FTPS poller file full path to the original file field of the Business Connect ReceiveRequest palette.

    Scripts Specify an FTP script.
    Scripts Engine Use the Nashorn scripts engine to execute custom scripts.
    Secure Transport Mode (FTPS only) The secure protocol employed in the transport layer.

    You can select one of the items from the list:

    • SSL_ONLY
    • SSL
    • TLS

    SSL stands for Secure Sockets Layer. TLS stands for Transport Layer Security, and is the successor of SSL v3. It is an open standard under RFC 2246.

    Start Time The start time of the scheduled window where polling from the external FTP server occurs.
    End Time The end time of the scheduled window where polling from the external FTP server occurs.

    Frequency

    (seconds)

    		This field defines how often polling occurs.

    By default, the frequency is 5 minutes (300 seconds).

    Note: Additional overhead is incurred when the polling interval is reduced, as each poll requires logging on to the remote FTP server and checking for available files for retrieval. To reduce unnecessary overhead, an optimized value for the polling interval should be entered based on the volume of inbound documents from your trading partners.
    Delete File Enable files to be deleted after retrieval. This option is intended for test purposes so that duplicate files are not retrieved from an FTP server.
    Note: This option does not work for all FTP servers.
    Require PGP Processing Select this check box if PGP unpackaging is required for an incoming message, which includes signature verification, decryption and/or decompression. This also assumes that the incoming messages are PGP packaged, otherwise the messages are rejected.

    This check box does not take effect if an FTP script is used. When the FTP script is used, the PGP options and policies are set up in FTP script through PGP API.

    If PGP unpackaging is required, the PGP keys used for the unpackaging are configured in the Inbound Document Exchange portion of the Document Exchange tab in a Business Agreement.

    If unselected, the message is sent to back office as pass through, even if the message is PGP packaged.

    PGP Policy The PGP policy only takes effect if the Require PGP Processing check box is selected. Four policies are available:
    • None No specific policies are mandated for the incoming message; the message can be signed and/or encrypted, with or without compression. However, the message has to be PGP packaged in certain way, otherwise it will be rejected.
    • Must Sign The incoming message must be and only be signed, with or without compression.
    • Must Encrypt The incoming message must and only be encrypted with or without compression.
    • Must Sign and Encrypt The message must be both signed and encrypted, with or without compression.
    • Pass-Through In this mode, the software does not process the receiving data from the trading partner server, but forwards it to the private process directly.
  6. Click Save.