Salesforce Docs Portal

SFTP Receive Endpoint Settings

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

  • Receive from Partners

    Source endpoint in an inbound message flow that receives B2B messages from partners either directly or via third-party connections.

    A host, partner, or third-party connection can own SFTP Receive from Partners endpoints.

  • Source at Host

    Source endpoint in an outbound message flow that receives messages from the backend applications.

    Only a host can own SFTP Source at Host endpoints.

Create SFTP receive endpoints by configuring these settings on the <host> or Partner page:

Name Description Required

Owner

Partner or host that owns the endpoint.

x

Usage

Endpoint function (Receive from partners or Source at host).

x

Protocol

Protocol that the endpoint supports (SFTP).

x

Endpoint Name

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

x

Description

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

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 server.

x

Character encoding override

Enables inbound endpoints to receive non UTF-8 encoded documents for XML, CSV, and X12 document types.

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

Source path

Path on the SFTP server to which your partner sends the inbound files.

x

Skip Delete

When enabled, Partner Manager keeps the source file after reading and processing.

Use this configuration only when connecting to SFTP/FTP hosts that don’t allow explicit file deletion after the first read. Using this configuration with other types of SFTP/FTP hosts can result in duplicate file processing.

Skip empty files

Skip empty files during processing.

No

Polling Frequency

Frequency at which the server checks the source path for new files. The default value is 1 minute.

x

Size check wait time

Wait time, in seconds, between size checks to determine if a file is ready for processing. The default value is 1 second. This allows a file write to complete before processing.

Mule performs two size checks by waiting the amount of time specified in the Size check wait time field. If both checks return the same value, the file is ready to process.

To disable this feature, specify a negative number or omit the value.

x

Support Format type

Indicates whether the endpoint supports EDI messages (EDIFACT, X12) or non-EDI messages (JSON, XML).

x

Associated message type

(Applies only to endpoints that support non-EDI formats) Message type to associate with the endpoint. If you select a message type, Partner Manager processes files received via the endpoint as the selected message type, regardless of the file naming convention.

Use hyphen (-) as the secondary file name delimiter to determine non-EDI message type

Lets you use a hyphen as the secondary file name delimiter to determine the message type from the message’s file name. Only shows if the supported format type is non-EDI.

No

Associated reference identifier

(Applies only to endpoints that support non-EDI formats that are owned by partners or third-party connections.) Partner information, such as the partner ID or third-party ID.

File name pattern

Filename pattern required by your partner.

Archival Path

Directory path on the SFTP server at which to store a copy of the file after processing.

The runtime application attempts to create the archive file up to three times. If permission or connection errors prevent Partner Manager from deleting the file, Partner Manager logs the issue in the runtime application and skips the archival step to prevent duplicate message processing.

See Also