FTP Action

FTP (File Transfer Protocol) Action

FTP (File Transfer Protocol) is the most widely used method for transmitting files between two Internet sites. It is a common way to log onto another Internet site for the purposes of retrieving and/or sending files. AWE's internal FTP engine is compatible with all FTP connection methods, particularly security-based connections, including:

FTP (Standard)
FTP with SSL.TLS (Implicit)
FTP with SSL/TLS (Explicit
SFTP (Password)
SFTP (Key)

Certificate Authenticity is supported for those servers that require clients to authenticate themselves using a certificate.

Properties Tab

On the Properties tab, select the Activity to perform and then configure the properties described below. The available properties depends on which activity is selected.

To set FTP properties

In the Available Actions pane, open the Network folder and double-click the FTP action or drag it into the Steps pane.
In the Activity to perform box, specify the type of FTP activity you want to do, then specify the properties. The available properties depend on the activity selected.

Specify the properties that appear, depending on the activity selected.
To set the Description tab properties, refer to Description Tab Options.
To set the Error Causes and On Error tab properties, refer to Step Error Handling.
When finished, click OK to save settings and close the properties dialog box.

Available Activities

The following table briefly describes the available activities for this action arranged in alphabetical order as specified in the Activity to perform parameter.

Activity

Description

Declaration

Example

Advanced

Sends specific customized commands to an FTP server. For most transactions, use the standard FTP Upload/Download actions.

The standard FTP Download and FTP Upload commands send predetermined command sequences to the server. FTP Advanced is useful when it is necessary to create or perform a customized sequence of commands. For example, the FTP Advanced action could be used to return a folder listing. This list could then be looped using the Loop List action to "examine" each file (such as the date) before performing some other action for each individual file based on the result.

Advanced FTP can also be used to perform commands that are server specific and/or not supported by other FTP actions such as "Move" (moves the file on the FTP Server without downloading it first).

This example will demonstrate how AWE can delete files older than 30 days via FTP. It will do the following:

Logon to a FTP server.
Execute the "Get long file list" command using the FTP Advanced action and populate a dataset with the results.
Loop through the dataset FileList, which has a list of files and folders on the FTP server.
An expression is then used in the If action to get a day differential between today's date and the date of the file on the FTP server. If the file is older than 30 days, it is then deleted.

The %DateDiff()% function returns the number of intervals between two dates.

</AMIF>

</AMLOOP>

Change Folder

Changes the current "working folder" on the FTP server so that relative paths may be used. It is not necessary to use this action if "absolute paths" are used (this is the preferred method).

This example performs the following steps:

Log on to FTP host "ftp.mycompany.com". User name "Godzilla". Session "MyFTPSession".
Change to folder "/home/ftp" via FTP. Session "FTPSession".
Log off of FTP host. Session "MyFTPSession".

Create Folder

Creates a folder on the FTP server. Subsequent FTP operations can be performed such as uploading files to the newly created folder.

This example logs onto an FTP site, creates a "/home/ftp" folder and logs out.

Delete

Deletes one or more files that reside on the FTP server. To specify more than one file, use wildcards (Example: * or ? ). This activity can be used to delete files from the FTP server after they have been downloaded using the FTP Download activity.

This example will demonstrate how AWE can delete files older than 30 days via FTP. It will do the following:

Logon to a FTP server.
Execute the "Get long file list" command using AWE's FTP Advanced action and populate a dataset with the results.
Loop through the dataset FileList, which has a list of files and folders on the FTP server.
An expression is then used in the If action to get a day differential between today's date and the date of the file on the FTP server. If the file is older than 30 days, it is then deleted.

The %DateDiff()% function returns the number of intervals between two dates.

</AMIF>

</AMLOOP>

Download

Downloads the file(s) specified from the FTP server. To specify more than one file, use wildcards (i.e. * or ?). Automated download of files from an FTP Server such as program updates, databases, reports, etc.

Example Task 1 - This task will log onto an FTP site, download a single file and log off.

NOTE: This example uses a file that is assumed to already exist. If you have not done so, please modify this task to point to a file which already exists on the server.

Example 2 - This task will demonstrate how AWE can download a file via FTP that contains a date string in the name. AWE creates a date variable and passes the variable into an FTP Download action to download a file by date.

NOTE: This example uses a file that is assumed to already exist. If you have not done so, please modify this task to point to a file which already exists on the server.

<AMVARIABLE NAME="dtmdate">%Format(Now, "mmdd")%</AMVARIABLE>

FXP

File eXchange Protocol (FXP) allows you to copy files from one FTP server to another FTP server (two remote hosts). FXP removes the middle step of transferring files from one FTP server to your local machine then to the second FTP server. The data transfer rate is also independent of your own Internet connection speed as it is based on the connection speed between the two hosts, which is usually faster than a user's own Internet connection.

NOTE: This activity is supported only in normal or SSL/TLS FTP connection types. To use this activity, you must first log on to the both the source and destination FTP server using the FTP Log On activity and create a separate session name for each.

This example demonstrates the activities used to download files from one FTP server to another. The first two steps logs onto two separate FTP hosts and creates a unique session name for each connection. The third step performs the file transfer from one server to another. The last two steps are used to log off each FTP server. In order for this task to work in your environment, please make the appropriate modifications in the properties of each activity.

Log Off

Ends a transaction with an FTP server that was previously started with an FTP Log On step. FTP transactions should always end with an FTP Log Off step.

This example will log onto an FTP site, download a single file, and log off.

Log On

Starts a transaction with a File Transfer Protocol (FTP) server and creates a session for the current connection. Other FTP related actions can follow this step. This activity allows simultaneous FTP connections using the same username/password.

NOTE: Be sure to end FTP sessions with an "FTP Log Off" step.

This example will log onto an FTP site, download a single file and log off.

Remove Folder

Deletes the folder(s) specified from the FTP server. To specify more than one folder, use wildcards (Example: * or ?). NOTE: If any files are contained in the folder(s) to be deleted, those files will be deleted along with the folder.

This example deletes folder "/home/ftp/" via FTP, session name "FTPSession2".

Rename

Renames the file(s) specified on the FTP server. To specify more than one file, use wildcards (i.e. * or ? ). NOTE: All files must be located in the same folder and must be renamed in the same folder.

Synchronize Folders

Synchronizes folders located on the FTP server with folders located on the local machine. Folders can be synchronized either uni-directionally (one-way) or bi-directionally (both ways).

Usually used replicate folders between an FTP server and a local machine or to backup specific folders.

This example logs onto an FTP site, synchronizes the remote folder /home/ftp (including subfolders) with the local folder C:\Temp and logs off.

This task logs onto an FTP site, synchronizes the remote folder "/home/myFolders/FTPFolder1" with the local folder "C:\myFolders\Folder1" and logs off. In order for this task to work in your environment, please make the appropriate modifications in the properties of each activity.

Upload

Uploads the specified local file(s) to the FTP server. To indicate more than one file, use wildcards (Example: * or ?). Commonly used to send files to other computers across the network or Internet. Can also be used to back-up files or complete directory structures.

Example Task 1 - This example logs onto an FTP site, uploads a single file and logs off.

Example 1 - This example logs onto an FTP site, uploads all text files located in the C:\Temp directory that are newer than 24 hours and logs off.

Advanced Properties

Advanced properties are active only if Custom is selected in the Credentials section in the Provide credentials list box.

Property	Type	Required	Default	Markup	Description
Connection Type	Options	Yes	FTP (Standard FTP)	TYPE="ftps_implicit"	Specifies the type of FTP connection that should be used. The available options are: FTP (Standard FTP): Connect using standard FTP. FTP with SSL (Implicit): Connect using FTPS (also known as FTP Secure or FTP-SSL). This connection type adds support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) cryptographic protocols. In Implicit mode, a client immediately sends the FTPS server a TLS/SSL "ClientHello" message. If such a message is not received by the FTPS server, the connection is dropped. FTP with SSL (Explicit): Connect using FTPS (also known as FTP Secure or FTP-SSL). This connection type adds support for the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) cryptographic protocols. In Explicit mode, a client must "explicitly request" security from a FTPS server and then use a mutually agreed encryption method. SFTP (Password): Connect using SFTP (also known as Secure FTP). SFTP uses SSH (Secure Shell) protocol to transfer files. Unlike standard FTP, it encrypts both commands and data, preventing sensitive information from being transmitted in the clear over the network. In Password mode, a password is used to authenticate the SFTP connection. SFTP (Public Key File): Connect using SFTP (also known as Secure FTP). SFTP uses SSH (Secure Shell) protocol to transfer files. Unlike standard FTP, it encrypts both commands and data, preventing sensitive information from being transmitted in the clear over the network. In Public Key File mode, connection is validated via a specified public key.
Port	Text	Yes	210	PORT="1000"	Specifies the port that should be used to connect to the FTP server. Most standard FTP servers operate on port 21 (the default port specified) however, this parameter can be customized in case the FTP server operates on other ports. NOTE: Other default ports may be assigned depending on the server connection type selected.
FTP Log File	Text	No	(Empty)	LOGFILE="c:\temp\error.log"	Specifies the location of a detailed FTP log file. This log file contains the exact text of the FTP session which can be useful in diagnosing particular errors or elusive problems.
Overwrite Existing Log File	Yes/No	No	Yes	OVERWRITELOG="NO"	If YES, specifies that the log file should be overwritten if the same file already exists. The default value is YES.
Timeout	Number	Yes	30 Seconds	TIMEOUT="60"	Indicates a connection timeout to customize how long AWE will wait before aborting a connection attempt. If connection is not established within the timeout value specified, it is automatically aborted. The default value is 30 seconds.
Upload Buffer Size	Number	Yes	65536 Bytes	UPLOADBUFFERSIZE="54443"	Specifies the upload buffer size value for files being uploaded. In some cases changing the upload buffer size can make a difference; particularly in transfers over high loss, high speed connections where latency plays an important role. The default value is 65536 bytes, which is the maximum buffer size. NOTE: Setting the Upload Buffer Size value too high for slow connections might cause time-outs and the transfer speed calculation becomes inaccurate.
Passive Mode (For Firewalls)	Yes/No	No	No	PASSIVEMODE="YES"	Determines how an FTP data connection is made. If set to YES, AWE issues the PASV command and the server tells AWE where to establish the data connection. AWE initiates both connections to the server, solving the problem of firewalls filtering the incoming data port connection to the client from the server. If set to NO, the PORT method is used. AWE listens for a data connection which is established by the server and the PORT command tells the server where to connect to. AWE then connects to the server where the server indicated. This method is sometimes used with some proxy configurations. However, some proxy configurations require PORT transfers and some FTP servers do not support PASV transfers. This option is available only if the FTP (Standard FTP), FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
Enable FIPS mode	Yes/No	No	No		Uses FIPS-compliant cryptographic modules and algorithms of Microsoft Windows.
Use compression	Yes/No	No	No
Encrypt data channel	Yes/No	No	No	ENCRYPTDATACHANNEL="YES"	If YES, specifies that all data channel communication between the FTPS client and server are to be encrypted. The default value is NO. It may NOT be advantageous to use data channel encryption when performing transfers under the following scenarios: Files being transferred are of a non-sensitive nature, making encryption unnecessary. Files being transferred are already encrypted at the file level, making encryption redundant. This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
Ignore invalid server certificates	Yes/No	No	No	IGNOREINVALIDCERTIFICATE="YES"	If YES, specifies that this action will ignore invalid certificates when connecting to an FTP server using SSL. The default value is NO. This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connecti on Type parameter.
Clear Command Channel	Yes/No	No	No	CLEARCOMMANDCHANNEL="YES"	If YES, this option enables support for the Clear Command Channel (CCC) functionality. The CCC command can be issued by a remote FTPS client and will cause AWE's FTP client to fall out of secure mode and back in to unsecure mode. This option is useful for clients who only need to secure the authentication portion of the session. Once the USER/PASS has completed, some clients will use CCC to return to unsecure mode, which is faster. The default value is NO. This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
Enable Tumbleweed compatibility mode	Yes/No	No	No	TUMBLEWEEDSERVER="YES"	If set to YES, allows compatibility with Tumbleweed Secure Content Delivery.
Client Certificate Source	Options	No	No Certificate	CERTIFICATESOURCE="file"	FTP over SSL allows sessions to be encrypted between an FTP client and server. This property is used to select the source of the certificate. A certificate is a digitally-signed statement that binds the value of a public key to the identity of the person, device, or service that holds the corresponding private key. One of the main benefits of certificates is that hosts no longer have to maintain a set of passwords for individual subjects who need to be authenticated as a prerequisite to access. Instead, the host merely establishes trust in a certificate issuer. The available options are: No Certificate (Default) Certificate Store - Allows selection of a certificate using the Window's trusted certificate store for certificate approval. File(s) - Allows selection of a certificate file. Automatically select certificate - AWE will select the best suitable certificate from the user store that matches the FTP server request. This option is available only if the FTP with SSL (Implicit) or FTP with SSL (Explicit) option is selected from the Server Connection Type parameter.
Certificate Issuer	Text	No	(Empty)	CERTIFICATEISSUERID="Name"	Specifies information regarding the certification authority that issued the certificate. This parameter is available only when Certificate Store option is selected from the Client Certificate Source parameter.
Certificate Serial Number	Number	No	(Empty)	CERTIFICATESERIAL= "c7 f5 fa f8 6d ab 77 87 43 4a 11 43 f1 cd 3c 0f"	Specifies the unique serial number that the issuing certification authority assigns to the certificate. The serial number is unique for all certificates issued by a given certification authority. This parameter is available only when Certificate Store option is selected from the Client Certificate Source parameter.
Certificate File	Text	No	(Empty)	CERTIFICATE= "C:\Temp\Certificate_Location"	Specifies the path and filename of the certificate file. This parameter is available only when the File(s) option is selected from the Client Certificate Source parameter.
Passphrase	Text	No	(Empty)	PASSPHRASE="passphrase"	Specifies the passphrase used to authenticate connection. A passphrase is a password that comprises a whole phrase. This parameter is available only when the File(s) option is selected from the Client Certificate Source parameter.
Certificate private key	Text	No	(Empty)	CERTIFICATEPRIVATEKEY= "C:\Temp\Private_Key"	Specifies the path and filename of the Private key file. This parameter is available only when the File(s) option is selected from the Client Certificate Source parameter. In public/private key encryption, different keys are used to encrypt and decrypt information. The first key is a private key (a key that is known only to its owner), while the second key (called the public key) can be made known and available to other entities on the network. The two keys are different but complementary in function. For example, a user’s public key can be published in a certificate in a directory so that it is accessible to other people in the organization. The sender of a message can retrieve the user’s certificate from Active Directory, obtain the public key from the certificate, and then encrypt the message by using the recipient's public key. Information that is encrypted with the public key can be decrypted only by using the corresponding private key of the set, which remains with its owner, the recipient of the message.

