////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
:description: The Put A File With FTP action uploads a file to an FTP server.

= Put a file with FTP

== Description

The Put A File With FTP action uploads a file to an FTP server.

== Options

=== General tab

[options="header", width="90%", cols="1,3"]
|===
|Option|Description
|Action name|The name of the workflow action.
2+|General tab
|FTP server name/IP address|The name of the server or the IP address.
|Port|The port number the FTP server connects on.
|Username|The user name associated with the FTP server account.
|Password|The password associated the FTP server account.
|Proxy host|Proxy server host name.
|Proxy port|Proxy server port number.
|Proxy username|Proxy server account user name.
|Proxy password|Proxy server account password.
|Test connection|Tests the configured connection.
2+|Advanced settings
|Binary mode|Enable if files must be transferred in binary mode.
|Timeout|The FTP server timeout in seconds.
|Use Active FTP connection|Enable if you are connecting to the FTP server using Active mode; you must set your firewall to accept connections to the port that your FTP client will open.
The default is Passive mode.
|Control Encoding|Select the character encoding to use for determining special characters in file names.
For Western Europe and the USA, ISO-8859-1 usually suffices.
Select encoding that is valid for your server.
|===

=== Files tab

[options="header", width="90%", cols="1,3"]
|===
|Option|Description
2+|Source (local) files
|Local directory|The local directory from which to upload.
|Browse...|Browse the filesystem for a local directory.
|Wildcard (regular expression)|If you are uploading multiple files, specify a regular expression that defines the set of files you want to upload.
|Remove files after transferal?|Enable to remove files from the local directory after they've been uploaded.
|Don't overwrite files|Enable to skip files that already exist in the remote directory.
|Remote directory|The directory on the FTP server to upload files to.
|Test folder|Test if the remote directory exists. This connects to the FTP server and attmepts to access the specfied directory. If this directory doesn't exist, the upload fails.
|===

=== Socks Proxy

[options="header", width="90%", cols="1,3"]
|===
|Option|Description
|Host|The Socks proxy server's  host name.
|Port|The port number the Socks proxy connects on.
|Username|The user name associated with the Socks proxy server account.
|Password|The password associated with the Socks proxy server account.
|===
