FTP Receive Endpoint Settings

FTP receive endpoints determine where to receive B2B messages transmitted over FTP. There are two types of FTP 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 FTP 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 FTP Source at Host endpoints.

Create FTP receive 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

Name	Description	Required
Owner	Host, partner, or third-party connection that owns the endpoint.	x
Usage	Endpoint function (`Receive from partners` or `Source at host`).	x
Protocol	Protocol that the endpoint supports (`FTP`).	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	FTP server host, such as `ftp.mulesoft.com`, `localhost`, or `192.168.0.1`. The host must be accessible from your Mule environment.	x
Port	Port number of the FTP server.	x
Character encoding override	Enables inbound endpoints to receive non UTF-8 encoded documents.
Username	Username for connecting to the FTP server.	x (if the server is authenticated)
Password	Password for the FTP server.	x (if the server is authenticated)
Source path	Path on the FTP server to which the partner or third-party connection sends the inbound files.	x
Polling Frequency	Frequency with which the server checks the source path for new files. The default is `1 minute`.	x
Supported Format Type	Applies only to FTP endpoints owned by partners or third-party connections. Indicates whether the endpoint supports EDI messages (EDIFACT, X12) or non-EDI messages (JSON, XML).	x
Size check wait time	Wait time, in seconds, between size checks to determine if a file is ready for processing. The default of `1 second` enables a file write to finish before processing the file. Mule performs two size checks by waiting the amount of time specified in this 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
Associated message type	(Applies when the format type is non-EDI) Message type to associate with the endpoint. If you select a message type, Partner Manager routes files received via the endpoint based on the selected message type instead of the filename.
Associated reference identifier	(Applies to partner and third-party endpoints when the format type is non-EDI) Partner information, such as the partner ID or third-party ID.
File name pattern	Filename pattern required by your partner.
Archival Path	FTP server path at which to store a copy of the file obtained from the source path.

Owner

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

Usage

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

Protocol

Protocol that the endpoint supports (FTP).

Endpoint Name

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

Description

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

Host

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

Port

Port number of the FTP server.

Character encoding override

Enables inbound endpoints to receive non UTF-8 encoded documents.

Username

Username for connecting to the FTP server.

x (if the server is authenticated)

Password

Password for the FTP server.

x (if the server is authenticated)

Source path

Path on the FTP server to which the partner or third-party connection sends the inbound files.

Polling Frequency

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

Supported Format Type

Applies only to FTP endpoints owned by partners or third-party connections. Indicates whether the endpoint supports EDI messages (EDIFACT, X12) or non-EDI messages (JSON, XML).

Size check wait time

Wait time, in seconds, between size checks to determine if a file is ready for processing. The default of 1 second enables a file write to finish before processing the file.

Mule performs two size checks by waiting the amount of time specified in this 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.

Associated message type

(Applies when the format type is non-EDI) Message type to associate with the endpoint. If you select a message type, Partner Manager routes files received via the endpoint based on the selected message type instead of the filename.

Associated reference identifier

(Applies to partner and third-party endpoints when the format type is non-EDI) Partner information, such as the partner ID or third-party ID.

File name pattern

Filename pattern required by your partner.

Archival Path

FTP server path at which to store a copy of the file obtained from the source path.

FTP Receive Endpoint Settings

See Also