Credentials Properties

The Credentials properties allow you to set or link specific recommendations for this particular FTP activity such as Host, Username, Password, etc.

Property	Type	Required	Default	Markup	Description
Provide Credentials					Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. The available options are: Custom (Default) - Specifies that a custom set of credentials will be entered for this FTP activity. Select this option if performing a single FTP activity. Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the FTP Log On activity. This allows several FTP activities to be linked to a specific session.
Host	Text	Yes	(Empty)	a)SERVER="ftp.netauto.com" b)SERVER="123.456.789.012"	Specifies the FTP server to connect to. This can be an IP address (i.e. xxx.xxx.xxx.xxx) or a server and domain name (i.e. server.domain.com). This property is active only if Custom is selected under the Provide Credentials property.
Username	Text	Yes	(Empty)	USERNAME="ClarkKent"	Specifies the username that should be used when logging on to the FTP Server. The Username should be pre-configured at the server level. This property is active only if Custom is selected under the Provide Credentials property.
Password	Text	Yes	(Empty)	PASSWORD="password"	Specifies the password that should be used when logging on to the FTP Server. When the step is created using the Task Builder it is written to the task encrypted. This property is active only if Custom is selected under the Provide Credentials property.
Use Anonymous Logon	Yes/No	No	No	ANONYMOUSLOGIN="YES"	Specifies that the FTP server should be logged onto as an "Anonymous" user. The server must be configured to accept Anonymous connections. If set to YES, the Username/Password parameters are ignored. The default value is NO. This property is active only if Custom is selected under the Provide Credentials property.
Session	Text	Yes	FTPSession	SESSION="FTPSession2"	Indicates the session name that this activity should originate from. This allows several FTP activities to be linked to a specific session. Numerous sessions can be used within a single task. This property is active only if Session Based is selected under the Provide Credentials property.

