FTP Put

The FTP Put activity issues an FTP put or mput command to the specified server. You can use process data as the content of the file to send to the remote server or you can send files in local disk storage. If you choose to use process data, you can place only one file on the remote server (FTP put command). If you use locally stored files, you can place one or more files on the remote server (FTP mput command).

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
FTP Connection	No	Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.
Quit (post-command)	No	When checked, this field specifies that the FTP connection should be closed after completing this command. If this field is not checked, the FTP connection remains open so that all FTP activities that specify the same FTP session (that is, the same host, port, username, and password) share the FTP session until the connection is closed.
Binary	Yes	Specifies whether to send the file content in binary or ASCII mode (checked signifies binary). When ASCII mode is used, differences in line endings between the FTP server and the machine executing the FTP command are automatically handled. Also, ASCII mode implies text data, and that data can be encoded in a character encoding other than ASCII (such as UTF-8 or Latin-1).
Timeout (msec)	Yes	The amount of time to wait (in milliseconds) for the FTP server to respond. This timeout is used when the FTP server places the FTP connection used by this activity into a waiting state. This overrides the value specified in the FTP Connection resource. See FTP Connection for more information.
Overwrite Existing File	Yes	When this field is checked, any existing files on the FTP server are overwritten if the FTP command sends files with the same names. If this field is unchecked, any attempt to send a file to the remote server with the same name as an existing file results in an exception.
Append	Yes	This field is only available when the Overwrite Existing File field is unchecked. This field specifies whether to append data to an existing file. If the specified file exists on the FTP server, append the data to the file when this field is checked. If this field is not checked, the file is overwritten if it exists on the FTP server.
Use Process Data	Yes	Specifies to use process data as the content of the file to place on the remote server. If this field is checked, you can only place one file on the remote server.
Maintain 2.0 Compatibility	No	This field is present only for activities migrated from TIBCO BusinessWorks 2.0. If checked, this field ensures the output schema retains the elements available in TIBCO BusinessWorks 2.0.

Input Item	Datatype	Description
RemoteFilename	string	The path and name of the file to place onto the remote server. Wildcards are not permitted in this field.
LocalFilename	string	The path and name of the local file to use in the FTP Put command. This item is only available if the Use Process Data field is unchecked.
Data	binary or string (depends upon if the Binary Configuration field is checked)	The contents of the file to be transferred to the FTP server, if the Use Process Data field is checked on the Configuration tab. You must map one or more process variables to this input item. The most common way to get the data for the remote file is to read a local file using the Read File activity, but you can map other data to this input item as well.
Host	string	The name of the FTP server. This overrides the value specified in the FTP Connection resource.
Port	integer	Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.
UserName	string	Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
Password	string	Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
Encoding	string	When the file to send is not binary and the Use Process Data field on the Configuration tab is checked, this specifies the character encoding of the file to send to the FTP server. If this is not specified, it is assumed that the encoding of the file is the same encoding of the machine where the FTP command is executed. If the encoding of the local machine and the FTP server are different, specify the encoding used by the FTP server in this element and the activity converts the file into the specified encoding.

Output Item	Datatype	Description
FilesTransferred	string	A repeating string element containing a list of names of files that were transferred. If an error occurred while transferring files, the activity output is not available. However, the Error Output tab lists the successfully transferred files and the files that failed to be transferred.
Success	boolean	Only available when Maintain 2.0 compatibility is checked on the Configuration tab. True or false depending upon whether the FTP put command was successfully executed by the FTP server.
Errormsg	string	Only available when Maintain 2.0 compatibility is checked on the Configuration tab. Any error messages returned from the FTP server.

Exception	Thrown When...
PutFilesException	An error occurred during the FTP put operation.
ConnectionErrorException	An error occurred when connecting to the FTP server.
CommandExecutionException	An error occurred when executing the FTP command.
ConnectionTimeoutException	The connection to the FTP server has timed out before the command has completed it execution.