FTP Server Connector
FTP Server Connector
FTP Server Connectors provide connection credentials to access the fully-featured ArcESB FTP Server.
The ArcESB FTP Server is primarily configured under the Profile page of the web UI. Individual FTP Server Connectors provide a unique client profile to authenticate to the FTP Server. The client profile consists of a Username (which is the same as the FTP Server Connector’s ConnectorID), a Password, a set of Send and Receive directories, and permissions to read/write files in these directories.
FTP clients are not given permissions to the root of the FTP Server, meaning that FTP clients should always cd into the ‘Send’ (to download) and ‘Receive’ (to upload) directories after connecting.
The FTP Server Profile must be configured before connections can be established with individual FTP Server Connectors.
FTP Server Tab
Server implementation settings.
- Port The port on which the FTP Server will listen for incoming connections.
- FTP Over TLS How SSL/TLS should be negotiated when clients connect to the server. When set to ‘Explicit’, a plaintext connection should be established first and then SSL/TLS should be started with an explicit command. When set to ‘Implicit’, SSL/TLS should be negotiated immediately without first establishing a plaintext connection.
- Server SSL Certificate The SSL certificate that identifies the server. Only required if the server is operating as an FTPS server (SSL/TLS is enabled).
- Certificate Password The password required to access the Server SSL Certificate.
- Welcome Message The banner to be presented to FTP clients when connecting to the server.
- Root Directory The root directory for the server. Subfolders will be created within the root for individual client profiles (i.e. for each configured FTP Server Connector). Each client profile includes a Send Folder, where clients can download files from the server, and a Receive Folder, where clients can upload files to the server.
- Allowed Files Filter A glob pattern that determines which files will be accepted by the FTP server. Multiple patterns can be specified in a comma-delimited list (e.g. *.x12,*.edi), and negative patterns can be specified to exclude certain file patterns (e.g. -*.txt).
Settings related to server logging.
- Enable Server Log Whether to maintain server-side logs for incoming FTP connections.
- Log Level The verbosity of logs generated by the connector. When requesting support, it is recommended to set this value to Debug.
- Rotate Log Files The number of days that the server should maintain a logfile before a new file is started.
- Delete Log Files The number of days that the server should maintain logs before the logfile is deleted.
Settings that do not fall into the previous categories.
- Passive Port Range When using Passive mode, the application uses any available port to listen for incoming data connections. This can be overridden by setting this field to a port range in ‘start-end’ format, for example: ‘1024-‘ refers to anything higher than 1024 (inclusive) and ‘1024-2048’ refers to connectors between 1024 and 2048 (inclusive).
- Passive Address When using Passive mode, the applications returns the IP address for the local interface. This can be overridden by setting this field to the desired public IP address.
- Allow Active Mode Whether FTP Active mode should be supported by the server.
After the FTP Server Profile has been configured, FTP Server Connectors can be created in the Flows page and configured for a specific trading partner.
Credentials for authenticating to the local FTP server.
- Connector Id The static name of the connector. All connector-specific files are held in a folder by the same name within the Data Directory.
- Connector Description An optional field to provide free-form description of the connector and its role in the flow.
- User The username credential for logging in to the local FTP server. This value is always the same as the connector’s ID.
- Password The password credential associated with the User.
Settings related to the read/write permissions the configured client has for the Send and Receive folders.
- Send Directory Permissions Whether the client should have read/write permissions for the Send directory, where files should be downloaded.
- Receive Directory Permissions Whether the client should have read/write permissions for the Receive directory, where files should be uploaded.
Settings related to the folders where clients will upload and download files.
- Send Folder Files placed in the Send folder are available to be downloaded by clients.
- Receive Folder Files uploaded by the client should be placed in the Receive folder. Files will remain in the Receive folder or be passed along to the next connected connector in the flow.
Settings not included in the previous categories.
- Move File After Send Whether files in the Send folder should be moved to the Sent folder after they are downloaded by the client.
- Active Mode Whether to enable Active or Passive mode on the remote FTP server. Passive mode is less likely to result in firewall interference with the connection.
- Log Level The verbosity of logs generated by the connector. When requesting support, it is recommended to set this to Debug.
- Parent Connector The connector from which settings should be inherited, unless explicitly overwritten within the existing connector configuration. Must be set to a connector of the same type as the current connector.
- Temp Receive Extensions Files with a matching extension are not recorded in the Receive table and do not fire the After Receive event until after they are renamed. Specified as a comma-delimited list of extensions.
- Allowed Files Filter A glob pattern that determines what files can be uploaded to directories for this user. Overrides the setting of the same name in the FTP Profile page when specifying filters per-user is required. Multiple patterns can be specified in a comma-delimited list (e.g. *.x12,*.edi), and negative patterns can be specified to exclude certain file patterns (e.g. -*.txt).
- Timeout The duration the server will wait for a connection response before throwing a timeout error.
- Log Messages Whether logs from processed files will include a copy of the file itself.
- Save to Sent Folder Whether files processed by the connector should be copied to the Sent folder for the connector.
Settings for specific use cases.
- Other Settings Allows configuration of hidden connector settings in a semicolon-separated list, like
setting1=value1;setting2=value2. Normal connector use cases and functionality should not require use of these settings.
Establishing a Connection
Each configured FTP Server Connector represents a single trading partner’s connection parameters. The trading partner should connect to the FTP server using the server settings from the Profile page (port, SSL mode, etc) and the authentication settings in the dedicated FTP Server Connector (User, Password).
Each trading partner has a separate pair of Send and Receive directories that are subfolders of the root. The partner should download files from the Send folder and upload files to the Receive folder. The client is not permitted to upload or download files from the root.