FTP receiver

The properties of this node are described.

Configuration properties

Table 1. FTP receiver configuration properties
Attribute Description
Runtime Tab
Sub Service Name Enter a unique identifier for each asynchronous receiver within a service definition.
Server Address Enter the IP address or host name of the remote FTP server.
Port Enter the port number of the remote FTP server. Defaults to port 21.
User ID Enter the login ID to use on the FTP server.
Polling Frequency Enter the time in seconds to poll the source directory for unprocessed files.
Includes Pattern Enter the regular expression pattern of the files to retrieve. If not specified all files are included in the working directory.

The following are examples of regular Perl expressions that can be used:

  • .*\.txt - All text files.
  • temp.\.txt - All text files containing the pattern of ‘temp'.
Password Enter the password to use on the FTP server.
Binary Transfer Select this option to transfer data that contains non-ascii characters.
ASCII Transfer Select this option to transfer text files.
Decompress File Select this field if the file being received is compressed.
Source File Parameters Tab
Working Directory Enter the directory on the FTP server from which files are to be transferred.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Completion Directory Enter the completion directory. After successfully transferred from the remote staging directory, the file is moved on the server into the completion directory.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
File Separator Enter the file separator used on the FTP server. The file separator is the folder delimiter specified by the FTP server's settings. This is most commonly represented as a forward slash ('/'). This field is mandatory.
Completion Suffix Enter the suffix to append the file when the file from the remote working directory is moved into the remote completion directory.
Destination File Properties Tab
Working Directory Enter the directory in which the files received are transferred to.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Completion Directory Enter the completion directory. After a file is transferred successfully from the remote working directory, it is subsequently moved to the local completion directory.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
File Separator Enter the file separator used on the FTP server. This field is mandatory.
Completion Suffix Optional. The suffix to append the file when the file from the local working directory is moved into the local completion directory.
Server Tab
Server Name Enter the name of the server which actually executes the service.

For more information about creating a new server, see "Adding a New Server".

Exception Tabs See Table 1 for the receiver link exception handling properties.
Note: Do not configure multiple instances of file receivers or senders trying to FTP the same file. This can lead to file data loss.

Connection properties

The following are the FTP node's connection properties:

Table 2. FTP connection properties
Connection Node Connection Rules
Can be the first node after the start node Only for services invoked asynchronously
Can be placed before
  • File I/O transport node
  • End node
  • Pass-through cannot follow FTP
Can be placed after
  • Start node, only for asynchronously invoked services
  • File I/O transport node.
  • Pass-through cannot precede FTP
Passes data unchanged Transport nodes do not modify data