FTPCaller

Uploads and downloads data from an FTP server.

The transformer supports the ftp, ftps and sftp protocols.

The transformer allows uploads from attribute values or from a file. Remote files may be downloaded into a local file, or into a feature attribute. The transformer also supports deleting remote files.

Implicit and Explicit FTPS

FTPS supports two methods of invoking TLS encryption: implicit mode and explicit mode. The transformer will use the explicit mode in the following cases:

The URL begins with ftpes: ftpes://hostname/path
The URL begins with ftps but also sets the port to 21: ftps://hostname:21/path

In all other cases, if the URL begins with ftps, the implicit mode will be used.

Optional Input Port

This transformer has two modes, depending on whether a connector is attached to the Input port or not:

Input-driven: When input features are connected, the transformer runs once for each feature it receives in the Input port.
Run Once: When no input features are connected, the transformer runs one time and outputs a single new feature.

Configuration

Input Ports

Output Ports

Parameters

Transfer

URL

This parameter is used to specify a remote file on the FTP server.

Note that the destination URL must be a file, not a folder.

Transfer Type

The Transfer Type parameter indicates the type of FTP operation the transformer will execute. The set of possible operations is:

Download to an Attribute: The remote file specified in the URL parameter will be downloaded into the attribute specified in the Target Attribute parameter. The attribute will be tagged with the encoding named in the Attribute Encoding parameter – no actual encoding conversion will be performed.
Download to a File: The remote file specified in the URL parameter will be downloaded to the local file named in the Target File parameter. If the local file already exists, it will be overwritten with the contents of the remote file. The value of the File Path Attribute will be set to the path of the downloaded file.
Upload from an Attribute: The data given in the Upload Data parameter will be uploaded to the remote file specified in the URL parameter.
Upload from a File: The local file named in the File to Upload parameter will be uploaded to the remote file specified in the URL parameter. If the local file does not exist, the feature will be output through the <Rejected> output port.
Delete a Remote File: The remote file specified in the URL parameter will be deleted from the FTP server.

Connection

Connection Mode	Use this parameter to control the type of connection which is used to transfer data between FME and the FTP server. When Active is selected, the server will connect to FME when transferring data. When Passive is selected, the connection is reversed and FME connects to the server. Some servers and network firewalls only allow one of these connection types, so a failed transfer can sometimes be fixed by changing the connection type. The most commonly used connection type is Passive, which is the default value of this parameter.
Transfer Mode	An FTP upload or download can be performed in binary mode or ASCII mode. When using ASCII mode, the FTP server may perform some text conversions. For example, to convert UNIX line terminators into Windows line terminators, or vice-versa. When using binary mode, all data will be transferred without any modifications. By default, binary mode is used, which should be acceptable in almost all situations.
Verify TLS Certificates	If this parameter is set to Yes, the transformer will verify TLS certificates when connecting to an FTPS server. This is done in two stages: Ensure that the certificate is for the host we are trying to connect to. Ensure that the certificate is valid.
Error Attribute	Features output though the <Rejected> output port will have an error message in the attribute named by this parameter.

Authentication

Authentication Type	This parameter determines how the connection to the FTP server is authenticated.
Username	This is the username of the user which will be accessing the FTP server. This parameter is only used when Authentication Type is not None / Anonymous.
Password	This is the password of the user which will be accessing the FTP server. This parameter is only used when Authentication Type is Password.

Proxy

Proxy Type	Select the proxy type which will be used in this transformer. If None is selected, no proxy will be used. If Use FME Network Proxy Settings is selected, the proxy settings defined in the FME Settings page will be used. If Native FTP Proxy is selected, the transformer will use an FTP proxy configured using the other parameters in this section.
Host	This is the hostname of the proxy server which will be used.
Username	This is the username of the user which will be accessing the proxy server. This can be different than the username used when accessing the FTP server.
Password	This is the password of the user which will be accessing the proxy server.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

How to Set Parameter Values

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Dialog Options - Tables

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior	Feature-Based
Feature Holding	No
Dependencies	None
Aliases
History

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

Search for all results about the FTPCaller on the FME Community.

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.