You are here: Reference Manual > FME Server Web Services > Notification Service > Subscribers > Creating an FTP Subscription

Creating an FTP Subscription

In the FME Server Web User Interface, select Notifications > Subscriptions, and click New.

  • Name: Provide a name for the subscription.
  • Protocol: Select FTP.
  • Topics Subscribed To: The topics that this FTP subscription is subscribed to.
  • Host: The FTP host name.
  • Port: The FTP port number.
  • Username: The FTP user name for authentication.
  • Password: The FTP user password for authentication.
  • Encryption: The encryption type, depending on the FTP server connection requirements. Options are None, FTPS and FTPES encryption protocols.
  • Transfer Type: The transfer method. "Auto" means the FTP subscription will guess the file type of the file being transferred. "ASCII" and "Binary" are available options when the file type is known.
  • Connection Type: The FTP connection mode. Passive Mode requires your FTP server to create connections using port numbers greater than 1023. Active Mode uses only ports 20 and 21 on the FTP server.
  • Destination Path: The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\). If the path does not exist, FME attempts to create it on the FTP server when the subscription runs.
  • Source Path: The path to the source file to upload. To specify a Resources location, click the ellipsis (...). To specify another path, enter it in the text field directly. File paths must use forward slashes (/) or escaped backslashes (\\). Template macros are supported for this field (see below).

In the example shown above, the source files are all the ones that have been written to {OutputLocation}, as specified in the FILE_DOWNLOAD_SERVICE section of the FME Engine configuration file. FILE_DOWNLOAD_SERVICE is used to configure transformations for the Data Download Service. For more information about the FME Engine configuration file, see Configuration File Layout.

The files are uploaded to the "test" directory of ftpserver.com.

All FME Engine keywords defined for SUCCESS_RESPONSE and FAILURE_RESPONSE can be used as template macros. For example, the following SUCCESS_RESPONSE configuration in the FME Engine configuration file provides {OutputLocation}, {ResultRootDir}, {NumFeaturesOutput}, and {LogFileName} as available template macros:

SUCCESS_RESPONSE 0:Translation Successful|OutputLocation=!FME_AUTO_DIR_NAME!|ResultRootDir=/fmedatadownload/results|NumFeaturesOutput=!FME_NUM_FEATURES_OUTPUT!|LogFileName=datadownload/!FME_AUTO_FILE_NAME_SIMPLE.log! \