File Attributes Properties

This group of properties causes this activity to filter which files are uploaded based on the attribute settings of the source file(s). In visual mode, a group of controls are provided to assist in the selection of the available options. In markup mode, a single text item is specified that contains the attributes of the files you want to upload.

Property	Type	Required	Default	Markup	Description
Read-only attribute is	Text (options)	No	Doesn't Matter	a)ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b)ATTRFILTER="-S" (exclude system files)	Filters which files to include based on Read-only attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+R) - Causes files with this attribute turned on to be included. Off (-R) - Causes files with this attribute turned off to be included.
Archive attribute is	Text (options)	No	Doesn't Matter	a)ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b)ATTRFILTER="-S" (exclude system files)	Filters which files to include based on Archive attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+A) - Causes files with this attribute turned on to be included. Off (-A) - Causes files with this attribute turned off to be included.
System attribute is	Text (options)	No	Doesn't Matter	a)ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b)ATTRFILTER="-S" (exclude system files)	Filters which files to include based on System attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+S) - Causes files with this attribute turned on to be included. Off (-S) - Causes files with this attribute turned off to be included.
Hidden attribute is	Text (options)	No	Doesn't Matter	a)ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b)ATTRFILTER="-S" (exclude system files)	Filters which files to include based on Hidden attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+H) - Causes files with this attribute turned on to be included. Off (-H) - Causes files with this attribute turned off to be included.
Compression attribute is	Text (options)	No	Doesn't Matter	a)ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b)ATTRFILTER="-S" (exclude system files)	Filters which files to include based on Compression attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+C) - Causes files with this attribute turned on to be included. Off (-C) - Causes files with this attribute turned off to be included.
Encryption attribute is	Text (options)	No	Doesn't Matter	a) ATTRFILTER="+R+S-H" (include read-only and system files, exclude hidden files) b) ATTRFILTER="-S" (exclude system files)	Filters which files to include based on Encryption attribute settings. The available options are: Doesn't Matter (Default) - Causes this attribute to be ignored. On (+E) - Causes files with this attribute turned on to be included. Off (-E) - Causes files with this attribute turned off to be included.

