FTP Put
FTP Put is a synchronous activity that issues an FTP put or mput command to the specified server. You can use the process data as the file content to send to the remote server or send the files to the local disk storage. Select Use Process Data to place only one file on the remote server (FTP put command). To use locally stored files for placing more than one files on the remote server (FTP mput command).
General
The General tab has the following fields.
Field | Literal Value/Module Property/Process Property | Description |
---|---|---|
Name | None | The name to be displayed as the label for the activity in the process. |
FTP Connection | Yes | The path to the shared configuration resource containing the user information such as host name, username, and password. |
Quit (post-command) | None | Select this check box to specify that the FTP connection should be closed after completing this command.
The FTP connection remains open, if you do not select this check box. All the FTP activities that specify the same FTP session (that is, the same host, port, username, and password), can share the FTP session until the connection is closed. |
Binary | None | Specifies whether to send the file content in binary or ASCII mode (selected signifies binary).
When ASCII mode is used, the differences in line-endings between the FTP server and the machine executing the FTP command are automatically handled. This mode also implies text data, and that data can be encoded in a character encoding other than ASCII (such as UTF-8 or Latin-1). |
Overwrite Existing File | None | Selecting this check box overwrites any existing files on the FTP server, if the FTP command sends files with the same names.
If this check box is not selected, any attempt to send a file to the remote server with the same name as an existing file, results in an exception. |
Append | None |
This element specifies whether to append the data to an existing file. Select this check box to append the data to the file, if the specified file exists on the FTP server. If not selected, the file is overwritten if it exists on the FTP server. |
Timeout (msec) | None | 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 property. |
Input
The following is the input for the activity.
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. |
Host | string | The name of the FTP server.
This overrides the value specified in the FTP Connection property. |
Port | integer | The port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property. |
UserName | string | The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property. |
Password | string | The password for logging into the FTP Server.
This overrides the value specified in the FTP Connection property. |
Encoding | string | Encoding of the data to be put on the FTP server. This field is present when the Use Process Data check box is selected on the General tab. |
Timeout | integer | The amount of time to wait 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 property. |
Output
The following is the output for this activity.
Fault
The Fault tab lists the following possible exceptions generated by this activity. For more information about error codes and the corrective actions to take, see the TIBCO BusinessWorks™ Container Edition Error Codes guide.
Fault | Generated 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 is timed out before the command execution is complete. |