Salesforce Docs Portal

SFTP Send Endpoint Settings

SFTP send endpoint settings configure where to send B2B messages transmitted over SFTP. There are two types of SFTP send endpoints:

  • Send to Partners

    • Target endpoint in an outbound message flow through which transformed B2B messages are sent to partners, either directly or through third-party connections

    • Acknowledgement endpoint in an inbound message flow

    A host, partner, or third-party connection can own SFTP Send to Partners endpoints.

  • Target at Host

    Target endpoint in an inbound message flow through which transformed JSON and XML messages are sent to the backend applications.

    Only a host can own SFTP Target at Host endpoints.

Create SFTP send endpoints by configuring these settings on the <host> or <partner> pages. You can also create these endpoints when you configure an outbound message flow:

Name Description Required

Owner

Host, partner, or third-party connection that owns the endpoint.

x

Usage

Endpoint function (Send to partners or Target at host).

x

Protocol

Protocol that the endpoint supports (SFTP).

x

Endpoint Name

Automatically generated name used to identify the endpoint, which you can modify manually.

x

Description

User-supplied value that describes the purpose of the endpoint.

Retry interval (in seconds)

Frequency of reconnection attempts when unable to connect to the remote AS2 service. The default is 30 Seconds.

No

Maximum retry attempts

Maximum number of reconnection attempts to make. If you don’t want Partner Manager to retry after an initial connection failure, set this value to 0.

No

Host

SFTP server host, such as sftp.mulesoft.com, localhost, or 192.168.0.1. The host must be accessible from your Mule environment.

x

Port

Port number of the SFTP.

x

Authentication type

Authentication method used to secure the SFTP endpoint. Values are:

  • None

    Provides no authentication for the endpoint

  • Basic

    Authenticates by using a username and password

  • Identity Key

    Authenticates by using a private SSH identity key

  • Basic and Identity Key

    Authenticates by using a username, password, and public SSH identity key

x

Username

(Applies to all authentication types except None)

Username for the SFTP server.

x

Password

(Applies to these authentication types: Basic, Basic and Identity Key)

Password for the SFTP server.

x

SSH

(Applies to these authentication types: Identity Key, Basic and Identity Key)

SSH private key file. The following considerations apply:

  • Send and receive endpoints that have the same owner can use the same SSH private key file.

  • Multiple message flows for the same or different partners can reference endpoints that use the same SSH private key file.

You can either select a private key file (.pem) that’s already configured in Anypoint Partner Manager or create a new configuration for a private key file.

To create a new configuration for a private key file:

  1. In the <partner> SSH or <host> SSH field, click Select.

  2. In the Select a <partner> ssh or Select a <host> ssh dialog, click New.

  3. Complete the fields in the New certificate for <partner> or New certificate for <host> dialog:

    • Identity Key name

      Enter the name of the private key file.

    • <partner> identity key PEM file or <host> identity key PEM file

      Click Choose file to select the private key file.

    • Key passphrase

      Enter the passphrase for the private key file.

    • Expiration date

      Enter the date on which you want the private key file to expire. This date is a reminder for you, but Anypoint Partner Manager doesn’t enforce it.

  4. Click Create.

x

Target Path

Path on your SFTP server to EDI files that were generated from outbound message flows. This is also the path on your SFTP server for storing transformed JSON and XML files generated from inbound message flows.

x

Filename pattern

Filename pattern required by your partner or back-end application.

See Also