File Options Properties

Property	Type	Required	Default	Markup	Description
Include Subfolders	Yes/No	No	(Empty)	SUBFOLDERS="YES"	When set to YES, specifies that, if present, subfolders should be searched for files matching the mask specified in the Remote Files parameter. The default value is NO.
Preserve Folder Structure	Yes/No	No	No	KEEPFOLDERSTRUCT="YES"	When set to YES, specifies that subfolders found in the source folder should be created in the destination folder and source files should be copied into their respective folders rather than directly into the root of the target folder specified in the Local File parameter. The default value is NO. This option is available only if the Include Subfolders parameter is set to YES.
Only Folder Structure	Yes/No	No	No	ONLYFOLDERSTRUCT="YES"	When set to YES, indicates that subfolders found in the source folder should be created in the destination folder but no files will be copied. Enabling this option causes any file-specific parameters to be ignored. The default value is NO. This parameter is available only if the Include Subfolders parameter is set to YES.
Overwrite if exists	Yes/No	No	No	OVERWRITE="YES"	When set to YES, specifies that, if files already exist in the destination, they should be overwritten. The default value is NO.
Only if exists in destination	Yes/No	No	No	ONLYIFEXIST="YES"	When set to YES, indicates that only files that already exist in the destination will be copied from the source. All other files, regardless of whether they match the mask or other parameter settings will be bypassed. The default value is NO. Valid only if the Overwrite if exists parameter is set to YES.
Resume Download	Yes/No	No	No	RESUME="YES"	When set to YES, specifies that downloads will resume on files that are partially downloaded (if the server supports resuming transfers).
Match Case	Yes/No	No	No	MATCHCASE="YES"	Indicates whether the properties set within this activity should be case sensitive in relation to the FTP server. The default value is NO.
Transfer Type	Options	Yes	Binary	TRANSFERTYPE="ASCII"	Specifies whether the transfer type should be set to binary or ASCII mode. The default is binary. Binary mode refers to transferring files as a binary stream of data. Where ASCII mode may use special control characters to format data, binary mode transmits the raw bytes of the file being transferred. In this way, the file is transferred in its exact original form. When files are transferred in ASCII mode, the transferred data is considered to contain only ASCII formatted text. The party that is receiving the transferred data is responsible for translating the format of the received text to one that is compatible with their operating system.
Validate Checksum	Yes/No	No	No	VALIDATECHECKSUM="YES"	Indicates whether to validate the integrity of data being transferred by calculating a checksum using the selected algorithm. The default value is NO.
Checksum Type	Options	No	CRC	CHECKSUMTYPE="sha1"	Specifies the checksum algorithm to use. The available options are: CRC (Default) MD5 SHA1
Include Mask	Text	No	.	INCLUDE="*.jpg"	Specifies a wildcard mask (such as * or ?) representing the files that should be synchronized. The default value is . which specifies all files.
Exclude Mask	Text	No	(Empty)	EXCLUDE="*.txt"	Causes this activity to omit any files matching the mask(s) specified. Filenames or wildcard masks (i.e. * or ?) may be used.
Only if Newer	Date	No	(Empty)	ISNEWERTHAN= "%DateAdd("s",-30, CStr(Now()))%"	Causes this activity to only upload file(s) if the source is newer than the date/time specified. If this parameter is left empty, the date of the file(s) will be ignored. Click Custom to select one of several available date/time ranges. Enable the Expression option to enter a date expression.
Only if Older	Date	No	(Empty)	ISOLDERTHAN= "%DateAdd("s",-30, CStr(Now()))%"	Causes this activity to only upload file(s) if the source is older than the date/time specified. If this parameter is left empty, the date of the file(s) will be ignored. Click Custom to select one of several available date/time ranges. Enable the Expression option to enter a date expression.
Regular Expression	Yes/No	No	No	RE="YES"	Specifies whether the value in the Exclude Mask parameter is a regular expressions. Regular Expression, also referred to as regex or regexp, provide a concise and flexible means for matching strings of text.

File Properties

Property	Type	Required	Default	Markup	Description
Local File(s)	Text	Yes	(Empty)	a)SOURCE="c:\foldername\file.txt" b)SOURCE="c:\foldername\.txt" c)SOURCE="c:\folder\.txt\|c:\folder\*.doc"	Specifies the file(s) to upload. This can be a fully qualified UNIX style path and filename (preferred) or a single file (requires use of the FTP Change Folder action). Wildcards (i.e. . or ?) may be used to download files matching a certain mask.
Remote File(s)	Text	Yes	(Empty)	a)SOURCE="/sourcefoldername/file.txt" b)SOURCE="/sourcefoldername/*.txt" c)SOURCE="file.txt"	Indicates the file(s) to delete. This can be a fully qualified UNIX style path and filename (preferred) or a single file (requires use of the FTP Change Folder action). Wildcards (Example: . or ?) may be used to delete files matching a certain mask.
Source Server File(s)	Text	Yes	(Empty)	a)SOURCE="/sourcefoldername/file.txt" b)SOURCE="/sourcefoldername/*.txt" c)SOURCE="file.txt"	Specifies the file(s) from the source server to transfer. This can be a fully qualified UNIX style path and filename (preferred) or a single file (requires use of the FTP Change Folder action). Wildcards (i.e. . or ?) may be used to download files matching a certain mask.
Destination Server File(s)	Text	Yes	(Empty)	a)DEST="/destinationfolder/file.txt" b)DEST="/destinationfolder/*.txt" c)DEST="file.txt"	Specifies the location in the destination server to transfer the files to. This can be a fully qualified path or a filename.
Create and Populate Dataset	Text	No	(Empty)	RESULTDATASET="theDataset"	Specifies the name of a dataset to be populated with information regarding the files to be copied. Refer to the Datasets section below for more details about the dataset fields this activity creates.

Folder Properties

Property	Type	Required	Default	Markup	Description
Remote Folder	Text	Yes	(Empty)	FOLDER="/home/folder1"	Specifies a fully qualified UNIX style path to the FTP server folder to change to.
Remote File(s)	Text	Yes	(Empty)	MARKUP: a)SOURCE="/foldername/file.txt" b)SOURCE="/foldername/*.txt" c)SOURCE="file.txt"	Indicates the file(s) to rename. This can be a fully qualified UNIX style path and filename (preferred) or a single file (requires use of the FTP Change Folder action). Wildcards (i.e. . or ?) may be used to rename files matching a certain mask.
Local Folder	Text	Yes	(Empty)	LOCALFOLDER="c:\foldername\"	Specifies the destination folder that resides locally.
Create and populate dataset	Text	No	(Empty)	RESULTDATASET="theDataset"	The name of a dataset to be populated with information regarding the folder/files to be synchronized. Refer to the Datasets section below for more details about created datasets.
Synchronization	Options	Yes	Bidirectional	SYNCHRONIZATION="remote_to_local"	Specifies the method by which the files should be synchronized. The available options are: Remote <-->Local (Bidirectional) - The files will be synchronized both ways, from the remote folder to the local folder and from the local folder to the remote folder. files from the FTP server that do not exist locally will be transferred to the folder specified in the Local Folder parameter and local files that do not exist in the FTP server will be transferred to the folder specified in the Remote Folder parameter. Remote --> Local (Unidirectional) - The files will be synchronized one way, from remote folder to the local folder. Files from the FTP server that do not exist locally will be transferred to the folder specified in the Local Folder parameter. Local --> Remote (Unidirectional) - The files will be synchronized one way, from local folder to the remote folder. Local files that do not exist in the FTP server will be transferred to the folder specified in the Remote Folder parameter.
Exact copy in remote/local folder	Yes/No	No	No	EXACTCOPY="YES"	When set to YES, an exact copy of files in the source folder will be created in the destination folder. Files and folders that exist in the destination folder but do not exist in the source folder are removed. If a newer version of a file or folder exists in the source, it will be copied to the destination. The default value is NO. This parameter is available only if Remote --> Local (Unidirectional) or Local --> Remote (Unidirectional) is selected via the Synchronization parameter.
If file exists at both locations	Options	No	Newer Overwrites Older	SYNCHOVERWRITE="ignore"	Specifies what should be done if a file with the same name exists in both source and destination folders. The available options are: Newer Overwrites Older (Default) - The file with the newer modified date will overwrite the matching file with an older modified date. Ignore - The file with the same name that exists in the source folder will be ignored. No actions will be performed regarding this file whether it is newer or older than its counterpart. Overwrite - The file with the same name that exists in the source folder will overwrite its counterpart that resides in the destination folder, whether it is newer or older.
FTP Server Timezone	Options	No	(GMT) Coordinated Universal Time [UTC]	FTPSERVERTIMEZONE="Fiji [Fiji Standard Time]"	Indicates the timezone to set for the FTP server. This is useful if file date/time specifications are set for this activity and the FTP server is in a different timezone than that of the local machine. This property converts the local time into the server timezone selected.
New Name	Text	Yes	(Empty)	MARKUP: a)DEST="/foldername/newfilename.txt" b)DEST="/foldername/*.txt" c)DEST="newfilenamefile.txt"	Specifies the new file name(s) for the files specified in the Remote File(s) parameter.
Match Case					Indicates whether the properties set within this activity should be case sensitive in relation to the FTP server. The default value is NO. This is a visual mode parameter used only during design time, therefore, contains no markup.

FTP Advanced Properties

Property	Type	Required	Default	Markup	Description
FTP Command	Text	Yes	(Empty)	FTPCOMMAND="connect"	Specifies the command to execute. The available commands are described in the Available Commands table below.
Parameters	Text	No	(Empty)	a)PARAMETER="c:\filename.txt b)PARAMETER="Foldername"	Indicates the parameter for the command specified. The use of this parameter varies depending on the command selected and in certain cases is not used.
Populate variable with sent data	Text	No	(Empty)	SENTDATAVARIABLE="variablename"	Specifies the name of a variable to be populated with information regarding sent data.
Populate variable with return data	Text	No	(Empty)	RESULTVARIABLE="variablename"	Specifies the name of a variable to be populated with information regarding return data (depending on the command sent).
Create dataset with file listing information	Text	No	(Empty)	FTPLONGLISTDATASET="datasetname"	Specifies the name of the dataset to be populated with information regarding file listing information. Only available if the GetLongFileList command is selected. This command is helpful because it can populate a dataset with the results. You can then loop through the dataset, which is a list of files on the server, and choose whether or not to download the current file. More on the exclusive column names that this dataset creates are detailed below under Datasets.
Match Case	Yes/No	Yes	No	MATCHCASE="Yes"	Indicates whether the properties set within this activity should be case sensitive in relation to the FTP server. The default value is NO.

Proxy Properties

These properties are active only if Custom is selected under the Provide Credentials property.

Property	Type	Required	Default	Markup	Description
Proxy Type	Options	No	None	PROXYTYPE="Socks5"	The proxy protocol that should be used. If you are unsure of the value to use in this parameter, contact your network administrator. The available options are: System Default - None (Default) - Instructs the activity not to use a proxy server regardless of the system default. Socks 4: Instructs the activity to go through a Socks 4 compliant server. Socks 4a: Instructs the activity to go through a Socks 4a compliant server. Socks 5: Instructs the activity to go through a Socks 5 compliant server. HTTP - Instructs the activity to go through a HTTP compliant server. FTPSite - Instructs the activity to go through a FTPSite compliant server. FTPUser - Instructs the activity to go through a FTPUser compliant server. FTPOpen - Instructs the activity to go through a FTPOpen compliant server.
Proxy Host	Text	No	(Empty)	PROXYSERVER="proxy.host.com"	The hostname (i.e. server.domain.com) or IP address i.e. (xxx.xxx.xxx.xxx) of the proxy server.
Proxy Port	Text	Yes	21	PORT="1000"	The port that should be used to connect to the FTP server. Most standard FTP servers operate on port 21 (the default port specified) however, this parameter can be customized in case the FTP server operates on other ports. NOTE: Other default ports may be assigned depending on the server connection type selected.
Proxy Username	Text	No	(Empty)	ROXYUSERNAME="username"	The username that should be used to authenticate when connecting through the proxy server. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.
Proxy Password	text	No	(Empty)	PROXYPASSWORD="encrypted"	The password that should be used to authenticate when connecting through the proxy server. When the step is created using the Task Builder it is written to the task encrypted. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.

Session Properties

Property	Type	Required	Default	Markup	Description
Source Server Session	Text	Yes	FTPSession	SESSION="Server1"	The session name used to log onto the source FTP server (created in a previous FTP Log On step).
Destination Server Session	Text	Yes	FTPSession	DERSTINATIONSESSION="Server2"	The session name used to log onto the destination FTP server (created in a previous FTP Log On step.
Session	Text	Yes	FTPSession	SESSION="SessionName"	Specifies the session name (created in a previous FTP Log On step) that this activity should originate from. This permits several FTP activities to be linked to a specific session, thus, allowing multiple simultaneous FTP transfers to take place within a single task.

Available Commands

Command	DOS	Description	Sample Syntax (if applicable)
Connect		Connect to an FTP server.	ftp.domain.com or 207.46.133.140.
Username	USER	Provide a username for logging in	anonymous
Password	PASS	Provide a password for logging in	password
Help	HELP	Retrieve FTP help information	N/A
System information	SYST	Retrieve information about the remote FTP server	N/A
Site command	SITE	Issue server specific commands that are not part of the FTP RFC.	CHMOD or DIRSTYLE
Passive mode	PASV	Switch to passive mode to negotiate file transfers through firewalls	N/A
ASCII mode	TYPE A	Switch to ASCII transfer mode. Used when transferring text files with FTP servers that do not use ASCII as the base character set. One example is EBCDIC.	N/A
Binary mode	TYPE I	Switch to binary transfer mode. Used when transferring binary files.	N/A
Download file	GET	Download single file (PORT followed by RETR).	\"/Remote FileName.exe\" [optional]\"C:\\Local FileName.exe\"
Download multiple files	MGET	Download multiple files using a mask (multiple PORT and RETR).	/*.exe
Upload file	PUT	Upload one file (PORT followed by STOR).	\"C:\\Local FileName.exe\" [optional]\"/Remote FileName.exe\"
Upload multiple files	MPUT	Upload multiple files using a mask (multiple PORT and STOR).	Example parameter: \"C:\\*.exe\"
Delete single file	DELE	Delete a file located in the FTP server	\"/FileName.exe\"
Delete multiple files	MDELETE	Delete files using a mask (multiple DELE).	\"/*.exe\"
Rename file	RNFR	Rename a file (RNFR followed by RNTO).	FileName.exe \"New FileName.exe\"
Create folder	MKD	Create a folder or directory.	\"New Folder\"
Remove folder	RMD	Remove a folder.	\"Old Folder\"
Change folder	CWD	Change the current folder	\"New Folder\"
Up one folder	CDUP	Change to the parent folder	N/A
Retrieve current folder	PWD	Retrieve the current folder	N/A
Get short file list	NLST	Retrieve a basic file listing (PORT followed by NLST).	*.exe
Get long file list	LIST	Retrieve a verbose file listing (PORT followed by LIST).	*.exe
Disconnect		Disconnect from an FTP server.	N/A
User defined		Issue a custom command to an FTP server.	N/A

Description Tab

This action includes the Description tab for entering a custom step description.

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).

Name	Data Type	Return Value
theDataset.FTPFileName	Text	The name of the current file.
theDataset.FTPFileSize	Number	The size of the current file.
theDataset.FTPFileDate	Date	The date of the current file.
theDataset.FTPFileType	Boolean	Whether the current file type is a folder or file. If it is a folder, 0 is returned. If it is a file, 1 is returned.

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, % Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.